From d7f5ca23a600fb42112e240ce5684ecf0e57f84e Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Tue, 29 Jul 2025 15:08:11 -0500 Subject: [PATCH] Fix Skype content formatting for new PlatyPS pipeline --- .openpublishing.redirection.skype.json | 4487 ++++++++++++++++- .../Add-CsSlaDelegates.md | 59 +- .../Approve-CsDeviceUpdateRule.md | 85 +- .../Backup-CsPool.md | 151 +- .../Clear-CsDeviceUpdateFile.md | 76 +- .../Clear-CsDeviceUpdateLog.md | 87 +- .../Clear-CsPersistentChatRoom.md | 48 +- .../Convert-CsUserData.md | 122 +- .../ConvertTo-JsonForPSWS.md | 38 +- .../Copy-CsVoicePolicy.md | 80 +- .../Debug-CsAddressBookReplication.md | 163 +- .../Debug-CsDataConference.md | 39 +- .../Debug-CsInterPoolReplication.md | 113 +- .../Debug-CsIntraPoolReplication.md | 112 +- .../Debug-CsLisConfiguration.md | 27 +- .../Debug-CsStorageServiceFailures.md | 61 +- .../Debug-CsUnifiedContactStore.md | 109 +- .../Disable-CsAdDomain.md | 101 +- .../Disable-CsAdForest.md | 119 +- .../Disable-CsComputer.md | 91 +- .../Disable-CsHostingProvider.md | 79 +- .../Disable-CsMeetingRoom.md | 80 +- .../Disable-CsPublicProvider.md | 79 +- .../Disable-CsUser.md | 73 +- .../Enable-CsAdDomain.md | 127 +- .../Enable-CsAdForest.md | 131 +- .../Enable-CsComputer.md | 91 +- .../Enable-CsHostingProvider.md | 79 +- .../Enable-CsMeetingRoom.md | 150 +- .../Enable-CsPublicProvider.md | 79 +- .../Enable-CsReplica.md | 89 +- .../Enable-CsTopology.md | 95 +- .../Enable-CsUser.md | 199 +- .../Export-CsArchivingData.md | 220 +- .../Export-CsConfiguration.md | 72 +- .../Export-CsLisConfiguration.md | 61 +- .../Export-CsPersistentChatData.md | 100 +- .../Export-CsRgsConfiguration.md | 79 +- .../Export-CsUserData.md | 183 +- .../Get-CsAVEdgeConfiguration.md | 75 +- .../Get-CsAccessEdgeConfiguration.md | 65 +- .../Get-CsAdContact.md | 135 +- .../Get-CsAdDomain.md | 51 +- .../Get-CsAdForest.md | 63 +- .../Get-CsAdPrincipal.md | 63 +- .../Get-CsAdServerSchema.md | 25 +- .../Get-CsAdUser.md | 143 +- .../Get-CsAdditionalInternalDomain.md | 25 +- .../Get-CsAddressBookConfiguration.md | 69 +- ...CsAddressBookNormalizationConfiguration.md | 37 +- .../Get-CsAddressBookNormalizationRule.md | 39 +- .../Get-CsAdminRole.md | 89 +- .../Get-CsAdminRoleAssignment.md | 61 +- .../Get-CsAllowedDomain.md | 75 +- .../Get-CsAnalogDevice.md | 105 +- .../Get-CsAnnouncement.md | 75 +- .../Get-CsApplicationEndpoint.md | 103 +- .../Get-CsArchivingConfiguration.md | 69 +- .../Get-CsArchivingPolicy.md | 79 +- .../Get-CsAudioConferencingProvider.md | 36 +- .../Get-CsAudioTestServiceApplication.md | 107 +- .../Get-CsAuthConfig.md | 49 +- .../Get-CsAutodiscoverConfiguration.md | 39 +- .../Get-CsBackupServiceConfiguration.md | 33 +- .../Get-CsBackupServiceStatus.md | 67 +- ...t-CsBandwidthPolicyServiceConfiguration.md | 63 +- .../Get-CsBlockedDomain.md | 73 +- .../Get-CsBroadcastMeetingConfiguration.md | 44 +- .../Get-CsBroadcastMeetingPolicy.md | 38 +- .../Get-CsBusyOptions.md | 38 +- .../Get-CsCallParkOrbit.md | 77 +- .../Get-CsCallViaWorkPolicy.md | 39 +- .../Get-CsCdrConfiguration.md | 69 +- .../Get-CsCertificate.md | 109 +- .../Get-CsClientAccessLicense.md | 129 +- .../Get-CsClientCertificate.md | 47 +- .../Get-CsClientPinInfo.md | 47 +- .../Get-CsClientPolicy.md | 82 +- .../Get-CsClientVersionConfiguration.md | 69 +- .../Get-CsClientVersionPolicy.md | 79 +- .../Get-CsClientVersionPolicyRule.md | 93 +- .../Get-CsCloudCallDataConnector.md | 17 +- ...t-CsCloudCallDataConnectorConfiguration.md | 25 +- .../Get-CsCloudMeetingPolicy.md | 46 +- .../Get-CsClsAgentStatus.md | 29 +- .../Get-CsClsConfiguration.md | 41 +- .../Get-CsClsRegion.md | 39 +- .../Get-CsClsScenario.md | 39 +- .../Get-CsClsSearchTerm.md | 39 +- .../Get-CsClsSecurityGroup.md | 39 +- .../Get-CsCommonAreaPhone.md | 99 +- .../Get-CsComputer.md | 85 +- .../Get-CsConferenceDirectory.md | 63 +- .../Get-CsConferenceDisclaimer.md | 63 +- .../Get-CsConferencingConfiguration.md | 75 +- .../Get-CsConferencingPolicy.md | 122 +- .../Get-CsConfigurationStoreLocation.md | 31 +- .../Get-CsConversationHistoryConfiguration.md | 33 +- .../Get-CsCpsConfiguration.md | 63 +- .../Get-CsDatabaseMirrorState.md | 71 +- .../Get-CsDeviceUpdateConfiguration.md | 73 +- .../Get-CsDeviceUpdateRule.md | 77 +- .../Get-CsDiagnosticConfiguration.md | 71 +- .../Get-CsDiagnosticHeaderConfiguration.md | 75 +- .../Get-CsDialInConferencingAccessNumber.md | 111 +- .../Get-CsDialInConferencingConfiguration.md | 71 +- ...t-CsDialInConferencingDtmfConfiguration.md | 69 +- .../Get-CsDialInConferencingLanguageList.md | 61 +- .../Get-CsDialPlan.md | 68 +- .../Get-CsEffectivePolicy.md | 83 +- ...et-CsEnhancedEmergencyServiceDisclaimer.md | 55 +- .../Get-CsExUmContact.md | 119 +- .../Get-CsExternalAccessPolicy.md | 126 +- .../Get-CsExternalUserCommunicationPolicy.md | 48 +- .../Get-CsFIPSConfiguration.md | 39 +- .../Get-CsFileTransferFilterConfiguration.md | 73 +- .../Get-CsGraphPolicy.md | 40 +- .../Get-CsGroupPickupUserOrbit.md | 57 +- .../Get-CsHealthMonitoringConfiguration.md | 65 +- .../Get-CsHostedVoicemailPolicy.md | 60 +- .../Get-CsHostingProvider.md | 70 +- .../Get-CsHybridApplicationEndpoint.md | 49 +- .../Get-CsHybridMediationServer.md | 56 +- .../Get-CsHybridPSTNAppliance.md | 58 +- .../Get-CsHybridPSTNSite.md | 40 +- .../Get-CsIPPhonePolicy.md | 38 +- .../Get-CsImConfiguration.md | 41 +- .../Get-CsImFilterConfiguration.md | 74 +- .../Get-CsImTranslationConfiguration.md | 33 +- .../Get-CsKerberosAccountAssignment.md | 69 +- .../Get-CsLisCivicAddress.md | 19 +- .../Get-CsLisLocation.md | 25 +- .../Get-CsLisPort.md | 17 +- .../Get-CsLisServiceProvider.md | 15 +- .../Get-CsLisSubnet.md | 17 +- .../Get-CsLisSwitch.md | 19 +- .../Get-CsLisWirelessAccessPoint.md | 19 +- .../Get-CsLocationPolicy.md | 71 +- .../Get-CsManagementConnection.md | 32 +- .../Get-CsManagementStoreReplicationStatus.md | 55 +- .../Get-CsMcxConfiguration.md | 41 +- .../Get-CsMediaConfiguration.md | 63 +- .../Get-CsMeetingConfiguration.md | 108 +- .../Get-CsMeetingRoom.md | 60 +- .../Get-CsMobilityPolicy.md | 94 +- .../Get-CsNetworkBandwidthPolicyProfile.md | 59 +- .../Get-CsNetworkConfiguration.md | 60 +- .../Get-CsNetworkInterRegionRoute.md | 63 +- .../Get-CsNetworkInterSitePolicy.md | 63 +- .../Get-CsNetworkInterface.md | 95 +- .../Get-CsNetworkRegion.md | 65 +- .../Get-CsNetworkRegionLink.md | 65 +- .../Get-CsNetworkSite.md | 65 +- .../Get-CsNetworkSubnet.md | 65 +- .../Get-CsOAuthConfiguration.md | 38 +- .../Get-CsOAuthServer.md | 41 +- ...-CsOutboundCallingNumberTranslationRule.md | 39 +- .../Get-CsOutboundTranslationRule.md | 61 +- .../Get-CsPartnerApplication.md | 45 +- .../Get-CsPersistentChatAddin.md | 31 +- .../Get-CsPersistentChatCategory.md | 67 +- ...CsPersistentChatComplianceConfiguration.md | 41 +- .../Get-CsPersistentChatConfiguration.md | 41 +- .../Get-CsPersistentChatEligiblePrincipal.md | 83 +- .../Get-CsPersistentChatEndpoint.md | 67 +- .../Get-CsPersistentChatPolicy.md | 45 +- .../Get-CsPersistentChatRoom.md | 109 +- .../Get-CsPersistentChatState.md | 39 +- .../Get-CsPinPolicy.md | 79 +- .../Get-CsPlatformServiceSettings.md | 27 +- .../{skype => SkypeForBusiness}/Get-CsPool.md | 73 +- .../Get-CsPoolBackupRelationship.md | 57 +- .../Get-CsPoolFabricState.md | 228 +- .../Get-CsPoolUpgradeReadinessState.md | 57 +- .../Get-CsPresenceManagementState.md | 27 +- .../Get-CsPresencePolicy.md | 80 +- .../Get-CsPresenceProvider.md | 39 +- .../Get-CsPrivacyConfiguration.md | 90 +- .../Get-CsProxyConfiguration.md | 77 +- .../Get-CsPstnUsage.md | 61 +- .../Get-CsPublicProvider.md | 75 +- .../Get-CsPushNotificationConfiguration.md | 46 +- .../Get-CsQoEConfiguration.md | 67 +- .../Get-CsRegistrarConfiguration.md | 81 +- .../Get-CsReportingConfiguration.md | 39 +- .../Get-CsRgsAgentGroup.md | 47 +- .../Get-CsRgsConfiguration.md | 25 +- .../Get-CsRgsHolidaySet.md | 47 +- .../Get-CsRgsHoursOfBusiness.md | 49 +- .../Get-CsRgsQueue.md | 47 +- .../Get-CsRgsWorkflow.md | 49 +- .../Get-CsRoutingConfiguration.md | 55 +- .../Get-CsServerApplication.md | 79 +- .../Get-CsServerPatchVersion.md | 23 +- .../Get-CsServerVersion.md | 15 +- .../Get-CsService.md | 464 +- .../Get-CsSimpleUrlConfiguration.md | 89 +- .../Get-CsSipDomain.md | 57 +- .../Get-CsSipResponseCodeTranslationRule.md | 71 +- .../{skype => SkypeForBusiness}/Get-CsSite.md | 65 +- .../Get-CsSlaConfiguration.md | 41 +- .../Get-CsStaticRoutingConfiguration.md | 77 +- .../Get-CsStorageServiceConfiguration.md | 37 +- .../Get-CsTeamsUpgradeConfiguration.md | 24 +- .../Get-CsTeamsUpgradePolicy.md | 42 +- .../Get-CsTelemetryConfiguration.md | 35 +- .../Get-CsTenantHybridConfiguration.md | 40 +- .../Get-CsTenantUpdateTimeWindow.md | 40 +- .../Get-CsTestDevice.md | 83 +- .../Get-CsTestUserCredential.md | 23 +- .../Get-CsThirdPartyVideoSystem.md | 97 +- .../Get-CsThirdPartyVideoSystemPolicy.md | 45 +- .../Get-CsTopology.md | 31 +- .../Get-CsTrunk.md | 39 +- .../Get-CsTrunkConfiguration.md | 63 +- .../Get-CsTrustedApplication.md | 77 +- .../Get-CsTrustedApplicationComputer.md | 79 +- .../Get-CsTrustedApplicationEndpoint.md | 117 +- .../Get-CsTrustedApplicationPool.md | 82 +- .../Get-CsUCPhoneConfiguration.md | 91 +- .../Get-CsUICulture.md | 36 +- .../Get-CsUnassignedNumber.md | 64 +- .../Get-CsUpgradeDomainInfo.md | 55 +- .../{skype => SkypeForBusiness}/Get-CsUser.md | 214 +- .../Get-CsUserAcp.md | 99 +- .../Get-CsUserCallForwardingSettings.md | 17 +- .../Get-CsUserDatabaseState.md | 38 +- .../Get-CsUserDelegates.md | 17 +- .../Get-CsUserLocationStatus.md | 62 +- .../Get-CsUserPoolInfo.md | 47 +- .../Get-CsUserPstnSettings.md | 63 +- .../Get-CsUserReplicatorConfiguration.md | 73 +- .../Get-CsUserServicesConfiguration.md | 89 +- .../Get-CsUserServicesPolicy.md | 51 +- .../Get-CsUserSession.md | 61 +- .../Get-CsUserSettingsPageConfiguration.md | 12 +- .../Get-CsUserTeamMembers.md | 17 +- .../Get-CsVideoInteropServerConfiguration.md | 44 +- ...ServerSyntheticTransactionConfiguration.md | 38 +- .../Get-CsVideoTrunk.md | 42 +- .../Get-CsVideoTrunkConfiguration.md | 44 +- .../Get-CsVoiceConfiguration.md | 60 +- .../Get-CsVoiceNormalizationRule.md | 77 +- .../Get-CsVoicePolicy.md | 67 +- .../Get-CsVoiceRoute.md | 66 +- .../Get-CsVoiceRoutingPolicy.md | 45 +- .../Get-CsVoiceTestConfiguration.md | 64 +- .../Get-CsVoicemailReroutingConfiguration.md | 66 +- .../Get-CsWatcherNodeConfiguration.md | 43 +- .../Get-CsWebServiceConfiguration.md | 87 +- .../Get-CsWindowsService.md | 91 +- .../Get-CsXmppAllowedPartner.md | 44 +- .../Get-CsXmppGatewayConfiguration.md | 37 +- .../Grant-CsArchivingPolicy.md | 127 +- .../Grant-CsCallViaWorkPolicy.md | 111 +- .../Grant-CsClientPolicy.md | 147 +- .../Grant-CsClientVersionPolicy.md | 114 +- .../Grant-CsConferencingPolicy.md | 138 +- .../Grant-CsDialPlan.md | 109 +- .../Grant-CsExternalAccessPolicy.md | 205 +- .../Grant-CsGraphPolicy.md | 88 +- .../Grant-CsHostedVoicemailPolicy.md | 111 +- .../Grant-CsIPPhonePolicy.md | 98 +- .../Grant-CsLocationPolicy.md | 96 +- .../Grant-CsMobilityPolicy.md | 137 +- .../Grant-CsOUPermission.md | 168 +- .../Grant-CsPersistentChatPolicy.md | 111 +- .../Grant-CsPinPolicy.md | 121 +- .../Grant-CsPresencePolicy.md | 128 +- .../Grant-CsSetupPermission.md | 96 +- .../Grant-CsTeamsUpgradePolicy.md | 141 +- .../Grant-CsThirdPartyVideoSystemPolicy.md | 112 +- .../Grant-CsUserServicesPolicy.md | 112 +- .../Grant-CsVoicePolicy.md | 130 +- .../Grant-CsVoiceRoutingPolicy.md | 125 +- .../Import-CSAnnouncementFile.md | 104 +- .../Import-CsCertificate.md | 181 +- ...Import-CsCompanyPhoneNormalizationRules.md | 81 +- .../Import-CsConfiguration.md | 46 +- .../Import-CsDeviceUpdate.md | 95 +- .../Import-CsLegacyConferenceDirectory.md | 66 +- .../Import-CsLegacyConfiguration.md | 69 +- .../Import-CsLisConfiguration.md | 41 +- .../Import-CsPersistentChatData.md | 72 +- .../Import-CsRgsAudioFile.md | 92 +- .../Import-CsRgsConfiguration.md | 55 +- .../Import-CsUserData.md | 157 +- .../Install-CsAdServerSchema.md | 105 +- .../Install-CsDatabase.md | 298 +- .../Install-CsMirrorDatabase.md | 208 +- .../Invoke-CsArchivingDatabasePurge.md | 161 +- .../Invoke-CsBackupServiceSync.md | 74 +- .../Invoke-CsCdrDatabasePurge.md | 124 +- .../Invoke-CsComputerFailBack.md | 97 +- .../Invoke-CsComputerFailOver.md | 109 +- .../Invoke-CsDatabaseFailover.md | 139 +- .../Invoke-CsManagementServerFailover.md | 143 +- .../Invoke-CsManagementStoreReplication.md | 61 +- .../Invoke-CsPoolFailBack.md | 131 +- .../Invoke-CsPoolFailOver.md | 148 +- .../Invoke-CsQoEDatabasePurge.md | 119 +- .../Invoke-CsRgsStoreReplicateData.md | 21 +- .../Invoke-CsStorageServiceFlush.md | 112 +- .../Invoke-CsUcsRollback.md | 111 +- .../Lock-CsClientPin.md | 80 +- .../Merge-CsLegacyTopology.md | 139 +- .../Move-CsAnalogDevice.md | 193 +- .../Move-CsApplicationEndpoint.md | 127 +- .../Move-CsCommonAreaPhone.md | 195 +- .../Move-CsConferenceDirectory.md | 94 +- .../Move-CsExUmContact.md | 175 +- .../Move-CsLegacyUser.md | 230 +- .../Move-CsManagementServer.md | 97 +- .../Move-CsMeetingRoom.md | 210 +- .../Move-CsRgsConfiguration.md | 68 +- .../Move-CsThirdPartyVideoSystem.md | 201 +- .../Move-CsUser.md | 210 +- .../New-CsAVEdgeConfiguration.md | 141 +- .../New-CsAdditionalInternalDomain.md | 67 +- .../New-CsAddressBookConfiguration.md | 268 +- ...CsAddressBookNormalizationConfiguration.md | 96 +- .../New-CsAddressBookNormalizationRule.md | 190 +- .../New-CsAdminRole.md | 188 +- .../New-CsAllowedDomain.md | 177 +- .../New-CsAnalogDevice.md | 196 +- .../New-CsAnnouncement.md | 205 +- .../New-CsArchivingConfiguration.md | 222 +- .../New-CsArchivingPolicy.md | 136 +- .../New-CsAutodiscoverConfiguration.md | 124 +- ...w-CsBandwidthPolicyServiceConfiguration.md | 145 +- .../New-CsBlockedDomain.md | 107 +- .../New-CsCallParkOrbit.md | 197 +- .../New-CsCallViaWorkPolicy.md | 140 +- .../New-CsCdrConfiguration.md | 170 +- .../New-CsClientPolicy.md | 1253 +++-- .../New-CsClientPolicyEntry.md | 38 +- .../New-CsClientVersionConfiguration.md | 123 +- .../New-CsClientVersionPolicy.md | 147 +- .../New-CsClientVersionPolicyRule.md | 344 +- ...w-CsCloudCallDataConnectorConfiguration.md | 63 +- .../New-CsClsConfiguration.md | 259 +- .../New-CsClsProvider.md | 105 +- .../New-CsClsRegion.md | 141 +- .../New-CsClsScenario.md | 135 +- .../New-CsClsSecurityGroup.md | 118 +- .../New-CsCommonAreaPhone.md | 169 +- .../New-CsConferenceDirectory.md | 86 +- .../New-CsConferencingConfiguration.md | 321 +- .../New-CsConferencingPolicy.md | 620 +-- .../New-CsCpsConfiguration.md | 148 +- .../New-CsDeviceUpdateConfiguration.md | 186 +- .../New-CsDiagnosticConfiguration.md | 151 +- .../New-CsDiagnosticHeaderConfiguration.md | 128 +- .../New-CsDiagnosticsFilter.md | 118 +- .../New-CsDialInConferencingAccessNumber.md | 219 +- .../New-CsDialInConferencingConfiguration.md | 143 +- ...w-CsDialInConferencingDtmfConfiguration.md | 190 +- .../New-CsDialPlan.md | 233 +- .../New-CsEmergencyNumber.md | 31 +- .../New-CsExUmContact.md | 147 +- .../New-CsExtendedTest.md | 38 +- .../New-CsExternalAccessPolicy.md | 215 +- .../New-CsExternalUserCommunicationPolicy.md | 80 +- .../New-CsFIPSConfiguration.md | 105 +- .../New-CsFileTransferFilterConfiguration.md | 110 +- .../New-CsGroupPickupUserOrbit.md | 71 +- .../New-CsHealthMonitoringConfiguration.md | 185 +- .../New-CsHostedVoicemailPolicy.md | 146 +- .../New-CsHostingProvider.md | 224 +- .../New-CsHybridApplicationEndpoint.md | 75 +- .../New-CsHybridPSTNSite.md | 143 +- .../New-CsImConfiguration.md | 81 +- .../New-CsImFilterConfiguration.md | 176 +- .../New-CsImTranslationConfiguration.md | 115 +- .../New-CsIssuedCertId.md | 32 +- .../New-CsKerberosAccount.md | 94 +- .../New-CsKerberosAccountAssignment.md | 106 +- .../New-CsLocationPolicy.md | 310 +- .../New-CsMcxConfiguration.md | 134 +- .../New-CsMediaConfiguration.md | 288 +- .../New-CsMeetingConfiguration.md | 250 +- .../New-CsMobilityPolicy.md | 283 +- .../New-CsNetworkBWAlternatePath.md | 32 +- .../New-CsNetworkBWPolicy.md | 40 +- .../New-CsNetworkBandwidthPolicyProfile.md | 169 +- .../New-CsNetworkInterRegionRoute.md | 141 +- .../New-CsNetworkInterSitePolicy.md | 161 +- .../New-CsNetworkMediaBypassConfiguration.md | 88 +- .../New-CsNetworkRegion.md | 224 +- .../New-CsNetworkRegionLink.md | 157 +- .../New-CsNetworkSite.md | 223 +- .../New-CsNetworkSubnet.md | 157 +- .../New-CsOAuthServer.md | 150 +- ...-CsOutboundCallingNumberTranslationRule.md | 184 +- .../New-CsOutboundTranslationRule.md | 174 +- .../New-CsPartnerApplication.md | 225 +- .../New-CsPersistentChatAddin.md | 47 +- .../New-CsPersistentChatCategory.md | 84 +- ...CsPersistentChatComplianceConfiguration.md | 169 +- .../New-CsPersistentChatConfiguration.md | 134 +- .../New-CsPersistentChatEndpoint.md | 101 +- .../New-CsPersistentChatPolicy.md | 165 +- .../New-CsPersistentChatRoom.md | 120 +- .../New-CsPinPolicy.md | 214 +- .../New-CsPlatformServiceSettings.md | 101 +- .../New-CsPresencePolicy.md | 179 +- .../New-CsPresenceProvider.md | 116 +- .../New-CsPrivacyConfiguration.md | 166 +- .../New-CsProxyConfiguration.md | 423 +- .../New-CsPublicProvider.md | 253 +- .../New-CsPushNotificationConfiguration.md | 133 +- .../New-CsQoEConfiguration.md | 176 +- .../New-CsRegistrarConfiguration.md | 273 +- .../New-CsReportingConfiguration.md | 95 +- .../New-CsRgsAgentGroup.md | 193 +- .../New-CsRgsAnswer.md | 44 +- .../New-CsRgsCallAction.md | 52 +- .../New-CsRgsHoliday.md | 62 +- .../New-CsRgsHolidaySet.md | 113 +- .../New-CsRgsHoursOfBusiness.md | 359 +- .../New-CsRgsPrompt.md | 50 +- .../New-CsRgsQuestion.md | 78 +- .../New-CsRgsQueue.md | 201 +- .../New-CsRgsTimeRange.md | 62 +- .../New-CsRgsWorkflow.md | 330 +- .../New-CsRoutingConfiguration.md | 134 +- .../New-CsServerApplication.md | 239 +- .../New-CsSimpleUrl.md | 90 +- .../New-CsSimpleUrlConfiguration.md | 108 +- .../New-CsSimpleUrlEntry.md | 29 +- .../New-CsSipDomain.md | 80 +- .../New-CsSipProxyCustom.md | 26 +- .../New-CsSipProxyRealm.md | 28 +- .../New-CsSipProxyTCP.md | 26 +- .../New-CsSipProxyTLS.md | 31 +- .../New-CsSipProxyTransport.md | 34 +- .../New-CsSipProxyUseDefault.md | 36 +- .../New-CsSipProxyUseDefaultCert.md | 36 +- .../New-CsSipResponseCodeTranslationRule.md | 156 +- .../New-CsStaticRoute.md | 126 +- .../New-CsStaticRoutingConfiguration.md | 104 +- .../New-CsStorageServiceConfiguration.md | 138 +- .../New-CsTeamsUpgradePolicy.md | 47 +- .../New-CsTelemetryConfiguration.md | 111 +- .../New-CsTenantUpdateTimeWindow.md | 166 +- .../New-CsTestDevice.md | 152 +- .../New-CsThirdPartyVideoSystem.md | 164 +- .../New-CsThirdPartyVideoSystemPolicy.md | 104 +- .../New-CsTrunkConfiguration.md | 524 +- .../New-CsTrustedApplication.md | 166 +- .../New-CsTrustedApplicationComputer.md | 80 +- .../New-CsTrustedApplicationEndpoint.md | 162 +- .../New-CsTrustedApplicationPool.md | 184 +- .../New-CsUCPhoneConfiguration.md | 186 +- .../New-CsUnassignedNumber.md | 184 +- .../New-CsUserReplicatorConfiguration.md | 146 +- .../New-CsUserServicesConfiguration.md | 270 +- .../New-CsUserServicesPolicy.md | 148 +- .../New-CsVideoInteropServerConfiguration.md | 102 +- ...ServerSyntheticTransactionConfiguration.md | 106 +- .../New-CsVideoTrunkConfiguration.md | 140 +- .../New-CsVoiceNormalizationRule.md | 246 +- .../New-CsVoicePolicy.md | 372 +- .../New-CsVoiceRegex.md | 79 +- .../New-CsVoiceRoute.md | 214 +- .../New-CsVoiceRoutingPolicy.md | 122 +- .../New-CsVoiceTestConfiguration.md | 208 +- .../New-CsVoicemailReroutingConfiguration.md | 124 +- .../New-CsWatcherNodeConfiguration.md | 220 +- .../New-CsWebLink.md | 34 +- .../New-CsWebOrigin.md | 28 +- .../New-CsWebServiceConfiguration.md | 553 +- .../New-CsWebTrustedCACertificate.md | 56 +- .../New-CsXmppAllowedPartner.md | 214 +- .../Publish-CsLisConfiguration.md | 46 +- .../Publish-CsTopology.md | 157 +- .../Register-CsHybridPSTNAppliance.md | 114 +- .../Remove-CsAVEdgeConfiguration.md | 79 +- .../Remove-CsAdditionalInternalDomain.md | 59 +- .../Remove-CsAddressBookConfiguration.md | 78 +- ...CsAddressBookNormalizationConfiguration.md | 68 +- .../Remove-CsAddressBookNormalizationRule.md | 70 +- .../Remove-CsAdminRole.md | 120 +- .../Remove-CsAllowedDomain.md | 80 +- .../Remove-CsAnalogDevice.md | 53 +- .../Remove-CsAnnouncement.md | 76 +- .../Remove-CsArchivingConfiguration.md | 79 +- .../Remove-CsArchivingPolicy.md | 103 +- .../Remove-CsAutodiscoverConfiguration.md | 69 +- .../Remove-CsBackupServiceConfiguration.md | 66 +- ...e-CsBandwidthPolicyServiceConfiguration.md | 77 +- .../Remove-CsBlockedDomain.md | 79 +- .../Remove-CsBusyOptions.md | 69 +- .../Remove-CsCallParkOrbit.md | 79 +- .../Remove-CsCallViaWorkPolicy.md | 85 +- .../Remove-CsCdrConfiguration.md | 79 +- .../Remove-CsCertificate.md | 161 +- .../Remove-CsClientPolicy.md | 104 +- .../Remove-CsClientVersionConfiguration.md | 80 +- .../Remove-CsClientVersionPolicy.md | 95 +- .../Remove-CsClientVersionPolicyRule.md | 98 +- .../Remove-CsClsConfiguration.md | 72 +- .../Remove-CsClsRegion.md | 70 +- .../Remove-CsClsScenario.md | 68 +- .../Remove-CsClsSecurityGroup.md | 70 +- .../Remove-CsCommonAreaPhone.md | 51 +- .../Remove-CsConferenceDirectory.md | 80 +- .../Remove-CsConferenceDisclaimer.md | 76 +- .../Remove-CsConferencingConfiguration.md | 80 +- .../Remove-CsConferencingPolicy.md | 98 +- .../Remove-CsConfigurationStoreLocation.md | 76 +- ...move-CsConversationHistoryConfiguration.md | 66 +- .../Remove-CsCpsConfiguration.md | 77 +- .../Remove-CsDeviceUpdateConfiguration.md | 82 +- .../Remove-CsDeviceUpdateRule.md | 81 +- .../Remove-CsDiagnosticConfiguration.md | 80 +- .../Remove-CsDiagnosticHeaderConfiguration.md | 80 +- ...Remove-CsDialInConferencingAccessNumber.md | 57 +- ...emove-CsDialInConferencingConfiguration.md | 80 +- ...e-CsDialInConferencingDtmfConfiguration.md | 80 +- .../Remove-CsDialPlan.md | 77 +- ...ve-CsEnhancedEmergencyServiceDisclaimer.md | 75 +- .../Remove-CsExUmContact.md | 49 +- .../Remove-CsExternalAccessPolicy.md | 97 +- ...emove-CsExternalUserCommunicationPolicy.md | 68 +- .../Remove-CsFIPSConfiguration.md | 94 +- ...emove-CsFileTransferFilterConfiguration.md | 79 +- .../Remove-CsGroupPickupUserOrbit.md | 64 +- .../Remove-CsHealthMonitoringConfiguration.md | 82 +- .../Remove-CsHostedVoicemailPolicy.md | 97 +- .../Remove-CsHostingProvider.md | 84 +- .../Remove-CsHybridApplicationEndpoint.md | 55 +- .../Remove-CsHybridPSTNSite.md | 90 +- .../Remove-CsImConfiguration.md | 69 +- .../Remove-CsImFilterConfiguration.md | 77 +- .../Remove-CsImTranslationConfiguration.md | 59 +- .../Remove-CsKerberosAccountAssignment.md | 78 +- .../Remove-CsLisLocation.md | 268 +- .../Remove-CsLisPort.md | 60 +- .../Remove-CsLisServiceProvider.md | 40 +- .../Remove-CsLisSubnet.md | 49 +- .../Remove-CsLisSwitch.md | 48 +- .../Remove-CsLisWirelessAccessPoint.md | 49 +- .../Remove-CsLocationPolicy.md | 97 +- .../Remove-CsManagementConnection.md | 41 +- .../Remove-CsMcxConfiguration.md | 73 +- .../Remove-CsMediaConfiguration.md | 79 +- .../Remove-CsMeetingConfiguration.md | 90 +- .../Remove-CsMobilityPolicy.md | 110 +- .../Remove-CsNetworkBandwidthPolicyProfile.md | 77 +- .../Remove-CsNetworkConfiguration.md | 77 +- .../Remove-CsNetworkInterRegionRoute.md | 77 +- .../Remove-CsNetworkInterSitePolicy.md | 77 +- .../Remove-CsNetworkRegion.md | 79 +- .../Remove-CsNetworkRegionLink.md | 77 +- .../Remove-CsNetworkSite.md | 77 +- .../Remove-CsNetworkSubnet.md | 77 +- .../Remove-CsOAuthServer.md | 98 +- ...-CsOutboundCallingNumberTranslationRule.md | 72 +- .../Remove-CsOutboundTranslationRule.md | 77 +- .../Remove-CsPartnerApplication.md | 100 +- .../Remove-CsPersistentChatAddin.md | 76 +- .../Remove-CsPersistentChatCategory.md | 44 +- ...CsPersistentChatComplianceConfiguration.md | 72 +- .../Remove-CsPersistentChatConfiguration.md | 71 +- .../Remove-CsPersistentChatEndpoint.md | 70 +- .../Remove-CsPersistentChatMessage.md | 207 +- .../Remove-CsPersistentChatPolicy.md | 104 +- .../Remove-CsPersistentChatRoom.md | 78 +- .../Remove-CsPinPolicy.md | 100 +- .../Remove-CsPlatformServiceSettings.md | 59 +- .../Remove-CsPresencePolicy.md | 100 +- .../Remove-CsPresenceProvider.md | 72 +- .../Remove-CsPrivacyConfiguration.md | 86 +- .../Remove-CsProxyConfiguration.md | 65 +- .../Remove-CsPublicProvider.md | 80 +- .../Remove-CsPushNotificationConfiguration.md | 101 +- .../Remove-CsQoEConfiguration.md | 80 +- .../Remove-CsRegistrarConfiguration.md | 80 +- .../Remove-CsReportingConfiguration.md | 72 +- .../Remove-CsRgsAgentGroup.md | 86 +- .../Remove-CsRgsHolidaySet.md | 86 +- .../Remove-CsRgsHoursOfBusiness.md | 88 +- .../Remove-CsRgsQueue.md | 86 +- .../Remove-CsRgsWorkflow.md | 86 +- .../Remove-CsRoutingConfiguration.md | 76 +- .../Remove-CsServerApplication.md | 80 +- .../Remove-CsSimpleUrlConfiguration.md | 98 +- .../Remove-CsSipDomain.md | 78 +- ...Remove-CsSipResponseCodeTranslationRule.md | 80 +- .../Remove-CsSlaConfiguration.md | 51 +- .../Remove-CsSlaDelegates.md | 51 +- .../Remove-CsStaticRoutingConfiguration.md | 79 +- .../Remove-CsStorageServiceConfiguration.md | 68 +- .../Remove-CsTeamsUpgradePolicy.md | 15 +- .../Remove-CsTelemetryConfiguration.md | 68 +- .../Remove-CsTenantUpdateTimeWindow.md | 74 +- .../Remove-CsTestDevice.md | 81 +- .../Remove-CsTestUserCredential.md | 69 +- .../Remove-CsThirdPartyVideoSystem.md | 38 +- .../Remove-CsThirdPartyVideoSystemPolicy.md | 96 +- .../Remove-CsTrunkConfiguration.md | 77 +- .../Remove-CsTrustedApplication.md | 77 +- .../Remove-CsTrustedApplicationComputer.md | 77 +- .../Remove-CsTrustedApplicationEndpoint.md | 49 +- .../Remove-CsTrustedApplicationPool.md | 77 +- .../Remove-CsUCPhoneConfiguration.md | 82 +- .../Remove-CsUnassignedNumber.md | 77 +- .../Remove-CsUserAcp.md | 88 +- .../Remove-CsUserReplicatorConfiguration.md | 76 +- .../Remove-CsUserServicesConfiguration.md | 80 +- .../Remove-CsUserServicesPolicy.md | 90 +- .../Remove-CsUserStoreBackupData.md | 67 +- ...emove-CsVideoInteropServerConfiguration.md | 70 +- ...ServerSyntheticTransactionConfiguration.md | 66 +- .../Remove-CsVideoTrunkConfiguration.md | 68 +- .../Remove-CsVoiceConfiguration.md | 75 +- .../Remove-CsVoiceNormalizationRule.md | 90 +- .../Remove-CsVoicePolicy.md | 95 +- .../Remove-CsVoiceRoute.md | 79 +- .../Remove-CsVoiceRoutingPolicy.md | 80 +- .../Remove-CsVoiceTestConfiguration.md | 77 +- ...emove-CsVoicemailReroutingConfiguration.md | 77 +- .../Remove-CsWatcherNodeConfiguration.md | 70 +- .../Remove-CsWebServiceConfiguration.md | 80 +- .../Remove-CsXmppAllowedPartner.md | 70 +- .../Request-CsCertificate.md | 379 +- .../Reset-CsDeviceUpdateRule.md | 84 +- .../Reset-CsNotificationQueues.md | 57 +- .../Reset-CsPoolRegistrarState.md | 147 +- .../Reset-CsRoutingGroup.md | 127 +- .../Restore-CsDeviceUpdateRule.md | 86 +- .../Revoke-CsClientCertificate.md | 78 +- .../Revoke-CsOUPermission.md | 164 +- .../Revoke-CsSetupPermission.md | 97 +- .../Search-CsClsLogging.md | 133 +- .../Set-CsAVEdgeConfiguration.md | 135 +- .../Set-CsAccessEdgeConfiguration.md | 476 +- .../Set-CsAddressBookConfiguration.md | 279 +- ...CsAddressBookNormalizationConfiguration.md | 84 +- .../Set-CsAddressBookNormalizationRule.md | 100 +- .../Set-CsAdminRole.md | 200 +- .../Set-CsAllowedDomain.md | 171 +- .../Set-CsAnalogDevice.md | 239 +- .../Set-CsAnnouncement.md | 175 +- .../Set-CsApplicationServer.md | 232 +- .../Set-CsArchivingConfiguration.md | 235 +- .../Set-CsArchivingPolicy.md | 165 +- .../Set-CsArchivingServer.md | 94 +- .../Set-CsAudioTestServiceApplication.md | 237 +- .../Set-CsAuthConfig.md | 55 +- .../Set-CsAutodiscoverConfiguration.md | 136 +- .../Set-CsBackupServiceConfiguration.md | 146 +- ...t-CsBandwidthPolicyServiceConfiguration.md | 131 +- .../Set-CsBlockedDomain.md | 113 +- .../Set-CsBroadcastMeetingConfiguration.md | 228 +- .../Set-CsBusyOptions.md | 76 +- .../Set-CsCallParkOrbit.md | 185 +- .../Set-CsCallParkServiceMusicOnHoldFile.md | 84 +- .../Set-CsCallViaWorkPolicy.md | 101 +- ...ApplianceConfigurationReplicationStatus.md | 74 +- .../Set-CsCceApplianceDeploymentStatus.md | 124 +- .../Set-CsCceApplianceStatus.md | 122 +- .../Set-CsCdrConfiguration.md | 186 +- .../Set-CsCertificate.md | 307 +- .../Set-CsClientPin.md | 87 +- .../Set-CsClientPolicy.md | 1257 +++-- .../Set-CsClientVersionConfiguration.md | 153 +- .../Set-CsClientVersionPolicy.md | 139 +- .../Set-CsClientVersionPolicyRule.md | 260 +- .../Set-CsCloudCallDataConnector.md | 63 +- ...t-CsCloudCallDataConnectorConfiguration.md | 33 +- .../Set-CsClsConfiguration.md | 416 +- .../Set-CsClsRegion.md | 92 +- .../Set-CsClsScenario.md | 82 +- .../Set-CsClsSearchTerm.md | 80 +- .../Set-CsClsSecurityGroup.md | 84 +- .../Set-CsCommonAreaPhone.md | 231 +- .../Set-CsConferenceDisclaimer.md | 119 +- .../Set-CsConferenceServer.md | 208 +- .../Set-CsConferencingConfiguration.md | 363 +- .../Set-CsConferencingPolicy.md | 760 +-- .../Set-CsConfigurationStoreLocation.md | 150 +- .../Set-CsConversationHistoryConfiguration.md | 86 +- .../Set-CsCpsConfiguration.md | 159 +- .../Set-CsDeviceUpdateConfiguration.md | 123 +- .../Set-CsDiagnosticConfiguration.md | 159 +- .../Set-CsDiagnosticHeaderConfiguration.md | 113 +- .../Set-CsDialInConferencingAccessNumber.md | 197 +- .../Set-CsDialInConferencingConfiguration.md | 193 +- ...t-CsDialInConferencingDtmfConfiguration.md | 219 +- .../Set-CsDialPlan.md | 201 +- .../Set-CsDirector.md | 204 +- .../Set-CsEdgeServer.md | 232 +- ...et-CsEnhancedEmergencyServiceDisclaimer.md | 107 +- .../Set-CsExUmContact.md | 179 +- .../Set-CsExternalAccessPolicy.md | 210 +- .../Set-CsExternalUserCommunicationPolicy.md | 98 +- .../Set-CsFIPSConfiguration.md | 86 +- .../Set-CsFileTransferFilterConfiguration.md | 149 +- .../Set-CsGroupPickupUserOrbit.md | 69 +- .../Set-CsHealthMonitoringConfiguration.md | 156 +- .../Set-CsHostedVoicemailPolicy.md | 171 +- .../Set-CsHostingProvider.md | 215 +- .../Set-CsHybridApplicationEndpoint.md | 71 +- .../Set-CsHybridMediationServer.md | 70 +- .../Set-CsHybridPSTNAppliance.md | 94 +- .../Set-CsHybridPSTNSite.md | 132 +- .../Set-CsIPPhonePolicy.md | 186 +- .../Set-CsImConfiguration.md | 81 +- .../Set-CsImFilterConfiguration.md | 187 +- .../Set-CsImTranslationConfiguration.md | 105 +- .../Set-CsKerberosAccountAssignment.md | 99 +- .../Set-CsKerberosAccountPassword.md | 122 +- .../Set-CsLisLocation.md | 298 +- .../Set-CsLisPort.md | 293 +- .../Set-CsLisServiceProvider.md | 63 +- .../Set-CsLisSubnet.md | 289 +- .../Set-CsLisSwitch.md | 279 +- .../Set-CsLisWirelessAccessPoint.md | 279 +- .../Set-CsLocationPolicy.md | 323 +- .../Set-CsManagementConnection.md | 82 +- .../Set-CsManagementServer.md | 80 +- .../Set-CsMcxConfiguration.md | 104 +- .../Set-CsMediaConfiguration.md | 311 +- .../Set-CsMediationServer.md | 152 +- .../Set-CsMeetingConfiguration.md | 298 +- .../Set-CsMeetingRoom.md | 177 +- .../Set-CsMobilityPolicy.md | 372 +- .../Set-CsMonitoringServer.md | 86 +- .../Set-CsNetworkBandwidthPolicyProfile.md | 187 +- .../Set-CsNetworkConfiguration.md | 202 +- .../Set-CsNetworkInterRegionRoute.md | 109 +- .../Set-CsNetworkInterSitePolicy.md | 127 +- .../Set-CsNetworkRegion.md | 181 +- .../Set-CsNetworkRegionLink.md | 127 +- .../Set-CsNetworkSite.md | 213 +- .../Set-CsNetworkSubnet.md | 127 +- .../Set-CsOAuthConfiguration.md | 215 +- .../Set-CsOAuthServer.md | 144 +- ...-CsOutboundCallingNumberTranslationRule.md | 98 +- .../Set-CsOutboundTranslationRule.md | 135 +- .../Set-CsPartnerApplication.md | 257 +- .../Set-CsPersistentChatActiveServer.md | 93 +- .../Set-CsPersistentChatAddin.md | 72 +- .../Set-CsPersistentChatCategory.md | 184 +- ...CsPersistentChatComplianceConfiguration.md | 130 +- .../Set-CsPersistentChatConfiguration.md | 104 +- .../Set-CsPersistentChatPolicy.md | 114 +- .../Set-CsPersistentChatRoom.md | 210 +- .../Set-CsPersistentChatState.md | 80 +- .../Set-CsPinPolicy.md | 203 +- .../Set-CsPlatformServiceSettings.md | 101 +- .../Set-CsPresenceManagementState.md | 169 +- .../Set-CsPresencePolicy.md | 153 +- .../Set-CsPresenceProvider.md | 74 +- .../Set-CsPrivacyConfiguration.md | 188 +- .../Set-CsProxyConfiguration.md | 437 +- .../Set-CsPstnGateway.md | 174 +- .../Set-CsPstnUsage.md | 93 +- .../Set-CsPublicProvider.md | 125 +- .../Set-CsPushNotificationConfiguration.md | 98 +- .../Set-CsQoEConfiguration.md | 193 +- .../Set-CsRegistrar.md | 340 +- .../Set-CsRegistrarConfiguration.md | 297 +- .../Set-CsReportingConfiguration.md | 80 +- .../Set-CsRgsAgentGroup.md | 81 +- .../Set-CsRgsConfiguration.md | 143 +- .../Set-CsRgsHolidaySet.md | 79 +- .../Set-CsRgsHoursOfBusiness.md | 79 +- .../Set-CsRgsQueue.md | 77 +- .../Set-CsRgsWorkflow.md | 79 +- .../Set-CsRoutingConfiguration.md | 149 +- .../Set-CsServerApplication.md | 193 +- .../Set-CsSimpleUrlConfiguration.md | 102 +- .../Set-CsSipDomain.md | 80 +- .../Set-CsSipResponseCodeTranslationRule.md | 149 +- .../{skype => SkypeForBusiness}/Set-CsSite.md | 126 +- .../Set-CsSlaConfiguration.md | 115 +- .../Set-CsStaticRoutingConfiguration.md | 91 +- .../Set-CsStorageServiceConfiguration.md | 98 +- .../Set-CsTeamsUpgradeConfiguration.md | 94 +- .../Set-CsTeamsUpgradePolicy.md | 24 +- .../Set-CsTelemetryConfiguration.md | 80 +- .../Set-CsTenantHybridConfiguration.md | 104 +- .../Set-CsTenantUpdateTimeWindow.md | 168 +- .../Set-CsTestDevice.md | 127 +- .../Set-CsTestUserCredential.md | 87 +- .../Set-CsThirdPartyVideoSystem.md | 131 +- .../Set-CsThirdPartyVideoSystemPolicy.md | 88 +- .../Set-CsTrunkConfiguration.md | 557 +- .../Set-CsTrustedApplication.md | 81 +- .../Set-CsTrustedApplicationEndpoint.md | 201 +- .../Set-CsTrustedApplicationPool.md | 167 +- .../Set-CsUCPhoneConfiguration.md | 226 +- .../Set-CsUICulture.md | 48 +- .../Set-CsUnassignedNumber.md | 187 +- .../{skype => SkypeForBusiness}/Set-CsUser.md | 293 +- .../Set-CsUserAcp.md | 170 +- .../Set-CsUserCallForwardingSettings.md | 93 +- .../Set-CsUserDatabaseState.md | 91 +- .../Set-CsUserDelegates.md | 43 +- .../Set-CsUserPstnSettings.md | 109 +- .../Set-CsUserReplicatorConfiguration.md | 177 +- .../Set-CsUserServer.md | 150 +- .../Set-CsUserServicesConfiguration.md | 283 +- .../Set-CsUserServicesPolicy.md | 124 +- .../Set-CsUserTeamMembers.md | 43 +- .../Set-CsVideoGateway.md | 88 +- .../Set-CsVideoInteropServer.md | 124 +- .../Set-CsVideoInteropServerConfiguration.md | 89 +- ...ServerSyntheticTransactionConfiguration.md | 80 +- .../Set-CsVideoTrunkConfiguration.md | 106 +- .../Set-CsVoiceConfiguration.md | 87 +- .../Set-CsVoiceNormalizationRule.md | 168 +- .../Set-CsVoicePolicy.md | 353 +- .../Set-CsVoiceRoute.md | 173 +- .../Set-CsVoiceRoutingPolicy.md | 96 +- .../Set-CsVoiceTestConfiguration.md | 181 +- .../Set-CsVoicemailReroutingConfiguration.md | 143 +- .../Set-CsWatcherNodeConfiguration.md | 148 +- .../Set-CsWebServer.md | 355 +- .../Set-CsWebServiceConfiguration.md | 502 +- .../Set-CsXmppAllowedPartner.md | 136 +- .../Set-CsXmppGatewayConfiguration.md | 122 +- .../Show-CsClsLogging.md | 41 +- .../SkypeForBusiness.md} | 0 .../Start-CsClsLogging.md | 91 +- .../Start-CsPool.md | 101 +- .../Start-CsWindowsService.md | 126 +- .../Stop-CsClsLogging.md | 79 +- .../Stop-CsWindowsService.md | 156 +- .../Sync-CsClsLogging.md | 41 +- .../Sync-CsUserData.md | 65 +- .../Test-CsASConference.md | 210 +- .../Test-CsAVConference.md | 266 +- .../Test-CsAVEdgeConnectivity.md | 194 +- .../Test-CsAddressBookService.md | 259 +- .../Test-CsAddressBookWebQuery.md | 286 +- .../Test-CsAudioConferencingProvider.md | 170 +- .../Test-CsCertificateConfiguration.md | 46 +- .../Test-CsClientAuth.md | 118 +- .../Test-CsClientAuthentication.md | 132 +- .../Test-CsComputer.md | 44 +- .../Test-CsDataConference.md | 249 +- .../Test-CsDatabase.md | 127 +- .../Test-CsDialInConferencing.md | 238 +- .../Test-CsDialPlan.md | 37 +- .../Test-CsExStorageConnectivity.md | 88 +- .../Test-CsExStorageNotification.md | 72 +- .../Test-CsExUMConnectivity.md | 154 +- .../Test-CsExUMVoiceMail.md | 167 +- .../Test-CsFederatedPartner.md | 144 +- .../Test-CsGroupExpansion.md | 296 +- .../Test-CsGroupIM.md | 265 +- .../{skype => SkypeForBusiness}/Test-CsIM.md | 347 +- .../Test-CsInterTrunkRouting.md | 92 +- .../Test-CsKerberosAccountAssignment.md | 48 +- .../Test-CsLisCivicAddress.md | 107 +- .../Test-CsLisConfiguration.md | 314 +- .../Test-CsLocationPolicy.md | 211 +- .../Test-CsManagementServer.md | 26 +- .../Test-CsMcxConference.md | 217 +- .../Test-CsMcxP2PIM.md | 200 +- .../Test-CsMcxPushNotification.md | 42 +- .../Test-CsOUPermission.md | 146 +- .../Test-CsP2PAV.md | 270 +- .../Test-CsP2PVideoInteropServerSipTrunkAV.md | 143 +- .../Test-CsPersistentChatMessage.md | 237 +- .../Test-CsPhoneBootstrap.md | 202 +- .../Test-CsPresence.md | 270 +- .../Test-CsPstnOutboundCall.md | 239 +- .../Test-CsPstnPeerToPeerCall.md | 271 +- .../Test-CsRegistration.md | 213 +- .../Test-CsReplica.md | 40 +- .../Test-CsSetupPermission.md | 64 +- .../Test-CsTopology.md | 78 +- .../Test-CsTrunkConfiguration.md | 69 +- .../Test-CsUcwaConference.md | 210 +- .../Test-CsUnifiedContactStore.md | 184 +- .../Test-CsVoiceNormalizationRule.md | 38 +- .../Test-CsVoicePolicy.md | 91 +- .../Test-CsVoiceRoute.md | 75 +- .../Test-CsVoiceTestConfiguration.md | 137 +- .../Test-CsVoiceUser.md | 66 +- .../Test-CsWatcherNodeConfiguration.md | 32 +- .../Test-CsWebApp.md | 219 +- .../Test-CsWebAppAnonymous.md | 202 +- .../Test-CsWebScheduler.md | 196 +- .../Test-CsXmppIM.md | 182 +- .../Uninstall-CsDatabase.md | 130 +- .../Uninstall-CsMirrorDatabase.md | 109 +- .../Unlock-CsClientPin.md | 77 +- .../Unpublish-CsLisConfiguration.md | 46 +- .../Unregister-CsHybridPSTNAppliance.md | 94 +- .../Update-CsAddressBook.md | 55 +- .../Update-CsAdminRole.md | 45 +- .../Update-CsClsLogging.md | 103 +- .../Update-CsTenantMeetingUrl.md | 76 +- .../Update-CsUserData.md | 172 +- .../Update-CsUserDatabase.md | 53 +- 901 files changed, 63055 insertions(+), 47706 deletions(-) rename skype/skype-ps/{skype => SkypeForBusiness}/Add-CsSlaDelegates.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Approve-CsDeviceUpdateRule.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Backup-CsPool.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/Clear-CsDeviceUpdateFile.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Clear-CsDeviceUpdateLog.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Clear-CsPersistentChatRoom.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Convert-CsUserData.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/ConvertTo-JsonForPSWS.md (93%) rename skype/skype-ps/{skype => SkypeForBusiness}/Copy-CsVoicePolicy.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/Debug-CsAddressBookReplication.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Debug-CsDataConference.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Debug-CsInterPoolReplication.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Debug-CsIntraPoolReplication.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Debug-CsLisConfiguration.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Debug-CsStorageServiceFailures.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Debug-CsUnifiedContactStore.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Disable-CsAdDomain.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Disable-CsAdForest.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Disable-CsComputer.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Disable-CsHostingProvider.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Disable-CsMeetingRoom.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Disable-CsPublicProvider.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Disable-CsUser.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Enable-CsAdDomain.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/Enable-CsAdForest.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/Enable-CsComputer.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Enable-CsHostingProvider.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Enable-CsMeetingRoom.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Enable-CsPublicProvider.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Enable-CsReplica.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/Enable-CsTopology.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Enable-CsUser.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Export-CsArchivingData.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Export-CsConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Export-CsLisConfiguration.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Export-CsPersistentChatData.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Export-CsRgsConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Export-CsUserData.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsAVEdgeConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsAccessEdgeConfiguration.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsAdContact.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsAdDomain.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsAdForest.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsAdPrincipal.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsAdServerSchema.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsAdUser.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsAdditionalInternalDomain.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsAddressBookConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsAddressBookNormalizationConfiguration.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsAddressBookNormalizationRule.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsAdminRole.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsAdminRoleAssignment.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsAllowedDomain.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsAnalogDevice.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsAnnouncement.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsApplicationEndpoint.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsArchivingConfiguration.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsArchivingPolicy.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsAudioConferencingProvider.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsAudioTestServiceApplication.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsAuthConfig.md (93%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsAutodiscoverConfiguration.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsBackupServiceConfiguration.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsBackupServiceStatus.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsBandwidthPolicyServiceConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsBlockedDomain.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsBroadcastMeetingConfiguration.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsBroadcastMeetingPolicy.md (95%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsBusyOptions.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsCallParkOrbit.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsCallViaWorkPolicy.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsCdrConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsCertificate.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsClientAccessLicense.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsClientCertificate.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsClientPinInfo.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsClientPolicy.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsClientVersionConfiguration.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsClientVersionPolicy.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsClientVersionPolicyRule.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsCloudCallDataConnector.md (95%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsCloudCallDataConnectorConfiguration.md (96%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsCloudMeetingPolicy.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsClsAgentStatus.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsClsConfiguration.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsClsRegion.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsClsScenario.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsClsSearchTerm.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsClsSecurityGroup.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsCommonAreaPhone.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsComputer.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsConferenceDirectory.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsConferenceDisclaimer.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsConferencingConfiguration.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsConferencingPolicy.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsConfigurationStoreLocation.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsConversationHistoryConfiguration.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsCpsConfiguration.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsDatabaseMirrorState.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsDeviceUpdateConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsDeviceUpdateRule.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsDiagnosticConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsDiagnosticHeaderConfiguration.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsDialInConferencingAccessNumber.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsDialInConferencingConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsDialInConferencingDtmfConfiguration.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsDialInConferencingLanguageList.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsDialPlan.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsEffectivePolicy.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsEnhancedEmergencyServiceDisclaimer.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsExUmContact.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsExternalAccessPolicy.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsExternalUserCommunicationPolicy.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsFIPSConfiguration.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsFileTransferFilterConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsGraphPolicy.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsGroupPickupUserOrbit.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsHealthMonitoringConfiguration.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsHostedVoicemailPolicy.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsHostingProvider.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsHybridApplicationEndpoint.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsHybridMediationServer.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsHybridPSTNAppliance.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsHybridPSTNSite.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsIPPhonePolicy.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsImConfiguration.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsImFilterConfiguration.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsImTranslationConfiguration.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsKerberosAccountAssignment.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsLisCivicAddress.md (93%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsLisLocation.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsLisPort.md (95%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsLisServiceProvider.md (96%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsLisSubnet.md (95%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsLisSwitch.md (94%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsLisWirelessAccessPoint.md (94%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsLocationPolicy.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsManagementConnection.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsManagementStoreReplicationStatus.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsMcxConfiguration.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsMediaConfiguration.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsMeetingConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsMeetingRoom.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsMobilityPolicy.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsNetworkBandwidthPolicyProfile.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsNetworkConfiguration.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsNetworkInterRegionRoute.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsNetworkInterSitePolicy.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsNetworkInterface.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsNetworkRegion.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsNetworkRegionLink.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsNetworkSite.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsNetworkSubnet.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsOAuthConfiguration.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsOAuthServer.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsOutboundCallingNumberTranslationRule.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsOutboundTranslationRule.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsPartnerApplication.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsPersistentChatAddin.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsPersistentChatCategory.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsPersistentChatComplianceConfiguration.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsPersistentChatConfiguration.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsPersistentChatEligiblePrincipal.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsPersistentChatEndpoint.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsPersistentChatPolicy.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsPersistentChatRoom.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsPersistentChatState.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsPinPolicy.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsPlatformServiceSettings.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsPool.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsPoolBackupRelationship.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsPoolFabricState.md (81%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsPoolUpgradeReadinessState.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsPresenceManagementState.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsPresencePolicy.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsPresenceProvider.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsPrivacyConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsProxyConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsPstnUsage.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsPublicProvider.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsPushNotificationConfiguration.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsQoEConfiguration.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsRegistrarConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsReportingConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsRgsAgentGroup.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsRgsConfiguration.md (94%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsRgsHolidaySet.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsRgsHoursOfBusiness.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsRgsQueue.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsRgsWorkflow.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsRoutingConfiguration.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsServerApplication.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsServerPatchVersion.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsServerVersion.md (97%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsService.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsSimpleUrlConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsSipDomain.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsSipResponseCodeTranslationRule.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsSite.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsSlaConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsStaticRoutingConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsStorageServiceConfiguration.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsTeamsUpgradeConfiguration.md (94%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsTeamsUpgradePolicy.md (94%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsTelemetryConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsTenantHybridConfiguration.md (95%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsTenantUpdateTimeWindow.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsTestDevice.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsTestUserCredential.md (95%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsThirdPartyVideoSystem.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsThirdPartyVideoSystemPolicy.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsTopology.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsTrunk.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsTrunkConfiguration.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsTrustedApplication.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsTrustedApplicationComputer.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsTrustedApplicationEndpoint.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsTrustedApplicationPool.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsUCPhoneConfiguration.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsUICulture.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsUnassignedNumber.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsUpgradeDomainInfo.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsUser.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsUserAcp.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsUserCallForwardingSettings.md (96%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsUserDatabaseState.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsUserDelegates.md (96%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsUserLocationStatus.md (93%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsUserPoolInfo.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsUserPstnSettings.md (93%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsUserReplicatorConfiguration.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsUserServicesConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsUserServicesPolicy.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsUserSession.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsUserSettingsPageConfiguration.md (98%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsUserTeamMembers.md (96%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsVideoInteropServerConfiguration.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsVideoInteropServerSyntheticTransactionConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsVideoTrunk.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsVideoTrunkConfiguration.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsVoiceConfiguration.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsVoiceNormalizationRule.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsVoicePolicy.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsVoiceRoute.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsVoiceRoutingPolicy.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsVoiceTestConfiguration.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsVoicemailReroutingConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsWatcherNodeConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsWebServiceConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsWindowsService.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsXmppAllowedPartner.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Get-CsXmppGatewayConfiguration.md (93%) rename skype/skype-ps/{skype => SkypeForBusiness}/Grant-CsArchivingPolicy.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Grant-CsCallViaWorkPolicy.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Grant-CsClientPolicy.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Grant-CsClientVersionPolicy.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Grant-CsConferencingPolicy.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Grant-CsDialPlan.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Grant-CsExternalAccessPolicy.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Grant-CsGraphPolicy.md (96%) rename skype/skype-ps/{skype => SkypeForBusiness}/Grant-CsHostedVoicemailPolicy.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Grant-CsIPPhonePolicy.md (96%) rename skype/skype-ps/{skype => SkypeForBusiness}/Grant-CsLocationPolicy.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Grant-CsMobilityPolicy.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Grant-CsOUPermission.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Grant-CsPersistentChatPolicy.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Grant-CsPinPolicy.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Grant-CsPresencePolicy.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Grant-CsSetupPermission.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Grant-CsTeamsUpgradePolicy.md (97%) rename skype/skype-ps/{skype => SkypeForBusiness}/Grant-CsThirdPartyVideoSystemPolicy.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Grant-CsUserServicesPolicy.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Grant-CsVoicePolicy.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Grant-CsVoiceRoutingPolicy.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Import-CSAnnouncementFile.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Import-CsCertificate.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Import-CsCompanyPhoneNormalizationRules.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Import-CsConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Import-CsDeviceUpdate.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Import-CsLegacyConferenceDirectory.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Import-CsLegacyConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Import-CsLisConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Import-CsPersistentChatData.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Import-CsRgsAudioFile.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Import-CsRgsConfiguration.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Import-CsUserData.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Install-CsAdServerSchema.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Install-CsDatabase.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Install-CsMirrorDatabase.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Invoke-CsArchivingDatabasePurge.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Invoke-CsBackupServiceSync.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Invoke-CsCdrDatabasePurge.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Invoke-CsComputerFailBack.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Invoke-CsComputerFailOver.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Invoke-CsDatabaseFailover.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Invoke-CsManagementServerFailover.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Invoke-CsManagementStoreReplication.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Invoke-CsPoolFailBack.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Invoke-CsPoolFailOver.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Invoke-CsQoEDatabasePurge.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Invoke-CsRgsStoreReplicateData.md (94%) rename skype/skype-ps/{skype => SkypeForBusiness}/Invoke-CsStorageServiceFlush.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Invoke-CsUcsRollback.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Lock-CsClientPin.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Merge-CsLegacyTopology.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Move-CsAnalogDevice.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Move-CsApplicationEndpoint.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Move-CsCommonAreaPhone.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Move-CsConferenceDirectory.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Move-CsExUmContact.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Move-CsLegacyUser.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Move-CsManagementServer.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Move-CsMeetingRoom.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Move-CsRgsConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Move-CsThirdPartyVideoSystem.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Move-CsUser.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsAVEdgeConfiguration.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsAdditionalInternalDomain.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsAddressBookConfiguration.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsAddressBookNormalizationConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsAddressBookNormalizationRule.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsAdminRole.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsAllowedDomain.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsAnalogDevice.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsAnnouncement.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsArchivingConfiguration.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsArchivingPolicy.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsAutodiscoverConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsBandwidthPolicyServiceConfiguration.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsBlockedDomain.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsCallParkOrbit.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsCallViaWorkPolicy.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsCdrConfiguration.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsClientPolicy.md (81%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsClientPolicyEntry.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsClientVersionConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsClientVersionPolicy.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsClientVersionPolicyRule.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsCloudCallDataConnectorConfiguration.md (94%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsClsConfiguration.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsClsProvider.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsClsRegion.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsClsScenario.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsClsSecurityGroup.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsCommonAreaPhone.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsConferenceDirectory.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsConferencingConfiguration.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsConferencingPolicy.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsCpsConfiguration.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsDeviceUpdateConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsDiagnosticConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsDiagnosticHeaderConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsDiagnosticsFilter.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsDialInConferencingAccessNumber.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsDialInConferencingConfiguration.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsDialInConferencingDtmfConfiguration.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsDialPlan.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsEmergencyNumber.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsExUmContact.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsExtendedTest.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsExternalAccessPolicy.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsExternalUserCommunicationPolicy.md (96%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsFIPSConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsFileTransferFilterConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsGroupPickupUserOrbit.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsHealthMonitoringConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsHostedVoicemailPolicy.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsHostingProvider.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsHybridApplicationEndpoint.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsHybridPSTNSite.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsImConfiguration.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsImFilterConfiguration.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsImTranslationConfiguration.md (79%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsIssuedCertId.md (93%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsKerberosAccount.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsKerberosAccountAssignment.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsLocationPolicy.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsMcxConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsMediaConfiguration.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsMeetingConfiguration.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsMobilityPolicy.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsNetworkBWAlternatePath.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsNetworkBWPolicy.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsNetworkBandwidthPolicyProfile.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsNetworkInterRegionRoute.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsNetworkInterSitePolicy.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsNetworkMediaBypassConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsNetworkRegion.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsNetworkRegionLink.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsNetworkSite.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsNetworkSubnet.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsOAuthServer.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsOutboundCallingNumberTranslationRule.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsOutboundTranslationRule.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsPartnerApplication.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsPersistentChatAddin.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsPersistentChatCategory.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsPersistentChatComplianceConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsPersistentChatConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsPersistentChatEndpoint.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsPersistentChatPolicy.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsPersistentChatRoom.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsPinPolicy.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsPlatformServiceSettings.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsPresencePolicy.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsPresenceProvider.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsPrivacyConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsProxyConfiguration.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsPublicProvider.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsPushNotificationConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsQoEConfiguration.md (81%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsRegistrarConfiguration.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsReportingConfiguration.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsRgsAgentGroup.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsRgsAnswer.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsRgsCallAction.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsRgsHoliday.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsRgsHolidaySet.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsRgsHoursOfBusiness.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsRgsPrompt.md (94%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsRgsQuestion.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsRgsQueue.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsRgsTimeRange.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsRgsWorkflow.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsRoutingConfiguration.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsServerApplication.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsSimpleUrl.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsSimpleUrlConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsSimpleUrlEntry.md (95%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsSipDomain.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsSipProxyCustom.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsSipProxyRealm.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsSipProxyTCP.md (94%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsSipProxyTLS.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsSipProxyTransport.md (93%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsSipProxyUseDefault.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsSipProxyUseDefaultCert.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsSipResponseCodeTranslationRule.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsStaticRoute.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsStaticRoutingConfiguration.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsStorageServiceConfiguration.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsTeamsUpgradePolicy.md (96%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsTelemetryConfiguration.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsTenantUpdateTimeWindow.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsTestDevice.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsThirdPartyVideoSystem.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsThirdPartyVideoSystemPolicy.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsTrunkConfiguration.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsTrustedApplication.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsTrustedApplicationComputer.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsTrustedApplicationEndpoint.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsTrustedApplicationPool.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsUCPhoneConfiguration.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsUnassignedNumber.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsUserReplicatorConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsUserServicesConfiguration.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsUserServicesPolicy.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsVideoInteropServerConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsVideoInteropServerSyntheticTransactionConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsVideoTrunkConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsVoiceNormalizationRule.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsVoicePolicy.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsVoiceRegex.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsVoiceRoute.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsVoiceRoutingPolicy.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsVoiceTestConfiguration.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsVoicemailReroutingConfiguration.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsWatcherNodeConfiguration.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsWebLink.md (94%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsWebOrigin.md (94%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsWebServiceConfiguration.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsWebTrustedCACertificate.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/New-CsXmppAllowedPartner.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Publish-CsLisConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Publish-CsTopology.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Register-CsHybridPSTNAppliance.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsAVEdgeConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsAdditionalInternalDomain.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsAddressBookConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsAddressBookNormalizationConfiguration.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsAddressBookNormalizationRule.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsAdminRole.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsAllowedDomain.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsAnalogDevice.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsAnnouncement.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsArchivingConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsArchivingPolicy.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsAutodiscoverConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsBackupServiceConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsBandwidthPolicyServiceConfiguration.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsBlockedDomain.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsBusyOptions.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsCallParkOrbit.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsCallViaWorkPolicy.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsCdrConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsCertificate.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsClientPolicy.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsClientVersionConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsClientVersionPolicy.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsClientVersionPolicyRule.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsClsConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsClsRegion.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsClsScenario.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsClsSecurityGroup.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsCommonAreaPhone.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsConferenceDirectory.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsConferenceDisclaimer.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsConferencingConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsConferencingPolicy.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsConfigurationStoreLocation.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsConversationHistoryConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsCpsConfiguration.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsDeviceUpdateConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsDeviceUpdateRule.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsDiagnosticConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsDiagnosticHeaderConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsDialInConferencingAccessNumber.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsDialInConferencingConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsDialInConferencingDtmfConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsDialPlan.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsEnhancedEmergencyServiceDisclaimer.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsExUmContact.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsExternalAccessPolicy.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsExternalUserCommunicationPolicy.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsFIPSConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsFileTransferFilterConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsGroupPickupUserOrbit.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsHealthMonitoringConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsHostedVoicemailPolicy.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsHostingProvider.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsHybridApplicationEndpoint.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsHybridPSTNSite.md (93%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsImConfiguration.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsImFilterConfiguration.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsImTranslationConfiguration.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsKerberosAccountAssignment.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsLisLocation.md (56%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsLisPort.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsLisServiceProvider.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsLisSubnet.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsLisSwitch.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsLisWirelessAccessPoint.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsLocationPolicy.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsManagementConnection.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsMcxConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsMediaConfiguration.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsMeetingConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsMobilityPolicy.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsNetworkBandwidthPolicyProfile.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsNetworkConfiguration.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsNetworkInterRegionRoute.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsNetworkInterSitePolicy.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsNetworkRegion.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsNetworkRegionLink.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsNetworkSite.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsNetworkSubnet.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsOAuthServer.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsOutboundCallingNumberTranslationRule.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsOutboundTranslationRule.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsPartnerApplication.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsPersistentChatAddin.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsPersistentChatCategory.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsPersistentChatComplianceConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsPersistentChatConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsPersistentChatEndpoint.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsPersistentChatMessage.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsPersistentChatPolicy.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsPersistentChatRoom.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsPinPolicy.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsPlatformServiceSettings.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsPresencePolicy.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsPresenceProvider.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsPrivacyConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsProxyConfiguration.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsPublicProvider.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsPushNotificationConfiguration.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsQoEConfiguration.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsRegistrarConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsReportingConfiguration.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsRgsAgentGroup.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsRgsHolidaySet.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsRgsHoursOfBusiness.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsRgsQueue.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsRgsWorkflow.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsRoutingConfiguration.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsServerApplication.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsSimpleUrlConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsSipDomain.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsSipResponseCodeTranslationRule.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsSlaConfiguration.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsSlaDelegates.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsStaticRoutingConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsStorageServiceConfiguration.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsTeamsUpgradePolicy.md (98%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsTelemetryConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsTenantUpdateTimeWindow.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsTestDevice.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsTestUserCredential.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsThirdPartyVideoSystem.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsThirdPartyVideoSystemPolicy.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsTrunkConfiguration.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsTrustedApplication.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsTrustedApplicationComputer.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsTrustedApplicationEndpoint.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsTrustedApplicationPool.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsUCPhoneConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsUnassignedNumber.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsUserAcp.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsUserReplicatorConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsUserServicesConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsUserServicesPolicy.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsUserStoreBackupData.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsVideoInteropServerConfiguration.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsVideoTrunkConfiguration.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsVoiceConfiguration.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsVoiceNormalizationRule.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsVoicePolicy.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsVoiceRoute.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsVoiceRoutingPolicy.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsVoiceTestConfiguration.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsVoicemailReroutingConfiguration.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsWatcherNodeConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsWebServiceConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Remove-CsXmppAllowedPartner.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Request-CsCertificate.md (81%) rename skype/skype-ps/{skype => SkypeForBusiness}/Reset-CsDeviceUpdateRule.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Reset-CsNotificationQueues.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Reset-CsPoolRegistrarState.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Reset-CsRoutingGroup.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Restore-CsDeviceUpdateRule.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Revoke-CsClientCertificate.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Revoke-CsOUPermission.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Revoke-CsSetupPermission.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Search-CsClsLogging.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsAVEdgeConfiguration.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsAccessEdgeConfiguration.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsAddressBookConfiguration.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsAddressBookNormalizationConfiguration.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsAddressBookNormalizationRule.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsAdminRole.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsAllowedDomain.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsAnalogDevice.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsAnnouncement.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsApplicationServer.md (80%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsArchivingConfiguration.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsArchivingPolicy.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsArchivingServer.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsAudioTestServiceApplication.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsAuthConfig.md (96%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsAutodiscoverConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsBackupServiceConfiguration.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsBandwidthPolicyServiceConfiguration.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsBlockedDomain.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsBroadcastMeetingConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsBusyOptions.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsCallParkOrbit.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsCallParkServiceMusicOnHoldFile.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsCallViaWorkPolicy.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsCceApplianceConfigurationReplicationStatus.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsCceApplianceDeploymentStatus.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsCceApplianceStatus.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsCdrConfiguration.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsCertificate.md (78%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsClientPin.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsClientPolicy.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsClientVersionConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsClientVersionPolicy.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsClientVersionPolicyRule.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsCloudCallDataConnector.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsCloudCallDataConnectorConfiguration.md (95%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsClsConfiguration.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsClsRegion.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsClsScenario.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsClsSearchTerm.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsClsSecurityGroup.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsCommonAreaPhone.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsConferenceDisclaimer.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsConferenceServer.md (81%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsConferencingConfiguration.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsConferencingPolicy.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsConfigurationStoreLocation.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsConversationHistoryConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsCpsConfiguration.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsDeviceUpdateConfiguration.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsDiagnosticConfiguration.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsDiagnosticHeaderConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsDialInConferencingAccessNumber.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsDialInConferencingConfiguration.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsDialInConferencingDtmfConfiguration.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsDialPlan.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsDirector.md (81%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsEdgeServer.md (81%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsEnhancedEmergencyServiceDisclaimer.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsExUmContact.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsExternalAccessPolicy.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsExternalUserCommunicationPolicy.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsFIPSConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsFileTransferFilterConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsGroupPickupUserOrbit.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsHealthMonitoringConfiguration.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsHostedVoicemailPolicy.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsHostingProvider.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsHybridApplicationEndpoint.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsHybridMediationServer.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsHybridPSTNAppliance.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsHybridPSTNSite.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsIPPhonePolicy.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsImConfiguration.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsImFilterConfiguration.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsImTranslationConfiguration.md (80%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsKerberosAccountAssignment.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsKerberosAccountPassword.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsLisLocation.md (64%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsLisPort.md (67%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsLisServiceProvider.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsLisSubnet.md (61%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsLisSwitch.md (64%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsLisWirelessAccessPoint.md (62%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsLocationPolicy.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsManagementConnection.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsManagementServer.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsMcxConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsMediaConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsMediationServer.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsMeetingConfiguration.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsMeetingRoom.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsMobilityPolicy.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsMonitoringServer.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsNetworkBandwidthPolicyProfile.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsNetworkConfiguration.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsNetworkInterRegionRoute.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsNetworkInterSitePolicy.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsNetworkRegion.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsNetworkRegionLink.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsNetworkSite.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsNetworkSubnet.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsOAuthConfiguration.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsOAuthServer.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsOutboundCallingNumberTranslationRule.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsOutboundTranslationRule.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsPartnerApplication.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsPersistentChatActiveServer.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsPersistentChatAddin.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsPersistentChatCategory.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsPersistentChatComplianceConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsPersistentChatConfiguration.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsPersistentChatPolicy.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsPersistentChatRoom.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsPersistentChatState.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsPinPolicy.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsPlatformServiceSettings.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsPresenceManagementState.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsPresencePolicy.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsPresenceProvider.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsPrivacyConfiguration.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsProxyConfiguration.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsPstnGateway.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsPstnUsage.md (80%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsPublicProvider.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsPushNotificationConfiguration.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsQoEConfiguration.md (81%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsRegistrar.md (81%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsRegistrarConfiguration.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsReportingConfiguration.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsRgsAgentGroup.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsRgsConfiguration.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsRgsHolidaySet.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsRgsHoursOfBusiness.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsRgsQueue.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsRgsWorkflow.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsRoutingConfiguration.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsServerApplication.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsSimpleUrlConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsSipDomain.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsSipResponseCodeTranslationRule.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsSite.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsSlaConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsStaticRoutingConfiguration.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsStorageServiceConfiguration.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsTeamsUpgradeConfiguration.md (94%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsTeamsUpgradePolicy.md (96%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsTelemetryConfiguration.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsTenantHybridConfiguration.md (93%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsTenantUpdateTimeWindow.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsTestDevice.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsTestUserCredential.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsThirdPartyVideoSystem.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsThirdPartyVideoSystemPolicy.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsTrunkConfiguration.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsTrustedApplication.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsTrustedApplicationEndpoint.md (79%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsTrustedApplicationPool.md (80%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsUCPhoneConfiguration.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsUICulture.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsUnassignedNumber.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsUser.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsUserAcp.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsUserCallForwardingSettings.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsUserDatabaseState.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsUserDelegates.md (99%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsUserPstnSettings.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsUserReplicatorConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsUserServer.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsUserServicesConfiguration.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsUserServicesPolicy.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsUserTeamMembers.md (99%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsVideoGateway.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsVideoInteropServer.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsVideoInteropServerConfiguration.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsVideoTrunkConfiguration.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsVoiceConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsVoiceNormalizationRule.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsVoicePolicy.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsVoiceRoute.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsVoiceRoutingPolicy.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsVoiceTestConfiguration.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsVoicemailReroutingConfiguration.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsWatcherNodeConfiguration.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsWebServer.md (79%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsWebServiceConfiguration.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsXmppAllowedPartner.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Set-CsXmppGatewayConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Show-CsClsLogging.md (91%) rename skype/skype-ps/{skype/skype.md => SkypeForBusiness/SkypeForBusiness.md} (100%) rename skype/skype-ps/{skype => SkypeForBusiness}/Start-CsClsLogging.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Start-CsPool.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Start-CsWindowsService.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Stop-CsClsLogging.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Stop-CsWindowsService.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Sync-CsClsLogging.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Sync-CsUserData.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsASConference.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsAVConference.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsAVEdgeConnectivity.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsAddressBookService.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsAddressBookWebQuery.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsAudioConferencingProvider.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsCertificateConfiguration.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsClientAuth.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsClientAuthentication.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsComputer.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsDataConference.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsDatabase.md (81%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsDialInConferencing.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsDialPlan.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsExStorageConnectivity.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsExStorageNotification.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsExUMConnectivity.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsExUMVoiceMail.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsFederatedPartner.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsGroupExpansion.md (81%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsGroupIM.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsIM.md (81%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsInterTrunkRouting.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsKerberosAccountAssignment.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsLisCivicAddress.md (81%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsLisConfiguration.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsLocationPolicy.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsManagementServer.md (91%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsMcxConference.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsMcxP2PIM.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsMcxPushNotification.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsOUPermission.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsP2PAV.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsP2PVideoInteropServerSipTrunkAV.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsPersistentChatMessage.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsPhoneBootstrap.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsPresence.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsPstnOutboundCall.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsPstnPeerToPeerCall.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsRegistration.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsReplica.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsSetupPermission.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsTopology.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsTrunkConfiguration.md (87%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsUcwaConference.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsUnifiedContactStore.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsVoiceNormalizationRule.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsVoicePolicy.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsVoiceRoute.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsVoiceTestConfiguration.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsVoiceUser.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsWatcherNodeConfiguration.md (92%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsWebApp.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsWebAppAnonymous.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsWebScheduler.md (84%) rename skype/skype-ps/{skype => SkypeForBusiness}/Test-CsXmppIM.md (85%) rename skype/skype-ps/{skype => SkypeForBusiness}/Uninstall-CsDatabase.md (82%) rename skype/skype-ps/{skype => SkypeForBusiness}/Uninstall-CsMirrorDatabase.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Unlock-CsClientPin.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Unpublish-CsLisConfiguration.md (88%) rename skype/skype-ps/{skype => SkypeForBusiness}/Unregister-CsHybridPSTNAppliance.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Update-CsAddressBook.md (89%) rename skype/skype-ps/{skype => SkypeForBusiness}/Update-CsAdminRole.md (86%) rename skype/skype-ps/{skype => SkypeForBusiness}/Update-CsClsLogging.md (90%) rename skype/skype-ps/{skype => SkypeForBusiness}/Update-CsTenantMeetingUrl.md (95%) rename skype/skype-ps/{skype => SkypeForBusiness}/Update-CsUserData.md (83%) rename skype/skype-ps/{skype => SkypeForBusiness}/Update-CsUserDatabase.md (89%) diff --git a/.openpublishing.redirection.skype.json b/.openpublishing.redirection.skype.json index 606ce0fd94..c034ac18a3 100644 --- a/.openpublishing.redirection.skype.json +++ b/.openpublishing.redirection.skype.json @@ -1814,6 +1814,4491 @@ "source_path": "skype/virtual-folder/skype/Update-CsOrganizationalAutoAttendant.md", "redirect_url": "/powershell/module/teams/", "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Clear-CsDeviceUpdateFile.md", + "redirect_url": "/powershell/module/skypeforbusiness/clear-csdeviceupdatefile", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Clear-CsDeviceUpdateLog.md", + "redirect_url": "/powershell/module/skypeforbusiness/clear-csdeviceupdatelog", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Clear-CsPersistentChatRoom.md", + "redirect_url": "/powershell/module/skypeforbusiness/clear-cspersistentchatroom", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Convert-CsUserData.md", + "redirect_url": "/powershell/module/skypeforbusiness/convert-csuserdata", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/ConvertTo-JsonForPSWS.md", + "redirect_url": "/powershell/module/skypeforbusiness/convertto-jsonforpsws", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Copy-CsVoicePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/copy-csvoicepolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Debug-CsAddressBookReplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/debug-csaddressbookreplication", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Debug-CsDataConference.md", + "redirect_url": "/powershell/module/skypeforbusiness/debug-csdataconference", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Debug-CsInterPoolReplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/debug-csinterpoolreplication", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Debug-CsIntraPoolReplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/debug-csintrapoolreplication", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Debug-CsLisConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/debug-cslisconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Debug-CsStorageServiceFailures.md", + "redirect_url": "/powershell/module/skypeforbusiness/debug-csstorageservicefailures", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Debug-CsUnifiedContactStore.md", + "redirect_url": "/powershell/module/skypeforbusiness/debug-csunifiedcontactstore", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Disable-CsAdDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/disable-csaddomain", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Disable-CsAdForest.md", + "redirect_url": "/powershell/module/skypeforbusiness/disable-csadforest", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Disable-CsComputer.md", + "redirect_url": "/powershell/module/skypeforbusiness/disable-cscomputer", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Disable-CsHostingProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/disable-cshostingprovider", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Disable-CsMeetingRoom.md", + "redirect_url": "/powershell/module/skypeforbusiness/disable-csmeetingroom", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Disable-CsPublicProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/disable-cspublicprovider", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Disable-CsUser.md", + "redirect_url": "/powershell/module/skypeforbusiness/disable-csuser", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Enable-CsAdDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/enable-csaddomain", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Enable-CsAdForest.md", + "redirect_url": "/powershell/module/skypeforbusiness/enable-csadforest", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Enable-CsComputer.md", + "redirect_url": "/powershell/module/skypeforbusiness/enable-cscomputer", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Enable-CsHostingProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/enable-cshostingprovider", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Enable-CsMeetingRoom.md", + "redirect_url": "/powershell/module/skypeforbusiness/enable-csmeetingroom", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Enable-CsPublicProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/enable-cspublicprovider", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Enable-CsReplica.md", + "redirect_url": "/powershell/module/skypeforbusiness/enable-csreplica", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Enable-CsTopology.md", + "redirect_url": "/powershell/module/skypeforbusiness/enable-cstopology", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Enable-CsUser.md", + "redirect_url": "/powershell/module/skypeforbusiness/enable-csuser", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Export-CsArchivingData.md", + "redirect_url": "/powershell/module/skypeforbusiness/export-csarchivingdata", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Export-CsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/export-csconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Export-CsLisConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/export-cslisconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Export-CsPersistentChatData.md", + "redirect_url": "/powershell/module/skypeforbusiness/export-cspersistentchatdata", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Export-CsRgsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/export-csrgsconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Export-CsUserData.md", + "redirect_url": "/powershell/module/skypeforbusiness/export-csuserdata", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsAccessEdgeConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csaccessedgeconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsAdContact.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csadcontact", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsAdditionalInternalDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csadditionalinternaldomain", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsAdDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csaddomain", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsAddressBookConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csaddressbookconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsAddressBookNormalizationConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csaddressbooknormalizationconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsAddressBookNormalizationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csaddressbooknormalizationrule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsAdForest.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csadforest", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsAdminRole.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csadminrole", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsAdminRoleAssignment.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csadminroleassignment", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsAdPrincipal.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csadprincipal", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsAdServerSchema.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csadserverschema", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsAdUser.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csaduser", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsAllowedDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csalloweddomain", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsAnalogDevice.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csanalogdevice", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsAnnouncement.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csannouncement", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsApplicationEndpoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csapplicationendpoint", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsArchivingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csarchivingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsArchivingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csarchivingpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsAudioConferencingProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csaudioconferencingprovider", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsAudioTestServiceApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csaudiotestserviceapplication", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsAuthConfig.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csauthconfig", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsAutodiscoverConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csautodiscoverconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsAVEdgeConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csavedgeconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsBackupServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csbackupserviceconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsBackupServiceStatus.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csbackupservicestatus", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsBandwidthPolicyServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csbandwidthpolicyserviceconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsBlockedDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csblockeddomain", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsBroadcastMeetingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csbroadcastmeetingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsBroadcastMeetingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csbroadcastmeetingpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsBusyOptions.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csbusyoptions", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsCallParkOrbit.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cscallparkorbit", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsCallViaWorkPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cscallviaworkpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsCdrConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cscdrconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsCertificate.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cscertificate", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsClientAccessLicense.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csclientaccesslicense", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsClientCertificate.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csclientcertificate", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsClientPinInfo.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csclientpininfo", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsClientPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csclientpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsClientVersionConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csclientversionconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsClientVersionPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csclientversionpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsClientVersionPolicyRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csclientversionpolicyrule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsCloudCallDataConnector.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cscloudcalldataconnector", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsCloudCallDataConnectorConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cscloudcalldataconnectorconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsCloudMeetingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cscloudmeetingpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsClsAgentStatus.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csclsagentstatus", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsClsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csclsconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsClsRegion.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csclsregion", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsClsScenario.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csclsscenario", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsClsSearchTerm.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csclssearchterm", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsClsSecurityGroup.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csclssecuritygroup", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsCommonAreaPhone.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cscommonareaphone", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsComputer.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cscomputer", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsConferenceDirectory.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csconferencedirectory", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsConferenceDisclaimer.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csconferencedisclaimer", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsConferencingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csconferencingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsConferencingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csconferencingpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsConfigurationStoreLocation.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csconfigurationstorelocation", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsConversationHistoryConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csconversationhistoryconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsCpsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cscpsconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsDatabaseMirrorState.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csdatabasemirrorstate", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsDeviceUpdateConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csdeviceupdateconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsDeviceUpdateRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csdeviceupdaterule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsDiagnosticConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csdiagnosticconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsDiagnosticHeaderConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csdiagnosticheaderconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsDialInConferencingAccessNumber.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csdialinconferencingaccessnumber", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsDialInConferencingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csdialinconferencingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsDialInConferencingDtmfConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csdialinconferencingdtmfconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsDialInConferencingLanguageList.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csdialinconferencinglanguagelist", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsDialPlan.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csdialplan", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsEffectivePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cseffectivepolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsEnhancedEmergencyServiceDisclaimer.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csenhancedemergencyservicedisclaimer", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsExternalAccessPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csexternalaccesspolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsExternalUserCommunicationPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csexternalusercommunicationpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsExUmContact.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csexumcontact", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsFileTransferFilterConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csfiletransferfilterconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsFIPSConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csfipsconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsGraphPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csgraphpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsGroupPickupUserOrbit.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csgrouppickupuserorbit", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsHealthMonitoringConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cshealthmonitoringconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsHostedVoicemailPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cshostedvoicemailpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsHostingProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cshostingprovider", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsHybridApplicationEndpoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cshybridapplicationendpoint", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsHybridMediationServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cshybridmediationserver", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsHybridPSTNAppliance.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cshybridpstnappliance", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsHybridPSTNSite.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cshybridpstnsite", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsImConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csimconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsImFilterConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csimfilterconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsImTranslationConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csimtranslationconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsIPPhonePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csipphonepolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsKerberosAccountAssignment.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cskerberosaccountassignment", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsLisCivicAddress.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csliscivicaddress", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsLisLocation.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cslislocation", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsLisPort.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cslisport", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsLisServiceProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cslisserviceprovider", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsLisSubnet.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cslissubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsLisSwitch.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cslisswitch", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsLisWirelessAccessPoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csliswirelessaccesspoint", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsLocationPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cslocationpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsManagementConnection.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csmanagementconnection", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsManagementStoreReplicationStatus.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csmanagementstorereplicationstatus", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsMcxConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csmcxconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsMediaConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csmediaconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsMeetingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csmeetingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsMeetingRoom.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csmeetingroom", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsMobilityPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csmobilitypolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsNetworkBandwidthPolicyProfile.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworkbandwidthpolicyprofile", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsNetworkConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworkconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsNetworkInterface.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworkinterface", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsNetworkInterRegionRoute.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworkinterregionroute", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsNetworkInterSitePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworkintersitepolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsNetworkRegion.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworkregion", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsNetworkRegionLink.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworkregionlink", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsNetworkSite.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworksite", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsNetworkSubnet.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csnetworksubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsOAuthConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csoauthconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsOAuthServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csoauthserver", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsOutboundCallingNumberTranslationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csoutboundcallingnumbertranslationrule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsOutboundTranslationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csoutboundtranslationrule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsPartnerApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspartnerapplication", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsPersistentChatAddin.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchataddin", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsPersistentChatCategory.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchatcategory", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsPersistentChatComplianceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchatcomplianceconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsPersistentChatConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchatconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsPersistentChatEligiblePrincipal.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchateligibleprincipal", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsPersistentChatEndpoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchatendpoint", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsPersistentChatPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchatpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsPersistentChatRoom.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchatroom", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsPersistentChatState.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspersistentchatstate", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsPinPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspinpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsPlatformServiceSettings.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csplatformservicesettings", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsPool.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspool", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsPoolBackupRelationship.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspoolbackuprelationship", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsPoolFabricState.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspoolfabricstate", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsPoolUpgradeReadinessState.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspoolupgradereadinessstate", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsPresenceManagementState.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspresencemanagementstate", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsPresencePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspresencepolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsPresenceProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspresenceprovider", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsPrivacyConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csprivacyconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsProxyConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csproxyconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsPstnUsage.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspstnusage", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsPublicProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspublicprovider", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsPushNotificationConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cspushnotificationconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsQoEConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csqoeconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsRegistrarConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csregistrarconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsReportingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csreportingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsRgsAgentGroup.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csrgsagentgroup", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsRgsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csrgsconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsRgsHolidaySet.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csrgsholidayset", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsRgsHoursOfBusiness.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csrgshoursofbusiness", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsRgsQueue.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csrgsqueue", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsRgsWorkflow.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csrgsworkflow", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsRoutingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csroutingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsServerApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csserverapplication", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsServerPatchVersion.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csserverpatchversion", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsServerVersion.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csserverversion", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsService.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csservice", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsSimpleUrlConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cssimpleurlconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsSipDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cssipdomain", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsSipResponseCodeTranslationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cssipresponsecodetranslationrule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsSite.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cssite", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsSlaConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csslaconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsStaticRoutingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csstaticroutingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsStorageServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csstorageserviceconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsTeamsUpgradeConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csteamsupgradeconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsTeamsUpgradePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csteamsupgradepolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsTelemetryConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cstelemetryconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsTenantHybridConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cstenanthybridconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsTenantUpdateTimeWindow.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cstenantupdatetimewindow", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsTestDevice.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cstestdevice", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsTestUserCredential.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cstestusercredential", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsThirdPartyVideoSystem.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csthirdpartyvideosystem", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsThirdPartyVideoSystemPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csthirdpartyvideosystempolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsTopology.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cstopology", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsTrunk.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cstrunk", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsTrunkConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cstrunkconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsTrustedApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cstrustedapplication", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsTrustedApplicationComputer.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cstrustedapplicationcomputer", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsTrustedApplicationEndpoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cstrustedapplicationendpoint", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsTrustedApplicationPool.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cstrustedapplicationpool", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsUCPhoneConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csucphoneconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsUICulture.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csuiculture", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsUnassignedNumber.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csunassignednumber", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsUpgradeDomainInfo.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csupgradedomaininfo", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsUser.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csuser", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsUserAcp.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csuseracp", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsUserCallForwardingSettings.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csusercallforwardingsettings", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsUserDatabaseState.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csuserdatabasestate", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsUserDelegates.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csuserdelegates", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsUserLocationStatus.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csuserlocationstatus", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsUserPoolInfo.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csuserpoolinfo", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsUserPstnSettings.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csuserpstnsettings", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsUserReplicatorConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csuserreplicatorconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsUserServicesConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csuserservicesconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsUserServicesPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csuserservicespolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsUserSession.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csusersession", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsUserSettingsPageConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csusersettingspageconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsUserTeamMembers.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csuserteammembers", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsVideoInteropServerConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csvideointeropserverconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsVideoInteropServerSyntheticTransactionConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csvideointeropserversynthetictransactionconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsVideoTrunk.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csvideotrunk", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsVideoTrunkConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csvideotrunkconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsVoiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csvoiceconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsVoicemailReroutingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csvoicemailreroutingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsVoiceNormalizationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csvoicenormalizationrule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsVoicePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csvoicepolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsVoiceRoute.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csvoiceroute", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csvoiceroutingpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsVoiceTestConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csvoicetestconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsWatcherNodeConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cswatchernodeconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsWebServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cswebserviceconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsWindowsService.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-cswindowsservice", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsXmppAllowedPartner.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csxmppallowedpartner", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Get-CsXmppGatewayConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/get-csxmppgatewayconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Grant-CsArchivingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csarchivingpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Grant-CsCallViaWorkPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-cscallviaworkpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Grant-CsClientPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csclientpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Grant-CsClientVersionPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csclientversionpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Grant-CsConferencingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csconferencingpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Grant-CsDialPlan.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csdialplan", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Grant-CsExternalAccessPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csexternalaccesspolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Grant-CsGraphPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csgraphpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Grant-CsHostedVoicemailPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-cshostedvoicemailpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Grant-CsIPPhonePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csipphonepolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Grant-CsLocationPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-cslocationpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Grant-CsMobilityPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csmobilitypolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Grant-CsOUPermission.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csoupermission", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Grant-CsPersistentChatPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-cspersistentchatpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Grant-CsPinPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-cspinpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Grant-CsPresencePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-cspresencepolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Grant-CsSetupPermission.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-cssetuppermission", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csteamsupgradepolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Grant-CsThirdPartyVideoSystemPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csthirdpartyvideosystempolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Grant-CsUserServicesPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csuserservicespolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Grant-CsVoicePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csvoicepolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Grant-CsVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/grant-csvoiceroutingpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Import-CSAnnouncementFile.md", + "redirect_url": "/powershell/module/skypeforbusiness/import-csannouncementfile", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Import-CsCertificate.md", + "redirect_url": "/powershell/module/skypeforbusiness/import-cscertificate", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Import-CsCompanyPhoneNormalizationRules.md", + "redirect_url": "/powershell/module/skypeforbusiness/import-cscompanyphonenormalizationrules", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Import-CsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/import-csconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Import-CsDeviceUpdate.md", + "redirect_url": "/powershell/module/skypeforbusiness/import-csdeviceupdate", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Import-CsLegacyConferenceDirectory.md", + "redirect_url": "/powershell/module/skypeforbusiness/import-cslegacyconferencedirectory", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Import-CsLegacyConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/import-cslegacyconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Import-CsLisConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/import-cslisconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Import-CsPersistentChatData.md", + "redirect_url": "/powershell/module/skypeforbusiness/import-cspersistentchatdata", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Import-CsRgsAudioFile.md", + "redirect_url": "/powershell/module/skypeforbusiness/import-csrgsaudiofile", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Import-CsRgsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/import-csrgsconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Import-CsUserData.md", + "redirect_url": "/powershell/module/skypeforbusiness/import-csuserdata", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Install-CsAdServerSchema.md", + "redirect_url": "/powershell/module/skypeforbusiness/install-csadserverschema", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Install-CsDatabase.md", + "redirect_url": "/powershell/module/skypeforbusiness/install-csdatabase", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Install-CsMirrorDatabase.md", + "redirect_url": "/powershell/module/skypeforbusiness/install-csmirrordatabase", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Invoke-CsArchivingDatabasePurge.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-csarchivingdatabasepurge", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Invoke-CsBackupServiceSync.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-csbackupservicesync", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Invoke-CsCdrDatabasePurge.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-cscdrdatabasepurge", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Invoke-CsComputerFailBack.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-cscomputerfailback", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Invoke-CsComputerFailOver.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-cscomputerfailover", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Invoke-CsDatabaseFailover.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-csdatabasefailover", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Invoke-CsManagementServerFailover.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-csmanagementserverfailover", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Invoke-CsManagementStoreReplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-csmanagementstorereplication", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Invoke-CsPoolFailBack.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-cspoolfailback", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Invoke-CsPoolFailOver.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-cspoolfailover", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Invoke-CsQoEDatabasePurge.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-csqoedatabasepurge", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Invoke-CsRgsStoreReplicateData.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-csrgsstorereplicatedata", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Invoke-CsStorageServiceFlush.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-csstorageserviceflush", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Invoke-CsUcsRollback.md", + "redirect_url": "/powershell/module/skypeforbusiness/invoke-csucsrollback", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Lock-CsClientPin.md", + "redirect_url": "/powershell/module/skypeforbusiness/lock-csclientpin", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Merge-CsLegacyTopology.md", + "redirect_url": "/powershell/module/skypeforbusiness/merge-cslegacytopology", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Move-CsAnalogDevice.md", + "redirect_url": "/powershell/module/skypeforbusiness/move-csanalogdevice", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Move-CsApplicationEndpoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/move-csapplicationendpoint", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Move-CsCommonAreaPhone.md", + "redirect_url": "/powershell/module/skypeforbusiness/move-cscommonareaphone", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Move-CsConferenceDirectory.md", + "redirect_url": "/powershell/module/skypeforbusiness/move-csconferencedirectory", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Move-CsExUmContact.md", + "redirect_url": "/powershell/module/skypeforbusiness/move-csexumcontact", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Move-CsLegacyUser.md", + "redirect_url": "/powershell/module/skypeforbusiness/move-cslegacyuser", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Move-CsManagementServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/move-csmanagementserver", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Move-CsMeetingRoom.md", + "redirect_url": "/powershell/module/skypeforbusiness/move-csmeetingroom", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Move-CsRgsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/move-csrgsconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Move-CsThirdPartyVideoSystem.md", + "redirect_url": "/powershell/module/skypeforbusiness/move-csthirdpartyvideosystem", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Move-CsUser.md", + "redirect_url": "/powershell/module/skypeforbusiness/move-csuser", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsAdditionalInternalDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csadditionalinternaldomain", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsAddressBookConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csaddressbookconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsAddressBookNormalizationConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csaddressbooknormalizationconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsAddressBookNormalizationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csaddressbooknormalizationrule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsAdminRole.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csadminrole", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsAllowedDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csalloweddomain", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsAnalogDevice.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csanalogdevice", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsAnnouncement.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csannouncement", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsArchivingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csarchivingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsArchivingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csarchivingpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsAutodiscoverConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csautodiscoverconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsAVEdgeConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csavedgeconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsBandwidthPolicyServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csbandwidthpolicyserviceconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsBlockedDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csblockeddomain", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsCallParkOrbit.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cscallparkorbit", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsCallViaWorkPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cscallviaworkpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsCdrConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cscdrconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsClientPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csclientpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsClientPolicyEntry.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csclientpolicyentry", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsClientVersionConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csclientversionconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsClientVersionPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csclientversionpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsClientVersionPolicyRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csclientversionpolicyrule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsCloudCallDataConnectorConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cscloudcalldataconnectorconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsClsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csclsconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsClsProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csclsprovider", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsClsRegion.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csclsregion", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsClsScenario.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csclsscenario", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsClsSecurityGroup.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csclssecuritygroup", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsCommonAreaPhone.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cscommonareaphone", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsConferenceDirectory.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csconferencedirectory", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsConferencingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csconferencingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsConferencingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csconferencingpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsCpsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cscpsconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsDeviceUpdateConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csdeviceupdateconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsDiagnosticConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csdiagnosticconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsDiagnosticHeaderConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csdiagnosticheaderconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsDiagnosticsFilter.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csdiagnosticsfilter", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsDialInConferencingAccessNumber.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csdialinconferencingaccessnumber", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsDialInConferencingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csdialinconferencingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsDialInConferencingDtmfConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csdialinconferencingdtmfconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsDialPlan.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csdialplan", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsEmergencyNumber.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csemergencynumber", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsExtendedTest.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csextendedtest", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsExternalAccessPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csexternalaccesspolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsExternalUserCommunicationPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csexternalusercommunicationpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsExUmContact.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csexumcontact", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsFileTransferFilterConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csfiletransferfilterconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsFIPSConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csfipsconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsGroupPickupUserOrbit.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csgrouppickupuserorbit", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsHealthMonitoringConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cshealthmonitoringconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsHostedVoicemailPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cshostedvoicemailpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsHostingProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cshostingprovider", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsHybridApplicationEndpoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cshybridapplicationendpoint", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsHybridPSTNSite.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cshybridpstnsite", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsImConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csimconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsImFilterConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csimfilterconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsImTranslationConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csimtranslationconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsIssuedCertId.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csissuedcertid", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsKerberosAccount.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cskerberosaccount", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsKerberosAccountAssignment.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cskerberosaccountassignment", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsLocationPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cslocationpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsMcxConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csmcxconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsMediaConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csmediaconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsMeetingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csmeetingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsMobilityPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csmobilitypolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsNetworkBandwidthPolicyProfile.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworkbandwidthpolicyprofile", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsNetworkBWAlternatePath.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworkbwalternatepath", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsNetworkBWPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworkbwpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsNetworkInterRegionRoute.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworkinterregionroute", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsNetworkInterSitePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworkintersitepolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsNetworkMediaBypassConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworkmediabypassconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsNetworkRegion.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworkregion", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsNetworkRegionLink.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworkregionlink", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsNetworkSite.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworksite", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsNetworkSubnet.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csnetworksubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsOAuthServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csoauthserver", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsOutboundCallingNumberTranslationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csoutboundcallingnumbertranslationrule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsOutboundTranslationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csoutboundtranslationrule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsPartnerApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cspartnerapplication", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsPersistentChatAddin.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cspersistentchataddin", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsPersistentChatCategory.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cspersistentchatcategory", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsPersistentChatComplianceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cspersistentchatcomplianceconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsPersistentChatConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cspersistentchatconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsPersistentChatEndpoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cspersistentchatendpoint", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsPersistentChatPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cspersistentchatpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsPersistentChatRoom.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cspersistentchatroom", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsPinPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cspinpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsPlatformServiceSettings.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csplatformservicesettings", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsPresencePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cspresencepolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsPresenceProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cspresenceprovider", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsPrivacyConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csprivacyconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsProxyConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csproxyconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsPublicProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cspublicprovider", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsPushNotificationConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cspushnotificationconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsQoEConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csqoeconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsRegistrarConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csregistrarconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsReportingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csreportingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsRgsAgentGroup.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csrgsagentgroup", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsRgsAnswer.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csrgsanswer", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsRgsCallAction.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csrgscallaction", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsRgsHoliday.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csrgsholiday", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsRgsHolidaySet.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csrgsholidayset", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsRgsHoursOfBusiness.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csrgshoursofbusiness", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsRgsPrompt.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csrgsprompt", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsRgsQuestion.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csrgsquestion", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsRgsQueue.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csrgsqueue", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsRgsTimeRange.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csrgstimerange", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsRgsWorkflow.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csrgsworkflow", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsRoutingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csroutingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsServerApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csserverapplication", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsSimpleUrl.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cssimpleurl", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsSimpleUrlConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cssimpleurlconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsSimpleUrlEntry.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cssimpleurlentry", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsSipDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cssipdomain", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsSipProxyCustom.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cssipproxycustom", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsSipProxyRealm.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cssipproxyrealm", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsSipProxyTCP.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cssipproxytcp", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsSipProxyTLS.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cssipproxytls", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsSipProxyTransport.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cssipproxytransport", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsSipProxyUseDefault.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cssipproxyusedefault", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsSipProxyUseDefaultCert.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cssipproxyusedefaultcert", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsSipResponseCodeTranslationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cssipresponsecodetranslationrule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsStaticRoute.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csstaticroute", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsStaticRoutingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csstaticroutingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsStorageServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csstorageserviceconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsTeamsUpgradePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csteamsupgradepolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsTelemetryConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cstelemetryconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsTenantUpdateTimeWindow.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cstenantupdatetimewindow", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsTestDevice.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cstestdevice", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsThirdPartyVideoSystem.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csthirdpartyvideosystem", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsThirdPartyVideoSystemPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csthirdpartyvideosystempolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsTrunkConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cstrunkconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsTrustedApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cstrustedapplication", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsTrustedApplicationComputer.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cstrustedapplicationcomputer", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsTrustedApplicationEndpoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cstrustedapplicationendpoint", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsTrustedApplicationPool.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cstrustedapplicationpool", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsUCPhoneConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csucphoneconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsUnassignedNumber.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csunassignednumber", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsUserReplicatorConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csuserreplicatorconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsUserServicesConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csuserservicesconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsUserServicesPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csuserservicespolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsVideoInteropServerConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csvideointeropserverconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsVideoInteropServerSyntheticTransactionConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csvideointeropserversynthetictransactionconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsVideoTrunkConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csvideotrunkconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsVoicemailReroutingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csvoicemailreroutingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsVoiceNormalizationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csvoicenormalizationrule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsVoicePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csvoicepolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsVoiceRegex.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csvoiceregex", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsVoiceRoute.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csvoiceroute", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csvoiceroutingpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsVoiceTestConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csvoicetestconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsWatcherNodeConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cswatchernodeconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsWebLink.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csweblink", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsWebOrigin.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csweborigin", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsWebServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cswebserviceconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsWebTrustedCACertificate.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-cswebtrustedcacertificate", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/New-CsXmppAllowedPartner.md", + "redirect_url": "/powershell/module/skypeforbusiness/new-csxmppallowedpartner", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Publish-CsLisConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/publish-cslisconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Publish-CsTopology.md", + "redirect_url": "/powershell/module/skypeforbusiness/publish-cstopology", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Register-CsHybridPSTNAppliance.md", + "redirect_url": "/powershell/module/skypeforbusiness/register-cshybridpstnappliance", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsAdditionalInternalDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csadditionalinternaldomain", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsAddressBookConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csaddressbookconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsAddressBookNormalizationConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csaddressbooknormalizationconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsAddressBookNormalizationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csaddressbooknormalizationrule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsAdminRole.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csadminrole", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsAllowedDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csalloweddomain", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsAnalogDevice.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csanalogdevice", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsAnnouncement.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csannouncement", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsArchivingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csarchivingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsArchivingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csarchivingpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsAutodiscoverConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csautodiscoverconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsAVEdgeConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csavedgeconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsBackupServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csbackupserviceconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsBandwidthPolicyServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csbandwidthpolicyserviceconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsBlockedDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csblockeddomain", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsBusyOptions.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csbusyoptions", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsCallParkOrbit.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cscallparkorbit", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsCallViaWorkPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cscallviaworkpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsCdrConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cscdrconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsCertificate.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cscertificate", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsClientPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csclientpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsClientVersionConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csclientversionconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsClientVersionPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csclientversionpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsClientVersionPolicyRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csclientversionpolicyrule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsClsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csclsconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsClsRegion.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csclsregion", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsClsScenario.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csclsscenario", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsClsSecurityGroup.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csclssecuritygroup", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsCommonAreaPhone.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cscommonareaphone", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsConferenceDirectory.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csconferencedirectory", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsConferenceDisclaimer.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csconferencedisclaimer", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsConferencingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csconferencingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsConferencingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csconferencingpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsConfigurationStoreLocation.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csconfigurationstorelocation", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsConversationHistoryConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csconversationhistoryconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsCpsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cscpsconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsDeviceUpdateConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csdeviceupdateconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsDeviceUpdateRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csdeviceupdaterule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsDiagnosticConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csdiagnosticconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsDiagnosticHeaderConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csdiagnosticheaderconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsDialInConferencingAccessNumber.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csdialinconferencingaccessnumber", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsDialInConferencingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csdialinconferencingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsDialInConferencingDtmfConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csdialinconferencingdtmfconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsDialPlan.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csdialplan", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsEnhancedEmergencyServiceDisclaimer.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csenhancedemergencyservicedisclaimer", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsExternalAccessPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csexternalaccesspolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsExternalUserCommunicationPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csexternalusercommunicationpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsExUmContact.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csexumcontact", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsFileTransferFilterConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csfiletransferfilterconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsFIPSConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csfipsconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsGroupPickupUserOrbit.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csgrouppickupuserorbit", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsHealthMonitoringConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cshealthmonitoringconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsHostedVoicemailPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cshostedvoicemailpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsHostingProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cshostingprovider", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsHybridApplicationEndpoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cshybridapplicationendpoint", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsHybridPSTNSite.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cshybridpstnsite", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsImConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csimconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsImFilterConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csimfilterconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsImTranslationConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csimtranslationconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsKerberosAccountAssignment.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cskerberosaccountassignment", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsLisLocation.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cslislocation", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsLisPort.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cslisport", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsLisServiceProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cslisserviceprovider", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsLisSubnet.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cslissubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsLisSwitch.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cslisswitch", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsLisWirelessAccessPoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csliswirelessaccesspoint", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsLocationPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cslocationpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsManagementConnection.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csmanagementconnection", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsMcxConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csmcxconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsMediaConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csmediaconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsMeetingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csmeetingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsMobilityPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csmobilitypolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsNetworkBandwidthPolicyProfile.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csnetworkbandwidthpolicyprofile", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsNetworkConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csnetworkconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsNetworkInterRegionRoute.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csnetworkinterregionroute", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsNetworkInterSitePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csnetworkintersitepolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsNetworkRegion.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csnetworkregion", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsNetworkRegionLink.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csnetworkregionlink", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsNetworkSite.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csnetworksite", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsNetworkSubnet.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csnetworksubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsOAuthServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csoauthserver", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsOutboundCallingNumberTranslationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csoutboundcallingnumbertranslationrule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsOutboundTranslationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csoutboundtranslationrule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsPartnerApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspartnerapplication", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsPersistentChatAddin.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspersistentchataddin", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsPersistentChatCategory.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspersistentchatcategory", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsPersistentChatComplianceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspersistentchatcomplianceconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsPersistentChatConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspersistentchatconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsPersistentChatEndpoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspersistentchatendpoint", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsPersistentChatMessage.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspersistentchatmessage", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsPersistentChatPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspersistentchatpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsPersistentChatRoom.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspersistentchatroom", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsPinPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspinpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsPlatformServiceSettings.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csplatformservicesettings", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsPresencePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspresencepolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsPresenceProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspresenceprovider", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsPrivacyConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csprivacyconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsProxyConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csproxyconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsPublicProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspublicprovider", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsPushNotificationConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cspushnotificationconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsQoEConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csqoeconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsRegistrarConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csregistrarconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsReportingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csreportingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsRgsAgentGroup.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csrgsagentgroup", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsRgsHolidaySet.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csrgsholidayset", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsRgsHoursOfBusiness.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csrgshoursofbusiness", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsRgsQueue.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csrgsqueue", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsRgsWorkflow.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csrgsworkflow", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsRoutingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csroutingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsServerApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csserverapplication", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsSimpleUrlConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cssimpleurlconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsSipDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cssipdomain", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsSipResponseCodeTranslationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cssipresponsecodetranslationrule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsSlaConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csslaconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsSlaDelegates.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cssladelegates", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsStaticRoutingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csstaticroutingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsStorageServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csstorageserviceconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsTeamsUpgradePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csteamsupgradepolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsTelemetryConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cstelemetryconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsTenantUpdateTimeWindow.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cstenantupdatetimewindow", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsTestDevice.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cstestdevice", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsTestUserCredential.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cstestusercredential", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsThirdPartyVideoSystem.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csthirdpartyvideosystem", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsThirdPartyVideoSystemPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csthirdpartyvideosystempolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsTrunkConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cstrunkconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsTrustedApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cstrustedapplication", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsTrustedApplicationComputer.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cstrustedapplicationcomputer", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsTrustedApplicationEndpoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cstrustedapplicationendpoint", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsTrustedApplicationPool.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cstrustedapplicationpool", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsUCPhoneConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csucphoneconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsUnassignedNumber.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csunassignednumber", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsUserAcp.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csuseracp", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsUserReplicatorConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csuserreplicatorconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsUserServicesConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csuserservicesconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsUserServicesPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csuserservicespolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsUserStoreBackupData.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csuserstorebackupdata", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsVideoInteropServerConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csvideointeropserverconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csvideointeropserversynthetictransactionconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsVideoTrunkConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csvideotrunkconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsVoiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csvoiceconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsVoicemailReroutingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csvoicemailreroutingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsVoiceNormalizationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csvoicenormalizationrule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsVoicePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csvoicepolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsVoiceRoute.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csvoiceroute", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csvoiceroutingpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsVoiceTestConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csvoicetestconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsWatcherNodeConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cswatchernodeconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsWebServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-cswebserviceconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Remove-CsXmppAllowedPartner.md", + "redirect_url": "/powershell/module/skypeforbusiness/remove-csxmppallowedpartner", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Request-CsCertificate.md", + "redirect_url": "/powershell/module/skypeforbusiness/request-cscertificate", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Reset-CsDeviceUpdateRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/reset-csdeviceupdaterule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Reset-CsNotificationQueues.md", + "redirect_url": "/powershell/module/skypeforbusiness/reset-csnotificationqueues", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Reset-CsPoolRegistrarState.md", + "redirect_url": "/powershell/module/skypeforbusiness/reset-cspoolregistrarstate", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Reset-CsRoutingGroup.md", + "redirect_url": "/powershell/module/skypeforbusiness/reset-csroutinggroup", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Restore-CsDeviceUpdateRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/restore-csdeviceupdaterule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Revoke-CsClientCertificate.md", + "redirect_url": "/powershell/module/skypeforbusiness/revoke-csclientcertificate", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Revoke-CsOUPermission.md", + "redirect_url": "/powershell/module/skypeforbusiness/revoke-csoupermission", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Revoke-CsSetupPermission.md", + "redirect_url": "/powershell/module/skypeforbusiness/revoke-cssetuppermission", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Search-CsClsLogging.md", + "redirect_url": "/powershell/module/skypeforbusiness/search-csclslogging", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsAccessEdgeConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csaccessedgeconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsAddressBookConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csaddressbookconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsAddressBookNormalizationConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csaddressbooknormalizationconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsAddressBookNormalizationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csaddressbooknormalizationrule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsAdminRole.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csadminrole", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsAllowedDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csalloweddomain", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsAnalogDevice.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csanalogdevice", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsAnnouncement.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csannouncement", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsApplicationServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csapplicationserver", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsArchivingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csarchivingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsArchivingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csarchivingpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsArchivingServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csarchivingserver", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsAudioTestServiceApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csaudiotestserviceapplication", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsAuthConfig.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csauthconfig", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsAutodiscoverConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csautodiscoverconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsAVEdgeConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csavedgeconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsBackupServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csbackupserviceconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsBandwidthPolicyServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csbandwidthpolicyserviceconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsBlockedDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csblockeddomain", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsBroadcastMeetingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csbroadcastmeetingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsBusyOptions.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csbusyoptions", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsCallParkOrbit.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cscallparkorbit", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsCallParkServiceMusicOnHoldFile.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cscallparkservicemusiconholdfile", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsCallViaWorkPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cscallviaworkpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsCceApplianceConfigurationReplicationStatus.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cscceapplianceconfigurationreplicationstatus", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsCceApplianceDeploymentStatus.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cscceappliancedeploymentstatus", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsCceApplianceStatus.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cscceappliancestatus", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsCdrConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cscdrconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsCertificate.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cscertificate", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsClientPin.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csclientpin", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsClientPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csclientpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsClientVersionConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csclientversionconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsClientVersionPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csclientversionpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsClientVersionPolicyRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csclientversionpolicyrule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsCloudCallDataConnector.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cscloudcalldataconnector", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsCloudCallDataConnectorConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cscloudcalldataconnectorconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsClsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csclsconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsClsRegion.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csclsregion", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsClsScenario.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csclsscenario", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsClsSearchTerm.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csclssearchterm", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsClsSecurityGroup.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csclssecuritygroup", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsCommonAreaPhone.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cscommonareaphone", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsConferenceDisclaimer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csconferencedisclaimer", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsConferenceServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csconferenceserver", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsConferencingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csconferencingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsConferencingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csconferencingpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsConfigurationStoreLocation.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csconfigurationstorelocation", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsConversationHistoryConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csconversationhistoryconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsCpsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cscpsconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsDeviceUpdateConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csdeviceupdateconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsDiagnosticConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csdiagnosticconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsDiagnosticHeaderConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csdiagnosticheaderconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsDialInConferencingAccessNumber.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csdialinconferencingaccessnumber", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsDialInConferencingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csdialinconferencingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsDialInConferencingDtmfConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csdialinconferencingdtmfconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsDialPlan.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csdialplan", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsDirector.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csdirector", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsEdgeServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csedgeserver", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsEnhancedEmergencyServiceDisclaimer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csenhancedemergencyservicedisclaimer", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsExternalAccessPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csexternalaccesspolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsExternalUserCommunicationPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csexternalusercommunicationpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsExUmContact.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csexumcontact", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsFileTransferFilterConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csfiletransferfilterconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsFIPSConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csfipsconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsGroupPickupUserOrbit.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csgrouppickupuserorbit", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsHealthMonitoringConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cshealthmonitoringconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsHostedVoicemailPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cshostedvoicemailpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsHostingProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cshostingprovider", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsHybridApplicationEndpoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cshybridapplicationendpoint", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsHybridMediationServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cshybridmediationserver", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsHybridPSTNAppliance.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cshybridpstnappliance", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsHybridPSTNSite.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cshybridpstnsite", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsImConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csimconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsImFilterConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csimfilterconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsImTranslationConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csimtranslationconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsIPPhonePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csipphonepolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsKerberosAccountAssignment.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cskerberosaccountassignment", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsKerberosAccountPassword.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cskerberosaccountpassword", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsLisLocation.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cslislocation", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsLisPort.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cslisport", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsLisServiceProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cslisserviceprovider", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsLisSubnet.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cslissubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsLisSwitch.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cslisswitch", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsLisWirelessAccessPoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csliswirelessaccesspoint", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsLocationPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cslocationpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsManagementConnection.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csmanagementconnection", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsManagementServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csmanagementserver", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsMcxConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csmcxconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsMediaConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csmediaconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsMediationServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csmediationserver", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsMeetingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csmeetingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsMeetingRoom.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csmeetingroom", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsMobilityPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csmobilitypolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsMonitoringServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csmonitoringserver", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsNetworkBandwidthPolicyProfile.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csnetworkbandwidthpolicyprofile", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsNetworkConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csnetworkconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsNetworkInterRegionRoute.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csnetworkinterregionroute", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsNetworkInterSitePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csnetworkintersitepolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsNetworkRegion.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csnetworkregion", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsNetworkRegionLink.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csnetworkregionlink", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsNetworkSite.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csnetworksite", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsNetworkSubnet.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csnetworksubnet", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsOAuthConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csoauthconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsOAuthServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csoauthserver", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsOutboundCallingNumberTranslationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csoutboundcallingnumbertranslationrule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsOutboundTranslationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csoutboundtranslationrule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsPartnerApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspartnerapplication", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsPersistentChatActiveServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspersistentchatactiveserver", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsPersistentChatAddin.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspersistentchataddin", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsPersistentChatCategory.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspersistentchatcategory", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsPersistentChatComplianceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspersistentchatcomplianceconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsPersistentChatConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspersistentchatconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsPersistentChatPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspersistentchatpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsPersistentChatRoom.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspersistentchatroom", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsPersistentChatState.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspersistentchatstate", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsPinPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspinpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsPlatformServiceSettings.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csplatformservicesettings", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsPresenceManagementState.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspresencemanagementstate", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsPresencePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspresencepolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsPresenceProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspresenceprovider", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsPrivacyConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csprivacyconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsProxyConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csproxyconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsPstnGateway.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspstngateway", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsPstnUsage.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspstnusage", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsPublicProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspublicprovider", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsPushNotificationConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cspushnotificationconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsQoEConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csqoeconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsRegistrar.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csregistrar", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsRegistrarConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csregistrarconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsReportingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csreportingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsRgsAgentGroup.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csrgsagentgroup", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsRgsConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csrgsconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsRgsHolidaySet.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csrgsholidayset", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsRgsHoursOfBusiness.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csrgshoursofbusiness", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsRgsQueue.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csrgsqueue", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsRgsWorkflow.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csrgsworkflow", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsRoutingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csroutingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsServerApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csserverapplication", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsSimpleUrlConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cssimpleurlconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsSipDomain.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cssipdomain", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsSipResponseCodeTranslationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cssipresponsecodetranslationrule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsSite.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cssite", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsSlaConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csslaconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsStaticRoutingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csstaticroutingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsStorageServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csstorageserviceconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsTeamsUpgradeConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csteamsupgradeconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsTeamsUpgradePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csteamsupgradepolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsTelemetryConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cstelemetryconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsTenantHybridConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cstenanthybridconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsTenantUpdateTimeWindow.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cstenantupdatetimewindow", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsTestDevice.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cstestdevice", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsTestUserCredential.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cstestusercredential", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsThirdPartyVideoSystem.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csthirdpartyvideosystem", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsThirdPartyVideoSystemPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csthirdpartyvideosystempolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsTrunkConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cstrunkconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsTrustedApplication.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cstrustedapplication", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsTrustedApplicationEndpoint.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cstrustedapplicationendpoint", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsTrustedApplicationPool.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cstrustedapplicationpool", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsUCPhoneConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csucphoneconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsUICulture.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csuiculture", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsUnassignedNumber.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csunassignednumber", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsUser.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csuser", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsUserAcp.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csuseracp", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsUserCallForwardingSettings.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csusercallforwardingsettings", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsUserDatabaseState.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csuserdatabasestate", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsUserDelegates.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csuserdelegates", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsUserPstnSettings.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csuserpstnsettings", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsUserReplicatorConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csuserreplicatorconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsUserServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csuserserver", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsUserServicesConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csuserservicesconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsUserServicesPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csuserservicespolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsUserTeamMembers.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csuserteammembers", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsVideoGateway.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csvideogateway", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsVideoInteropServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csvideointeropserver", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsVideoInteropServerConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csvideointeropserverconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csvideointeropserversynthetictransactionconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsVideoTrunkConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csvideotrunkconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsVoiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csvoiceconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsVoicemailReroutingConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csvoicemailreroutingconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsVoiceNormalizationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csvoicenormalizationrule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsVoicePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csvoicepolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsVoiceRoute.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csvoiceroute", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsVoiceRoutingPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csvoiceroutingpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsVoiceTestConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csvoicetestconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsWatcherNodeConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cswatchernodeconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsWebServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cswebserver", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsWebServiceConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-cswebserviceconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsXmppAllowedPartner.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csxmppallowedpartner", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Set-CsXmppGatewayConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/set-csxmppgatewayconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Show-CsClsLogging.md", + "redirect_url": "/powershell/module/skypeforbusiness/show-csclslogging", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/skype.md", + "redirect_url": "/powershell/module/skypeforbusiness/skypeforbusiness", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Start-CsClsLogging.md", + "redirect_url": "/powershell/module/skypeforbusiness/start-csclslogging", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Start-CsPool.md", + "redirect_url": "/powershell/module/skypeforbusiness/start-cspool", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Start-CsWindowsService.md", + "redirect_url": "/powershell/module/skypeforbusiness/start-cswindowsservice", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Stop-CsClsLogging.md", + "redirect_url": "/powershell/module/skypeforbusiness/stop-csclslogging", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Stop-CsWindowsService.md", + "redirect_url": "/powershell/module/skypeforbusiness/stop-cswindowsservice", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Sync-CsClsLogging.md", + "redirect_url": "/powershell/module/skypeforbusiness/sync-csclslogging", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Sync-CsUserData.md", + "redirect_url": "/powershell/module/skypeforbusiness/sync-csuserdata", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsAddressBookService.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csaddressbookservice", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsAddressBookWebQuery.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csaddressbookwebquery", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsASConference.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csasconference", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsAudioConferencingProvider.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csaudioconferencingprovider", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsAVConference.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csavconference", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsAVEdgeConnectivity.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csavedgeconnectivity", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsCertificateConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cscertificateconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsClientAuth.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csclientauth", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsClientAuthentication.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csclientauthentication", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsComputer.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cscomputer", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsDatabase.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csdatabase", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsDataConference.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csdataconference", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsDialInConferencing.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csdialinconferencing", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsDialPlan.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csdialplan", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsExStorageConnectivity.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csexstorageconnectivity", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsExStorageNotification.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csexstoragenotification", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsExUMConnectivity.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csexumconnectivity", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsExUMVoiceMail.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csexumvoicemail", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsFederatedPartner.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csfederatedpartner", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsGroupExpansion.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csgroupexpansion", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsGroupIM.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csgroupim", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsIM.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csim", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsInterTrunkRouting.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csintertrunkrouting", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsKerberosAccountAssignment.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cskerberosaccountassignment", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsLisCivicAddress.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csliscivicaddress", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsLisConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cslisconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsLocationPolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cslocationpolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsManagementServer.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csmanagementserver", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsMcxConference.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csmcxconference", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsMcxP2PIM.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csmcxp2pim", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsMcxPushNotification.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csmcxpushnotification", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsOUPermission.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csoupermission", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsP2PAV.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csp2pav", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsP2PVideoInteropServerSipTrunkAV.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csp2pvideointeropserversiptrunkav", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsPersistentChatMessage.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cspersistentchatmessage", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsPhoneBootstrap.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csphonebootstrap", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsPresence.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cspresence", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsPstnOutboundCall.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cspstnoutboundcall", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsPstnPeerToPeerCall.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cspstnpeertopeercall", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsRegistration.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csregistration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsReplica.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csreplica", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsSetupPermission.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cssetuppermission", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsTopology.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cstopology", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsTrunkConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cstrunkconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsUcwaConference.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csucwaconference", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsUnifiedContactStore.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csunifiedcontactstore", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsVoiceNormalizationRule.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csvoicenormalizationrule", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsVoicePolicy.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csvoicepolicy", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsVoiceRoute.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csvoiceroute", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsVoiceTestConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csvoicetestconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsVoiceUser.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csvoiceuser", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsWatcherNodeConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cswatchernodeconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsWebApp.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cswebapp", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsWebAppAnonymous.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cswebappanonymous", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsWebScheduler.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-cswebscheduler", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Test-CsXmppIM.md", + "redirect_url": "/powershell/module/skypeforbusiness/test-csxmppim", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Uninstall-CsDatabase.md", + "redirect_url": "/powershell/module/skypeforbusiness/uninstall-csdatabase", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Uninstall-CsMirrorDatabase.md", + "redirect_url": "/powershell/module/skypeforbusiness/uninstall-csmirrordatabase", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Unlock-CsClientPin.md", + "redirect_url": "/powershell/module/skypeforbusiness/unlock-csclientpin", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Unpublish-CsLisConfiguration.md", + "redirect_url": "/powershell/module/skypeforbusiness/unpublish-cslisconfiguration", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Unregister-CsHybridPSTNAppliance.md", + "redirect_url": "/powershell/module/skypeforbusiness/unregister-cshybridpstnappliance", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Update-CsAddressBook.md", + "redirect_url": "/powershell/module/skypeforbusiness/update-csaddressbook", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Update-CsAdminRole.md", + "redirect_url": "/powershell/module/skypeforbusiness/update-csadminrole", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Update-CsClsLogging.md", + "redirect_url": "/powershell/module/skypeforbusiness/update-csclslogging", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Update-CsTenantMeetingUrl.md", + "redirect_url": "/powershell/module/skypeforbusiness/update-cstenantmeetingurl", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Update-CsUserData.md", + "redirect_url": "/powershell/module/skypeforbusiness/update-csuserdata", + "redirect_document_id": false + }, + { + "source_path": "skype/skype-ps/skype/Update-CsUserDatabase.md", + "redirect_url": "/powershell/module/skypeforbusiness/update-csuserdatabase", + "redirect_document_id": false } ] -} \ No newline at end of file +} diff --git a/skype/skype-ps/skype/Add-CsSlaDelegates.md b/skype/skype-ps/SkypeForBusiness/Add-CsSlaDelegates.md similarity index 88% rename from skype/skype-ps/skype/Add-CsSlaDelegates.md rename to skype/skype-ps/SkypeForBusiness/Add-CsSlaDelegates.md index 3700e12bc1..bd4a959bcf 100644 --- a/skype/skype-ps/skype/Add-CsSlaDelegates.md +++ b/skype/skype-ps/SkypeForBusiness/Add-CsSlaDelegates.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/add-cssladelegates applicable: Skype for Business Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Add-CsSlaDelegates -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/add-cssladelegates +schema: 2.0.0 +title: Add-CsSlaDelegates --- # Add-CsSlaDelegates @@ -25,17 +26,17 @@ Add-CsSlaDelegates [-Identity] -Delegate [-Confirm] [-Pa ## DESCRIPTION SLA is a feature in Skype for Business (SfB) for handling multiple calls on a specific number called a shared number. SLA can configure any enterprise voice enabled SfB user as a shared number with multiple lines to respond to multiple calls. The calls are not actually received on the shared number, instead they are forwarded to users that act as delegates for the shared number. Any one of the delegates can pick up the call while the rest of the delegates get a notification on their phone about who picked up the call and which line has become busy as a result. Both the number of lines and the delegates are configurable for a shared number in SLA. In addition, advanced options such as BusyOption (what happens in a situation when all lines are busy) and MissedCallOption (the case in which none of the delegates pick up a call) can also be configured for a shared number. -The `Add-CsSlaDelegates` cmdlet provides a way to retrieve a shared number configuration. +The `Add-CsSlaDelegates` cmdlet provides a way to retrieve a shared number configuration. NOTE: Logging in with the account created for the SLA number is not supported. Using the SLA number account with any device or Desktop Client can result in unpredictable behavior. It is not necessary to use that account for the Shared Line Appearance feature to function. -By default, members of the RTCUniversalServerAdmins group are authorized to run the `Add-CsSlaDelegates`. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt: +By default, members of the RTCUniversalServerAdmins group are authorized to run the `Add-CsSlaDelegates`. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt: Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Add-CsSlaDelegates"} ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Add-CsSlaDelegates -Identity emergency -Delegate sip:delegate_1@contosohealth.com ``` @@ -45,13 +46,15 @@ This example adds a delegate "delegate_1@contosohealth.com" to an SLA configurat ## PARAMETERS ### -Delegate + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies a user that will respond to a call on the shared number specified by the Identity parameter. This parameter requires a valid sip address. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -61,7 +64,10 @@ Accept wildcard characters: False ``` ### -Identity -Indicates the identity of the shared number to which the delegate will be added. + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the identity of the shared number to which the delegate will be added. User identities can be specified using one of five formats: - SIP address: Example. sip:kenmyer@litwareinc.com. @@ -73,8 +79,7 @@ User identities can be specified using one of five formats: ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -83,14 +88,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -PassThru + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +The presence of the passthru switch causes the cmdlet to pass the current objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -99,14 +106,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -The presence of the passthru switch causes the cmdlet to pass the current objects through the pipeline. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -116,13 +125,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Approve-CsDeviceUpdateRule.md b/skype/skype-ps/SkypeForBusiness/Approve-CsDeviceUpdateRule.md similarity index 89% rename from skype/skype-ps/skype/Approve-CsDeviceUpdateRule.md rename to skype/skype-ps/SkypeForBusiness/Approve-CsDeviceUpdateRule.md index e35882d1bb..2c7415810d 100644 --- a/skype/skype-ps/skype/Approve-CsDeviceUpdateRule.md +++ b/skype/skype-ps/SkypeForBusiness/Approve-CsDeviceUpdateRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/approve-csdeviceupdaterule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Approve-CsDeviceUpdateRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/approve-csdeviceupdaterule +schema: 2.0.0 +title: Approve-CsDeviceUpdateRule --- # Approve-CsDeviceUpdateRule @@ -52,7 +53,7 @@ Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Approve-CsDeviceUpdateRule"} ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Approve-CsDeviceUpdateRule -Identity service:WebServer:atl-cs-001.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9 ``` @@ -60,7 +61,7 @@ Approve-CsDeviceUpdateRule -Identity service:WebServer:atl-cs-001.litwareinc.com The command shown in Example 1 approves the device update rule d5ce3c10-2588-420a-82ac-dc2d9b1222ff9 found on the service WebServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsDeviceUpdateRule -Filter service:WebServer:atl-cs-001.litwareinc.com* | Approve-CsDeviceUpdateRule ``` @@ -70,7 +71,7 @@ To do this, the command first calls the `Get-CsDeviceUpdateRule` cmdlet along wi (By definition, these are all the device update rules that have been assigned to the service WebServer:atl-cs-001.litwareinc.com.) This filtered collection is then piped to the `Approve-CsDeviceUpdateRule` cmdlet, which approves each rule in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsDeviceUpdateRule | Where-Object {$_.Brand -eq "LG-Nortel"} | Approve-CsDeviceUpdateRule ``` @@ -83,7 +84,28 @@ The filtered collection is then piped to the `Approve-CsDeviceUpdateRule` cmdlet ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the device update rule being approved. The Identity for a device update rule consists of two parts: the service where the device update rule has been assigned (for example, service:WebServer:atl-cs-001.litwareinc.com) and a globally unique identifier (GUID). Consequently, a device update rule configured for the Redmond site will have an Identity similar to this: service:WebServer:atl-cs-001.litwareinc.com /d5ce3c10-2588-420a-82ac-dc2d9b1222ff9. @@ -91,8 +113,7 @@ Consequently, a device update rule configured for the Redmond site will have an ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -102,13 +123,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -117,14 +140,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -134,29 +159,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -170,14 +181,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdate.Rule object. +### Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdate.Rule object. The `Approve-CsDeviceUpdateRule` cmdlet accepts pipelined instances of the device update rule object. ## OUTPUTS -### -None. +### None Instead, the `Approve-CsDeviceUpdateRule` cmdlet approves instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdate.Rule object. ## NOTES diff --git a/skype/skype-ps/skype/Backup-CsPool.md b/skype/skype-ps/SkypeForBusiness/Backup-CsPool.md similarity index 82% rename from skype/skype-ps/skype/Backup-CsPool.md rename to skype/skype-ps/SkypeForBusiness/Backup-CsPool.md index ebbf326a13..152b6e8178 100644 --- a/skype/skype-ps/skype/Backup-CsPool.md +++ b/skype/skype-ps/SkypeForBusiness/Backup-CsPool.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/backup-cspool applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Backup-CsPool -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/backup-cspool +schema: 2.0.0 +title: Backup-CsPool --- # Backup-CsPool @@ -39,7 +40,7 @@ Skype for Business Server Control Panel: The functions carried out by the Backup ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Backup-CsPool -PoolFqdn "atl-cs-001.litwareinc.com" ``` @@ -47,7 +48,7 @@ Backup-CsPool -PoolFqdn "atl-cs-001.litwareinc.com" The command shown in Example 1 backs up the pool atl-cs-001.litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Backup-CsPool -PoolFqdn "atl-cs-001.litwareinc.com" -SteadyState ``` @@ -57,26 +58,10 @@ In Example 2, a "steady state" backup is done for the pool atl-cs-001.litwareinc ## PARAMETERS -### -PoolFqdn -Fully qualified domain name of the pool being backed up. -For example: - -`-SourcePoolFqdn "atl-cs-001.litwareinc.com"` +### -Category -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Category Enables you to select the Skype for Business Server modules that will be backed up; if this parameter is not present then all the modules will be backed up. Allowed values are: @@ -87,8 +72,7 @@ Allowed values are: ```yaml Type: BackupCategory Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -97,31 +81,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -FailedOverPoolOnly -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -FailedOverPoolOnly When specified, backup will take place only if the pool is in a failed over state. If you use this parameter then you must also use the FullBackup parameter. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,13 +101,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -147,14 +119,16 @@ Accept wildcard characters: False ``` ### -FullBackup + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, backup will not begin until the backup service has reached its final state. You cannot use both the FullBackup parameter and the SteadyState parameter in the same command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -164,13 +138,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the topology information from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,7 +155,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool being backed up. +For example: + +`-SourcePoolFqdn "atl-cs-001.litwareinc.com"` + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Report + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + File path for the log file created when the cmdlet runs. For example: @@ -192,8 +192,7 @@ By default, reports are written to the AppData\Local\Temp folder in your user pr ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -203,13 +202,15 @@ Accept wildcard characters: False ``` ### -RetryCount + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum number of times Backup-CsPool will try to call the backup service before failing. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -219,14 +220,16 @@ Accept wildcard characters: False ``` ### -SteadyState + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, backup will not begin until the backup service has reached a steady state. A "steady state" occurs when the pool switches to read-only or failover/failback mode and no longer produces any new data that needs to be backed up. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -236,13 +239,33 @@ Accept wildcard characters: False ``` ### -WaitTime + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Amount of time (in seconds) that the cmdlet will wait before checking to see if the backup service is in either the full state or the steady state. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -252,13 +275,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -272,14 +297,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Backup-CsPool` cmdlet does not accept pipelined data. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Clear-CsDeviceUpdateFile.md b/skype/skype-ps/SkypeForBusiness/Clear-CsDeviceUpdateFile.md similarity index 88% rename from skype/skype-ps/skype/Clear-CsDeviceUpdateFile.md rename to skype/skype-ps/SkypeForBusiness/Clear-CsDeviceUpdateFile.md index 4565de64c5..be8ee46bae 100644 --- a/skype/skype-ps/skype/Clear-CsDeviceUpdateFile.md +++ b/skype/skype-ps/SkypeForBusiness/Clear-CsDeviceUpdateFile.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/clear-csdeviceupdatefile applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Clear-CsDeviceUpdateFile -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/clear-csdeviceupdatefile +schema: 2.0.0 +title: Clear-CsDeviceUpdateFile --- # Clear-CsDeviceUpdateFile @@ -41,7 +42,7 @@ Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Clear-CsDeviceUpdateFile"} ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Clear-CsDeviceUpdateFile -Identity "service:WebServer:atl-cs-001.litwareinc.com" ``` @@ -51,47 +52,53 @@ The command shown in Example 1 deletes all the device update files from the serv ## PARAMETERS -### -Identity -Unique identifier of the service hosting the device update files. -For example, this syntax clears device update files from the Web Services service for the pool atl-cs-001.litwareinc.com: -Identity "service:WebServer:atl-cs-001.litwareinc.com". +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier of the service hosting the device update files. +For example, this syntax clears device update files from the Web Services service for the pool atl-cs-001.litwareinc.com: -Identity "service:WebServer:atl-cs-001.litwareinc.com". ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -100,14 +107,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -121,14 +130,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Clear-CsDeviceUpdateFile` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None + The `Clear-CsDeviceUpdateFile` cmdlet does not return any values. ## NOTES diff --git a/skype/skype-ps/skype/Clear-CsDeviceUpdateLog.md b/skype/skype-ps/SkypeForBusiness/Clear-CsDeviceUpdateLog.md similarity index 87% rename from skype/skype-ps/skype/Clear-CsDeviceUpdateLog.md rename to skype/skype-ps/SkypeForBusiness/Clear-CsDeviceUpdateLog.md index 37114a8907..f1970237e4 100644 --- a/skype/skype-ps/skype/Clear-CsDeviceUpdateLog.md +++ b/skype/skype-ps/SkypeForBusiness/Clear-CsDeviceUpdateLog.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/clear-csdeviceupdatelog applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Clear-CsDeviceUpdateLog -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/clear-csdeviceupdatelog +schema: 2.0.0 +title: Clear-CsDeviceUpdateLog --- # Clear-CsDeviceUpdateLog @@ -37,7 +38,7 @@ Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Clear-CsDeviceUpdateLog"} ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Clear-CsDeviceUpdateLog -Identity "service:WebServer:atl-cs-001.litwareinc.com" -DaysBack 10 ``` @@ -47,24 +48,10 @@ The command shown in Example 1 connects to the Device Update Web service with th ## PARAMETERS -### -Identity -Unique identifier of the service hosting the Device Update Web service log files. -For example, this syntax clears Device Update Web service log files from the Web Services for the pool atl-cs-001.litwareinc.com: -Identity "service:WebServer:atl-cs-001.litwareinc.com". - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -DaysBack -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -DaysBack Maximum age (in days) of the log files to be maintained. All log files older than the value specified using the DaysBack parameter will be deleted. For example, if you set DaysBack to 7 then any log files more than seven days old will be removed. @@ -74,8 +61,7 @@ This parameter can be set to any integer value between 1 and 30, inclusive. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 3 @@ -85,13 +71,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -100,30 +88,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier of the service hosting the Device Update Web service log files. +For example, this syntax clears Device Update Web service log files from the Web Services for the pool atl-cs-001.litwareinc.com: -Identity "service:WebServer:atl-cs-001.litwareinc.com". ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -137,14 +148,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Clear-CsDeviceUpdateLog` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None The `Clear-CsDeviceUpdateLog` cmdlet does not return any values. ## NOTES diff --git a/skype/skype-ps/skype/Clear-CsPersistentChatRoom.md b/skype/skype-ps/SkypeForBusiness/Clear-CsPersistentChatRoom.md similarity index 90% rename from skype/skype-ps/skype/Clear-CsPersistentChatRoom.md rename to skype/skype-ps/SkypeForBusiness/Clear-CsPersistentChatRoom.md index e6cc17f0f3..9ff0083198 100644 --- a/skype/skype-ps/skype/Clear-CsPersistentChatRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Clear-CsPersistentChatRoom.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/clear-cspersistentchatroom applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Clear-CsPersistentChatRoom -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/clear-cspersistentchatroom +schema: 2.0.0 +title: Clear-CsPersistentChatRoom --- # Clear-CsPersistentChatRoom @@ -51,7 +52,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Clear ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Clear-CsPersistentChatRoom -Identity "atl-cs-001.litwareinc.com\ITChatRoom" -EndDate "3/1/2018" ``` @@ -59,7 +60,7 @@ Clear-CsPersistentChatRoom -Identity "atl-cs-001.litwareinc.com\ITChatRoom" -End The command shown in Example removes all the content from the Persistent Chat chat room ITChatRoom that was added to the room on or before March 1, 2018. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatRoom | Clear-CsPersistentChatRoom -EndDate "3/1/2018" -Confirm:$False ``` @@ -73,6 +74,9 @@ Note that, in order to suppress the confirmation prompt which would otherwise ap ## PARAMETERS ### -EndDate + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Indicates the last date for which content should be removed. For example, if you specify an EndDate of 3/1/2018 (March 1, 2018 in US English) then all the Persistent Chat content added to the room on or before 3/1/2018 will be deleted. @@ -82,8 +86,7 @@ You must specify an EndDate when running the `Clear-CsPersistentChatRoom` cmdlet ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: Named @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Identity of the chat room whose content is to be removed. For example: @@ -101,8 +107,7 @@ For example: ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 1 @@ -112,13 +117,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: ChatRoom Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 1 @@ -128,6 +135,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Prompts you for confirmation before executing the command. If you set the value of this parameter to False then you will not get a confirmation prompt when you run the cmdlet: @@ -137,7 +147,6 @@ If you set the value of this parameter to False then you will not get a confirma Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -147,13 +156,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -167,13 +178,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.GroupChat.Cmdlets.ChatRoomObject The `Clear-CsPersistentChatRoom` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.GroupChat.Cmdlets.ChatRoomObject object. ## OUTPUTS -### -None. Instead, `Clear-CsPersistentChatRoom` modifies existing instances of the Microsoft.Rtc.Management.GroupChat.Cmdlets.ChatRoomObject object. +### None ## NOTES diff --git a/skype/skype-ps/skype/Convert-CsUserData.md b/skype/skype-ps/SkypeForBusiness/Convert-CsUserData.md similarity index 87% rename from skype/skype-ps/skype/Convert-CsUserData.md rename to skype/skype-ps/SkypeForBusiness/Convert-CsUserData.md index 36e5bfd5b6..51a720b703 100644 --- a/skype/skype-ps/skype/Convert-CsUserData.md +++ b/skype/skype-ps/SkypeForBusiness/Convert-CsUserData.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/convert-csuserdata applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Convert-CsUserData -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/convert-csuserdata +schema: 2.0.0 +title: Convert-CsUserData --- # Convert-CsUserData @@ -37,7 +38,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Conve ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Convert-CsUserData -InputFile "C:\Logs\Lync2013Data.Zip" -OutputFile "C:\Logs\Lync2010Data.xml" -TargetVersion Lync2010 ``` @@ -46,7 +47,7 @@ The command shown in Example 1 converts the user data stored in the file C:\Logs The converted data is stored in the XML file C:\Logs\Lync2010Data.xml. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Convert-CsUserData -InputFile "C:\Logs\Lync2013Data.Zip" -OutputFile "C:\Logs\Lync2010data.xml" -TargetVersion Lync2010 -UserFilter "kenmyer@litwareinc.com" ``` @@ -57,61 +58,62 @@ This is done by including the UserFilter parameter followed by the user's SIP ad ## PARAMETERS -### -InputFile -Full path to the .ZIP file or .XML file containing the user data to be converted. -For example: +### -ConfDirectoryFilter --InputFile "C:\Data\Lync2010.zip" +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to convert conference directory data. +To do this, include the ConfDirectoryFilter parameter and specify the Identity of the conference directory: + +-ConfDirectoryFilter 13 + +You can retrieve conference directory Identities by using this command: + +Get-CsConferenceDirectory | Select-Object Identity, ServiceId ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutputFile -Full path to the file that will store the converted data. -If you are outputting the data using the Microsoft Lync Server 2010 format then the output file must use a .XML file extension; for example: - --OutputFile "C:\Data\ConvertedLync2010Data.xml" - -If you are using the Microsoft Lync Server 2013 Preview format, the output file must use a .ZIP file extension: +### -Force --OutputFile "C:\Data\ConvertedLyncData.zip" +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetVersion -Indicates the format for the converted data. -Allowed values are: +### -InputFile -- Lync2010 -- Current +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Full path to the .ZIP file or .XML file containing the user data to be converted. +For example: + +-InputFile "C:\Data\Lync2010.zip" ```yaml -Type: ConvertTarget +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -120,39 +122,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConfDirectoryFilter -Enables you to convert conference directory data. -To do this, include the ConfDirectoryFilter parameter and specify the Identity of the conference directory: +### -OutputFile --ConfDirectoryFilter 13 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You can retrieve conference directory Identities by using this command: +Full path to the file that will store the converted data. +If you are outputting the data using the Microsoft Lync Server 2010 format then the output file must use a .XML file extension; for example: + +-OutputFile "C:\Data\ConvertedLync2010Data.xml" + +If you are using the Microsoft Lync Server 2013 Preview format, the output file must use a .ZIP file extension: + +-OutputFile "C:\Data\ConvertedLyncData.zip" -Get-CsConferenceDirectory | Select-Object Identity, ServiceId ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -TargetVersion + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the format for the converted data. +Allowed values are: + +- Lync2010 +- Current ```yaml -Type: SwitchParameter +Type: ConvertTarget Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -160,6 +171,9 @@ Accept wildcard characters: False ``` ### -UserFilter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to convert data for a single user. That user specified by using his or her SIP address, minus the sip: prefix. For example: @@ -169,8 +183,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,13 +197,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Convert-CsUserData` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Convert-CsUserData` cmdlet creates either XML or ZIP files, depending on whether the converted data is to be used with Lync Server or with Skype for Business Server. ## NOTES diff --git a/skype/skype-ps/skype/ConvertTo-JsonForPSWS.md b/skype/skype-ps/SkypeForBusiness/ConvertTo-JsonForPSWS.md similarity index 93% rename from skype/skype-ps/skype/ConvertTo-JsonForPSWS.md rename to skype/skype-ps/SkypeForBusiness/ConvertTo-JsonForPSWS.md index a337781345..d9f32a0ac2 100644 --- a/skype/skype-ps/skype/ConvertTo-JsonForPSWS.md +++ b/skype/skype-ps/SkypeForBusiness/ConvertTo-JsonForPSWS.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/convertto-jsonforpsws applicable: Skype for Business Online -title: ConvertTo-JsonForPSWS -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/convertto-jsonforpsws +schema: 2.0.0 +title: ConvertTo-JsonForPSWS --- # ConvertTo-JsonForPSWS @@ -28,7 +30,7 @@ You can then use the `ConvertTo-JsonForPSWS` cmdlet to convert a JSON-formatted ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> (Get-UICulture).Calendar | ConvertTo-JsonForPSWS { @@ -46,7 +48,7 @@ PS C:\> (Get-UICulture).Calendar | ConvertTo-JsonForPSWS This command uses the `ConvertTo-JsonForPSWS` cmdlet to convert a GregorianCalendar object to a JSON-formatted string for PowerShell Web Services. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> @{Account="User01";Domain="Domain01";Admin="True"} | ConvertTo-JsonForPSWS -Compress {"Admin":"True","Account":"User01","Domain":"Domain01"} @@ -54,7 +56,7 @@ PS C:\> @{Account="User01";Domain="Domain01";Admin="True"} | ConvertTo-JsonForPS This command shows the effect of using the Compress parameter of `ConvertTo-JsonForPSWS`. The compression affects only the appearance of the string, not its validity. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> Get-Date | Select-Object -Property * | ConvertTo-JsonForPSWS { @@ -101,7 +103,7 @@ This command shows how to use the `ConvertTo-JsonForPSWS` cmdlet to convert an o It uses the `ConvertTo-JsonForPSWS` cmdlet to convert a System.DateTime object from the Get-Date cmdlet to a JSON-formatted string for PowerShell Web Services. The command uses the Select-Object cmdlet to get all () of the properties of the **DateTime* object. The output shows the JSON string that `ConvertTo-JsonForPSWS` returned. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` PS C:\> $JsonSecurityHelp = Get-Content $Pshome\Modules\Microsoft.PowerShell.Security\en-US\Microsoft.PowerShell.Security.dll-Help.xml | ConvertTo-JsonForPSWS ``` @@ -111,13 +113,15 @@ This command uses the `ConvertTo-JsonForPSWS` cmdlet to convert a Windows PowerS ## PARAMETERS ### -Compress + +> Applicable: Skype for Business Online + Omits white space and indented formatting in the output string. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -127,13 +131,15 @@ Accept wildcard characters: False ``` ### -Depth + +> Applicable: Skype for Business Online + Specifies how many levels of contained objects are included in the JSON representation. The default value is 2. ```yaml Type: Int Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -143,6 +149,9 @@ Accept wildcard characters: False ``` ### -InputObject + +> Applicable: Skype for Business Online + Specifies the objects to convert to JSON format. Enter a variable that contains the objects, or type a command or expression that gets the objects. You can also pipe an object to `ConvertTo-JsonForPSWS`. The InputObject parameter is required, but its value can be null ($Null) or an empty string. When the input object is $Null, `ConvertTo-JsonForPSWS` does not generate any output. When the input object is an empty string, `ConvertTo-JsonForPSWS` returns an empty string. @@ -150,8 +159,7 @@ The InputObject parameter is required, but its value can be null ($Null) or an e ```yaml Type: Object Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 0 diff --git a/skype/skype-ps/skype/Copy-CsVoicePolicy.md b/skype/skype-ps/SkypeForBusiness/Copy-CsVoicePolicy.md similarity index 82% rename from skype/skype-ps/skype/Copy-CsVoicePolicy.md rename to skype/skype-ps/SkypeForBusiness/Copy-CsVoicePolicy.md index 2b2f8404d0..4ca7fe1c67 100644 --- a/skype/skype-ps/skype/Copy-CsVoicePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Copy-CsVoicePolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/copy-csvoicepolicy applicable: Lync Server 2013 -title: Copy-CsVoicePolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/copy-csvoicepolicy +schema: 2.0.0 +title: Copy-CsVoicePolicy --- # Copy-CsVoicePolicy @@ -26,7 +28,7 @@ This cmdlet has been deprecated for use with Lync Server 2013 and Lync Online. A ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> {{ Add example code here }} ``` @@ -36,30 +38,16 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -PolicyName - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### -BypassDualWrite -### -Tenant +> Applicable: Skype for Business Online ```yaml -Type: Guid +Type: Object Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -68,11 +56,12 @@ Accept wildcard characters: False ### -Force +> Applicable: Lync Server 2013, Skype for Business Online + ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online +Aliases: Required: False Position: Named @@ -83,11 +72,12 @@ Accept wildcard characters: False ### -Identity +> Applicable: Lync Server 2013, Skype for Business Online + ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online +Aliases: Required: False Position: 2 @@ -98,11 +88,12 @@ Accept wildcard characters: False ### -LocalStore +> Applicable: Lync Server 2013, Skype for Business Online + ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online +Aliases: Required: False Position: Named @@ -111,15 +102,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BypassDualWrite +### -PolicyName + +> Applicable: Lync Server 2013, Skype for Business Online ```yaml -Type: Object +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: -Required: False +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Online + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: True Position: Named Default value: None Accept pipeline input: False diff --git a/skype/skype-ps/skype/Debug-CsAddressBookReplication.md b/skype/skype-ps/SkypeForBusiness/Debug-CsAddressBookReplication.md similarity index 87% rename from skype/skype-ps/skype/Debug-CsAddressBookReplication.md rename to skype/skype-ps/SkypeForBusiness/Debug-CsAddressBookReplication.md index 1afa8db7a1..a1e08a42d8 100644 --- a/skype/skype-ps/skype/Debug-CsAddressBookReplication.md +++ b/skype/skype-ps/SkypeForBusiness/Debug-CsAddressBookReplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/debug-csaddressbookreplication applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Debug-CsAddressBookReplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/debug-csaddressbookreplication +schema: 2.0.0 +title: Debug-CsAddressBookReplication --- # Debug-CsAddressBookReplication @@ -39,7 +40,7 @@ The functions carried out by the Debug-CsAddressBookReplication cmdlet are not a ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Debug-CsAddressBookReplication ``` @@ -47,7 +48,7 @@ Debug-CsAddressBookReplication The command shown in Example 1 verifies Address book replication for the current pool. To verify replication for a specified pool, include the PoolFqdn parameter followed by the fully qualified domain name of the pool to be verified. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Debug-CsAddressBookReplication -User "sip:kenmyer@litwareinc.com" ``` @@ -55,14 +56,14 @@ Debug-CsAddressBookReplication -User "sip:kenmyer@litwareinc.com" In Example 2, the User parameter is included when verifying Address book replication for the current pool. When the User parameter is included, additional related information is returned for the specified user. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Debug-CsAddressBookReplication -User "sip:kenmyer@litwareinc.com" -VerifyReplication ``` Example 3 uses the VerifyReplication parameter to make a change to the specified user account and then verify that this change can be successfully replicated to the Address Book. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Debug-CsAddressBookReplication -VerifyNormalization ``` @@ -72,7 +73,31 @@ The command shown in Example 4 uses the VerifyNormalization parameter to return ## PARAMETERS +### -AnalyzeFailures + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When included in a command, Debug-CsAddessBookReplication will return information about any SQL Server stored procedure errors (SprocExecuteErrors) associated with the Address Book. +The returned data includes information about which stored procedure failed; when the procedure failed; and how many times the procedure has failed. +Debug-CsAddressBookReplication will also return the SQL error code and provide the failed SQL statement. +Among other things, that enables you to rerun the statement from within the SQL debugger. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DomainController + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a domain controller to connect to when verifying Address book replication. If this parameter is not included then the cmdlet will use the first available domain controller. @@ -80,7 +105,6 @@ If this parameter is not included then the cmdlet will use the first available d Type: String Parameter Sets: (All) Aliases: DC -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -90,13 +114,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -106,6 +132,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -127,7 +156,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -137,6 +165,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax @@ -148,7 +179,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -158,14 +188,16 @@ Accept wildcard characters: False ``` ### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the pool being checked. If this parameter is not included then the Debug-CsAddressBookReplication cmdlet will verify the current pool. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -174,32 +206,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -User -When included, returns detailed replication information for the specified user accounts. -The user account to be verified can be specified by using the user's SIP address, email address, or SamAccountName. +### -StartDate -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Indicates the earliest activity date for the errors returned by the AnalyzeFailures parameter. +For example, if you set the start date to 3/1/2018 (Match 1, 2018, in U.S. +English) any errors prior to that date (for example, errors recorded on February 21, 2018) will be excluded from the returned data. -### -VerifyNormalization -If specified, detailed information will be returned for any user accounts where Address book normalization failed. -Normalization rules are used to convert phone numbers to the E.164 format used by Skype for Business Server. +Use the date-time formats specified by your Regional and Language Options settings when assigning values to the StartDate parameter. ```yaml -Type: SwitchParameter +Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -208,15 +228,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VerifyReplication -When specified, the Debug-CsAddressBookReplication cmdlet will modify the specified user account in Active Directory and then verify that the changes are replicated to the Address book. -Note that the user account modification is for testing purposes only, and will not actually change the property values of that account. +### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Globally unique identifier (GUID) of the Skype for Business Online tenant account for which address book replication is being verified. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,17 +253,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AnalyzeFailures -When included in a command, Debug-CsAddessBookReplication will return information about any SQL Server stored procedure errors (SprocExecuteErrors) associated with the Address Book. -The returned data includes information about which stored procedure failed; when the procedure failed; and how many times the procedure has failed. -Debug-CsAddressBookReplication will also return the SQL error code and provide the failed SQL statement. -Among other things, that enables you to rerun the statement from within the SQL debugger. +### -User + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When included, returns detailed replication information for the specified user accounts. +The user account to be verified can be specified by using the user's SIP address, email address, or SamAccountName. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -244,18 +272,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StartDate -Indicates the earliest activity date for the errors returned by the AnalyzeFailures parameter. -For example, if you set the start date to 3/1/2018 (Match 1, 2018, in U.S. -English) any errors prior to that date (for example, errors recorded on February 21, 2018) will be excluded from the returned data. +### -VerifyNormalization -Use the date-time formats specified by your Regional and Language Options settings when assigning values to the StartDate parameter. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If specified, detailed information will be returned for any user accounts where Address book normalization failed. +Normalization rules are used to convert phone numbers to the E.164 format used by Skype for Business Server. ```yaml -Type: DateTime +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -264,21 +291,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for which address book replication is being verified. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -VerifyReplication -You can return the tenant ID for each of your tenants by running this command: +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +When specified, the Debug-CsAddressBookReplication cmdlet will modify the specified user account in Active Directory and then verify that the changes are replicated to the Address book. +Note that the user account modification is for testing purposes only, and will not actually change the property values of that account. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -297,7 +320,7 @@ The Debug-CsAddressBookReplication cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.Activities.Database.AddressBookReplicationTaskOutput The Debug-CsAddressBookReplication cmdlet returns instances of the Microsoft.Rtc.SyntheticTransactions.Activities.Database.AddressBookReplicationTaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Debug-CsDataConference.md b/skype/skype-ps/SkypeForBusiness/Debug-CsDataConference.md similarity index 87% rename from skype/skype-ps/skype/Debug-CsDataConference.md rename to skype/skype-ps/SkypeForBusiness/Debug-CsDataConference.md index 6db0f9115d..459fed005a 100644 --- a/skype/skype-ps/skype/Debug-CsDataConference.md +++ b/skype/skype-ps/SkypeForBusiness/Debug-CsDataConference.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/debug-csdataconference applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Debug-CsDataConference -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/debug-csdataconference +schema: 2.0.0 +title: Debug-CsDataConference --- # Debug-CsDataConference @@ -26,21 +27,21 @@ The functions carried out by the Debug-CsDataConference cmdlet are not available ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Debug-CsDataConference ``` The command shown in Example 1 returns diagnostic information for the Conferencing Server installed on the local computer. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Debug-CsDataConference -TargetFqdn "atl-cs-001.litwareinc.com" ``` In Example 2, diagnostic information is returned for the Conferencing Server installed on the remote computer atl-cs-001.litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Debug-CsDataConference | Select-Object -ExpandProperty Details | Format-List ``` @@ -55,13 +56,15 @@ The Select-Object cmdlet uses the ExpandProperty parameter to return complete in ## PARAMETERS ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any nonfatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -71,16 +74,18 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +For example: `-Report "C:\Logs\DataConference.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -90,6 +95,9 @@ Accept wildcard characters: False ``` ### -TargetFqdn + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the computer where the Skype for Business Server 2015 Conferencing Server is installed. If this parameter is not included, the Debug-CsDataConference cmdlet will run against the local computer. If Conferencing Server is not installed on the local computer, an error will occur. @@ -97,8 +105,7 @@ If Conferencing Server is not installed on the local computer, an error will occ ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Debug-CsInterPoolReplication.md b/skype/skype-ps/SkypeForBusiness/Debug-CsInterPoolReplication.md similarity index 85% rename from skype/skype-ps/skype/Debug-CsInterPoolReplication.md rename to skype/skype-ps/SkypeForBusiness/Debug-CsInterPoolReplication.md index ebc215436e..0637412f12 100644 --- a/skype/skype-ps/skype/Debug-CsInterPoolReplication.md +++ b/skype/skype-ps/SkypeForBusiness/Debug-CsInterPoolReplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/debug-csinterpoolreplication applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Debug-CsInterPoolReplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/debug-csinterpoolreplication +schema: 2.0.0 +title: Debug-CsInterPoolReplication --- # Debug-CsInterPoolReplication @@ -44,14 +45,14 @@ The functions carried out by the Debug-CsInterPoolReplication cmdlet are not ava ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Debug-CsInterPoolReplication -PoolFqdn "atl-cs-001.litwareinc.com" ``` The command shown in Example 1 verifies the full replication status between the pool atl-cs-001.litwareinc.com and its previously-assigned backup pool. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Debug-CsInterPoolReplication -PoolFqdn "atl-cs-001.litwareinc.com" -BackupModule DataConf ``` @@ -61,26 +62,10 @@ In Example 2, only the replication of data conferencing data is verified between ## PARAMETERS -### -PoolFqdn -Fully qualified domain name of the primary pool being tested. -For example: - -`-PoolFqdn "atl-cs-001.litwareinc.com"` +### -BackupModule -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -BackupModule Enables administrators to specify the data store to be verified. Allowed values are: @@ -94,8 +79,7 @@ The default value is All. ```yaml Type: BackupModules Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -104,14 +88,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -DatabaseCommandTimeoutInSeconds + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: Int32 ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -120,14 +106,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -136,16 +124,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DatabaseCommandTimeoutInSeconds -PARAMVALUE: Int32 +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the primary pool being tested. +For example: + +`-PoolFqdn "atl-cs-001.litwareinc.com"` ```yaml -Type: Int32 +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -153,13 +146,15 @@ Accept wildcard characters: False ``` ### -ResyncSignatureMismatchItems + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -169,13 +164,33 @@ Accept wildcard characters: False ``` ### -SuppressMultiMasterDetection + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + When included in the command, Debug-CsInterPoolReplication will not verify whether or not the pool is part of a multi-master replication configuration before beginning its verification checks. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -185,13 +200,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Debug-CsIntraPoolReplication.md b/skype/skype-ps/SkypeForBusiness/Debug-CsIntraPoolReplication.md similarity index 87% rename from skype/skype-ps/skype/Debug-CsIntraPoolReplication.md rename to skype/skype-ps/SkypeForBusiness/Debug-CsIntraPoolReplication.md index 5f9eb262df..4428f88621 100644 --- a/skype/skype-ps/skype/Debug-CsIntraPoolReplication.md +++ b/skype/skype-ps/SkypeForBusiness/Debug-CsIntraPoolReplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/debug-csintrapoolreplication applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Debug-CsIntraPoolReplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/debug-csintrapoolreplication +schema: 2.0.0 +title: Debug-CsIntraPoolReplication --- # Debug-CsIntraPoolReplication @@ -55,14 +56,14 @@ The functions carried out by the Debug-CsIntraPoolReplication cmdlet are not ava ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Debug-CsIntraPoolReplication -UserUri "sip:kenmyer@litwareinc.com" ``` The command shown in Example 1 verifies replication on a Front End server by using the user with the SIP address "sip:kenmyer@litwareinc.com". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUser -OU "OU=Redmond,dc=litwareinc,dc=com" | ForEach-Object {Debug-CsIntraPoolReplication $_.Identity} ``` @@ -71,7 +72,7 @@ In Example 2, replication is verified by using all the users who have user accou To do this, the command first calls Get-CsUser along with the OU parameter; the parameter value "OU=Redmond,dc=litwareinc,dc=com" limits the returned data to user accounts found in the Redmond OU. Those accounts are then piped to the ForEach-Object cmdlet which, in turn, uses Debug-CsIntraPoolReplication cmdlet to verify the replication status of each account in the OU. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` "sip:kenmyer@litwareinc.com","sip:pilar@litwareinc.com" | ForEach-Object {Debug-CsIntraPoolReplication -UserUri $_} ``` @@ -79,14 +80,14 @@ Those accounts are then piped to the ForEach-Object cmdlet which, in turn, uses The command shown in Example 3 verifies replication status by using a pair of user SIP addresses. To perform this task, the two SIP addresses (enclosed in quotation marks and separated by using a comma) are piped to the ForEach-Object cmdlet, which then runs the Debug-CsIntraPoolReplication cmdlet against each SIP address.. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Debug-CsIntraPoolReplication -ConferenceDirectory 13 ``` In Example 4, replication is verified for the conference directory with the ID 13. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsUser -Filter {RegistrarPool -eq "atl-cs-001.litwareinc.com"} | Debug-CsIntraPoolReplication UserUri {$_.Identity} ``` @@ -99,6 +100,9 @@ Those accounts are then piped to the Debug-CsIntraPoolReplication cmdlet, which ## PARAMETERS ### -ConferenceDirectory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to verify the replication of a conference directory. Conference directories should be specified using the directory Identity; conference directory Identities can be retrieved by using this command: @@ -109,8 +113,7 @@ You cannot use the ConferenceDirectory parameter and the UserUri parameter in th ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: ConferenceDirectory -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -119,35 +122,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -UserUri -SIP address of the user account employed in testing intra-pool replication. -For example: - -`-UserUri sip:kenmyer@litwareinc.com` - -You cannot use the ConferenceDirectory parameter and the UserUri parameter in the same command. - -```yaml -Type: UserIdParameter -Parameter Sets: User -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Force Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -157,6 +141,9 @@ Accept wildcard characters: False ``` ### -PoolFqdn + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the pool to be checked. For example: @@ -165,8 +152,7 @@ For example: ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: PoolFqdn -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -176,13 +162,15 @@ Accept wildcard characters: False ``` ### -Service + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a particular service to be verified. ```yaml Type: String Parameter Sets: PoolFqdn -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -192,13 +180,15 @@ Accept wildcard characters: False ``` ### -ShowAll + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + When included in the command, shows information about all the services involved in replication. ```yaml Type: SwitchParameter Parameter Sets: PoolFqdn -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -208,6 +198,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify the type of replication to be verified. Allowed values are: @@ -217,8 +210,7 @@ Allowed values are: ```yaml Type: ServiceEnumerationType Parameter Sets: PoolFqdn -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -227,20 +219,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UserUri + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address of the user account employed in testing intra-pool replication. +For example: + +`-UserUri sip:kenmyer@litwareinc.com` + +You cannot use the ConferenceDirectory parameter and the UserUri parameter in the same command. + +```yaml +Type: UserIdParameter +Parameter Sets: User +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 -### -String or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String + +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. + Debug-CsIntraPoolReplication accepts a pipelined string value representing the SIP address or Active Directory display name of a user account that has been enabled for Lync Server. The cmdlet also accepts pipelined instances of the Active Directory user object for a Lync Server-enabled user. ## OUTPUTS -### -Debug-CsIntraPoolReplication returns instances of the Microsoft.Rtc.Management.UserPinservice.Data.syncReplicationDetails object. +### Microsoft.Rtc.Management.UserPinService.Data.SyncReplicationDetails + +Debug-CsIntraPoolReplication returns instances of the Microsoft.Rtc.Management.UserPinService.Data.SyncReplicationDetails object. ## NOTES diff --git a/skype/skype-ps/skype/Debug-CsLisConfiguration.md b/skype/skype-ps/SkypeForBusiness/Debug-CsLisConfiguration.md similarity index 92% rename from skype/skype-ps/skype/Debug-CsLisConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Debug-CsLisConfiguration.md index 11d2b846e0..068d86b1e0 100644 --- a/skype/skype-ps/skype/Debug-CsLisConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Debug-CsLisConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/debug-cslisconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Debug-CsLisConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/debug-cslisconfiguration +schema: 2.0.0 +title: Debug-CsLisConfiguration --- # Debug-CsLisConfiguration @@ -40,7 +41,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Debug-CsLisConfiguration | Format-Table -Wrap ``` @@ -53,13 +54,15 @@ Therefore, in this example we pipe the output to the Format-Table cmdlet, specif ## PARAMETERS ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -69,14 +72,16 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to specify a domain controller. If no domain controller is specified, the first available will be used. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Debug-CsStorageServiceFailures.md b/skype/skype-ps/SkypeForBusiness/Debug-CsStorageServiceFailures.md similarity index 88% rename from skype/skype-ps/skype/Debug-CsStorageServiceFailures.md rename to skype/skype-ps/SkypeForBusiness/Debug-CsStorageServiceFailures.md index 417dd26a22..81dbd7b696 100644 --- a/skype/skype-ps/skype/Debug-CsStorageServiceFailures.md +++ b/skype/skype-ps/SkypeForBusiness/Debug-CsStorageServiceFailures.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/debug-csstorageservicefailures applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Debug-CsStorageServiceFailures -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/debug-csstorageservicefailures +schema: 2.0.0 +title: Debug-CsStorageServiceFailures --- # Debug-CsStorageServiceFailures @@ -75,7 +76,7 @@ Other : ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Debug-CsStorageServiceFailures -SipURI kmyer@contoso.com ``` @@ -84,7 +85,7 @@ This example returns debugging information about storage service failures relati -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Debug-CsStorageServiceFailures -Component ConversationHistory ``` @@ -95,13 +96,15 @@ This example returns debugging information about storage service failures relati ## PARAMETERS ### -AdapterId + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the GUID of the data adapter on which to gather the debugging information. ```yaml Type: Guid Parameter Sets: (All) Aliases: g -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -111,6 +114,9 @@ Accept wildcard characters: False ``` ### -Binding + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the Windows Communication Foundation (WCF) binding. A WCF binding determines the transport, encoding, and protocol details required for clients and services to communicate with each other. Valid values are: @@ -122,7 +128,6 @@ Valid values are: Type: String Parameter Sets: (All) Aliases: b -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -132,6 +137,9 @@ Accept wildcard characters: False ``` ### -Component + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the storage service component for which debug information will be returned. Acceptable values for the Component parameter are: @@ -148,7 +156,6 @@ Acceptable values for the Component parameter are: Type: Component Parameter Sets: (All) Aliases: c -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -158,6 +165,9 @@ Accept wildcard characters: False ``` ### -EndTime + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The EndDate parameter specifies the end date of the date range. Use the short date format defined in the Regional Options settings for the computer on which the command is run. @@ -168,8 +178,7 @@ If you enter the date and time of day, you must enclose the argument in quotatio ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,13 +188,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error messages and completes the cmdlet operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -195,6 +206,9 @@ Accept wildcard characters: False ``` ### -HostNameStorageService + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the server where the Skype for Business Storage Service is running. This parameter is required if the Binding parameter is set to NetTCP. @@ -202,7 +216,6 @@ This parameter is required if the Binding parameter is set to NetTCP. Type: String Parameter Sets: (All) Aliases: h -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -212,14 +225,16 @@ Accept wildcard characters: False ``` ### -OutFileName + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the full path of where to write a text file containing the debug results. Otherwise, they are written to the console. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -229,6 +244,9 @@ Accept wildcard characters: False ``` ### -SipUri + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the Session Initiation Protocol (SIP) Uniform Resource Identifier (URI) of the user on which to collect debug data. This is the SIPAddress property of the user as returned by the Get-CsUser cmdlet. @@ -236,7 +254,6 @@ This is the SIPAddress property of the user as returned by the Get-CsUser cmdlet Type: String Parameter Sets: (All) Aliases: s -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -246,6 +263,9 @@ Accept wildcard characters: False ``` ### -StartTime + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The StartDate parameter specifies the start date of the date range. Use the short date format defined in the Regional Options settings for the computer on which the command is run. @@ -256,8 +276,7 @@ If you enter the date and time of day, you must enclose the argument in quotatio ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Debug-CsUnifiedContactStore.md b/skype/skype-ps/SkypeForBusiness/Debug-CsUnifiedContactStore.md similarity index 91% rename from skype/skype-ps/skype/Debug-CsUnifiedContactStore.md rename to skype/skype-ps/SkypeForBusiness/Debug-CsUnifiedContactStore.md index df94000299..0589de5b92 100644 --- a/skype/skype-ps/skype/Debug-CsUnifiedContactStore.md +++ b/skype/skype-ps/SkypeForBusiness/Debug-CsUnifiedContactStore.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/debug-csunifiedcontactstore applicable: Skype for Business Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Debug-CsUnifiedContactStore -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/debug-csunifiedcontactstore +schema: 2.0.0 +title: Debug-CsUnifiedContactStore --- # Debug-CsUnifiedContactStore @@ -44,14 +45,14 @@ The functions carried out by the Debug-CsUnifiedContactStore cmdlet are not avai ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Debug-CsUnifiedContactStore -PoolFqdn "atl-cs-001.litwareinc.com" ``` The command shown in Example 1 verifies the unified contact store status for all the users who have accounts homed on the pool atl-cs-001.litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Debug-CsUnifiedContactStore -Identity "kenmyer@litwareinc.com" ``` @@ -61,85 +62,93 @@ In Example 2, the unified contact store status is verified for a single user: th ## PARAMETERS -### -Identity -SIP address of an individual user whose unified contact store status is being verified. -(You can specify only one user per command.) For example: +### -ContactDataExportFileName -`-Identity "kenmyer@litwareinc.com"` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -When specifying the SIP address, the sip: prefix is optional. -This syntax will also work: +File path for the XML file that will contain the contacts for the specified user when those contacts exported from the unified contact store. +For example: -`-Identity "sip:kenmyer@litwareinc.com"` +`-ContactDataExportFileName "C:\Exports\KenMyer.xml"` + +Note that you must include the Identity parameter and the SIP address for the user whose contacts you want to export. +If that user has not been enabled for the unified contact store, the command will terminate and no contacts will be exported. ```yaml -Type: UserIdParameter +Type: String Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -PoolFqdn -Fully qualified domain name of the Registrar pool whose unified contact store status is being verified. -All user accounts homed on the specified pool will be checked. -For example: +### -Force -`-PoolFqdn "atl-cs-001.litwareinc.com"` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any nonfatal error message that might occur when running the command. ```yaml -Type: Fqdn -Parameter Sets: PoolFqdn -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -ContactDataExportFileName -File path for the XML file that will contain the contacts for the specified user when those contacts exported from the unified contact store. -For example: +### -Identity -`-ContactDataExportFileName "C:\Exports\KenMyer.xml"` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Note that you must include the Identity parameter and the SIP address for the user whose contacts you want to export. -If that user has not been enabled for the unified contact store, the command will terminate and no contacts will be exported. +SIP address of an individual user whose unified contact store status is being verified. +(You can specify only one user per command.) For example: + +`-Identity "kenmyer@litwareinc.com"` + +When specifying the SIP address, the sip: prefix is optional. +This syntax will also work: + +`-Identity "sip:kenmyer@litwareinc.com"` ```yaml -Type: String +Type: UserIdParameter Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any nonfatal error message that might occur when running the command. +### -PoolFqdn + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the Registrar pool whose unified contact store status is being verified. +All user accounts homed on the specified pool will be checked. +For example: + +`-PoolFqdn "atl-cs-001.litwareinc.com"` ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: Fqdn +Parameter Sets: PoolFqdn +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` diff --git a/skype/skype-ps/skype/Disable-CsAdDomain.md b/skype/skype-ps/SkypeForBusiness/Disable-CsAdDomain.md similarity index 84% rename from skype/skype-ps/skype/Disable-CsAdDomain.md rename to skype/skype-ps/SkypeForBusiness/Disable-CsAdDomain.md index 38a11de6d4..ed7d781f8e 100644 --- a/skype/skype-ps/skype/Disable-CsAdDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Disable-CsAdDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/disable-csaddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Disable-CsAdDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/disable-csaddomain +schema: 2.0.0 +title: Disable-CsAdDomain --- # Disable-CsAdDomain @@ -37,7 +38,7 @@ Historical Note: The tasks carried out by Disable-CsAdDomain are similar to the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Disable-CsAdDomain ``` @@ -45,14 +46,14 @@ Disable-CsAdDomain The command shown in Example 1 rolls back the domain preparation process in the local domain. Because the Force parameter is not included, the command will fail if the Disable-CsAdDomain cmdlet determines that at least one Front End Server, A/V Conferencing Server, or Web Services server is still active in the domain. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Disable-CsAdDomain -Domain asia.litwareinc.com ``` Example 2 rolls back the domain preparation process for the domain asia.litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Disable-CsAdDomain -Force ``` @@ -64,14 +65,16 @@ This means that rollback will occur even if the Disable-CsAdDomain cmdlet determ ## PARAMETERS ### -Domain + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the domain where domain preparation should be rolled back (for example, -Domain asia.litwareinc.com). If this parameter is not included, rollback will take place on the local domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -81,14 +84,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to specify the FQDN of the domain controller to be used when running Disable-CsAdDomain. If not specified, the cmdlet will use the first available domain controller. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -97,15 +102,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalCatalog -FQDN of a global catalog server in your domain. -This parameter is not required if you are running the Disable-CsAdDomain cmdlet on a computer with an account in your domain. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If present rollback will occur even if the Disable-CsAdDomain cmdlet determines that at least one Front End, conferencing, or Web Services server is still active in the domain. +If not present then the command will fail if a Front End, Conferencing, or Web Services server is still active in the domain. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -114,16 +121,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalSettingsDomainController -FQDN of a domain controller where global settings are stored. -If global settings are stored in the System container in Active Directory Domain Services this parameter must point to the root domain controller. -If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. +### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of a global catalog server in your domain. +This parameter is not required if you are running the Disable-CsAdDomain cmdlet on a computer with an account in your domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,15 +140,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -If present rollback will occur even if the Disable-CsAdDomain cmdlet determines that at least one Front End, conferencing, or Web Services server is still active in the domain. -If not present then the command will fail if a Front End, Conferencing, or Web Services server is still active in the domain. +### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of a domain controller where global settings are stored. +If global settings are stored in the System container in Active Directory Domain Services this parameter must point to the root domain controller. +If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,16 +161,18 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +For example: `-Report "C:\Logs\DisableDomain.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -168,14 +181,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -184,14 +199,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Disable-CsAdForest.md b/skype/skype-ps/SkypeForBusiness/Disable-CsAdForest.md similarity index 84% rename from skype/skype-ps/skype/Disable-CsAdForest.md rename to skype/skype-ps/SkypeForBusiness/Disable-CsAdForest.md index c417b7c00c..32d51bdf41 100644 --- a/skype/skype-ps/skype/Disable-CsAdForest.md +++ b/skype/skype-ps/SkypeForBusiness/Disable-CsAdForest.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/disable-csadforest applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Disable-CsAdForest -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/disable-csadforest +schema: 2.0.0 +title: Disable-CsAdForest --- # Disable-CsAdForest @@ -40,7 +41,7 @@ Historical Note: The tasks carried out by Disable-CsAdForest are similar to the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Disable-CsAdForest ``` @@ -49,7 +50,7 @@ The command shown in Example 1 rolls back the forest preparation tasks carried o Because the Force parameter is not included, the command will fail if the Disable-CsAdForest cmdlet detects that at least one of the domains in the forest is still prepared for Skype for Business Server. In that case, you will need to rolls back the domain preparation by running the Disable-CsAdDomain cmdlet. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Disable-CsAdForest -Force ``` @@ -60,15 +61,17 @@ Rollback is forced by including the Force parameter. ## PARAMETERS -### -GroupDomain -Fully qualified domain name (FQDN) of the domain where the Skype for Business Server universal groups were created (for example, -GroupDomain asia.litwareinc.com). -If this parameter is not included, the Disable-CsAdForest cmdlet will look for the universal groups in the local domain. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If present, forces the rollback of the forest preparation steps even if the Disable-CsAdForest cmdlet detects that at least one of the domains in the forest is still prepared for Skype for Business Server. +If not present, the command will fail if the Disable-CsAdForest cmdlet detects that at least one of the domains in the forest is still prepared for. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -77,14 +80,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GroupDomainController -FQDN of a domain controller where universal group information is stored. +### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of a global catalog server in your domain. +This parameter is not required if you are running the Disable-CsComputer cmdlet on a computer with an account in your domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -93,15 +99,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalCatalog -FQDN of a global catalog server in your domain. -This parameter is not required if you are running the Disable-CsComputer cmdlet on a computer with an account in your domain. +### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of a domain controller where global settings are stored. +If global settings are stored in the System container in Active Directory Domain Services, then this parameter must point to the root domain controller. +If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -110,16 +119,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalSettingsDomainController -FQDN of a domain controller where global settings are stored. -If global settings are stored in the System container in Active Directory Domain Services, then this parameter must point to the root domain controller. -If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. +### -GroupDomain + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the domain where the Skype for Business Server universal groups were created (for example, -GroupDomain asia.litwareinc.com). +If this parameter is not included, the Disable-CsAdForest cmdlet will look for the universal groups in the local domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,14 +138,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RootDomainController -FQDN of the root domain controller, used to create trust paths for clients that need to access resources in domains other than their own. +### -GroupDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of a domain controller where universal group information is stored. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -145,16 +157,18 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +For example: `-Report "C:\Logs\DisableForest.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -163,15 +177,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -If present, forces the rollback of the forest preparation steps even if the Disable-CsAdForest cmdlet detects that at least one of the domains in the forest is still prepared for Skype for Business Server. -If not present, the command will fail if the Disable-CsAdForest cmdlet detects that at least one of the domains in the forest is still prepared for. +### -RootDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of the root domain controller, used to create trust paths for clients that need to access resources in domains other than their own. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -180,14 +195,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -196,14 +213,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Disable-CsComputer.md b/skype/skype-ps/SkypeForBusiness/Disable-CsComputer.md similarity index 83% rename from skype/skype-ps/skype/Disable-CsComputer.md rename to skype/skype-ps/SkypeForBusiness/Disable-CsComputer.md index d6b985bdfd..bdf93e9c97 100644 --- a/skype/skype-ps/skype/Disable-CsComputer.md +++ b/skype/skype-ps/SkypeForBusiness/Disable-CsComputer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/disable-cscomputer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Disable-CsComputer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/disable-cscomputer +schema: 2.0.0 +title: Disable-CsComputer --- # Disable-CsComputer @@ -36,14 +37,14 @@ You must be a local administrator and a member of the domain in order to run the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Disable-CsComputer ``` The command shown in Example 1 disables the local computer. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Disable-CsComputer -Report C:\Logs\Disable.html ``` @@ -55,14 +56,16 @@ This log file is generated by adding the Report parameter followed by the path t ## PARAMETERS -### -Scorch -Uninstalls all Skype for Business Server services and server roles for the local computer. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -72,14 +75,16 @@ Accept wildcard characters: False ``` ### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of a global catalog server in your domain. This parameter is not required if you are running the Disable-CsComputer cmdlet on a computer with an account in your domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -88,17 +93,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +### -GlobalSettingsDomainController -`-Report "C:\Logs\DisableComputer.html"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of a domain controller where global settings are stored. +If global settings are stored in the System container in Active Directory Domain Services, then this parameter must point to the root domain controller. +If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -107,14 +113,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: + +`-Report "C:\Logs\DisableComputer.html"` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -123,14 +134,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Scorch + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Uninstalls all Skype for Business Server services and server roles for the local computer. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -140,13 +153,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -155,16 +170,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalSettingsDomainController -FQDN of a domain controller where global settings are stored. -If global settings are stored in the System container in Active Directory Domain Services, then this parameter must point to the root domain controller. -If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Disable-CsHostingProvider.md b/skype/skype-ps/SkypeForBusiness/Disable-CsHostingProvider.md similarity index 91% rename from skype/skype-ps/skype/Disable-CsHostingProvider.md rename to skype/skype-ps/SkypeForBusiness/Disable-CsHostingProvider.md index ed00fbdde6..621e1d5b6e 100644 --- a/skype/skype-ps/skype/Disable-CsHostingProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Disable-CsHostingProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/disable-cshostingprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Disable-CsHostingProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/disable-cshostingprovider +schema: 2.0.0 +title: Disable-CsHostingProvider --- # Disable-CsHostingProvider @@ -62,7 +63,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Disable-CsHostingProvider -Identity "Fabrikam.com" ``` @@ -70,7 +71,7 @@ Disable-CsHostingProvider -Identity "Fabrikam.com" The command shown in Example 1 disables the hosting provider Fabrikam.com. Note that this command will return an error message if Fabrikam.com is already disabled. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsHostingProvider | Where-Object {$_.Enabled -eq $True} | Disable-CsHostingProvider ``` @@ -80,7 +81,7 @@ To do this, the command first calls the Get-CsHostingProvider cmdlet to return a That collection is then piped to the Where-Object cmdlet, which picks out only those providers where the Enabled property is equal to True. The filtered collection is then piped to the Disable-CsHostingProvider cmdlet, which disables each provider in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsHostingProvider | Where-Object {$_.VerificationLevel -ne "AlwaysVerifiable" -and $_.Enabled -eq $True} | Disable-CsHostingProvider ``` @@ -93,15 +94,35 @@ The filtered collection is then piped to the Disable-CsHostingProvider cmdlet, w ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the hosting provider to be disabled. The Identity might be the fully qualified domain (FQDN) name of the hosting provider (for example, fabrikam.com) or perhaps the name of the company providing the services (Fabrikam, Inc.). ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -111,13 +132,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -126,14 +149,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -143,29 +168,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Disable-CsMeetingRoom.md b/skype/skype-ps/SkypeForBusiness/Disable-CsMeetingRoom.md similarity index 89% rename from skype/skype-ps/skype/Disable-CsMeetingRoom.md rename to skype/skype-ps/SkypeForBusiness/Disable-CsMeetingRoom.md index 15cd889743..4dbc72c916 100644 --- a/skype/skype-ps/skype/Disable-CsMeetingRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Disable-CsMeetingRoom.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/disable-csmeetingroom applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Disable-CsMeetingRoom -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/disable-csmeetingroom +schema: 2.0.0 +title: Disable-CsMeetingRoom --- # Disable-CsMeetingRoom @@ -52,14 +54,14 @@ The functions carried out by the Disable-CsMeetingRoom cmdlet are not available ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Disable-CsMeetingRoom -Identity "sip:RedmondMeetingRoom@litwareinc.com" ``` The command shown in Example 1 disables the meeting room sip:RedmondMeetingRoom@litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMeetingRoom | Disable-CsMeetingRoom ``` @@ -71,7 +73,29 @@ That collection is then piped to the Disable-CsMeetingRoom cmdlet, which disable ## PARAMETERS +### -DomainController + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to connect to the specified domain controller in order to disable a meeting room. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account to be configured as a meeting room. Identities are typically specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). @@ -83,8 +107,7 @@ For example, the Identity "* Smith" returns all the user who have a display name ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -93,14 +116,17 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -PassThru + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to pass a meeting room object through the pipeline that represents the meeting room being disabled. +By default, the Disable-CsMeetingRoom cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -109,32 +135,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to connect to the specified domain controller in order to disable a meeting room. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -PassThru -Enables you to pass a meeting room object through the pipeline that represents the meeting room being disabled. -By default, the Disable-CsMeetingRoom cmdlet does not pass objects through the pipeline. +Prompts you for confirmation before running the cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -144,13 +154,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Disable-CsPublicProvider.md b/skype/skype-ps/SkypeForBusiness/Disable-CsPublicProvider.md similarity index 90% rename from skype/skype-ps/skype/Disable-CsPublicProvider.md rename to skype/skype-ps/SkypeForBusiness/Disable-CsPublicProvider.md index 7fe6d0507f..ede7b6dd53 100644 --- a/skype/skype-ps/skype/Disable-CsPublicProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Disable-CsPublicProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/disable-cspublicprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Disable-CsPublicProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/disable-cspublicprovider +schema: 2.0.0 +title: Disable-CsPublicProvider --- # Disable-CsPublicProvider @@ -55,7 +56,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Disable-CsPublicProvider -Identity "Skype" ``` @@ -63,7 +64,7 @@ Disable-CsPublicProvider -Identity "Skype" Example 1 disables the public provider with the Identity Skype. This command will return an error if Skype is already disabled. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPublicProvider | Where-Object {$_.Enabled -eq $True} | Disable-CsPublicProvider ``` @@ -73,7 +74,7 @@ To do this, the command first uses the Get-CsPublicProvider cmdlet to return a c This collection is piped to the Where-Object cmdlet, which picks out only those providers where the Enabled property is equal to True. In turn, this filtered collection is piped to the Disable-CsPublicProvider cmdlet, which disables each provider in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPublicProvider | Where-Object {$_.VerificationLevel -ne "AlwaysVerifiable" -and $_.Enabled -eq $True} | Disable-CsPublicProvider ``` @@ -86,15 +87,35 @@ This collection is then piped to the Where-Object cmdlet, which selects the prov ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the public provider to be disabled. The Identity is typically the name of the website providing the services. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -104,13 +125,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,14 +142,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -136,29 +161,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Disable-CsUser.md b/skype/skype-ps/SkypeForBusiness/Disable-CsUser.md similarity index 89% rename from skype/skype-ps/skype/Disable-CsUser.md rename to skype/skype-ps/SkypeForBusiness/Disable-CsUser.md index df9affeaa4..c850bfdebd 100644 --- a/skype/skype-ps/skype/Disable-CsUser.md +++ b/skype/skype-ps/SkypeForBusiness/Disable-CsUser.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/disable-csuser applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Disable-CsUser -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/disable-csuser +schema: 2.0.0 +title: Disable-CsUser --- # Disable-CsUser @@ -48,7 +49,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Disable-CsUser -Identity "Ken Myer" ``` @@ -56,7 +57,7 @@ Disable-CsUser -Identity "Ken Myer" Example 1 disables the Skype for Business Server account for the user Ken Myer. In this example, the user's display name is used to indicate his Identity. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUser -LdapFilter "Department=Finance" | Disable-CsUser ``` @@ -65,7 +66,7 @@ In Example 2, all the users in the Finance department have their Skype for Busin To carry out this task, the command first uses the Get-CsUser cmdlet and the LdapFilter parameter to return a collection of all the users who belong to the Finance department. That collection is then piped to the Disable-CsUser cmdlet, which disables each account in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsUser -UnassignedUser | Disable-CsUser ``` @@ -78,7 +79,29 @@ That collection is then piped to the Disable-CsUser cmdlet, which disables each ## PARAMETERS +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to connect to the specified domain controller in order to disable a user account. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-cs-001) or its fully qualified domain name (FQDN) (for example, atl-cs-001.litwareinc.com). + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account to be disabled. User Identities can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). You can also reference a user account by using the Active Directory distinguished name. @@ -89,8 +112,7 @@ For example, the Identity "* Smith" returns all the users who have a display nam ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -99,32 +121,17 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -DomainController -Enables you to connect to the specified domain controller in order to disable a user account. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-cs-001) or its fully qualified domain name (FQDN) (for example, atl-cs-001.litwareinc.com). - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PassThru -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PassThru Enables you to pass a user object through the pipeline that represents the user account being disabled. By default, the Disable-CsUser cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,13 +141,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -150,13 +159,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Enable-CsAdDomain.md b/skype/skype-ps/SkypeForBusiness/Enable-CsAdDomain.md similarity index 82% rename from skype/skype-ps/skype/Enable-CsAdDomain.md rename to skype/skype-ps/SkypeForBusiness/Enable-CsAdDomain.md index c23a8ddc5c..add3c8a6a8 100644 --- a/skype/skype-ps/skype/Enable-CsAdDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsAdDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/enable-csaddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Enable-CsAdDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/enable-csaddomain +schema: 2.0.0 +title: Enable-CsAdDomain --- # Enable-CsAdDomain @@ -42,14 +43,14 @@ Historical Note: This cmdlet carries out tasks similar to those carried out by t ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Enable-CsAdDomain ``` The command shown in Example 1 prepares the local domain for the installation of Skype for Business Server. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Enable-CsAdDomain -Domain asia.litwareinc.com ``` @@ -59,15 +60,17 @@ Example 2 prepares the domain asia.litwareinc.com for the installation of Skype ## PARAMETERS -### -Domain -Fully qualified domain name (FQDN) of the domain where domain preparation is to take place (for example, -Domain asia.litwareinc.com). -If this parameter is not included, domain preparation will take place on the local domain. +### -CrossForest + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If present, indicates that domain preparation is taking place in a domain in a different forest. +This parameter is not required if the domain being enabled is in the same forest as the computer where the command is being run. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -76,15 +79,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables administrators to specify the FQDN of the domain controller to be used when running the Enable-CsAdDomain cmdlet. -If not specified, the cmdlet will use the first available domain controller. +### -Domain + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the domain where domain preparation is to take place (for example, -Domain asia.litwareinc.com). +If this parameter is not included, domain preparation will take place on the local domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -93,14 +98,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipPrepareCheck -If set to True ($True), then the Enable-CsAdDomain cmdlet will skip its initial preparation check. +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to specify the FQDN of the domain controller to be used when running the Enable-CsAdDomain cmdlet. +If not specified, the cmdlet will use the first available domain controller. ```yaml -Type: Boolean +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -109,15 +117,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CrossForest -If present, indicates that domain preparation is taking place in a domain in a different forest. -This parameter is not required if the domain being enabled is in the same forest as the computer where the command is being run. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -127,14 +136,16 @@ Accept wildcard characters: False ``` ### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a global catalog server in your domain. This parameter is not required if you are running the Enable-CsAdDomain cmdlet on a computer with an account in your domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -144,6 +155,9 @@ Accept wildcard characters: False ``` ### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a domain controller where global settings are stored. If global settings are stored in the System container in Active Directory Domain Services, then this parameter must point to the root domain controller. If global settings are stored in the Configuration container then any domain controller can be used and this parameter can be omitted. @@ -151,8 +165,7 @@ If global settings are stored in the Configuration container then any domain con ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -161,14 +174,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: + +`-Report "C:\Logs\DomainPrep.html"` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -177,17 +195,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +### -SkipPrepareCheck -`-Report "C:\Logs\DomainPrep.html"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True ($True), then the Enable-CsAdDomain cmdlet will skip its initial preparation check. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -196,14 +213,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -212,14 +231,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Enable-CsAdForest.md b/skype/skype-ps/SkypeForBusiness/Enable-CsAdForest.md similarity index 82% rename from skype/skype-ps/skype/Enable-CsAdForest.md rename to skype/skype-ps/SkypeForBusiness/Enable-CsAdForest.md index 0ef2979fe9..a59f2490ee 100644 --- a/skype/skype-ps/skype/Enable-CsAdForest.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsAdForest.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/enable-csadforest applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Enable-CsAdForest -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/enable-csadforest +schema: 2.0.0 +title: Enable-CsAdForest --- # Enable-CsAdForest @@ -43,7 +44,7 @@ Historical Note: This cmdlet carries out tasks similar to those carried out by t ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Enable-CsAdForest ``` @@ -51,7 +52,7 @@ Enable-CsAdForest This command prepares the Active Directory forest for the installation of Skype for Business Server. Because the GroupDomain parameter is not used, the universal security groups generated when you run the Enable-CsAdForest cmdlet will be created in the local domain. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Enable-CsAdForest -GroupDomain northamerica.litwareinc.com ``` @@ -62,31 +63,16 @@ The GroupDomain parameter is used to ensure that the universal security groups c ## PARAMETERS -### -GroupDomain -Fully qualified domain name (FQDN) of the domain where the new universal security groups should be created. -If this parameter is not included, then the groups will be created in the local domain. +### -Force -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -GroupDomainController -FQDN of a domain controller where universal group information is stored. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,14 +82,16 @@ Accept wildcard characters: False ``` ### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a global catalog server in your domain. This parameter is not required if you are running the Enable-CsAdForest cmdlet on a computer with an account in your domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -113,6 +101,9 @@ Accept wildcard characters: False ``` ### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a domain controller where global settings are stored. If global settings are stored in the System container in Active Directory, then this parameter must point to the root domain controller. If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. @@ -120,8 +111,7 @@ If global settings are stored in the Configuration container, then any domain co ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -130,14 +120,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RootDomainController -FQDN of the root domain controller, used to create trust paths for clients that need to access resources in domains other than their own. +### -GroupDomain + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the domain where the new universal security groups should be created. +If this parameter is not included, then the groups will be created in the local domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -146,14 +139,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -GroupDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of a domain controller where universal group information is stored. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -163,16 +158,18 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +For example: `-Report "C:\Logs\ForestPrep.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -181,14 +178,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -RootDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of the root domain controller, used to create trust paths for clients that need to access resources in domains other than their own. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipPrepareCheck + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True), causes Enable-CsAdForest to run without first doing its initial preparation checks. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -198,13 +215,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -213,14 +232,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipPrepareCheck -When set to True ($True), causes Enable-CsAdForest to run without first doing its initial preparation checks. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Enable-CsComputer.md b/skype/skype-ps/SkypeForBusiness/Enable-CsComputer.md similarity index 83% rename from skype/skype-ps/skype/Enable-CsComputer.md rename to skype/skype-ps/SkypeForBusiness/Enable-CsComputer.md index 7d94d1d9aa..7357c234ad 100644 --- a/skype/skype-ps/skype/Enable-CsComputer.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsComputer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/enable-cscomputer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Enable-CsComputer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/enable-cscomputer +schema: 2.0.0 +title: Enable-CsComputer --- # Enable-CsComputer @@ -33,14 +34,14 @@ You must be a local administrator and a member of the domain in order to run the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Enable-CsComputer ``` The command shown in Example 1 activates any new Skype for Business Server services or server roles that have been installed on the local computer. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Enable-CsComputer -Verbose ``` @@ -51,15 +52,16 @@ In this case, however, the addition of the Verbose parameter ensures that a step ## PARAMETERS -### -GlobalCatalog -Fully qualified domain name (FQDN) of a global catalog server in your domain. -This parameter is not required if you are running the Enable-CsComputer cmdlet on a computer with an account in your domain. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -68,17 +70,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +### -GlobalCatalog -`-Report "C:\Logs\EnableComputer.html"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of a global catalog server in your domain. +This parameter is not required if you are running the Enable-CsComputer cmdlet on a computer with an account in your domain. ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -87,14 +89,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of a domain controller where global settings are stored. +If global settings are stored in the System container in Active Directory, then this parameter must point to the root domain controller. +If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -103,14 +109,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: + +`-Report "C:\Logs\EnableComputer.html"` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -120,13 +131,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -135,16 +148,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalSettingsDomainController -FQDN of a domain controller where global settings are stored. -If global settings are stored in the System container in Active Directory, then this parameter must point to the root domain controller. -If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Enable-CsHostingProvider.md b/skype/skype-ps/SkypeForBusiness/Enable-CsHostingProvider.md similarity index 90% rename from skype/skype-ps/skype/Enable-CsHostingProvider.md rename to skype/skype-ps/SkypeForBusiness/Enable-CsHostingProvider.md index 13691b8524..2559c78694 100644 --- a/skype/skype-ps/skype/Enable-CsHostingProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsHostingProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/enable-cshostingprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Enable-CsHostingProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/enable-cshostingprovider +schema: 2.0.0 +title: Enable-CsHostingProvider --- # Enable-CsHostingProvider @@ -60,7 +61,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Enable-CsHostingProvider -Identity Fabrikam.com ``` @@ -68,7 +69,7 @@ Enable-CsHostingProvider -Identity Fabrikam.com In Example 1, the hosting provider with the Identity Fabrikam.com is enabled for use. Note that this command will return an error if Fabrikam.com has already been enabled for use. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsHostingProvider | Where-Object {$_.Enabled -eq $False} | Enable-CsHostingProvider ``` @@ -78,7 +79,7 @@ To do this, the command first calls the Get-CsHostingProvider cmdlet without any This collection is then piped to the Where-Object cmdlet, which selects any provider where the Enabled property is equal to False; by definition, that is any provider that is currently disabled. This filtered collection is then piped to the Enable-CsHostingProvider cmdlet, which enables each of the providers in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsHostingProvider | Where-Object {$_.EnabledSharedAddressSpace -eq $True -and $_.Enabled -eq $False} | Enable-CsHostingProvider ``` @@ -91,15 +92,35 @@ After that, the filtered collection is piped to the Enable-CsHostingProvider cmd ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the hosting provider to be enabled. The Identity is might be the fully qualified domain name (FQDN) of the hosting provider (for example, fabrikam.com) or perhaps the name of the company providing the services (Fabrikam, Inc.). ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -109,13 +130,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -124,14 +147,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -141,29 +166,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Enable-CsMeetingRoom.md b/skype/skype-ps/SkypeForBusiness/Enable-CsMeetingRoom.md similarity index 87% rename from skype/skype-ps/skype/Enable-CsMeetingRoom.md rename to skype/skype-ps/SkypeForBusiness/Enable-CsMeetingRoom.md index c823fe60ad..782d086d89 100644 --- a/skype/skype-ps/skype/Enable-CsMeetingRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsMeetingRoom.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/enable-csmeetingroom applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Enable-CsMeetingRoom -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/enable-csmeetingroom +schema: 2.0.0 +title: Enable-CsMeetingRoom --- # Enable-CsMeetingRoom @@ -58,7 +60,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Enable-CsMeetingRoom -Identity "Redmond Meeting room" -RegistrarPool "atl-cs-001.litwareinc.com" -SipAddress "sip:RedmondMeetingRoom@litwareinc.com" ``` @@ -66,7 +68,7 @@ Enable-CsMeetingRoom -Identity "Redmond Meeting room" -RegistrarPool "atl-cs-001 The command shown in Example 1 enables the meeting room that has the Identity (in this case, the Active Directory display name) Redmond Meeting room. The new meeting room is homed on the Registrar pool arl-cs-001.litwareinc.com and given the SIP address sip:RedmondMeetingRoom@litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAdUser -OU "OU=MeetingRooms,dc=litwareinc,dc=com" | Enable-CsMeetingRoom -RegistrarPool "atl-cs-001.litwareinc.com" -SipAddressType "SamAccountName" -SipDomain "litwareinc.com" ``` @@ -79,36 +81,17 @@ Each new meeting rooms will be home on the Registrar pool atl-cs-001.litwareinc. ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be configured as a meeting room. -Identities are typically specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\room14); and, 4) the user's Active Directory display name (for example, Room 14). - -You can also reference a user account by using the user's Active Directory distinguished name. - -You can use the asterisk (*) wildcard character when using the Display Name as the user Identity. -For example, the Identity "Smith" returns all the user who have a display name that ends with the string value " Smith". - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +### -DomainController -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before running the cmdlet. +Enables you to connect to the specified domain controller in order to enable a meeting room. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -117,15 +100,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to connect to the specified domain controller in order to enable a meeting room. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). +### -HostingProviderProxyFqdn + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the hosting provider proxy server. +This parameter is used only with Skype for Business Online. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: HostingProvider Required: False Position: Named @@ -134,24 +119,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HostingProviderProxyFqdn -Fully qualified domain name of the hosting provider proxy server. -This parameter is used only with Skype for Business Online. +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the user account to be configured as a meeting room. +Identities are typically specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\room14); and, 4) the user's Active Directory display name (for example, Room 14). + +You can also reference a user account by using the user's Active Directory distinguished name. + +You can use the asterisk (*) wildcard character when using the Display Name as the user Identity. +For example, the Identity "Smith" returns all the user who have a display name that ends with the string value " Smith". ```yaml -Type: Fqdn +Type: UserIdParameter Parameter Sets: (All) -Aliases: HostingProvider -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -OriginatorSid + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Value of the msRTCSIP-OriginatorSID attribute. This Active Directory attribute is used to enable single sign-on. This parameter is used only with Skype for Business Online. @@ -159,8 +154,7 @@ This parameter is used only with Skype for Business Online. ```yaml Type: SecurityIdentifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -170,14 +164,16 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to pass a meeting room object through the pipeline that represents the meeting room being enabled for Skype for Business Server. By default, the Enable-CsMeetingRoom cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -187,14 +183,16 @@ Accept wildcard characters: False ``` ### -ProxyPool + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Proxy pool name. This parameter is used only with Skype for Business Online. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -204,13 +202,15 @@ Accept wildcard characters: False ``` ### -RegistrarPool + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Registrar pool where the meeting room's Skype for Business Server 2015 account will be homed. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -220,6 +220,9 @@ Accept wildcard characters: False ``` ### -SipAddress + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to assign the meeting room a specific SIP address. When specifying the SIP address, preface the address with "sip:". That means the value supplied to the SipAddress parameter should look something like this: @@ -234,8 +237,7 @@ Instead, you must auto-generate SIP address for those rooms by using the SipAddr ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -245,6 +247,9 @@ Accept wildcard characters: False ``` ### -SipAddressType + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Instructs Skype for Business Server to auto-generate a SIP address for the new meeting room. In order to have Skype for Business Server auto-generate the SIP address, you must include the SipAddressType parameter and use one of the following parameter values: @@ -252,7 +257,7 @@ In order to have Skype for Business Server auto-generate the SIP address, you mu For example, the user Room 14 would have a SIP address similar to this: Room.14@litwareinc.com. If you use this address type then you must also include the SipDomain parameter. -- EmailAddress: The user's email address (as defined in Active Directory) is used as the SIP address.UserPrincipalName. +- EmailAddress: The user's email address (as defined in Active Directory) is used as the SIP address.UserPrincipalName. The user's UPN is used as the SIP address. - SamAccountName: The SIP address is the user's SamAccountName (logon name) followed by the SIP domain. @@ -264,8 +269,7 @@ The SipAddressType parameter is not required if you use the SIPAddress parameter ```yaml Type: AddressType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -275,6 +279,9 @@ Accept wildcard characters: False ``` ### -SipDomain + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + The SIP domain for the meeting room being enabled. This parameter is required if you use the SIPAddressType parameter to have Skype for Business Server auto-generate a SIP address for the user and you based SIP addresses on the SamAccountName or the user's first name and last name. This parameter is not required if you base SIP addresses on the user's email address or UPN; that's because the domain name is already included in those attribute values. @@ -282,8 +289,25 @@ This parameter is not required if you base SIP addresses on the user's email add ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -293,13 +317,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Enable-CsPublicProvider.md b/skype/skype-ps/SkypeForBusiness/Enable-CsPublicProvider.md similarity index 89% rename from skype/skype-ps/skype/Enable-CsPublicProvider.md rename to skype/skype-ps/SkypeForBusiness/Enable-CsPublicProvider.md index e94296ea51..cf4594e191 100644 --- a/skype/skype-ps/skype/Enable-CsPublicProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsPublicProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/enable-cspublicprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Enable-CsPublicProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/enable-cspublicprovider +schema: 2.0.0 +title: Enable-CsPublicProvider --- # Enable-CsPublicProvider @@ -50,7 +51,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Enable-CsPublicProvider -Identity "Skype" ``` @@ -58,7 +59,7 @@ Enable-CsPublicProvider -Identity "Skype" The command shown in Example 1 enables the public provider with the Identity Skype. This command will return an error if Skype is already enabled. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPublicProvider | Where-Object {$_.Enabled -eq $False} | Enable-CsPublicProvider ``` @@ -68,7 +69,7 @@ In order to carry out this task, the command first uses the Get-CsPublicProvider That collection is piped to the Where-Object cmdlet, which selects only those providers where the Enabled property is equal to False. The filtered collection is then piped to the Enable-CsPublicProvider cmdlet, which enables each provider in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPublicProvider | Where-Object {$_.VerificationLevel -eq "AlwaysVerifiable" -and $_.Enabled -eq $False} | Enable-CsPublicProvider ``` @@ -81,15 +82,35 @@ This collection is piped to the Where-Object cmdlet, which picks out those provi ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the public provider to be enabled. The Identity is typically the name of the website providing the services (for example, Yahoo!; AOL; and MSN). ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -99,13 +120,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -114,14 +137,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -131,29 +156,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Enable-CsReplica.md b/skype/skype-ps/SkypeForBusiness/Enable-CsReplica.md similarity index 82% rename from skype/skype-ps/skype/Enable-CsReplica.md rename to skype/skype-ps/SkypeForBusiness/Enable-CsReplica.md index 9b9ffe4c9e..7f99fef26d 100644 --- a/skype/skype-ps/skype/Enable-CsReplica.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsReplica.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/enable-csreplica applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Enable-CsReplica -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/enable-csreplica +schema: 2.0.0 +title: Enable-CsReplica --- # Enable-CsReplica @@ -33,7 +34,7 @@ Instead, this will automatically take place when you install Skype for Business ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- (Skype for Business Server 2015) +### EXAMPLE 1 (Skype for Business Server 2015) ``` Enable-CsReplica ``` @@ -43,15 +44,16 @@ The command shown in Example 1 adds the local computer to the Skype for Business ## PARAMETERS -### -GlobalCatalog -Fully qualified domain name (FQDN) of a global catalog server in your domain. -This parameter is not required if you are running the Enable-CsReplica cmdlet on a computer with an account in your domain. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -60,17 +62,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +### -GlobalCatalog -`-Report "C:\Logs\EnableReplica.html"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of a global catalog server in your domain. +This parameter is not required if you are running the Enable-CsReplica cmdlet on a computer with an account in your domain. ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -79,14 +81,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of a domain controller where global settings are stored. +If global settings are stored in the System container in Active Directory Domain Services, then this parameter must point to the root domain controller. +If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -95,14 +101,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: + +`-Report "C:\Logs\EnableReplica.html"` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -112,13 +123,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -127,16 +140,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalSettingsDomainController -FQDN of a domain controller where global settings are stored. -If global settings are stored in the System container in Active Directory Domain Services, then this parameter must point to the root domain controller. -If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Enable-CsTopology.md b/skype/skype-ps/SkypeForBusiness/Enable-CsTopology.md similarity index 89% rename from skype/skype-ps/skype/Enable-CsTopology.md rename to skype/skype-ps/SkypeForBusiness/Enable-CsTopology.md index 6ea479e1df..5f683b1e9f 100644 --- a/skype/skype-ps/skype/Enable-CsTopology.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsTopology.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/enable-cstopology applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Enable-CsTopology -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/enable-cstopology +schema: 2.0.0 +title: Enable-CsTopology --- # Enable-CsTopology @@ -59,7 +60,7 @@ To verify that setup permissions have been delegated, run the Test-CsSetupPermis ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Enable-CsTopology ``` @@ -69,15 +70,16 @@ The command shown in Example 1 enables the most recently published topology. ## PARAMETERS -### -GlobalCatalog -Fully qualified domain name (FQDN) of a global catalog server in your domain. -This parameter is not required if you are running the Enable-CsTopology cmdlet on a computer with an account in your domain. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -86,16 +88,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalSettingsDomainController -FQDN of a domain controller where global settings are stored. -If global settings are stored in the System container in Active Directory Domain Services, then this parameter must point to the root domain controller. -If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. +### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of a global catalog server in your domain. +This parameter is not required if you are running the Enable-CsTopology cmdlet on a computer with an account in your domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -104,14 +107,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipPrepareCheck -If set to True ($True) the Enable-CsTopology cmdlet will skip its initial preparation check. +### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of a domain controller where global settings are stored. +If global settings are stored in the System container in Active Directory Domain Services, then this parameter must point to the root domain controller. +If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. ```yaml -Type: Boolean +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -121,16 +128,18 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +For example: `-Report "C:\Logs\Enable_Topology.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,14 +148,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -SkipPrepareCheck + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True ($True) the Enable-CsTopology cmdlet will skip its initial preparation check. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -155,14 +166,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -171,14 +184,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Enable-CsUser.md b/skype/skype-ps/SkypeForBusiness/Enable-CsUser.md similarity index 88% rename from skype/skype-ps/skype/Enable-CsUser.md rename to skype/skype-ps/SkypeForBusiness/Enable-CsUser.md index edbb4b7306..8014aa2f70 100644 --- a/skype/skype-ps/skype/Enable-CsUser.md +++ b/skype/skype-ps/SkypeForBusiness/Enable-CsUser.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/enable-csuser applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Enable-CsUser -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/enable-csuser +schema: 2.0.0 +title: Enable-CsUser --- # Enable-CsUser @@ -40,7 +41,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Enable-CsUser -Identity "Pilar Ackerman" -RegistrarPool "atl-cs-001.litwareinc.com" -SipAddressType SamAccountName -SipDomain litwareinc.com ``` @@ -48,7 +49,7 @@ Enable-CsUser -Identity "Pilar Ackerman" -RegistrarPool "atl-cs-001.litwareinc.c In Example 1, the Enable-CsUser cmdlet enables the user account with the display name Pilar Ackerman. In this example, the user is assigned to the Registrar pool atl-cs-001.litwareinc.com, and Skype for Business Server auto-generates the SIP address by using the user's SamAccountName (pilar) followed by the SIP domain litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Enable-CsUser -Identity "Pilar Ackerman" -RegistrarPool "atl-cs-001.litwareinc.com" -SipAddress "sip:pilar@litwareinc.com" ``` @@ -57,7 +58,7 @@ In Example 2, the Active Directory user account belonging to Pilar Ackerman is e In order to configure the account for Skype for Business Server the following parameters are used along with the Enable-CsUser cmdlet: Identity, which identifies the account to be enabled; RegistrarPool, which indicates the Standard Edition server or Enterprise Edition Front End pool on which the user is to be homed; and SipAddress, which specifies the SIP address for the new user. In this case, the SIP address is explicitly assigned instead of using Skype for Business Server to auto-generate the address. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAdUser -LdapFilter "department=Finance" | Enable-CsUser -RegistrarPool "atl-cs-001.litwareinc.com" -SipAddressType SamAccountName -SipDomain litwareinc.com ``` @@ -73,7 +74,7 @@ Instead, two parameters, SipAddressType and SipDomain, are added to the command. That means that a new SIP address consisting of the user's SamAccountName and the SIP domain name will automatically be generated for each account. For example, a user with the SamAccountName kenmyer will be given the SIP address sip:kenmyer@litwareinc.com. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsAdUser -Filter {Enabled -ne $True} | Enable-CsUser -RegistrarPool "atl-cs-001.litwareinc.com" -SipAddressType SamAccountName -SipDomain litwareinc.com ``` @@ -83,7 +84,7 @@ To do this, the Get-CsAdUser cmdlet is invoked, along with the Filter parameter. The filter {Enabled -ne $True} returns a collection of all the users who have not been enabled for Skype for Business Server. That collection is then piped to the Enable-CsUser cmdlet, which enables each account, assigning the user to the Registrar pool atl-cs-001.litwareinc.com and auto-generating a SIP address for each user. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Enable-CsUser -Identity user@litwareinc.com -HostingProvider sipfed.online.lync.com -SipAddressType UserPrincipalName ``` @@ -93,7 +94,48 @@ Example 5 populates an existing Active Directory user in on-premises Skype for B ## PARAMETERS +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to connect to the specified domain controller in order to enable a user account. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-cs-001) or its fully qualified domain name (FQDN) (for example, atl-cs-001.litwareinc.com). + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HostingProviderProxyFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is used only for Skype for Business Online. +It should not be used with an on-premises implementation of Skype for Business Server. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: HostingProvider + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account to be enabled for Skype for Business Server. User Identities can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). You can also reference a user account by using the user's Active Directory distinguished name. @@ -104,8 +146,7 @@ For example, the Identity "* Smith" returns all the user who have a display name ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -114,14 +155,17 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -RegistrarPool -Indicates the Registrar pool where the user's Skype for Business Server 2015 account will be homed. +### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to pass a user object through the pipeline that represents the user account being enabled for Skype for Business Server. +By default, the Enable-CsUser cmdlet does not pass objects through the pipeline. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -130,26 +174,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipAddressType -Instructs Skype for Business Server 2015 to auto-generate a SIP address for the new user. -In order to have Skype for Business Server 2015 auto-generate the SIP address, you must include the SipAddressType parameter and use one of the following parameter values: +### -ProxyPool -- FirstLastName: The SIP address is the user's first name and a period followed by the user's last name and the SIP domain. -For example, the user Ken Myer would have a SIP address similar to this: Ken.Myer@litwareinc.com. -If you use this address type then you must also include the SipDomain parameter. -- EmailAddress: The user's email address (as defined in Active Directory) is used as the SIP address. -- UserPrincipalName: The user's UPN is used as the SIP address. -- SamAccountName: The SIP address is the user's SamAccountName (logon name) followed by the SIP domain. -For example, the user with the SamAccountName kmyer will have a SIP address similar to this: kmyer@litwareinc.com. -If you use this address type then you must also include the SipDomain parameter. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The SipAddressType parameter is not required if you use the SipAddress parameter and explicitly assign the user a SIP address. +This parameter is used only for Skype for Business Online. +It should not be used with an on-premises implementation of Skype for Business Online. ```yaml -Type: AddressType +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,16 +193,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipDomain -The SIP domain for the user account being enabled. -This parameter is required if you use the SipAddressType parameter to have Skype for Business Server auto-generate a SIP address for the user and you based SIP addresses on the SamAccountName or the user's first name and last name. -This parameter is not required if you base SIP addresses on the user's email address or UPN; that's because the domain name is already included in those attribute values. +### -RegistrarPool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Registrar pool where the user's Skype for Business Server 2015 account will be homed. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -177,6 +212,9 @@ Accept wildcard characters: False ``` ### -SipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to assign the user a specific SIP address. When specifying the SIP address, preface the address with "sip:". That means the value supplied to the SipAddress parameter should look something like this: @@ -191,8 +229,7 @@ Instead, you must auto-generate SIP address for those users by using the SipAddr ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -201,32 +238,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HostingProviderProxyFqdn -This parameter is used only for Skype for Business Online. -It should not be used with an on-premises implementation of Skype for Business Server. +### -SipAddressType -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: HostingProvider -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Instructs Skype for Business Server 2015 to auto-generate a SIP address for the new user. +In order to have Skype for Business Server 2015 auto-generate the SIP address, you must include the SipAddressType parameter and use one of the following parameter values: -### -ProxyPool -This parameter is used only for Skype for Business Online. -It should not be used with an on-premises implementation of Skype for Business Online. +- FirstLastName: The SIP address is the user's first name and a period followed by the user's last name and the SIP domain. +For example, the user Ken Myer would have a SIP address similar to this: Ken.Myer@litwareinc.com. +If you use this address type then you must also include the SipDomain parameter. +- EmailAddress: The user's email address (as defined in Active Directory) is used as the SIP address. +- UserPrincipalName: The user's UPN is used as the SIP address. +- SamAccountName: The SIP address is the user's SamAccountName (logon name) followed by the SIP domain. +For example, the user with the SamAccountName kmyer will have a SIP address similar to this: kmyer@litwareinc.com. +If you use this address type then you must also include the SipDomain parameter. + +The SipAddressType parameter is not required if you use the SipAddress parameter and explicitly assign the user a SIP address. ```yaml -Type: Fqdn +Type: AddressType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -235,15 +268,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to connect to the specified domain controller in order to enable a user account. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-cs-001) or its fully qualified domain name (FQDN) (for example, atl-cs-001.litwareinc.com). +### -SipDomain + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The SIP domain for the user account being enabled. +This parameter is required if you use the SipAddressType parameter to have Skype for Business Server auto-generate a SIP address for the user and you based SIP addresses on the SamAccountName or the user's first name and last name. +This parameter is not required if you base SIP addresses on the user's email address or UPN; that's because the domain name is already included in those attribute values. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -252,15 +288,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the user account being enabled for Skype for Business Server. -By default, the Enable-CsUser cmdlet does not pass objects through the pipeline. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -270,29 +307,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Export-CsArchivingData.md b/skype/skype-ps/SkypeForBusiness/Export-CsArchivingData.md similarity index 86% rename from skype/skype-ps/skype/Export-CsArchivingData.md rename to skype/skype-ps/SkypeForBusiness/Export-CsArchivingData.md index cd7d61b79f..2f6392b199 100644 --- a/skype/skype-ps/skype/Export-CsArchivingData.md +++ b/skype/skype-ps/SkypeForBusiness/Export-CsArchivingData.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/export-csarchivingdata applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Export-CsArchivingData -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/export-csarchivingdata +schema: 2.0.0 +title: Export-CsArchivingData --- # Export-CsArchivingData @@ -66,7 +67,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Export-CsArchivingData -Identity "ArchivingDatabase:atl-sql-001.litwareinc.com" -StartDate 6/1/2018 -OutputFolder "C:\ArchivingExports" ``` @@ -74,7 +75,7 @@ Export-CsArchivingData -Identity "ArchivingDatabase:atl-sql-001.litwareinc.com" The command shown in Example 1 extracts records from the Archiving database located on the server atl-sql-001.litwareinc.com, and then saves the resulting EML file to the folder C:\ArchivingExports. The specified start date of June 1, 2018 (-StartDate 6/1/2018) ensures that only items recorded in the database after 5/31/2018 will be exported. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Export-CsArchivingData -Identity "ArchivingDatabase:atl-sql-001.litwareinc.com" -StartDate 6/1/2018 -OutputFolder "C:\ArchivingExports" -UserUri "kenmyer@litwareinc.com" ``` @@ -82,7 +83,7 @@ Export-CsArchivingData -Identity "ArchivingDatabase:atl-sql-001.litwareinc.com" Example 2 is a variation of the command shown in Example 1; in this case, however, only the records pertaining to the user Ken Myer are exported. To limit your export to records pertaining to a single user, include the UserUri parameter followed by appropriate SIP address. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Export-CsArchivingData -Identity "ArchivingDatabase:atl-sql-001.litwareinc.com" -StartDate 6/1/2018 -EndDate 6/30/2018 -OutputFolder "C:\ArchivingExports" ``` @@ -96,17 +97,19 @@ With a start date of June 1, 2018 and an end date of June 30, 2018, exporting is ## PARAMETERS ### -DBInstance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is intended for use only with Microsoft Lync Server 2010. If you are using the Export-CsArchivingData cmdlet on Skype for Business Server you should use the Identity parameter instead. Path to the SQL Server database instance where archiving data is recorded. -For example: +For example: `"atl-sql-001\Archinst"` ```yaml Type: String Parameter Sets: ExcludeWebConfArchiveSet, PurgeSet, ByDbInstance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -115,58 +118,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutputFolder -Full path to the folder where the exported data should be stored (for example, C:\ArchivingExports). -If this folder does not exist, then the Export-CsArchivingData cmdlet will create it. +### -EndDate + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the latest activity date for records to be exported. +For example, if you set the end date to 6/1/2018 (June 1, 2018, in U.S. +English) any items recorded in the database after that date (for example, items recorded on June 2, 2018) will be excluded from the export. +Although you will not receive an error message, your export will fail if the end date occurs before the start date (for example, an end date of 1/1/2018 and a start date of 6/1/2018). + +Use the date-time formats specified by your Regional and Language Options settings when assigning values to the StartDate and EndDate properties. + +If an end date is not specified then the current date will be used. ```yaml -Type: String +Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -StartDate -Indicates the earliest activity date for the records to be exported. -For example, if you set the start date to 6/1/2018 (June 1, 2018, in U.S. -English) any items recorded in the database prior to that date (for example, items recorded on May 31, 2018) will be excluded from the export. +### -ExcludeWebConfArchive -Use the date-time formats specified by your Regional and Language Options settings when assigning values to the StartDate and EndDate properties. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Instructs the Export-CsArchivingData cmdlet to only export instant messaging records. +By default, the cmdlet exports both IM and conferencing records. ```yaml -Type: DateTime +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EndDate -Indicates the latest activity date for records to be exported. -For example, if you set the end date to 6/1/2018 (June 1, 2018, in U.S. -English) any items recorded in the database after that date (for example, items recorded on June 2, 2018) will be excluded from the export. -Although you will not receive an error message, your export will fail if the end date occurs before the start date (for example, an end date of 1/1/2018 and a start date of 6/1/2018). +### -Force -Use the date-time formats specified by your Regional and Language Options settings when assigning values to the StartDate and EndDate properties. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -If an end date is not specified then the current date will be used. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: DateTime +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,32 +180,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserUri -Enables you to export archiving data for a single user; this is done by using the UserUri parameter and specifying the SIP address of the user. -The UserUri parameter will accept only one URI at a time. +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service identity of the archiving database to be exported. +For example: + +`-Identity "ArchivingDatabase:atl-sql-001.litwareinc.com"` + +You can also specify the database by using just the pool name: + +`-Identity "atl-sql-001.litwareinc.com"` + +You can retrieve the service identities for your archiving databases by using this command: + +`Get-CsService -ArchivingDatabase | Select-Object Identity` ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: ExcludeWebConfArchiveSet, PurgeSet, ByIdentity +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -ExcludeWebConfArchive -Instructs the Export-CsArchivingData cmdlet to only export instant messaging records. -By default, the cmdlet exports both IM and conferencing records. +### -IncludeTrustedApplication + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Include data logged by trusted applications (CAA/CAS) when exporting records. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -209,31 +227,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Purge -When included, the Purge parameter causes any record that has been successfully exported to be deleted from the Archiving database. -If you do not include this parameter, exported records will be retained in the database. +### -OutputFolder + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Full path to the folder where the exported data should be stored (for example, C:\ArchivingExports). +If this folder does not exist, then the Export-CsArchivingData cmdlet will create it. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Purge + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When included, the Purge parameter causes any record that has been successfully exported to be deleted from the Archiving database. +If you do not include this parameter, exported records will be retained in the database. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -242,30 +265,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -StartDate + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the earliest activity date for the records to be exported. +For example, if you set the start date to 6/1/2018 (June 1, 2018, in U.S. +English) any items recorded in the database prior to that date (for example, items recorded on May 31, 2018) will be excluded from the export. + +Use the date-time formats specified by your Regional and Language Options settings when assigning values to the StartDate and EndDate properties. ```yaml -Type: SwitchParameter +Type: DateTime Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IncludeTrustedApplication -Include data logged by trusted applications (CAA/CAS) when exporting records. +### -UserUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to export archiving data for a single user; this is done by using the UserUri parameter and specifying the SIP address of the user. +The UserUri parameter will accept only one URI at a time. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -274,41 +306,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Service identity of the archiving database to be exported. -For example: - -`-Identity "ArchivingDatabase:atl-sql-001.litwareinc.com"` - -You can also specify the database by using just the pool name: - -`-Identity "atl-sql-001.litwareinc.com"` +### -Confirm -You can retrieve the service identities for your archiving databases by using this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsService -ArchivingDatabase | Select-Object Identity` +Prompts you for confirmation before executing the command. ```yaml -Type: XdsIdentity -Parameter Sets: ExcludeWebConfArchiveSet, PurgeSet, ByIdentity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -324,16 +349,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### None - ## OUTPUTS -### +### None The Export-CsArchivingData cmdlet returns Archiving database records in EML format. - ## NOTES - ## RELATED LINKS [Get-CsArchivingConfiguration](Get-CsArchivingConfiguration.md) diff --git a/skype/skype-ps/skype/Export-CsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Export-CsConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Export-CsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Export-CsConfiguration.md index 07b09a1158..44c9c232e8 100644 --- a/skype/skype-ps/skype/Export-CsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Export-CsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/export-csconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Export-CsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/export-csconfiguration +schema: 2.0.0 +title: Export-CsConfiguration --- # Export-CsConfiguration @@ -51,7 +52,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Export-CsConfiguration -FileName "C:\Config.zip" ``` @@ -61,38 +62,42 @@ The command shown in Example 1 exports Skype for Business Server data from the C ## PARAMETERS -### -FileName -Path to the .ZIP file to be created when you run the Export-CsConfiguration cmdlet. -For example: +### -AsBytes -`-FileName "C:\Config.zip".` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that you must include either the FileName or the AsBytes parameters, but not both, when calling the Export-CsConfiguration cmdlet. +Returns topology information as a byte array; the returned data must then be stored in a variable in order to be used by the Import-CsConfiguration cmdlet. +You cannot use both AsBytes and FileName in the same command. ```yaml -Type: String -Parameter Sets: FileName -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: AsBytes +Aliases: -Required: True +Required: False Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AsBytes -Returns topology information as a byte array; the returned data must then be stored in a variable in order to be used by the Import-CsConfiguration cmdlet. -You cannot use both AsBytes and FileName in the same command. +### -FileName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Path to the .ZIP file to be created when you run the Export-CsConfiguration cmdlet. +For example: + +`-FileName "C:\Config.zip".` + +Note that you must include either the FileName or the AsBytes parameters, but not both, when calling the Export-CsConfiguration cmdlet. ```yaml -Type: SwitchParameter -Parameter Sets: AsBytes -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: FileName +Aliases: -Required: False +Required: True Position: 2 Default value: None Accept pipeline input: False @@ -100,6 +105,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. To set the Force parameter to True use this syntax: @@ -108,8 +116,7 @@ To set the Force parameter to True use this syntax: ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,13 +126,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the configuration data from the local computer rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,16 +150,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### None - ## OUTPUTS -### +### System.Byte[] If called along with the AsBytes parameter, the Export-CsConfiguration cmdlet returns configuration information in the form of a byte array. - ## NOTES - ## RELATED LINKS [Import-CsConfiguration](Import-CsConfiguration.md) diff --git a/skype/skype-ps/skype/Export-CsLisConfiguration.md b/skype/skype-ps/SkypeForBusiness/Export-CsLisConfiguration.md similarity index 92% rename from skype/skype-ps/skype/Export-CsLisConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Export-CsLisConfiguration.md index 86b50a823e..d481723ba9 100644 --- a/skype/skype-ps/skype/Export-CsLisConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Export-CsLisConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/export-cslisconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Export-CsLisConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/export-cslisconfiguration +schema: 2.0.0 +title: Export-CsLisConfiguration --- # Export-CsLisConfiguration @@ -45,21 +46,21 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Export-CsLisConfiguration -FileName C:\E911Config.bak ``` This example exports the entire E9-1-1 configuration from the Location Information Server (LIS) to the backup file named E911Config.bak. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $lisconfig = Export-CsLisConfiguration -AsBytes ``` In this example, the LIS configuration is stored as an array of bytes in a variable, $lisconfig. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $lisconfig = Export-CsLisConfiguration -AsBytes @@ -80,38 +81,42 @@ The contents of the file are then piped to the Import-CsLisConfiguration cmdlet, ## PARAMETERS -### -FileName -The path and file name of the file to which you want to save the configuration. -This cannot be the name of an existing file. +### -AsBytes -If you supply a value to the AsBytes parameter, you cannot supply a value to the FileName parameter. -If you're accessing this cmdlet remotely, you must use AsBytes rather than FileName. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns the configuration as a byte array. +The output of the command should be assigned to a variable for later import. +(If you don't assign the output to a variable, the byte array representing the configuration will scroll down your Lync Server Management Shell window.) You cannot specify both the AsBytes parameter and the FileName parameter; you can use only one or the other for each call to this cmdlet. ```yaml -Type: String -Parameter Sets: FileName -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: AsBytes +Aliases: -Required: True +Required: False Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AsBytes -Returns the configuration as a byte array. -The output of the command should be assigned to a variable for later import. -(If you don't assign the output to a variable, the byte array representing the configuration will scroll down your Lync Server Management Shell window.) You cannot specify both the AsBytes parameter and the FileName parameter; you can use only one or the other for each call to this cmdlet. +### -FileName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The path and file name of the file to which you want to save the configuration. +This cannot be the name of an existing file. + +If you supply a value to the AsBytes parameter, you cannot supply a value to the FileName parameter. +If you're accessing this cmdlet remotely, you must use AsBytes rather than FileName. ```yaml -Type: SwitchParameter -Parameter Sets: AsBytes -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: FileName +Aliases: -Required: False +Required: True Position: 2 Default value: None Accept pipeline input: False diff --git a/skype/skype-ps/skype/Export-CsPersistentChatData.md b/skype/skype-ps/SkypeForBusiness/Export-CsPersistentChatData.md similarity index 90% rename from skype/skype-ps/skype/Export-CsPersistentChatData.md rename to skype/skype-ps/SkypeForBusiness/Export-CsPersistentChatData.md index c748866515..6138af84ad 100644 --- a/skype/skype-ps/skype/Export-CsPersistentChatData.md +++ b/skype/skype-ps/SkypeForBusiness/Export-CsPersistentChatData.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/export-cspersistentchatdata applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Export-CsPersistentChatData -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/export-cspersistentchatdata +schema: 2.0.0 +title: Export-CsPersistentChatData --- # Export-CsPersistentChatData @@ -53,7 +54,7 @@ The functions carried out by the Export-CsPersistentChatData cmdlet are not avai ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Export-CsPersistentChatData -DBInstance "atl-sql-001.litwareinc.com\rtc" -FileName "C:\Logs\PersistentChatData.zip" ``` @@ -64,36 +65,40 @@ Because the Level parameter was not specified, the Export-CsPersistentChatData c ## PARAMETERS -### -DBInstance -Fully qualified domain name and name of the SQL Server instance where the Skype for Business Server 2015 Persistent Chat database is located. -For example, this syntax specifies the database found in the RTC database instance on the server atl-sql-001.litwareinc.com: +### -AsBytes -`-DBInstance "atl-sql-001.litwareinc.com\rtc"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Returns Persistent Chat information as a byte array; the returned data must then be stored in a variable in order to be used by the Import-CsPersistentChatData cmdlet. +You cannot use both AsBytes and FileName in the same command. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Type: SwitchParameter +Parameter Sets: AsBytes +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AsBytes -Returns Persistent Chat information as a byte array; the returned data must then be stored in a variable in order to be used by the Import-CsPersistentChatData cmdlet. -You cannot use both AsBytes and FileName in the same command. +### -DBInstance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Fully qualified domain name and name of the SQL Server instance where the Skype for Business Server 2015 Persistent Chat database is located. +For example, this syntax specifies the database found in the RTC database instance on the server atl-sql-001.litwareinc.com: + +`-DBInstance "atl-sql-001.litwareinc.com\rtc"` ```yaml -Type: SwitchParameter -Parameter Sets: AsBytes -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Type: String +Parameter Sets: (All) +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -101,13 +106,15 @@ Accept wildcard characters: False ``` ### -DBName + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + SQL instance name of the Persistent Chat database. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -117,13 +124,15 @@ Accept wildcard characters: False ``` ### -DisableExportedNodes + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When present, all exported categories and chat rooms will be disabled when the export is complete. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -133,6 +142,9 @@ Accept wildcard characters: False ``` ### -FileName + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Full path to the .ZIP file that the Export-CsPersistentChatData cmdlet will create; this file will contain the exported user data. For example: @@ -141,8 +153,7 @@ For example: ```yaml Type: String Parameter Sets: FileName -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -152,6 +163,9 @@ Accept wildcard characters: False ``` ### -Level + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to specify which Persistent Chat information will be exported. Allowed values are: @@ -166,8 +180,7 @@ The default value is All, which means that all the Persistent Chat information w ```yaml Type: ExportLevel Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -177,6 +190,9 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Full path for the log file created when the cmdlet runs. For example: @@ -185,8 +201,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -196,14 +211,16 @@ Accept wildcard characters: False ``` ### -Scope + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to export data for a specified set of categories (and their corresponding chat rooms). By default all Categories are exported. ```yaml Type: System.Collections.Generic.List`1[System.String] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -213,6 +230,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Beginning date for the time period for which Persistent Chat chat room content should be exported. For example: @@ -223,8 +243,7 @@ This parameter is valid only when they Level is set to RoomDirectory. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -240,14 +259,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### None - ## OUTPUTS -### +### None The Export-CsPersistentChatData cmdlet creates .ZIP files. - ## NOTES - ## RELATED LINKS diff --git a/skype/skype-ps/skype/Export-CsRgsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Export-CsRgsConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Export-CsRgsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Export-CsRgsConfiguration.md index eb820753a3..b0ece41a50 100644 --- a/skype/skype-ps/skype/Export-CsRgsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Export-CsRgsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/export-csrgsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Export-CsRgsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/export-csrgsconfiguration +schema: 2.0.0 +title: Export-CsRgsConfiguration --- # Export-CsRgsConfiguration @@ -42,7 +43,7 @@ The functions carried out by the Export-CsRgsConfiguration cmdlet are not availa ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Export-CsRgsConfiguration -Source "ApplicationServer:atl-rgs-001.litwareinc.com" -FileName "C:\Exports\Rgs.zip" ``` @@ -53,6 +54,9 @@ The command shown in Example 1 exports the Response Group configuration settings ## PARAMETERS ### -FileName + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Path to the .ZIP file to be created when you run the Export-CsRgsConfiguration cmdlet. For example: @@ -63,8 +67,7 @@ Note that your command will fail if this file already exists. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -73,33 +76,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Source -Identity of the Response Group instance whose configuration settings are being exported. -For example: - -`-Source "ApplicationServer:atl-rgs-001.litwareinc.com"` +### -Force -```yaml -Type: RgsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -109,6 +95,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If specified, configuration information for all the Response Group instances found on the designated pool will be exported. For example: @@ -117,8 +106,7 @@ For example: ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,13 +116,15 @@ Accept wildcard characters: False ``` ### -RemoveExportedConfiguration + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When specified, the Response Group instance will be deleted after the configuration information has been exported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -143,6 +133,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Source + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Identity of the Response Group instance whose configuration settings are being exported. +For example: + +`-Source "ApplicationServer:atl-rgs-001.litwareinc.com"` + +```yaml +Type: RgsIdentity +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 (https://go.microsoft.com/fwlink/?LinkID=113216). @@ -153,7 +164,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### +### None The Export-CsRgsConfiguration cmdlet creates compressed files with the .ZIP file extension. diff --git a/skype/skype-ps/skype/Export-CsUserData.md b/skype/skype-ps/SkypeForBusiness/Export-CsUserData.md similarity index 86% rename from skype/skype-ps/skype/Export-CsUserData.md rename to skype/skype-ps/SkypeForBusiness/Export-CsUserData.md index 0a7cb7f3d3..a4961125d3 100644 --- a/skype/skype-ps/skype/Export-CsUserData.md +++ b/skype/skype-ps/SkypeForBusiness/Export-CsUserData.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/export-csuserdata applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Export-CsUserData -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/export-csuserdata +schema: 2.0.0 +title: Export-CsUserData --- # Export-CsUserData @@ -54,7 +55,7 @@ NOTE: URNs that have the following characters back slash (\\) and forward slash ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Export-CsUserData -PoolFqdn "atl-cs-001.litwareinc.com" -FileName "C:\Logs\ExportedUserData.zip" ``` @@ -63,99 +64,99 @@ The command shown in Example 1 exports user data from the pool atl-cs-001.litwar ## PARAMETERS -### -FileName -Full path to the .ZIP file that the `Export-CsUserData` cmdlet will create; this file will contain the exported user data. -For example: +### -ConfDirectoryFilter --FileName "C:\Logs\ExportedData.zip" +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When specified, allows you to export conference directory information for the specified conference directory. +For example, to export data from the conference directory with the ID 13 use this syntax: + +-ConfDirectoryFilter 13 + +You can return conference directory IDs by using this command: + +`Get-CsConferenceDirectory` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Fully qualified domain name of the pool where the User database containing the user data to be exported is installed. -For example: - --Identity "atl-sql-001.litwareinc.com" +### -DbName -Note that you can retrieve fully qualified domain names for your User database pools by running this command: +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Get-CsService -UserDatabase +Name of the SQL Server database containing the user data to be exported. ```yaml Type: String -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: SqlInstance +Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -PoolFqdn -Fully qualified domain name of the Registrar pool containing the user data to be exported. -For example: +### -DomainController --PoolFqdn "atl-cs-001.litwareinc.com" +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to specify the FQDN of the domain controller to be used when running the `Export-CsUserData` cmdlet. +If not specified, the cmdlet will use the first available domain controller. ```yaml Type: Fqdn -Parameter Sets: PoolFqdn -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ConfDirectoryFilter -When specified, allows you to export conference directory information for the specified conference directory. -For example, to export data from the conference directory with the ID 13 use this syntax: +### -FileName --ConfDirectoryFilter 13 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You can return conference directory IDs by using this command: +Full path to the .ZIP file that the `Export-CsUserData` cmdlet will create; this file will contain the exported user data. +For example: -`Get-CsConferenceDirectory` +-FileName "C:\Logs\ExportedData.zip" ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables administrators to specify the FQDN of the domain controller to be used when running the `Export-CsUserData` cmdlet. -If not specified, the cmdlet will use the first available domain controller. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -164,30 +165,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool where the User database containing the user data to be exported is installed. +For example: + +-Identity "atl-sql-001.litwareinc.com" + +Note that you can retrieve fully qualified domain names for your User database pools by running this command: + +Get-CsService -UserDatabase ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Identity +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### -LegacyFormat + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When specified, data is saved in the format used by Microsoft Lync Server 2010. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -196,20 +208,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserFilter -Enables you to export data for a single user. -That user is in dictated by specifying his or her SIP address, minus the sip: prefix. +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the Registrar pool containing the user data to be exported. For example: --UserFilter "kenmyer@litwareinc.com" +-PoolFqdn "atl-cs-001.litwareinc.com" ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Fqdn +Parameter Sets: PoolFqdn +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -217,6 +230,9 @@ Accept wildcard characters: False ``` ### -SqlInstanceName + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Name of the SQL Server instance containing the user data to be exported. For example: @@ -225,8 +241,7 @@ For example: ```yaml Type: String Parameter Sets: SqlInstance -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -235,14 +250,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DbName -Name of the SQL Server database containing the user data to be exported. +### -UserFileFilter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Full path to a text file containing a list of user URIs for whom data should be exported. ```yaml Type: String -Parameter Sets: SqlInstance -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -251,14 +268,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserFileFilter -Full path to a text file containing a list of user URIs for whom data should be exported. +### -UserFilter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to export data for a single user. +That user is in dictated by specifying his or her SIP address, minus the sip: prefix. +For example: + +-UserFilter "kenmyer@litwareinc.com" ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -278,7 +301,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### +### None The `Export-CsUserData` cmdlet creates new .ZIP files. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsAVEdgeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsAVEdgeConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Get-CsAVEdgeConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAVEdgeConfiguration.md index 25ec18533d..ddd00426b5 100644 --- a/skype/skype-ps/skype/Get-CsAVEdgeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAVEdgeConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csavedgeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAVEdgeConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csavedgeconfiguration +schema: 2.0.0 +title: Get-CsAVEdgeConfiguration --- # Get-CsAVEdgeConfiguration @@ -41,7 +42,7 @@ The Get-CsAVEdgeConfiguration cmdlet provides a way for you to retrieve informat ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAVEdgeConfiguration ``` @@ -49,14 +50,14 @@ Get-CsAVEdgeConfiguration The command shown in Example 1 returns a collection of all the A/V Edge configuration settings configured for use in the organization. Calling the Get-CsAVEdgeConfiguration cmdlet without any additional parameters always returns a complete collection of A/V Edge configuration settings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAVEdgeConfiguration -Identity site:Redmond ``` In Example 2 a single collection of A/V Edge configuration settings is returned: the collection that has the Identity site:Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAVEdgeConfiguration -Filter "site:*" ``` @@ -65,7 +66,7 @@ Example 3 returns a collection of all the A/V Edge configuration settings that h To do this, the Get-CsAVEdgeConfiguration cmdlet is called along with the Filter parameter; the filter value "site:*" limits the returned data to settings that have an Identity that begins with the characters "site:". By definition, that limits the returned data to settings configured at the site scope. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsAVEdgeConfiguration | Where-Object {$_.MaxBandwidthPerUserKB -gt 10000} ``` @@ -74,14 +75,14 @@ In Example 4, the only A/V Edge configuration settings that are returned are tho To perform this task, the command first calls the Get-CsAVEdgeConfiguration cmdlet without any parameters; that returns a collection of all the A/V Edge configuration settings currently in use. That collection is then piped to the Where-Object cmdlet, which picks out only the settings where the MaxBandwidthPerUserKB is greater than 10000 kilobits per second. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsAVEdgeConfiguration | Where-Object {$_.MaxBandwidthPerUserKB -eq 10000} ``` Example 5 is similar to the command shown in Example 4; in Example 5, however, the only A/V Edge settings returned are those where the MaxBandwidthPerUserKB property is exactly equal to 10000 kilobits per second. -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsAVEdgeConfiguration | Where-Object {$_.MaxTokenLifetime -lt "08:00:00"} ``` @@ -93,11 +94,34 @@ This collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters when indicating the A/V Edge configuration settings to be returned. +For example, to return all the settings configured at the site scope, use this syntax: -Filter site:*. +To return a collection of all the settings configured at the service, use this syntax: -Filter "service:*". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of A/V Edge configuration settings to be retrieved. To retrieve the global collection, use the following syntax: -Identity global. To retrieve a site collection use syntax similar to this: -Identity site:Redmond. -Settings configured at the service scope should be referred to using syntax similar to this: +Settings configured at the service scope should be referred to using syntax similar to this: `-Identity service:EdgeServer:atl-cs-001.litwareinc.com` @@ -108,8 +132,7 @@ If this parameter is not included, the Get-CsAVEdgeConfiguration cmdlet returns ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -118,32 +141,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when indicating the A/V Edge configuration settings to be returned. -For example, to return all the settings configured at the site scope, use this syntax: -Filter site:*. -To return a collection of all the settings configured at the service, use this syntax: -Filter "service:*". - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the A/V Edge configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAccessEdgeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsAccessEdgeConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsAccessEdgeConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAccessEdgeConfiguration.md index 11284940f2..ed018d04a8 100644 --- a/skype/skype-ps/skype/Get-CsAccessEdgeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAccessEdgeConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csaccessedgeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAccessEdgeConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csaccessedgeconfiguration +schema: 2.0.0 +title: Get-CsAccessEdgeConfiguration --- # Get-CsAccessEdgeConfiguration @@ -48,7 +49,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAccessEdgeConfiguration ``` @@ -56,7 +57,7 @@ Get-CsAccessEdgeConfiguration Example 1 demonstrates the basic use of the Get-CsAccessEdgeConfiguration cmdlet: calling the cmdlet without any additional parameters returns all the property values for your Access Edge server implementation. Note that there is no need to include the Identity or Filter parameters; that's because there is only one set of Access Edge server configuration data. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAccessEdgeConfiguration | Select-Object Allow* ``` @@ -66,7 +67,7 @@ To do this, the command first uses the Get-CsAccessEdgeConfiguration cmdlet to r This information is then piped to the Select-Object cmdlet, which picks out only those properties that start with the string value "Allow". In turn, those are the only property values displayed on the screen. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` (Get-CsAccessEdgeConfiguration).EnablePartnerDiscovery ``` @@ -79,50 +80,56 @@ After all the property values have been returned, standard "dot notation" (the o ## PARAMETERS -### -Identity -Unique identifier of the Access Edge configuration settings to be returned. -Because you can only have a single, global instance of these settings, you do not have to include the Identity when calling the Get-CsAccessEdgeConfiguration cmdlet. -However, you can use the following syntax to retrieve the global settings: -Identity global. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards when specifying the Access Edge configuration settings to be returned. +Because you can only have a single, global instance of these settings there is little reason to use the Filter parameter. +However, if you prefer, you can use syntax similar to this to retrieve the global settings: -Identity "g*". ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the Access Edge configuration settings to be returned. -Because you can only have a single, global instance of these settings there is little reason to use the Filter parameter. -However, if you prefer, you can use syntax similar to this to retrieve the global settings: -Identity "g*". +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier of the Access Edge configuration settings to be returned. +Because you can only have a single, global instance of these settings, you do not have to include the Identity when calling the Get-CsAccessEdgeConfiguration cmdlet. +However, you can use the following syntax to retrieve the global settings: -Identity global. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the Access Edge configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAdContact.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdContact.md similarity index 88% rename from skype/skype-ps/skype/Get-CsAdContact.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAdContact.md index 34b07fefb1..ec7766caeb 100644 --- a/skype/skype-ps/skype/Get-CsAdContact.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdContact.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csadcontact applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAdContact -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csadcontact +schema: 2.0.0 +title: Get-CsAdContact --- # Get-CsAdContact @@ -41,7 +42,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAdContact ``` @@ -49,7 +50,7 @@ Get-CsAdContact The command shown in Example 1 returns a collection of all the multi-forest contacts found in Active Directory Domain Services. Calling the Get-CsAdContact cmdlet without any additional parameters returns all the property values for all the Active Directory contacts. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAdContact | Select-Object DisplayName, SipAddress ``` @@ -57,14 +58,14 @@ Get-CsAdContact | Select-Object DisplayName, SipAddress Example 2 also returns a collection of all the Active Directory contacts. In this case, however, that collection is piped to the Select-Object cmdlet, which specifies the only two attributes that will be displayed on the screen: DisplayName and SipAddress. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAdContact -Identity "Ken Myer" ``` Example 3 returns information for a single Active Directory contact: the contact with the Identity "Ken Myer". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsAdContact -LdapFilter "Organization=Fabrikam" ``` @@ -73,7 +74,7 @@ In Example 4, the command returns all the Active Directory contacts who work for To do this, the Get-CsAdContact cmdlet is called, along with the LdapFilter parameter. In this example, the limits the returned data to contacts that have their Organization attribute set to "Fabrikam". -### -------------------------- Example 5 -------------------------- +### Example 5 ``` $x = Get-Credential -Credential "litwareinc\administrator" @@ -91,27 +92,10 @@ The parameter value $x indicates that the Get-CsAdContact cmdlet should be run u ## PARAMETERS -### -Identity -Indicates the Identity of the contact to be returned. -Contact Identities can be specified by using one of three formats: 1) the contact's SIP address; 2) the contact's Active Directory distinguished name; and, 3) the contact's Active Directory display name (for example, Ken Myer). - -You can use the asterisk (*) wildcard character when using the Display Name as the contact Identity. -For example, the Identity "* Smith" returns all the contacts with a display name that ends in the string value "Smith". +### -Credential -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Credential Enables you to run the Get-CsAdContact cmdlet under alternate credentials; this might be required if the account you used to log on to Windows does not have the necessary privileges required to work with contact objects. To use the Credential parameter you must first create a PSCredential object using the Get-Credential cmdlet. @@ -120,8 +104,7 @@ For details, see the Help topic for Get-Credential. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,14 +114,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to retrieve contact information. To connect to a particular domain controller, include the DomainController parameter followed by the fully qualified domain name (for example, atl-cs-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -148,6 +133,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on attributes specific to Skype for Business Server. The Filter parameter uses the same Windows PowerShell filtering syntax used by the Where-Object cmdlet. @@ -156,8 +144,51 @@ For example, a filter that returns only contacts who have a SIP address that end ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the contact to be returned. +Contact Identities can be specified by using one of three formats: 1) the contact's SIP address; 2) the contact's Active Directory distinguished name; and, 3) the contact's Active Directory display name (for example, Ken Myer). + +You can use the asterisk (*) wildcard character when using the Display Name as the contact Identity. +For example, the Identity "* Smith" returns all the contacts with a display name that ends in the string value "Smith". + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -LDAPFilter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to limit the returned data by filtering on generic Active Directory attributes. +For example, you can limit returned data to contacts who work in a specific department, or contacts that have a specified manager or job title. + +The LdapFilter parameter uses the LDAP query language when creating filters. +For example, a filter that returns the contact that has the telephone number 1-425-555-1298 would look like this: "telephoneNumber=1-425-555-1298", with "telephoneNumber" representing the Active Directory attribute; "=" representing the comparison operator (equal to); and "1-425-555-1298" representing the filter value. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -167,6 +198,9 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the retrieved information from a specific Active Directory organizational unit (OU) or container. This parameter returns data from both the specified OU and any of its child OUs. For example, if the Finance OU has two child OUs: AccountsPayable and AccountsReceivable. @@ -177,8 +211,7 @@ When specifying an OU, use the distinguished name of that container; for example ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -188,6 +221,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the number of records returned by the cmdlet. For example, to return seven contacts (regardless of the number of contacts that are in your forest) include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which 7 users will be returned. @@ -199,28 +235,7 @@ If you set the ResultSize to 7 but you have only three contacts in your forest, ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LDAPFilter -Enables you to limit the returned data by filtering on generic Active Directory attributes. -For example, you can limit returned data to contacts who work in a specific department, or contacts that have a specified manager or job title. - -The LdapFilter parameter uses the LDAP query language when creating filters. -For example, a filter that returns the contact that has the telephone number 1-425-555-1298 would look like this: "telephoneNumber=1-425-555-1298", with "telephoneNumber" representing the Active Directory attribute; "=" representing the comparison operator (equal to); and "1-425-555-1298" representing the filter value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAdDomain.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdDomain.md similarity index 87% rename from skype/skype-ps/skype/Get-CsAdDomain.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAdDomain.md index 5bccf6a4ec..4ab1141e44 100644 --- a/skype/skype-ps/skype/Get-CsAdDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csaddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAdDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csaddomain +schema: 2.0.0 +title: Get-CsAdDomain --- # Get-CsAdDomain @@ -46,7 +47,7 @@ Historical Note: Get-CsAdDomain performs the same function as the following Micr ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAdDomain ``` @@ -54,7 +55,7 @@ Get-CsAdDomain Example 1 returns information regarding the current status of your local Active Directory domain. If your domain settings are up-to-date, and the domain is ready to host Skype for Business Server, the value LC_DOMAIN_SETTINGS_STATE_READY will be returned. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAdDomain -Domain "fabrikam.com" ``` @@ -62,7 +63,7 @@ Get-CsAdDomain -Domain "fabrikam.com" The command shown in Example 2 returns the current status of a specific domain: fabrikam.com. In a multi-domain environment, you can return information for a given domain by including the Domain parameter. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAdDomain -Report "C:\Logs\DomainReport.html" ``` @@ -75,14 +76,16 @@ Those steps include tasks such as verifying the existence of Active Directory gr ## PARAMETERS ### -Domain + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the domain to be checked; for example: -Domain "litwareinc.com". If this parameter is not specified, then the local domain will be checked. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -92,14 +95,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to specify the FQDN of the domain controller to be used when running the Get-CsAdDomain cmdlet. If not specified, the cmdlet will use the first available domain controller. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -109,14 +114,16 @@ Accept wildcard characters: False ``` ### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a global catalog server in your domain. This parameter is not required if you are running the Get-CsAdDomain cmdlet on a computer with an account in your domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -126,6 +133,9 @@ Accept wildcard characters: False ``` ### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a domain controller where global settings are stored. If global settings are stored in the System container in Active Directory, then this parameter must point to the root domain controller. If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. @@ -133,8 +143,7 @@ If global settings are stored in the Configuration container, then any domain co ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -144,16 +153,18 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +For example: `-Report "C:\Logs\DomainPrep.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAdForest.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdForest.md similarity index 87% rename from skype/skype-ps/skype/Get-CsAdForest.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAdForest.md index 7c4a94daab..1d7038bb66 100644 --- a/skype/skype-ps/skype/Get-CsAdForest.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdForest.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csadforest applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAdForest -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csadforest +schema: 2.0.0 +title: Get-CsAdForest --- # Get-CsAdForest @@ -46,14 +47,14 @@ Typically all domain members have this permission. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Get-CsAdForest ``` Example 1 returns information indicating whether your Active Directory forest has been correctly configured to allow for the installation of Skype for Business Server. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell Get-CsAdForest -Report C:\Logs\ForestState.html ``` @@ -66,14 +67,16 @@ This file includes a detailed list of all the Active Directory groups and Active ## PARAMETERS ### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of a global catalog server in your domain. This parameter is not required if you are running the Get-CsAdForest cmdlet on a computer with an account in your domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a domain controller where global settings are stored. If global settings are stored in the System container in AD DS, then this parameter must point to the root domain controller. If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. @@ -90,8 +96,7 @@ If global settings are stored in the Configuration container, then any domain co ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -100,14 +105,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RootDomainController -FQDN of the root domain controller, used to create trust paths for clients that need to access resources in domains other than their own. +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: + +`-Report "C:\Logs\ForestPrep.html"` ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,17 +126,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +### -RootDomainController -`-Report "C:\Logs\ForestPrep.html"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of the root domain controller, used to create trust paths for clients that need to access resources in domains other than their own. ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -136,13 +145,15 @@ Accept wildcard characters: False ``` ### -SkipPrepareCheck + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True ($True), causes Get-CsAdForest to run without first doing its initial preparation checks. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAdPrincipal.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdPrincipal.md similarity index 90% rename from skype/skype-ps/skype/Get-CsAdPrincipal.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAdPrincipal.md index 408fcea9c1..f172ce5769 100644 --- a/skype/skype-ps/skype/Get-CsAdPrincipal.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdPrincipal.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csadprincipal applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAdPrincipal -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csadprincipal +schema: 2.0.0 +title: Get-CsAdPrincipal --- # Get-CsAdPrincipal @@ -52,14 +53,14 @@ The functions carried out by the Get-CsAdPrincipal cmdlet are not available in t ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAdPrincipal ``` The command shown in Example 1 returns all the Active Directory principals in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAdPrincipal -Filter {SipAddress -eq "sip:RedmondMeetingRoom@litwareinc.com"} ``` @@ -67,7 +68,7 @@ Get-CsAdPrincipal -Filter {SipAddress -eq "sip:RedmondMeetingRoom@litwareinc.com In Example 2, information is returned for a single Active Directory principal: the principal with the SIP address "sip:RedmondMeetingRoom@litwareinc.com". This is done by including the Filter parameter and a filter value that looks for principals where the SipAddress property is equal to (-eq) "sip:RedmondMeetingRoom@litwareinc.com". -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAdPrincipal | Where-Object {$_.ObjectClass -contains "contact"} ``` @@ -80,6 +81,9 @@ That collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS ### -Credential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to run the Get-CsAdPrincipal cmdlet under alternate credentials. This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with user objects. @@ -89,8 +93,7 @@ For details, see the Get-Credential cmdlet help topic. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -100,14 +103,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to retrieve Active Directory principal information. To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -117,6 +122,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on attributes specific to Skype for Business Server. The Filter parameter uses much of the same Windows PowerShell filtering syntax used by the Where-Object cmdlet. @@ -124,13 +132,12 @@ For example, a filter that returns only principals whose sip address equals "Red `-Filter {SipAddress -eq "sip:RedmondMeetingRoom@litwareinc.com"}` -In that example, SipAddress represents the Skype for Business attribute, -eq represents the comparison operator (equal to "sip:RedmondMeetingRoom@litwareinc.com") +In that example, SipAddress represents the Skype for Business attribute, -eq represents the comparison operator (equal to "sip:RedmondMeetingRoom@litwareinc.com") ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -140,6 +147,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the principal account to be retrieved. Identities are typically specified by using one of four formats: 1) the account SIP address; 2) the user's user principal name (UPN); 3) the account domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the account Active Directory display name (for example, Ken Myer). @@ -151,8 +161,7 @@ For example, the Identity "* Smith" returns all the users who have a display nam ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -162,6 +171,9 @@ Accept wildcard characters: False ``` ### -LDAPFilter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business Server). For example, you can limit returned data to principals who belong to a specific department or who have a specific manager or job title. @@ -175,8 +187,7 @@ In that example, the "l" (a lowercase L) represents the Active Directory attribu ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -186,6 +197,9 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to return information about principals in a specific organizational unit (OU) or container. The OU parameter returns data from both the specified OU and any of its child OUs. For example, if the Finance OU has two child OUs -- AccountsPayable and AccountsReceivable - principals will be returned from each of these three OUs. @@ -201,8 +215,7 @@ To return principals from the Users container, use this syntax: ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -212,6 +225,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the number of records returned by the cmdlet. For example, to return seven principals (regardless of the number of principals that are in your forest) include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which seven principals will be returned. @@ -223,8 +239,7 @@ If you set the ResultSize to 7 but you have only three principals in your forest ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAdServerSchema.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdServerSchema.md similarity index 92% rename from skype/skype-ps/skype/Get-CsAdServerSchema.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAdServerSchema.md index 68b5c4a03e..ed0dbdc5be 100644 --- a/skype/skype-ps/skype/Get-CsAdServerSchema.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdServerSchema.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csadserverschema applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAdServerSchema -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csadserverschema +schema: 2.0.0 +title: Get-CsAdServerSchema --- # Get-CsAdServerSchema @@ -36,7 +37,7 @@ However, you can also run the Get-CsAdServerSchema cmdlet independently of the S ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAdServerSchema ``` @@ -44,7 +45,7 @@ Get-CsAdServerSchema The command shown in Example 1 returns the current state of the Active Directory server schema. If the schema is up to date, the command returns the following value: SCHEMA_VERSION_STATE_CURRENT. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAdServerSchema -Report C:\Logs\Server_Schema.html ``` @@ -57,15 +58,17 @@ This information includes details such as the schema major version and minor ver ## PARAMETERS ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +For example: `-Report "C:\Logs\SchemaPrep.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAdUser.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdUser.md similarity index 90% rename from skype/skype-ps/skype/Get-CsAdUser.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAdUser.md index 64a6b36104..6c342dad43 100644 --- a/skype/skype-ps/skype/Get-CsAdUser.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdUser.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csaduser applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAdUser -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csaduser +schema: 2.0.0 +title: Get-CsAdUser --- # Get-CsAdUser @@ -51,14 +52,14 @@ The LdapFilter parameter enables you to limit the returned data for users who fi One important thing to note about the Get-CsAdUser cmdlet is this: although the Enabled attribute, which determines whether or not a user has been enabled for Skype for Business Server, is a Boolean value, this property actually has three valid values: -True: +True: The user has been enabled for Skype for Business Server. -False: +False: The user has temporarily had their Skype for Business Server account disabled. This is typically carried out by using the Set-CsUser cmdlet and setting the Enabled parameter to $False. -Null: +Null: The user has not been enabled for Skype for Business Server. What that means is that, if you want to return a list of users who are not enabled for Skype for Business Server then you must use a command that returns all the users where the Enabled attribute is null: @@ -74,14 +75,14 @@ Users who have not been enabled for Skype for Business Server will not be return ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAdUser ``` The command shown in Example 1 returns a collection of all the user accounts in your Active Directory domain. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAdUser -Identity "Pilar Ackerman" ``` @@ -89,7 +90,7 @@ Get-CsAdUser -Identity "Pilar Ackerman" In Example 2, the Get-CsAdUser cmdlet returns user account information for Pilar Ackerman. In this example, the user's display name is used to specify her Identity. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAdUser -OU "ou=Finance,dc=litwareinc,dc=com" ``` @@ -97,7 +98,7 @@ Get-CsAdUser -OU "ou=Finance,dc=litwareinc,dc=com" Example 3 returns user account information for all the users in the Finance organizational unit. To do this, the DN of the OU must be passed to the OU parameter. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsAdUser -Filter {Enabled -ne $True} | Select-Object DisplayName ``` @@ -107,7 +108,7 @@ To do this, the Filter parameter is used with the Get-CsAdUser cmdlet to restric This filter tells the Get-CsAdUser cmdlet to return only those user accounts that have not been enabled for use with Skype for Business Server. After the data has been retrieved, the information is piped to the Select-Object cmdlet, which then identifies the only property (in this case, DisplayName) that will actually be displayed on the screen. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsAdUser -LdapFilter "Department=Finance" ``` @@ -118,28 +119,10 @@ This is done by using the LDAP filter value "Department=Finance". ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be retrieved. -User Identities can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). -You can also reference a user account by using the user's Active Directory distinguished name. - -You can use the asterisk (*) wildcard character when using the Display Name as the user Identity. -For example, the Identity "* Smith" returns all the users who have a display name that ends with the string value " Smith". - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Credential -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Credential Enables you to run the Get-CsAdUser cmdlet under alternate credentials. This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with user objects. @@ -149,8 +132,7 @@ For details, see the Get-Credential cmdlet help topic. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -160,14 +142,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to retrieve user information. To connect to a particular domain controller, include the DomainController parameter followed by fully qualified domain name (FQDN) (for example, atl-cs-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -177,6 +161,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on attributes specific to Skype for Business Server. The Filter parameter uses the same Windows PowerShell filtering syntax used by the Where-Object cmdlet. @@ -185,8 +172,52 @@ For example, a filter that returns only users who are not enabled for Skype for ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the user account to be retrieved. +User Identities can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). +You can also reference a user account by using the user's Active Directory distinguished name. + +You can use the asterisk (*) wildcard character when using the Display Name as the user Identity. +For example, the Identity "* Smith" returns all the users who have a display name that ends with the string value " Smith". + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -LDAPFilter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business Server). +For example, you can limit returned data to users who work in a specific department or users who have a specific manager or job title. + +The LdapFilter parameter uses the LDAP query language when creating filters. +For example, a filter that returns only users who work in the city of Redmond would look like this: "l=Redmond", with "l" (a lowercase L) representing the Active Directory attribute (locality); "=" representing the comparison operator (equal to); and "Redmond" representing the filter value. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -196,6 +227,9 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to return users from a specific Active Directory organizational unit (OU) or container. This parameter returns data from both the specified OU and any of its child OUs. For example, if the Finance OU has two child OUs -- AccountsPayable and AccountsReceivable -- users will be returned from each of these three OUs. @@ -206,8 +240,7 @@ To return users from the Users container, use this syntax: cn=Users,dc=litwarein ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -217,6 +250,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the number of records returned by the cmdlet. For example, to return seven users (regardless of the number of users in your forest) include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which seven users will be returned. @@ -228,28 +264,7 @@ If you set the ResultSize to 7 but you have only three users in your forest, the ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LDAPFilter -Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business Server). -For example, you can limit returned data to users who work in a specific department or users who have a specific manager or job title. - -The LdapFilter parameter uses the LDAP query language when creating filters. -For example, a filter that returns only users who work in the city of Redmond would look like this: "l=Redmond", with "l" (a lowercase L) representing the Active Directory attribute (locality); "=" representing the comparison operator (equal to); and "Redmond" representing the filter value. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAdditionalInternalDomain.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdditionalInternalDomain.md similarity index 88% rename from skype/skype-ps/skype/Get-CsAdditionalInternalDomain.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAdditionalInternalDomain.md index 0e359015b0..9538208c0a 100644 --- a/skype/skype-ps/skype/Get-CsAdditionalInternalDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdditionalInternalDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csadditionalinternaldomain applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAdditionalInternalDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csadditionalinternaldomain +schema: 2.0.0 +title: Get-CsAdditionalInternalDomain --- # Get-CsAdditionalInternalDomain @@ -42,13 +43,15 @@ Gets additional SIP domain names from LocalStore ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data. ```yaml Type: String Parameter Sets: Filter Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -58,13 +61,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the additional SIP domain to be returned. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: 1 @@ -74,13 +79,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAddressBookConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsAddressBookConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Get-CsAddressBookConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAddressBookConfiguration.md index 7515253dc6..0210f37d72 100644 --- a/skype/skype-ps/skype/Get-CsAddressBookConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAddressBookConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csaddressbookconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAddressBookConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csaddressbookconfiguration +schema: 2.0.0 +title: Get-CsAddressBookConfiguration --- # Get-CsAddressBookConfiguration @@ -52,7 +53,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAddressBookConfiguration ``` @@ -60,14 +61,14 @@ Get-CsAddressBookConfiguration Example 1 returns information about all the Address Book configuration settings in use in your organization. This is the default behavior if you call the Get-CsAddressBookConfiguration cmdlet without any additional parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAddressBookConfiguration -Identity site:Redmond ``` Example 2 returns information for the Address Book configuration settings with the Identity site:Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAddressBookConfiguration -Filter site:* ``` @@ -75,7 +76,7 @@ Get-CsAddressBookConfiguration -Filter site:* In this example, the Filter parameter and the filter value "site:*" are used to return information about all the Address Book configuration settings that have been applied at the site scope. The supplied filter value returns information for all the Address Book settings that have an Identity that begins with the string value "site:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsAddressBookConfiguration | Where-Object {$_.UseNormalizationRules -eq $True} ``` @@ -87,7 +88,30 @@ That collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters in order to return a collection (or multiple collections) of Address Book settings. +For example, to return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. +To return a collection of all the settings that have the string value "EMEA" somewhere in their Identity, use this syntax: -Filter *EMEA*. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of Address Book settings to be returned. To refer to the global settings, use this syntax: -Identity global. To refer to a collection configured at the site scope, use syntax similar to this: -Identity site:Redmond. @@ -100,8 +124,7 @@ If this parameter is not specified, then the Get-CsAddressBookConfiguration cmdl ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -110,32 +133,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters in order to return a collection (or multiple collections) of Address Book settings. -For example, to return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. -To return a collection of all the settings that have the string value "EMEA" somewhere in their Identity, use this syntax: -Filter *EMEA*. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the Address Book configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAddressBookNormalizationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsAddressBookNormalizationConfiguration.md similarity index 92% rename from skype/skype-ps/skype/Get-CsAddressBookNormalizationConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAddressBookNormalizationConfiguration.md index 17e9105af0..ac202d9c5a 100644 --- a/skype/skype-ps/skype/Get-CsAddressBookNormalizationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAddressBookNormalizationConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csaddressbooknormalizationconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAddressBookNormalizationConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csaddressbooknormalizationconfiguration +schema: 2.0.0 +title: Get-CsAddressBookNormalizationConfiguration --- # Get-CsAddressBookNormalizationConfiguration @@ -39,7 +40,7 @@ That means that, in some cases, you might need to create identical rules: one fo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAddressBookNormalizationConfiguration ``` @@ -47,7 +48,7 @@ Get-CsAddressBookNormalizationConfiguration The command shown in Example 1 returns a collection of all the Address Book normalization configuration settings currently in use in the organization. This is done by calling the Get-CsAddressBookNormalizationConfiguration cmdlet without any additional parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAddressBookNormalizationConfiguration -Identity "site:Redmond" ``` @@ -56,7 +57,7 @@ In Example 2, information is returned for a single collection of normalization r -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAddressBookNormalizationConfiguration -Filter "site:*" ``` @@ -69,14 +70,16 @@ That syntax limits the returned data to all the collections that have an Identit ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return a collection (or multiple collections) of Address Book normalization configuration settings. For example, to return a collection of all the settings configured at the site scope, use this syntax: -Filter "site:*" ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of Address Book normalization configuration settings to be returned. To refer to the global settings, use this syntax: -Identity global @@ -99,8 +105,7 @@ If this parameter is not specified, then the Get-CsAddressBookNormalizationConfi ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -110,13 +115,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the Address Book normalization configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAddressBookNormalizationRule.md b/skype/skype-ps/SkypeForBusiness/Get-CsAddressBookNormalizationRule.md similarity index 91% rename from skype/skype-ps/skype/Get-CsAddressBookNormalizationRule.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAddressBookNormalizationRule.md index d12fa7f30e..591a8c2770 100644 --- a/skype/skype-ps/skype/Get-CsAddressBookNormalizationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAddressBookNormalizationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csaddressbooknormalizationrule applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAddressBookNormalizationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csaddressbooknormalizationrule +schema: 2.0.0 +title: Get-CsAddressBookNormalizationRule --- # Get-CsAddressBookNormalizationRule @@ -37,21 +38,21 @@ That means, in some cases, you might need to create identical rules: one for ass ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAddressBookNormalizationRule ``` The command shown in Example 1 returns information about all the Address Book normalization rules configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAddressBookNormalizationRule -Identity "Global/Generic_All" ``` In Example 2, information is returned for a single Address Book normalization rule: the rule Generic_All found in the global collection of Address Book normalization rules. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAddressBookNormalizationRule -Identity "Global" ``` @@ -60,7 +61,7 @@ Example 3 returns all the normalization rules found in the global collection of To return all the rules in a collection simply specify the collection scope. For example, to find all the rules in the collection assigned to the Redmond site use this syntax: -Identity "site:Redmond". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsAddressBookNormalizationRule | Where-Object {$_.Priority -eq 1} ``` @@ -73,6 +74,9 @@ That collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters to return a collection of normalization rules based on the rule Identity. Note, however, that Filter works only on the scope portion of the Identity and not on the rule name. For example, the filter value *lob* will return all rules at the global scope (scopes that contain the letters "lob"). @@ -85,8 +89,7 @@ To return all the rules in a given collection (such as the Redmond site) you can ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the rule. If a value is specified for this parameter, it must be in the format scope/name; for example, site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name. If neither the Identity nor the Filter parameters are included in a command, the Get-CsAddressBookNormalizationRule cmdlet will return all the Address book normalization rules configured for use in the organization. @@ -103,8 +109,7 @@ If neither the Identity nor the Filter parameters are included in a command, the ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -114,13 +119,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the Address book normalization rules from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAdminRole.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdminRole.md similarity index 91% rename from skype/skype-ps/skype/Get-CsAdminRole.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAdminRole.md index 45ac191dd0..3b2336d91e 100644 --- a/skype/skype-ps/skype/Get-CsAdminRole.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdminRole.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csadminrole applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAdminRole -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csadminrole +schema: 2.0.0 +title: Get-CsAdminRole --- # Get-CsAdminRole @@ -88,7 +89,7 @@ To return a list of all the RBAC roles this cmdlet has been assigned to (includi ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAdminRole ``` @@ -96,14 +97,14 @@ Get-CsAdminRole The command shown in Example 1 returns information about all the RBAC roles configured for use in your organization. This is done by calling the Get-CsAdminRole cmdlet without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAdminRole -Identity "CsHelpDesk" ``` In Example 2, a single RBAC role is returned: the role that has the Identity CsHelpDesk. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAdminRole -Filter "*Voice*" ``` @@ -111,7 +112,7 @@ Get-CsAdminRole -Filter "*Voice*" Example 3 returns all the RBAC roles that have the string value "Voice" somewhere in their Identity (for example, CsVoiceAdministrator; RedmondVoiceAdministrators). To do this, Get-CsAdminRole is called along with the Filter parameter; the filter value "*Voice*" limits the returned data to RBAC roles that have the string value "Voice" somewhere in their Identity. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsAdminRole | Where-Object {$_.IsStandardRole -eq $False} ``` @@ -121,7 +122,7 @@ To carry out this task, the command first uses the Get-CsAdminRole cmdlet to ret This collection is then piped to the Where-Object cmdlet, which selects only those roles where the IsStandardRole property is equal to False. By definition, any role that meets that criterion is a custom RBAC role. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Set-CsUser\b"} ``` @@ -131,7 +132,7 @@ To do this, the command first calls the Get-CsAdminRole cmdlet without any param This collection is then piped to the Where-Object cmdlet, which picks out any role where the Cmdlets property includes the string value "Set-CsUser\b". (The \b is a word boundary marker that indicates that "Set-CsUser" represents the entire string value.) -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsAdminRole | Where-Object {$_.UserScopes -match "OU: ou=Redmond,dc=litwareinc,dc=com"} ``` @@ -140,7 +141,7 @@ Example 6 returns information about all the RBAC roles that include the specifie To perform this task, the command first calls the Get-CsAdminRole cmdlet in order to return a collection of all the RBAC roles currently configured for use. This collection is then piped to the Where-Object cmdlet, which selects all of the roles that include the string value "OU:ou=Redmond,dc=litwareinc,dc=com" in the UserScopes property. -### -------------------------- Example 7 -------------------------- +### Example 7 ``` Get-CsAdminRole -Identity "CsVoiceAdministrator" | Select-Object -ExpandProperty Cmdlets ``` @@ -152,7 +153,29 @@ This information is then piped to the Select-Object cmdlet, which uses the Expan ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards in order to specify the RBAC role (or roles) to be returned. +For example, to return all the roles that include the string value "Redmond" in their Identity, you can use this syntax: -Filter "*Redmond*". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the RBAC role to be returned. The Identity for an RBAC role must be the same as the SamAccountName for the Active Directory universal security group associated with that role. For example, the help desk role has an Identity equal to CsHelpDesk; CsHelpDesk is also the SamAccountName of the Active Directory security group associated with that role. @@ -160,8 +183,7 @@ For example, the help desk role has an Identity equal to CsHelpDesk; CsHelpDesk ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -170,15 +192,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards in order to specify the RBAC role (or roles) to be returned. -For example, to return all the roles that include the string value "Redmond" in their Identity, you can use this syntax: -Filter "*Redmond*". +### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Retrieves the RBAC data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -188,6 +211,9 @@ Accept wildcard characters: False ``` ### -Sid + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use a security identifier (SID) to specify the RBAC role to be retrieved. SIDs are assigned by Skype for Business Server at the time that the RBAC role is created, and look similar to this: S-1-5-21-1573807623-1597889489-1765977225-1145. @@ -196,8 +222,7 @@ This same SID can also be found on the corresponding Active Directory security g ```yaml Type: String Parameter Sets: SID -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -206,22 +231,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -Retrieves the RBAC data from the local replica of the Central Management store rather than from the Central Management store itself. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -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). diff --git a/skype/skype-ps/skype/Get-CsAdminRoleAssignment.md b/skype/skype-ps/SkypeForBusiness/Get-CsAdminRoleAssignment.md similarity index 89% rename from skype/skype-ps/skype/Get-CsAdminRoleAssignment.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAdminRoleAssignment.md index 553b2ad153..56d953fe88 100644 --- a/skype/skype-ps/skype/Get-CsAdminRoleAssignment.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAdminRoleAssignment.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csadminroleassignment applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAdminRoleAssignment -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csadminroleassignment +schema: 2.0.0 +title: Get-CsAdminRoleAssignment --- # Get-CsAdminRoleAssignment @@ -33,14 +34,14 @@ The Get-CsAdminRoleAssignment cmdlet provides a way for you to retrieve a list o ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAdminRoleAssignment -Identity "kenmyer" ``` The command shown in Example 1 returns all of the RBAC roles assigned to the user kenmyer. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUser | ForEach-Object {$_.DisplayName; Get-CsAdminRoleAssignment -Identity $_.SamAccountName} ``` @@ -53,7 +54,28 @@ The user account information must be piped to the ForEach-Object cmdlet because ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SamAccountName of the user whose RBAC roles are to be returned, You can retrieve the SamAccountName for a user by using a command similar to this: `Get-CsUser "Ken Myer" | Select-Object SamAccountName` @@ -64,8 +86,7 @@ Other common values used when specifying identities, such as the Active Director ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -74,30 +95,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the RBAC role assignment data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAllowedDomain.md b/skype/skype-ps/SkypeForBusiness/Get-CsAllowedDomain.md similarity index 91% rename from skype/skype-ps/skype/Get-CsAllowedDomain.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAllowedDomain.md index d929aab5aa..e4c6fff5c5 100644 --- a/skype/skype-ps/skype/Get-CsAllowedDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAllowedDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csalloweddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAllowedDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csalloweddomain +schema: 2.0.0 +title: Get-CsAllowedDomain --- # Get-CsAllowedDomain @@ -48,7 +49,7 @@ The Get-CsAllowedDomain cmdlet provides a way for you to return information abou ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAllowedDomain ``` @@ -56,7 +57,7 @@ Get-CsAllowedDomain The command shown in Example 1 returns a collection of all the domains included in the list of domains approved for federation. Calling the Get-CsAllowedDomain cmdlet without any additional parameters always returns the complete collection of approved domains. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAllowedDomain -Identity fabrikam.com ``` @@ -64,7 +65,7 @@ Get-CsAllowedDomain -Identity fabrikam.com Example 2 returns information about the allowed domain with the Identity "fabrikam.com". Because identities must be unique, this command will never return more than one item. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAllowedDomain -Filter *fabrikam* ``` @@ -74,7 +75,7 @@ To do this, the command uses the Filter parameter and the filter value "\*fabrik This filter value tells the Get-CsAllowedDomain cmdlet to return only those domains where the Identity (the only property you can filter on) includes the string value "fabrikam". Domains such as fabrikam.com, fabrikam.net, and africa.fabrikam.org will all be returned by this command. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsAllowedDomain | Where-Object {$_.ProxyFqdn -eq $Null} ``` @@ -84,7 +85,7 @@ To carry out this task, the Get-CsAllowedDomain cmdlet is first called without a This collection is then piped to the Where-Object cmdlet, which selects only those allowed domains where the ProxyFqdn property is equal to a null value; a null value means that no value has been entered for ProxyFqdn. To find all the domains that have a value of some kind configured for the ProxyFqdn property, use this syntax instead: `Where-Object {$_.ProxyFqdn -ne $Null}`. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsAllowedDomain | Where-Object {$_.MarkForMonitoring -eq $True} ``` @@ -95,57 +96,63 @@ That collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS -### -Identity -Name of the domain to be returned. -Domains are listed on the allowed list by their fully qualified domain name (FQDN); that means that the Identity for a given domain will be similar to fabrikam.com or contoso.net. -Note that you cannot use wildcards when specifying a domain Identity. -To use wildcards to return a given domain (or set of domains), use the Filter parameter instead. +### -Filter -If this parameter is not specified, then all of the domains on the allowed domain list will be returned. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters in order to return one or more domains from the list of allowed domains. + +To return all of the domains that have an Identity that begins with the letter "r", use this syntax: `-Filter r*` + +To return all of the domains that have an Identity that ends with ".net", use this syntax: `-Filter "*.net"` + +To return all of the domains that have an Identity that begins with the letter "r" or with the letter "g", use this syntax: `-Filter [rg]*` ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters in order to return one or more domains from the list of allowed domains. +### -Identity -To return all of the domains that have an Identity that begins with the letter "r", use this syntax: `-Filter r*` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -To return all of the domains that have an Identity that ends with ".net", use this syntax: `-Filter "*.net"` +Name of the domain to be returned. +Domains are listed on the allowed list by their fully qualified domain name (FQDN); that means that the Identity for a given domain will be similar to fabrikam.com or contoso.net. +Note that you cannot use wildcards when specifying a domain Identity. +To use wildcards to return a given domain (or set of domains), use the Filter parameter instead. -To return all of the domains that have an Identity that begins with the letter "r" or with the letter "g", use this syntax: `-Filter [rg]*` +If this parameter is not specified, then all of the domains on the allowed domain list will be returned. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the allowed domains from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAnalogDevice.md b/skype/skype-ps/SkypeForBusiness/Get-CsAnalogDevice.md similarity index 89% rename from skype/skype-ps/skype/Get-CsAnalogDevice.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAnalogDevice.md index 395151838c..f50c21942b 100644 --- a/skype/skype-ps/skype/Get-CsAnalogDevice.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAnalogDevice.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csanalogdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAnalogDevice -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csanalogdevice +schema: 2.0.0 +title: Get-CsAnalogDevice --- # Get-CsAnalogDevice @@ -45,7 +46,7 @@ Optional parameters provide different ways for you to filter information; for ex ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAnalogDevice ``` @@ -53,7 +54,7 @@ Get-CsAnalogDevice The command shown in Example 1 returns a collection of all the analog devices currently configured for use in the organization. This is done by calling the Get-CsAnalogDevice cmdlet without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAnalogDevice | Select-Object DisplayName, LineUri ``` @@ -62,7 +63,7 @@ In Example 2, only two property values -- DisplayName and LineUri -- are returne To carry out this task, the command first calls the Get-CsAnalogDevice cmdlet without any parameters; this returns all the property values for all the analog devices in the organization. This collection is then piped to the Select-Object cmdlet, which selects and displays only the values for the DisplayName and the LineUri properties. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAnalogDevice -Filter {DisplayName -eq "Building 14 Receptionist"} ``` @@ -70,7 +71,7 @@ Get-CsAnalogDevice -Filter {DisplayName -eq "Building 14 Receptionist"} Example 3 returns information about the analog device that has the Active Directory display name "Building 14 Receptionist". To do this, the command calls Get-CsAnalogDevice and the Filter parameter; the filter value {DisplayName -eq "Building 14 Receptionist"} limits the returned items to analog devices where the DisplayName property is equal to "Building 14 Receptionist". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsAnalogDevice -Filter {Gateway -eq "192.168.0.240"} ``` @@ -78,7 +79,7 @@ Get-CsAnalogDevice -Filter {Gateway -eq "192.168.0.240"} Example 4 returns all of the analog devices configured for the gateway 192.168.0.240. This is done by calling the Get-CsAnalogDevice cmdlet and including the Filter parameter; the filter value "192.168.0.240" ensures that the only objects returned are analog devices where the Gateway property is equal to 192.168.0.240. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsAnalogDevice -Filter {AnalogFax -eq $True} ``` @@ -87,14 +88,14 @@ The command shown in Example 5 returns information about all the analog fax mach To perform this task, the command calls the Get-CsAnalogDevice cmdlet along with the Filter parameter. The filter value {AnalogFax -eq $True} limits the returned objects to fax machines: analog devices where the AnalogFax property is equal to True. -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsAnalogDevice -Filter {LineUri -eq "tel:+14255556001"} ``` In Example 6, a single analog device is returned: the device that has a LineUri (phone number) equal to tel:+14255556001. -### -------------------------- Example 7 -------------------------- +### Example 7 ``` Get-CsAnalogDevice -Filter {LineUri -like "tel:+1425555*"} ``` @@ -103,7 +104,7 @@ Example 7 returns all of the analog devices that have an area code of 425 and th To carry out this task, the Get-CsAnalogDevice cmdlet is used along with the Filter parameter; the filter value {LineUri -like "tel:+1425555*"} limits the returned data to devices where the LineUri property begins with the characters "tel:+1425555". That's equivalent to a phone number that begins with these characters: 1425555 (for example, the 1-425-555-1298). -### -------------------------- Example 8 -------------------------- +### Example 8 ``` Get-CsAnalogDevice -OU "ou=Telecommunications,dc=litwareinc,dc=com" ``` @@ -111,7 +112,7 @@ Get-CsAnalogDevice -OU "ou=Telecommunications,dc=litwareinc,dc=com" Example 8 returns a collection of all the analog devices that have a contact object in the Telecommunications OU in Active Directory Domain Services. To do this, the Get-CsAnalogDevice cmdlet is called along with the OU parameter; the parameter value limits the returned objects to analog devices that have contacts objects in the OU with the distinguished name ou=Telecommunications,dc=litwareinc,dc=com. -### -------------------------- Example 9 -------------------------- +### Example 9 ``` Get-CsAnalogDevice | Grant-CsVoicePolicy -PolicyName "AnalogVoicePolicy" ``` @@ -123,25 +124,10 @@ This collection is then piped to the Grant-CsVoicePolicy cmdlet, which assigns t ## PARAMETERS -### -Identity -Unique identifier for the analog device. -Analog devices are identified by using the Active Directory distinguished name of the associated contact object. -By default, analog devices use a GUID (globally unique identifier) as their common name, which means devices will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. +### -Credential -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Credential Enables you to run the Get-CsAnalogDevice cmdlet under alternate credentials. This might be required if the account you used to log on to the Windows does not have the necessary privileges required to work with contact objects. @@ -151,8 +137,7 @@ For details, see the Get-Credential cmdlet Help topic. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,14 +147,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to retrieve contact information. To connect to a particular domain controller, include the DomainController parameter followed by the fully qualified domain name (FQDN) of the computer; for example, atl-cs-001.litwareinc.com. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,6 +166,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on attributes specific to Skype for Business Server. For example, you can limit returned data to analog device contact objects that have been assigned a specific voice policy, or contacts that have not been assigned a specific voice policy. @@ -190,8 +180,7 @@ For example, a filter that returns only fax machines would look like this, with ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -200,7 +189,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the analog device. +Analog devices are identified by using the Active Directory distinguished name of the associated contact object. +By default, analog devices use a GUID (globally unique identifier) as their common name, which means devices will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + ### -LdapFilter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business Server). For example, you can limit returned data to contact objects that have been assigned to a specific department or are located in a specific building. @@ -214,8 +226,7 @@ In the preceding filter, "l" represents the Active Directory attribute (locality ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,19 +236,21 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to return contact objects from a specific Active Directory organizational unit (OU). This returns data from both the specified OU and any of its child OUs. For example, if the Finance OU has two child OUs -- AccountsPayable and AccountsReceivable -- analog device information will be returned from each of these OUs. -When specifying an OU, use the distinguished name of that container; for example: +When specifying an OU, use the distinguished name of that container; for example: `-OU "OU=Finance,dc=litwareinc,dc=com"` ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -247,6 +260,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the number of records returned by a command. For example, to return seven analog devices (regardless of how many analog devices are in your forest), include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which seven phones will be returned. @@ -258,8 +274,7 @@ If set to 0 the command will run, but no data will be returned. ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAnnouncement.md b/skype/skype-ps/SkypeForBusiness/Get-CsAnnouncement.md similarity index 89% rename from skype/skype-ps/skype/Get-CsAnnouncement.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAnnouncement.md index a6d35b457e..cbcf29f92c 100644 --- a/skype/skype-ps/skype/Get-CsAnnouncement.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAnnouncement.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csannouncement applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAnnouncement -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csannouncement +schema: 2.0.0 +title: Get-CsAnnouncement --- # Get-CsAnnouncement @@ -40,7 +41,7 @@ This cmdlet retrieves one or more of these announcement settings. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAnnouncement ``` @@ -48,7 +49,7 @@ Get-CsAnnouncement Example 1 returns all of the announcements configured for use in the organization. This is done by calling the Get-CsAnnouncement cmdlet without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAnnouncement -Identity "ApplicationServer:redmond.litwareinc.com/1951f734-c80f-4fb2-965d-51807c792b90" ``` @@ -56,14 +57,14 @@ Get-CsAnnouncement -Identity "ApplicationServer:redmond.litwareinc.com/1951f734- The command shown in Example 2 returns a single announcement: the announcement with the Identity ApplicationServer:redmond.litwareinc.com/1951f734-c80f-4fb2-965d-51807c792b90. For an alternate (and arguably easier) way to retrieve a specific announcement, see Example 5. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAnnouncement -Identity "ApplicationServer:redmond.litwareinc.com" ``` The command shown in Example 3 returns information about all of the announcements that have been configured for use on the service ApplicationServer:redmond.litwareinc.com. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsAnnouncement -Filter "*ApplicationServer:Redmond*" ``` @@ -72,7 +73,7 @@ In Example 4, information is returned for all of the announcements configured fo This is done by including the Filter parameter and the filter value "*ApplicationServer:Redmond*", which limits the returned data to announcements that have an Identity that contains the string value "ApplicationServer:Redmond". By definition, those are announcements configured for use in the Redmond site. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsAnnouncement | Where-Object {$_.Name -eq "Welcome Announcement"} ``` @@ -81,7 +82,7 @@ Example 5 shows an alternate way to return a specific announcement or set of ann To do this, the Get-CsAnnouncement cmdlet is first called, without any parameters, in order to return a collection of all the announcements in use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out those announcements that have a Name equal to (-eq) "Welcome Announcement". -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsAnnouncement -Identity "ApplicationServer:redmond.litwareinc.com" | Where-Object {$_.Name -eq "Welcome Announcement"} ``` @@ -92,7 +93,7 @@ This will return a collection of all announcements associated with that service. As in Example 5, this collection is then piped to the Where-Object cmdlet, which picks out those announcements that have a Name equal to (-eq) "Welcome Announcement". Because announcement names must be unique within an Application service, this command will never return more than a single item. -### -------------------------- Example 7 -------------------------- +### Example 7 ``` Get-CsAnnouncement | Where-Object {$_.Name -like "Welcome*"} ``` @@ -101,7 +102,7 @@ This example is similar to Example 5 in that we retrieve all the announcements, However, in Example 5 we used the -eq operator in the where clause to find an identical match for the name. In this example we've used the -like operator and a wildcard value to find all announcements that, in this case, begin with the string Welcome. -### -------------------------- Example 8 -------------------------- +### Example 8 ``` Get-CsAnnouncement | Where-Object {($_.TextToSpeechPrompt -ne $Null) -and ($_.Language -ne "en-US")} ``` @@ -114,7 +115,29 @@ This collection is then piped to the Where-Object cmdlet, which selects all the ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter allows you to perform a wildcard search on the Identity of all announcements configured for the organization. +Use the wildcard character (*) to filter on any part of the Identity. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + An identifier for the Announcement you want to retrieve. If you omit this parameter and the Filter parameter, all instances of announcements configured for the organization will be displayed. The value for the Identity parameter can be supplied in one of two ways: @@ -125,8 +148,7 @@ The value for the Identity parameter can be supplied in one of two ways: ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -135,31 +157,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -This parameter allows you to perform a wildcard search on the Identity of all announcements configured for the organization. -Use the wildcard character (*) to filter on any part of the Identity. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the announcement information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/Get-CsApplicationEndpoint.md similarity index 84% rename from skype/skype-ps/skype/Get-CsApplicationEndpoint.md rename to skype/skype-ps/SkypeForBusiness/Get-CsApplicationEndpoint.md index abcb4005cc..b62ddbae28 100644 --- a/skype/skype-ps/skype/Get-CsApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsApplicationEndpoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csapplicationendpoint applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsApplicationEndpoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csapplicationendpoint +schema: 2.0.0 +title: Get-CsApplicationEndpoint --- # Get-CsApplicationEndpoint @@ -33,14 +34,14 @@ These objects are stored in Active Directory in the Application Contacts contain ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsApplicationEndpoint ``` This example retrieves information about all application endpoints defined within the Skype for Business Server 2015 deployment. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsApplicationEndpoint -Filter {DisplayName -like "*endpoint*"} ``` @@ -49,7 +50,7 @@ Example 2 retrieves all application endpoints that have the string "endpoint" an To do this, the command uses the Filter parameter. The value of the parameter filters to find endpoint objects that have a display name (DisplayName) that contains (-like) the string endpoint (*endpoint* - the wildcard characters indicate that any characters can come before or after the string endpoint, meaning endpoint can be anywhere within the display name). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsApplicationEndpoint -ApplicationId tapp2 | Select-Object Identity, SipAddress, DisplayName, OwnerUrn ``` @@ -62,40 +63,22 @@ The next part of this command pipes the returned object or objects to the Select ## PARAMETERS -### -Identity -The Identity, SIP address, or display name of the application endpoint to retrieve. -The Identity consists of the distinguished name of the endpoint. -This will typically contain a globally unique identifier (GUID) as part of the CN, for example: - -`CN={8811fefe-e0bb-4fab-ae39-7aaeddd423dc},CN=Application Contacts,CN=RTC Service,CN=Services,CN=Configuration,DC=Vdomain,DC=com.` - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -ApplicationId -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -ApplicationId The application ID of the application endpoint you want to retrieve. The application ID is the value of the endpoint's OwnerUrn property. For example, if the OwnerUrn property has a value of urn:application:Caa, the application ID is urn:application:Caa. However, you can enter only the suffix, in this case Caa, to retrieve the endpoint. -For example: +For example: `-ApplicationId Caa` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -105,14 +88,16 @@ Accept wildcard characters: False ``` ### -Credential + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Alternate credentials under which the Get operation will proceed. You can retrieve a PSCredential object by calling the Windows PowerShell cmdlet Get-Credential. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,14 +107,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to specify a domain controller. If no domain controller is specified, the first available will be used. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,6 +126,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on specific attributes for Skype for Business Server. For example, you can limit returned data to contacts whose display names or SIP addresses match a certain wildcard pattern. @@ -148,8 +138,7 @@ For example, a filter that returns only contacts that have been enabled for Ente ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,14 +147,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity, SIP address, or display name of the application endpoint to retrieve. +The Identity consists of the distinguished name of the endpoint. +This will typically contain a globally unique identifier (GUID) as part of the CN, for example: + +`CN={8811fefe-e0bb-4fab-ae39-7aaeddd423dc},CN=Application Contacts,CN=RTC Service,CN=Services,CN=Configuration,DC=Vdomain,DC=com.` + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + ### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The organizational unit (OU) in which the endpoint resides. ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,13 +188,15 @@ Accept wildcard characters: False ``` ### -PoolFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Fully Qualified Domain Name (FQDN) of the pool on which the application endpoint resides. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -191,13 +206,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum number of endpoint records to retrieve. ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsArchivingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsArchivingConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsArchivingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsArchivingConfiguration.md index 55d5040275..36a35bb482 100644 --- a/skype/skype-ps/skype/Get-CsArchivingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsArchivingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csarchivingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsArchivingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csarchivingconfiguration +schema: 2.0.0 +title: Get-CsArchivingConfiguration --- # Get-CsArchivingConfiguration @@ -52,21 +53,21 @@ With the Get-CsArchivingConfiguration cmdlet, you can determine how IM session a ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsArchivingConfiguration ``` The command shown in Example 1 returns a collection of all the archiving configuration settings in use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsArchivingConfiguration -Identity site:Redmond ``` In Example 2, the Identity parameter is used to limit the returned collection of archiving configuration settings to those settings that have the Identity site:Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsArchivingConfiguration -Filter site:* ``` @@ -74,7 +75,7 @@ Get-CsArchivingConfiguration -Filter site:* In Example 3, the Filter parameter is used to limit the returned collection of archiving configuration settings to settings that have been configured at the site scope. The parameter value "site:*" limits the returned items to those that have an Identity that starts with the string value "site:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsArchivingConfiguration | Where-Object {$_.EnableArchiving -ne "None"} ``` @@ -88,7 +89,30 @@ If this property is set to any other value (either "IMOnly" or "ImAndWebConf") t ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters in order to return a collection (or collections) of archiving configuration settings. +To return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. +To return a collection of all the settings that have the string value "Canada" somewhere in their Identity (the only property you can filter on) use this syntax: -Filter "*Canada*". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the unique identifier for the collection of archiving settings you want to return. To refer to the global settings use this syntax: -Identity global. To refer to a collection configured at the site scope, use syntax similar to this: -Identity site:Redmond. @@ -106,8 +130,7 @@ If this parameter is not specified, then the Get-CsArchivingConfiguration cmdlet ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -116,32 +139,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters in order to return a collection (or collections) of archiving configuration settings. -To return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. -To return a collection of all the settings that have the string value "Canada" somewhere in their Identity (the only property you can filter on) use this syntax: -Filter "*Canada*". - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the archiving configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsArchivingPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsArchivingPolicy.md similarity index 91% rename from skype/skype-ps/skype/Get-CsArchivingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsArchivingPolicy.md index f7195895dc..d47ea6b291 100644 --- a/skype/skype-ps/skype/Get-CsArchivingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsArchivingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csarchivingpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsArchivingPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csarchivingpolicy +schema: 2.0.0 +title: Get-CsArchivingPolicy --- # Get-CsArchivingPolicy @@ -55,7 +56,7 @@ To determine whether or not IM session archiving has been enabled, use the Get-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsArchivingPolicy ``` @@ -63,7 +64,7 @@ Get-CsArchivingPolicy Example 1 calls the Get-CsArchivingPolicy cmdlet without any parameters. This returns a collection of all the archiving policies currently in use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsArchivingPolicy -Identity site:Redmond ``` @@ -71,7 +72,7 @@ Get-CsArchivingPolicy -Identity site:Redmond In Example 2, the Get-CsArchivingPolicy cmdlet is used to return the archiving policy with the Identity site:Redmond. Because identities must be unique, this command will always return, at most, a single policy. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsArchivingPolicy -Filter tag:* ``` @@ -80,7 +81,7 @@ Example 3 returns a collection of all the archiving policies that have been conf This is done by including the Filter parameter and the filter value "tag:*". That filter value instructs the Get-CsArchivingPolicy cmdlet to return only those policies that have an identity beginning with the string value "tag:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsArchivingPolicy | Where-Object {$_.ArchiveInternal -eq $False} ``` @@ -90,7 +91,7 @@ To do this, the Get-CsArchivingPolicy cmdlet is first used to return a collectio That collection is then piped to the Where-Object cmdlet. In turn, the Where-Object cmdlet applies a filter that restricts the returned data to those policies where the ArchiveInternal property is equal to False. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsArchivingPolicy | Where-Object {$_.ArchiveInternal -eq $False -and $_.ArchiveExternal -eq $False} ``` @@ -104,7 +105,31 @@ To select policies that meet just one (or both) of the specified criteria use th ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. +For example, to return all of the policies configured at the site scope, use this syntax: -Filter "site:*". +This returns any policy where the Identity (the only property you can filter on) begins with the string value "site:". +To return a collection of all the per-user policies that have an Identity that begins with "Sales", use this syntax: -Filter "Sales*". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the archiving policy to be returned. To refer to the global policy, use this syntax: -Identity global. To refer to a site policy, use syntax similar to this: -Identity site:Redmond. @@ -114,8 +139,7 @@ If this parameter is omitted, then all of the archiving policies configured for ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -124,33 +148,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. -For example, to return all of the policies configured at the site scope, use this syntax: -Filter "site:*". -This returns any policy where the Identity (the only property you can filter on) begins with the string value "site:". -To return a collection of all the per-user policies that have an Identity that begins with "Sales", use this syntax: -Filter "Sales*". - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the archiving policy data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -160,6 +167,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose archiving policies are being returned. For example: @@ -172,8 +182,7 @@ You can return the tenant ID for each of your Skype for Business Online tenants ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAudioConferencingProvider.md b/skype/skype-ps/SkypeForBusiness/Get-CsAudioConferencingProvider.md similarity index 92% rename from skype/skype-ps/skype/Get-CsAudioConferencingProvider.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAudioConferencingProvider.md index b3dc99ff07..16334fbcc5 100644 --- a/skype/skype-ps/skype/Get-CsAudioConferencingProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAudioConferencingProvider.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csaudioconferencingprovider applicable: Skype for Business Online -title: Get-CsAudioConferencingProvider -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/get-csaudioconferencingprovider +schema: 2.0.0 +title: Get-CsAudioConferencingProvider --- # Get-CsAudioConferencingProvider @@ -38,21 +40,21 @@ Administrators can retrieve information about the audio conferencing providers a ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAudioConferencingProvider ``` The command shown in Example 1 returns information about all the audio conferencing providers available for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAudioConferencingProvider -Identity "Fabrikam Telecom" ``` In Example 2, information is returned for a single audio conferencing provider: the provider with the Identity Fabrikam Telecom. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAudioConferencingProvider -Filter "*Fabrikam*" ``` @@ -64,6 +66,9 @@ In this example, the filter value "*Fabrikam*" returns all audio conferencing pr ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Online + Enables you to use wildcard characters when indicating the audio conferencing provider (or providers) to be returned. For example, this syntax returns information about all the audio conferencing providers that have the string value "fabrikam" somewhere in their Identity: @@ -74,8 +79,7 @@ Note that you cannot use the Filter parameter and the Identity parameters in the ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -85,6 +89,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + Unique identifier for the audio conferencing provider to be returned. For example: @@ -95,8 +102,7 @@ If neither the Identity parameter nor the Filter parameter are included in a com ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 2 @@ -106,13 +112,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Online + This parameter is not used with Skype for Business Online. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAudioTestServiceApplication.md b/skype/skype-ps/SkypeForBusiness/Get-CsAudioTestServiceApplication.md similarity index 88% rename from skype/skype-ps/skype/Get-CsAudioTestServiceApplication.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAudioTestServiceApplication.md index 4829ab115f..c9611cfdb6 100644 --- a/skype/skype-ps/skype/Get-CsAudioTestServiceApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAudioTestServiceApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csaudiotestserviceapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAudioTestServiceApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csaudiotestserviceapplication +schema: 2.0.0 +title: Get-CsAudioTestServiceApplication --- # Get-CsAudioTestServiceApplication @@ -41,21 +42,21 @@ Administrators can also use the Set-CsAudioTestServiceApplication to modify the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAudioTestServiceApplication ``` In Example 1, the Get-CsAudioTestServiceApplication cmdlet is called without any additional parameters in order to return a collection of all the Audio Test service contacts currently in use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAudioTestServiceApplication -Identity "sip:RedmondAudioTest@litwareinc.com" ``` In Example 2, a single Audio Test service contact is returned: the contact that has the Identity sip:RedmondAudioTest@litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAudioTestServiceApplication -Filter {DisplayName -like "*Redmond*"} ``` @@ -67,34 +68,39 @@ This command returns contacts with display names such as "Redmond Audio Test Ser ## PARAMETERS -### -Identity -SIP address of the audio test service contact. +### -Credential + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to run the cmdlet under alternate credentials. +This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with contact objects. + +To use the Credential parameter, you must first create a PSCredential object by using the Get-Credential cmdlet. +For details, see the Get-Credential cmdlet help topic. ```yaml -Type: UserIdParameter +Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Credential -Enables you to run the cmdlet under alternate credentials. -This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with contact objects. +### -DomainController -To use the Credential parameter, you must first create a PSCredential object by using the Get-Credential cmdlet. -For details, see the Get-Credential cmdlet help topic. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to connect to the specified domain controller in order to retrieve contact information. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-cs-001) or its fully qualified domain name (FQDN) (for example, atl-cs-001.litwareinc.com). ```yaml -Type: PSCredential +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -104,6 +110,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering for attributes specific to Skype for Business Server. For example, you can limit returned data to audio test contact objects that have a specific display name or use a particular language. @@ -117,8 +126,7 @@ You cannot use both the Filter and the Identity parameters in the same command. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -127,7 +135,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address of the audio test service contact. + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + ### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to return contacts from a specific Active Directory organizational unit (OU). The OU parameter returns data from both the specified OU and any of its child OUs. For example, if the Finance OU has two child OUs, such as AccountsPayable and AccountsReceivable, users will be returned from each of these three OUs. @@ -137,8 +166,7 @@ When specifying an OU, use the distinguished name (DN) of that container; for ex ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -148,6 +176,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the number of records returned by a command. For example, to return seven users (regardless of how many users are in your forest) include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which seven users will be returned. @@ -159,25 +190,7 @@ If set to 0 the command will run, but no data will be returned. ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -Enables you to connect to the specified domain controller in order to retrieve contact information. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-cs-001) or its fully qualified domain name (FQDN) (for example, atl-cs-001.litwareinc.com). - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsAuthConfig.md b/skype/skype-ps/SkypeForBusiness/Get-CsAuthConfig.md similarity index 93% rename from skype/skype-ps/skype/Get-CsAuthConfig.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAuthConfig.md index 56541b3cdc..c9a293a28f 100644 --- a/skype/skype-ps/skype/Get-CsAuthConfig.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAuthConfig.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csauthconfig applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAuthConfig -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csauthconfig +schema: 2.0.0 +title: Get-CsAuthConfig --- # Get-CsAuthConfig @@ -45,37 +46,44 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Pool + +> Applicable: Skype for Business Server 2019 + +{{Fill Pool Description}} ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Pool -{{Fill Pool Description}} +### -Confirm + +> Applicable: Skype for Business Server 2019 + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2019 +Aliases: cf Required: False -Position: 0 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -83,7 +91,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None diff --git a/skype/skype-ps/skype/Get-CsAutodiscoverConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsAutodiscoverConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsAutodiscoverConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsAutodiscoverConfiguration.md index 9b8fbb11b7..6d7bae8898 100644 --- a/skype/skype-ps/skype/Get-CsAutodiscoverConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsAutodiscoverConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csautodiscoverconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsAutodiscoverConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csautodiscoverconfiguration +schema: 2.0.0 +title: Get-CsAutodiscoverConfiguration --- # Get-CsAutodiscoverConfiguration @@ -53,21 +54,21 @@ The Get-CsAutoDiscoverConfiguration cmdlet provides a way to return information ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsAutoDiscoverConfiguration ``` The command shown in Example 1 returns all the Autodiscover configuration settings currently in use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAutoDiscoverConfiguration -Identity "global" ``` In Example 2, only one collection of Autodiscover configuration settings are returned: the global collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAutoDiscoverConfiguration -Filter "site:*" ``` @@ -76,7 +77,7 @@ The command shown in Example 3 returns all the Autodiscover configuration settin To do this, the Filter parameter is included, along with the filter value "site:*"; that filter value ensures that the only settings returned are those that have an Identity that begins with the string value "site:". By definition, any settings with an Identity beginning with "site:" are settings configured at the site scope. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsAutoDiscoverConfiguration | Where-Object {$_.WebLinks -like "*fabrikam.com"} ``` @@ -90,6 +91,9 @@ This collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcards when specifying the Identity of the Autodiscover configuration settings to be returned. For example, this syntax returns all the settings configured at the site scope: @@ -100,8 +104,7 @@ Note that you cannot use both the Identity and the Filter parameters in the same ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -111,6 +114,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of Autodiscover configuration settings to be retrieved. To retrieve the global settings, use this syntax: @@ -125,8 +131,7 @@ If this parameter is not included, then the Get-CsAutoDiscoverConfiguration cmdl ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -136,13 +141,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the Autodiscover configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsBackupServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsBackupServiceConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsBackupServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsBackupServiceConfiguration.md index 0807cde4a1..c3b0acbf34 100644 --- a/skype/skype-ps/skype/Get-CsBackupServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsBackupServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csbackupserviceconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsBackupServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csbackupserviceconfiguration +schema: 2.0.0 +title: Get-CsBackupServiceConfiguration --- # Get-CsBackupServiceConfiguration @@ -42,7 +43,7 @@ The functions carried out by the Get-CsBackupServiceConfiguration cmdlet are not ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsBackupServiceConfiguration ``` @@ -54,6 +55,9 @@ Because there is only a single, global set of backup service configuration setti ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard values when referencing a collection of backup service configuration settings. Because you can only have a single, global instance of these settings there is no reason to use the Filter parameter. However, if you prefer you can use the following syntax to reference the global settings: @@ -65,8 +69,7 @@ The preceding syntax returns all the conference backup service configuration set ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -76,6 +79,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique Identity of the backup service configuration settings. Because you can only have a single, global instance of these settings, you do not need to specify an Identity when calling the Get-CsBackupServiceConfiguration cmdlet. You can, however, use the following syntax to reference the global settings: @@ -85,8 +91,7 @@ You can, however, use the following syntax to reference the global settings: ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -96,13 +101,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the backup service configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsBackupServiceStatus.md b/skype/skype-ps/SkypeForBusiness/Get-CsBackupServiceStatus.md similarity index 88% rename from skype/skype-ps/skype/Get-CsBackupServiceStatus.md rename to skype/skype-ps/SkypeForBusiness/Get-CsBackupServiceStatus.md index 6b305b2b3c..b1a78d9221 100644 --- a/skype/skype-ps/skype/Get-CsBackupServiceStatus.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsBackupServiceStatus.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csbackupservicestatus applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsBackupServiceStatus -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csbackupservicestatus +schema: 2.0.0 +title: Get-CsBackupServiceStatus --- # Get-CsBackupServiceStatus @@ -33,7 +34,7 @@ The functions carried out by the Get-CsBackupServiceStatus cmdlet are not availa ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsBackupServiceStatus -PoolFqdn "atl-cs-001.litwareinc.com" ``` @@ -43,26 +44,10 @@ The preceding command returns the backup service status for the pool atl-cs-001. ## PARAMETERS -### -PoolFqdn -Fully qualified domain name of the pool whose backup service status is being checked. -For example: - -`-PoolFqdn "atl-cs-001.litwareinc.com"` - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Category -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Category Type of backup whose status is being checked. Allowed values are: @@ -75,8 +60,7 @@ If this parameter is not specified then all three backup types will be checked. ```yaml Type: BackupCategory Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -86,13 +70,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -101,6 +87,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool whose backup service status is being checked. +For example: + +`-PoolFqdn "atl-cs-001.litwareinc.com"` + +```yaml +Type: Fqdn +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 (https://go.microsoft.com/fwlink/?LinkID=113216). @@ -112,7 +119,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### +### System.Object Returns information about the backup service. diff --git a/skype/skype-ps/skype/Get-CsBandwidthPolicyServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsBandwidthPolicyServiceConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Get-CsBandwidthPolicyServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsBandwidthPolicyServiceConfiguration.md index 7b0c12b2c5..f02225a05a 100644 --- a/skype/skype-ps/skype/Get-CsBandwidthPolicyServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsBandwidthPolicyServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csbandwidthpolicyserviceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsBandwidthPolicyServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csbandwidthpolicyserviceconfiguration +schema: 2.0.0 +title: Get-CsBandwidthPolicyServiceConfiguration --- # Get-CsBandwidthPolicyServiceConfiguration @@ -38,21 +39,21 @@ The Get-CsBandwidthPolicyServiceConfiguration cmdlet retrieves settings for one ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsBandwidthPolicyServiceConfiguration ``` Example 1 retrieves all bandwidth policy service configurations defined within the Skype for Business Server implementation. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsBandwidthPolicyServiceConfiguration -Identity site:Redmond ``` This example retrieves the bandwidth policy service configuration defined for the Redmond site (-Identity site:Redmond). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsBandwidthPolicyServiceConfiguration -Filter site:* ``` @@ -62,7 +63,7 @@ We do this by passing the value site:* to the Filter parameter. This will search the Identity property of all bandwidth policy service configurations for values that begin with site: and are followed by any other characters. Because all site-level configurations have Identity values beginning with site: and followed by the name of the site, this filter will find all configurations for all sites. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsBandwidthPolicyServiceConfiguration | Where-Object {$_.MaxLogFileSizeMb -gt 4} ``` @@ -79,48 +80,54 @@ If the value of MaxLogFileSizeMb is not greater than 4, the item is ignored and ## PARAMETERS -### -Identity -The unique identifier of the configuration you want to retrieve. -This identifier will consist of the scope (for the global configuration) or the scope and name (for a site-level configuration, such as site:Redmond). +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A string containing one or more wildcard characters that will be used to search the Identity property of all bandwidth policy service configurations to find every configuration with an Identity that matches the wildcard pattern. +For example, the Filter value site:* will retrieve all configurations with Identity values that begin with the string site: and end with any set of characters. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -A string containing one or more wildcard characters that will be used to search the Identity property of all bandwidth policy service configurations to find every configuration with an Identity that matches the wildcard pattern. -For example, the Filter value site:* will retrieve all configurations with Identity values that begin with the string site: and end with any set of characters. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the configuration you want to retrieve. +This identifier will consist of the scope (for the global configuration) or the scope and name (for a site-level configuration, such as site:Redmond). ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the bandwidth policy service configuration from the local replica of the Central Management store, rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsBlockedDomain.md b/skype/skype-ps/SkypeForBusiness/Get-CsBlockedDomain.md similarity index 90% rename from skype/skype-ps/skype/Get-CsBlockedDomain.md rename to skype/skype-ps/SkypeForBusiness/Get-CsBlockedDomain.md index 4db4188c4b..4ee223ec1b 100644 --- a/skype/skype-ps/skype/Get-CsBlockedDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsBlockedDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csblockeddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsBlockedDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csblockeddomain +schema: 2.0.0 +title: Get-CsBlockedDomain --- # Get-CsBlockedDomain @@ -48,7 +49,7 @@ The Get-CsBlockedDomain cmdlet enables you to return information about the domai ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsBlockedDomain ``` @@ -56,7 +57,7 @@ Get-CsBlockedDomain The command shown in Example 1 returns a collection of all the domains included on the blocked domain list. This is done by calling the Get-CsBlockedDomain cmdlet without any additional parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` ``` @@ -64,7 +65,7 @@ This is done by calling the Get-CsBlockedDomain cmdlet without any additional pa In Example 2, the only blocked domain returned is the one with the Identity "fabrikam.com". Because domains on the blocked list must have unique identities, this command will return, at most, a single item. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsBlockedDomain -Filter *.net ``` @@ -72,7 +73,7 @@ Get-CsBlockedDomain -Filter *.net Example 3 uses the Filter parameter to return a collection of all the blocked domains that have an identity that ends in the string value ".net". This sample command returns such domains as northwindtraders.net, contoso.net, and fabrikam.net. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsBlockedDomain | Where-Object {$_.Comment -eq $Null} ``` @@ -81,7 +82,7 @@ Example 4 returns a collection of all the domains where the Comment property has To do this, the command first uses the Get-CsBlockedDomain cmdlet to return a collection of all the domains on the blocked list. This collection is then piped to the Where-Object cmdlet, which selects only those domains where the Comment property is equal to a null value. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsBlockedDomain | Where-Object {$_.Comment -match "Ken Myer"} ``` @@ -93,7 +94,31 @@ This collection is then piped to the Where-Object cmdlet, which picks out those ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters in order to return one or more domains from the list of blocked domains. +To return all the domains that have an Identity that begins with the letter "r" use this syntax: -Filter r*. +To return all the domains that have an Identity that ends with ".net" use this syntax: -Filter "*.net". +To return all the domains that have an Identity that begins with the letter "f" or with the letter "g" use this syntax: -Filter \[fg\]*. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the domain to be returned. Domains are listed on the blocked list by their fully qualified domain name (FQDN); thus the Identity for a given domain will be similar to fabrikam.com or contoso.net. Note that you cannot use wildcards when specifying a domain Identity. @@ -104,8 +129,7 @@ If this parameter is not specified, then all the domains on the blocked domain l ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -114,33 +138,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters in order to return one or more domains from the list of blocked domains. -To return all the domains that have an Identity that begins with the letter "r" use this syntax: -Filter r*. -To return all the domains that have an Identity that ends with ".net" use this syntax: -Filter "*.net". -To return all the domains that have an Identity that begins with the letter "f" or with the letter "g" use this syntax: -Filter \[fg\]*. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the blocked domain data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsBroadcastMeetingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsBroadcastMeetingConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsBroadcastMeetingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsBroadcastMeetingConfiguration.md index 82470cd5a7..cfbc17d9c1 100644 --- a/skype/skype-ps/skype/Get-CsBroadcastMeetingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsBroadcastMeetingConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csbroadcastmeetingconfiguration applicable: Skype for Business Online -title: Get-CsBroadcastMeetingConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/get-csbroadcastmeetingconfiguration +schema: 2.0.0 +title: Get-CsBroadcastMeetingConfiguration --- # Get-CsBroadcastMeetingConfiguration @@ -38,7 +40,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsBroadcastMeetingConfiguration ``` @@ -49,13 +51,15 @@ This example returns the tenant's global broadcast meeting configuration. ## PARAMETERS ### -ExposeSDNConfigurationJsonBlob + +> Applicable: Skype for Business Online + When set to true, the cmdlet will only return broadcast meeting configuration settings that relate to the Software Defined Network configuration. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -65,13 +69,15 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -81,13 +87,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 2 @@ -97,13 +105,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Online + Retrieves the information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -113,13 +123,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsBroadcastMeetingPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsBroadcastMeetingPolicy.md similarity index 95% rename from skype/skype-ps/skype/Get-CsBroadcastMeetingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsBroadcastMeetingPolicy.md index acdf4bbf3d..f3b3f83093 100644 --- a/skype/skype-ps/skype/Get-CsBroadcastMeetingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsBroadcastMeetingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csbroadcastmeetingpolicy applicable: Skype for Business Online -title: Get-CsBroadcastMeetingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/get-csbroadcastmeetingpolicy +schema: 2.0.0 +title: Get-CsBroadcastMeetingPolicy --- # Get-CsBroadcastMeetingPolicy @@ -165,7 +167,7 @@ BroadcastMeetingRecordingEnforced : False ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsBroadcastMeetingPolicy ``` @@ -177,13 +179,15 @@ See detailed description for more information. ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -193,13 +197,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 2 @@ -209,13 +215,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Online + Retrieves the information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -225,13 +233,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsBusyOptions.md b/skype/skype-ps/SkypeForBusiness/Get-CsBusyOptions.md similarity index 87% rename from skype/skype-ps/skype/Get-CsBusyOptions.md rename to skype/skype-ps/SkypeForBusiness/Get-CsBusyOptions.md index 717261c488..d9b4394a19 100644 --- a/skype/skype-ps/skype/Get-CsBusyOptions.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsBusyOptions.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csbusyoptions applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsBusyOptions -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csbusyoptions +schema: 2.0.0 +title: Get-CsBusyOptions --- # Get-CsBusyOptions @@ -31,7 +32,7 @@ This cmdlet retrieves configuration information about Busy Options for a specifi ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsBusyOptions -Identity sip:KenMyer@Contoso.com ``` @@ -42,6 +43,9 @@ This example returns the Busy Options setting for "KenMyer@Contoso.com". ## PARAMETERS ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account to be modified. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. You can use the asterisk (*) wildcard character when using the display name as the user Identity. For example, the Identity "*Smith" returns all the users who have a display name that ends with the string value "Smith". @@ -49,8 +53,7 @@ You can use the asterisk (*) wildcard character when using the display name as t ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 0 @@ -60,13 +63,15 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -81,21 +86,18 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.AD.UserIdParameter object. - +### Microsoft.Rtc.Management.AD.UserIdParameter ## OUTPUTS -### -Microsoft.Rtc.Management.Bob.Cmdlets.ActionType object. -Microsoft.Rtc.Management.AD.UserIdParameter object. +### Microsoft.Rtc.Management.Bob.Cmdlets.ActionType +### Microsoft.Rtc.Management.AD.UserIdParameter ## NOTES - ## RELATED LINKS + [Remove-CsBusyOptions](https://learn.microsoft.com/powershell/module/skype/remove-csbusyoptions?view=skype-ps) [Set-CsBusyOptions](https://learn.microsoft.com/powershell/module/skype/set-csbusyoptions?view=skype-ps) diff --git a/skype/skype-ps/skype/Get-CsCallParkOrbit.md b/skype/skype-ps/SkypeForBusiness/Get-CsCallParkOrbit.md similarity index 89% rename from skype/skype-ps/skype/Get-CsCallParkOrbit.md rename to skype/skype-ps/SkypeForBusiness/Get-CsCallParkOrbit.md index d13afad9f1..9048383a95 100644 --- a/skype/skype-ps/skype/Get-CsCallParkOrbit.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCallParkOrbit.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cscallparkorbit applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsCallParkOrbit -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cscallparkorbit +schema: 2.0.0 +title: Get-CsCallParkOrbit --- # Get-CsCallParkOrbit @@ -38,7 +39,7 @@ Call park orbits are composed of settings that specify a range of numbers at whi ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsCallParkOrbit ``` @@ -46,14 +47,14 @@ Get-CsCallParkOrbit In this example, the Get-CsCallParkOrbit cmdlet is called without specifying any additional parameters. When called like this, the Get-CsCallParkOrbit cmdlet returns a collection of all the call park orbit ranges configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsCallParkOrbit -Identity "Redmond CPO 1" ``` In Example 2, the Get-CsCallParkOrbit cmdlet is used to return information about the call park orbit range with the name "Redmond CPO 1". -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsCallParkOrbit -Filter *Redmond* ``` @@ -63,7 +64,7 @@ For example, this command will return call park orbits with identities such as " The command uses the Filter parameter with the wildcard character (*) to designate what to search for. (This search is not case sensitive.) -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsCallParkOrbit | Where-Object {$_.CallParkServiceId.toString() -eq "ApplicationServer:pool0.litwareinc.com"} ``` @@ -75,7 +76,7 @@ Notice that we add the toString method to the end of the CallParkServiceId param The CallParkServiceId is of type WritableServiceId. In order to compare that value to the supplied string, we must first turn it into a string by calling the toString method. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsCallParkOrbit | Where-Object {$_.NumberRangeStart.StartsWith("*")} ``` @@ -85,7 +86,7 @@ After the Get-CsCallParkOrbit cmdlet retrieves a collection of all the call park The Where-Object cmdlet narrows the collection to only those call park orbit ranges that have a call park location starting with a *. It does this by checking the StartsWith property of the NumberRangeStart object for the string "*". -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsCallParkOrbit | Where-Object {[Char]::IsDigit($_.NumberRangeStart[0])} ``` @@ -101,48 +102,54 @@ If it is, the call park orbit information for the corresponding collection item ## PARAMETERS -### -Identity -The unique name of the call park orbit range. -This name was assigned by the administrator when the call park orbit range was defined. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter accepts a wildcard string and returns all call park orbit ranges with identities matching that string. +For example, a Filter value of Redmond* will return all call park orbit ranges with names beginning with the string Redmond, such as Redmond 1, Redmond 2, RedmondCPO, etc. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -This parameter accepts a wildcard string and returns all call park orbit ranges with identities matching that string. -For example, a Filter value of Redmond* will return all call park orbit ranges with names beginning with the string Redmond, such as Redmond 1, Redmond 2, RedmondCPO, etc. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique name of the call park orbit range. +This name was assigned by the administrator when the call park orbit range was defined. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the call park orbit information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -152,13 +159,16 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the type of call park orbit to be retrieved. Skype for Business Server 2015 allows for two different types of call park orbits: -- CallPark: +- CallPark: This is the standard call park orbit, in which a user places a call on hold and then can retrieve that call from any phone by dialing the specified call park number. -- GroupPickup: +- GroupPickup: With group pickup, users can answer any incoming call that is made to any member of their call pickup group. Call pickup groups are configured by administrators. @@ -173,8 +183,7 @@ This parameter was introduced in Lync Server 2013. ```yaml Type: OrbitType Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsCallViaWorkPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsCallViaWorkPolicy.md similarity index 88% rename from skype/skype-ps/skype/Get-CsCallViaWorkPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsCallViaWorkPolicy.md index 5bf6b230bd..c45e422c97 100644 --- a/skype/skype-ps/skype/Get-CsCallViaWorkPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCallViaWorkPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cscallviaworkpolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsCallViaWorkPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cscallviaworkpolicy +schema: 2.0.0 +title: Get-CsCallViaWorkPolicy --- # Get-CsCallViaWorkPolicy @@ -35,7 +36,7 @@ Use the Get-CsCallViaWorkPolicy cmdlet to return call via work policies. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsCallViaWorkPolicy -Identity Site:Redmond ``` @@ -47,6 +48,9 @@ This example returns the properties of the policy currently assigned to the Redm ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters when indicating the policy (or policies) to be returned. For example, to return all the policies configured at the site scope use this syntax: -Filter "site:\*". To return a collection of all the per-user policies, use this syntax: -Filter "tag:\*" @@ -54,8 +58,7 @@ To return a collection of all the per-user policies, use this syntax: -Filter "t ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -65,6 +68,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the identity of the policy to be returned. Call via work policies can be returned at the global, site, or per-user scope. @@ -77,8 +83,7 @@ Per-user syntax: -Identity CallviaWorkStandard ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -88,13 +93,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the call via work policy data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -104,13 +111,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsCdrConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsCdrConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Get-CsCdrConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsCdrConfiguration.md index 2b953208c4..2a16c870ab 100644 --- a/skype/skype-ps/skype/Get-CsCdrConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCdrConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cscdrconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsCdrConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cscdrconfiguration +schema: 2.0.0 +title: Get-CsCdrConfiguration --- # Get-CsCdrConfiguration @@ -46,21 +47,21 @@ The Get-CsCdrConfiguration cmdlet provides a way for you return detailed informa ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsCdrConfiguration ``` This example uses the Get-CsCdrConfiguration cmdlet to return a collection of all the CDR settings configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsCdrConfiguration -Identity site:Redmond ``` Example 2 uses the Identity parameter to return a single collection of CDR settings: the settings with the Identity site:Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsCdrConfiguration -Filter site:* ``` @@ -69,7 +70,7 @@ In Example 3, the Filter parameter is employed to return all the CDR settings th The filter value "site:*" returns all the CDR settings that have an Identity that begins with the string value "site:". By definition, those are settings that have been configured at the site scope. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsCdrConfiguration | Where-Object {$_.KeepCallDetailForDays -lt 30} ``` @@ -81,7 +82,30 @@ That collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters in order to return a collection of CDR configuration settings. +For example, to return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. +To return a collection of all the settings that have the string value "Western" somewhere in their Identity, use this syntax: -Filter *Western*. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the unique identifier for the collection of CDR configuration settings you want to return. To refer to the global settings, use this syntax: -Identity global. To refer to a collection configured at the site scope, use syntax similar to this: -Identity site:Redmond. @@ -93,8 +117,7 @@ If this parameter is not specified then the Get-CsCdrConfiguration cmdlet return ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -103,32 +126,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters in order to return a collection of CDR configuration settings. -For example, to return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. -To return a collection of all the settings that have the string value "Western" somewhere in their Identity, use this syntax: -Filter *Western*. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the CDR configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsCertificate.md b/skype/skype-ps/SkypeForBusiness/Get-CsCertificate.md similarity index 89% rename from skype/skype-ps/skype/Get-CsCertificate.md rename to skype/skype-ps/SkypeForBusiness/Get-CsCertificate.md index 99a8ec2704..a5ce49063b 100644 --- a/skype/skype-ps/skype/Get-CsCertificate.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCertificate.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cscertificate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsCertificate -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cscertificate +schema: 2.0.0 +title: Get-CsCertificate --- # Get-CsCertificate @@ -35,7 +36,7 @@ If a certificate has not been configured for use with Skype for Business Server ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsCertificate ``` @@ -43,7 +44,7 @@ Get-CsCertificate The command shown in Example 1 returns information about the certificates currently assigned to Skype for Business Server components. This is done by calling the Get-CsCertificate cmdlet without any additional parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsCertificate -Type WebServicesInternal ``` @@ -51,7 +52,7 @@ Get-CsCertificate -Type WebServicesInternal Example 2 retrieves all the Skype for Business Server certificates used for internal Web services. To do this, the Type parameter is included, along with the parameter value WebServicesInternal. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsCertificate | Where-Object {$_.NotAfter -lt "9/1/2018"} ``` @@ -63,7 +64,7 @@ The date specified in this example (9/1/2018) uses the U.S. English format for date-time values. Dates should be specified using a format compatible with your Regional and Language Options. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsCertificate | Where-Object {$_.Issuer -eq "Cn=MyCa"} ``` @@ -72,7 +73,7 @@ Example 4 returns information about all the Skype for Business Server certificat To do this, the command first calls the Get-CsCertificate cmdlet without any parameters in order to return a collection of all the certificates currently in use. This collection is then piped to the Where-Object cmdlet, which picks out all the certificates where the Issuer property is equal to (-eq) "Cn=MyCa". -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsCertificate | Where-Object {$_.Subject -eq "CN=atl-cs-001.litwareinc.com"} ``` @@ -84,55 +85,38 @@ In turn, the Where-Object cmdlet selects only those certificates where the Subje ## PARAMETERS -### -Type -Type of certificate being requested. -Certificate types include, but are not limited to, the following: - -- AccessEdgeExternal -- AudioVideoAuthentication -- DataEdgeExternal -- Default -- External -- Internal -- iPhoneAPNService -- iPadAPNService -- MPNService -- PICWebService (Skype for Business Online only) -- ProvisionService (Skype for Business Online only) -- WebServicesExternal -- WebServicesInternal -- WsFedTokenTransfer +### -Identity -For example, this syntax returns information about the Default certificate: +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-Type Default` - -You can specify multiple types in a single command by separating the certificate types with commas: +Enables you to retrieve certificates configured at the global scope (global certificates are copied and distributed to the appropriate computers). +Use this syntax to return information about the global certificates: -`-Type Internal,External,Default` +`Get-CsCertificate -Identity "global"` ```yaml -Type: CertType[] +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -NetportId + +> Applicable: Lync Server 2010 + Reserved for future use. This parameter is for certificates dedicated to a specific port, a scenario not yet supported by Lync Server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010 +Aliases: Required: False Position: Named @@ -142,6 +126,9 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to record detailed information about the procedures carried out by the Get-CsCertificate cmdlet. The parameter value should be the full path to the HTML file that will be generated; for example: -Report C:\Logs\Certificates.html. If the specified file already exists, it will automatically be overwritten with the new information. @@ -149,8 +136,7 @@ If the specified file already exists, it will automatically be overwritten with ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -159,20 +145,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Enables you to retrieve certificates configured at the global scope (global certificates are copied and distributed to the appropriate computers). -Use this syntax to return information about the global certificates: +### -Type -`Get-CsCertificate -Identity "global"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of certificate being requested. +Certificate types include, but are not limited to, the following: + +- AccessEdgeExternal +- AudioVideoAuthentication +- DataEdgeExternal +- Default +- External +- Internal +- iPhoneAPNService +- iPadAPNService +- MPNService +- PICWebService (Skype for Business Online only) +- ProvisionService (Skype for Business Online only) +- WebServicesExternal +- WebServicesInternal +- WsFedTokenTransfer + +For example, this syntax returns information about the Default certificate: + +`-Type Default` + +You can specify multiple types in a single command by separating the certificate types with commas: + +`-Type Internal,External,Default` ```yaml -Type: XdsIdentity +Type: CertType[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/skype/skype-ps/skype/Get-CsClientAccessLicense.md b/skype/skype-ps/SkypeForBusiness/Get-CsClientAccessLicense.md similarity index 90% rename from skype/skype-ps/skype/Get-CsClientAccessLicense.md rename to skype/skype-ps/SkypeForBusiness/Get-CsClientAccessLicense.md index ca9a1a2205..de7c82fddf 100644 --- a/skype/skype-ps/skype/Get-CsClientAccessLicense.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClientAccessLicense.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csclientaccesslicense applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsClientAccessLicense -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csclientaccesslicense +schema: 2.0.0 +title: Get-CsClientAccessLicense --- # Get-CsClientAccessLicense @@ -55,7 +56,7 @@ The functions carried out by the Get-CsClientAccessLicense cmdlet are not availa ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsClientAccessLicense -MonitoringDatabase "atl-sql-001\Archinst" -LicenseName "Standard" -LicenseBasedType "UserBased" -StartDate "6/1/2018" ``` @@ -66,7 +67,53 @@ License usage information will be returned for the time period beginning on June ## PARAMETERS +### -DailyUsage + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If specified, license usage is broken down on a day-by-day basis for the specified time period. +If not specified, then license usage is summarized for the specified time period. + +```yaml +Type: SwitchParameter +Parameter Sets: DefaultSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EndDate + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Ending date for the time period for which client license usage should be checked. +For example: + +`-EndDate "2/1/2018"` + +The EndDate must be later than the StartDate. +Note that the end date does not appear in the output when you call the Get-CsClientAccessLicense cmdlet. + +```yaml +Type: DateTime +Parameter Sets: DefaultSet +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -License + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns the available license names. This parameter cannot be used with any other parameters; this is the only valid syntax: @@ -75,8 +122,7 @@ This parameter cannot be used with any other parameters; this is the only valid ```yaml Type: SwitchParameter Parameter Sets: LicenseSet -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -86,6 +132,9 @@ Accept wildcard characters: False ``` ### -LicenseBasedType + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the license is UserBased or DeviceBased. With UserBased licenses, each user who accesses Skype for Business Server is required to have a client access license, regardless of the number of devices he or she uses to access Skype for Business Server. With DeviceBased licenses, each device used to access Skype for Business Server requires a separate license. @@ -96,8 +145,7 @@ Device-based licensing is aimed at on-site users who typically access Skype for ```yaml Type: String Parameter Sets: DefaultSet -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -107,6 +155,9 @@ Accept wildcard characters: False ``` ### -LicenseName + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the kind of license being retrieved. Valid values are: @@ -117,8 +168,7 @@ Valid values are: ```yaml Type: String Parameter Sets: DefaultSet -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -128,6 +178,9 @@ Accept wildcard characters: False ``` ### -MonitoringDatabase + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SQL Server instance for the monitoring database. This is typically specified by using the fully qualified domain name of the SQL Server computer and SQL Server instance of the monitoring database. For example: @@ -141,8 +194,7 @@ If the monitoring database is in the default SQL Server instance then you only n ```yaml Type: String Parameter Sets: DefaultSet -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -152,6 +204,9 @@ Accept wildcard characters: False ``` ### -StartDate + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Beginning date for the time period for which client license usage should be checked. For example, using the US English format the StartDate parameter might look like this: @@ -162,8 +217,7 @@ The StartDate must be earlier than the EndDate. ```yaml Type: DateTime Parameter Sets: DefaultSet -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -172,45 +226,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DailyUsage -If specified, license usage is broken down on a day-by-day basis for the specified time period. -If not specified, then license usage is summarized for the specified time period. - -```yaml -Type: SwitchParameter -Parameter Sets: DefaultSet -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDate -Ending date for the time period for which client license usage should be checked. -For example: - -`-EndDate "2/1/2018"` - -The EndDate must be later than the StartDate. -Note that the end date does not appear in the output when you call the Get-CsClientAccessLicense cmdlet. - -```yaml -Type: DateTime -Parameter Sets: DefaultSet -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -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). @@ -222,7 +237,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### +### System.Object The Get-CsClientAccessLicense cmdlet returns licensing information. diff --git a/skype/skype-ps/skype/Get-CsClientCertificate.md b/skype/skype-ps/SkypeForBusiness/Get-CsClientCertificate.md similarity index 91% rename from skype/skype-ps/skype/Get-CsClientCertificate.md rename to skype/skype-ps/SkypeForBusiness/Get-CsClientCertificate.md index 396563d963..cc91f49b05 100644 --- a/skype/skype-ps/skype/Get-CsClientCertificate.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClientCertificate.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csclientcertificate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsClientCertificate -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csclientcertificate +schema: 2.0.0 +title: Get-CsClientCertificate --- # Get-CsClientCertificate @@ -38,14 +39,14 @@ That means that you will not be able to run the Get-CsClientCertificate cmdlet f ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsClientCertificate -Identity "Ken Myer" ``` The command shown in Example 1 returns all the client certificates issued to Ken Myer. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClientCertificate -Identity "Ken Myer" | Where-Object {$_.ExpirationTime -lt "9/5/2018"} ``` @@ -57,7 +58,7 @@ The date specified in this example (9/5/2018) uses the U.S. English format for date-time values. Dates should be specified using a format compatible with your Regional and Language Options. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClientCertificate -Identity "Ken Myer" | Where-Object {$_.PublicationTime -gt "1/1/2018"} ``` @@ -66,7 +67,7 @@ Example 3 returns all the client certificates that have been issued to Ken Myer To accomplish this task, the command first calls the Get-CsClientCertificate cmdlet to return a collection of all the client certificates issued to Ken Myer. This collection is then piped to the Where-Object cmdlet, which selects only those certificates where the PublicationTime property is greater than January 1, 2018 (1/1/2018). -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsUser | Where-Object {$_.RegistrarPool -ne $Null} | Get-CsClientCertificate ``` @@ -81,6 +82,9 @@ This filtered collection is then piped to the Get-CsClientCertificate cmdlet, wh ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account with the certificate information you want to retrieve. User Identities can be specified by using one of four formats: 1) the user's Session Initiation Protocol (SIP) address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). You can also reference a user account by using the user's Active Directory distinguished name. @@ -90,8 +94,7 @@ Wildcards cannot be used when specifying the user Identity. ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -100,14 +103,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -116,14 +121,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsClientPinInfo.md b/skype/skype-ps/SkypeForBusiness/Get-CsClientPinInfo.md similarity index 90% rename from skype/skype-ps/skype/Get-CsClientPinInfo.md rename to skype/skype-ps/SkypeForBusiness/Get-CsClientPinInfo.md index 58a1c53bdf..e8611b2f06 100644 --- a/skype/skype-ps/skype/Get-CsClientPinInfo.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClientPinInfo.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csclientpininfo applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsClientPinInfo -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csclientpininfo +schema: 2.0.0 +title: Get-CsClientPinInfo --- # Get-CsClientPinInfo @@ -40,7 +41,7 @@ That means that you will not be able to run the Get-CsClientPinInfo cmdlet from ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsUser | Get-CsClientPinInfo ``` @@ -49,14 +50,14 @@ Example 1 returns PIN information for all the users who have been enabled for Sk To do this, the command first calls the Get-CsUser cmdlet to return all users who have been enabled for Skype for Business Server. That collection is piped to the Get-CsClientPinInfo cmdlet, which displays PIN information for each user in the collection. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClientPinInfo -Identity "litwareinc\kenmyer" ``` In Example 2, the Get-CsClientPinInfo cmdlet is used to display PIN information for a single user: the user with the Identity litwareinc\kenmyer. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsUser -OU "OU=Finance,DC=litwareinc,DC=com" | Get-CsClientPinInfo ``` @@ -65,7 +66,7 @@ Example 3 returns PIN information for all the users with accounts in the Finance To do this, the Get-CsUser cmdlet and the OU parameter are used to return a collection of all the users in the Finance OU. That collection is then piped to the Get-CsClientPinInfo cmdlet, which displays PIN information for each user in the collection. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsUser -LdapFilter "Title=Manager" | Get-CsClientPinInfo ``` @@ -78,6 +79,9 @@ The Get-CsClientPinInfo cmdlet is then used to display PIN information for each ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account for which the PIN should be locked. User Identities can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). You can also reference a user account by using the user's Active Directory distinguished name. @@ -88,8 +92,7 @@ For example, the Identity "* Smith" returns all the users who have a display nam ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -98,14 +101,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -114,14 +119,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsClientPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsClientPolicy.md similarity index 87% rename from skype/skype-ps/skype/Get-CsClientPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsClientPolicy.md index 43174d771f..c5454eb694 100644 --- a/skype/skype-ps/skype/Get-CsClientPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClientPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csclientpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsClientPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-csclientpolicy +schema: 2.0.0 +title: Get-CsClientPolicy --- # Get-CsClientPolicy @@ -41,7 +43,7 @@ The Get-CsClientPolicy cmdlet enables you to return information about all the cl ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsClientPolicy ``` @@ -49,7 +51,7 @@ Get-CsClientPolicy In Example 1, Get-CsClientPolicy is called without any additional parameters; this returns a collection of all the client policies configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClientPolicy -Identity SalesPolicy ``` @@ -57,7 +59,7 @@ Get-CsClientPolicy -Identity SalesPolicy In Example 2, Get-CsClientPolicy is used to return the per-user client policy that has an Identity SalesPolicy. Because identities are unique, this command will never return more than one item. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClientPolicy -Filter "tag:*" ``` @@ -65,7 +67,7 @@ Get-CsClientPolicy -Filter "tag:*" Example 3 uses the Filter parameter to return all the client policies that have been configured at the per-user scope. The filter value "tag:*" tells Get-CsClientPolicy to return only those policies that have an Identity that begins with the string value "tag:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsClientPolicy | Where-Object {$_.DisableSavingIM -eq $True} ``` @@ -74,7 +76,7 @@ The preceding command returns a collection of all the client policies where the To do this, Get-CsClientPolicy is first called without any parameters in order to return a collection of all the client policies configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those policies where the DisableSavingIM property is equal to True. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsClientPolicy | Where-Object {$_.DisableSavingIM -eq $True -and $_.EnableIMAutoArchiving -eq $False} ``` @@ -84,7 +86,7 @@ To do this, the command first calls Get-CsClientPolicy in order to return a coll That collection is then piped to Where-Object, which picks out only those policies that meet both of the following criteria: DisableSavingIM must be equal to True and EnableIMAutoArchiving must be equal to False. The -and operator tells Where-Object that only objects that meet all the specified criteria should be selected. -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsClientPolicy | Where-Object {$_.DisableSavingIM -eq $True -or $_.EnableIMAutoArchiving -eq $False} ``` @@ -98,7 +100,30 @@ The -or operator tells Where-Object that any object that meets at least one of t ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters when indicating the policy (or policies) to be returned. +For example, to return all the policies configured at the site scope use this syntax: -Filter "site:\*". +To return a collection of all the per-user policies, use this syntax: -Filter "tag:\*". + +```yaml +Type: String +Parameter Sets: Filter, (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the client policy to be returned. To refer to the global policy, use this syntax: -Identity global. To refer to a site policy, use syntax similar to this: -Identity site:Redmond. @@ -109,8 +134,7 @@ If this parameter is omitted, then all the client policies configured for use in ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -119,32 +143,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when indicating the policy (or policies) to be returned. -For example, to return all the policies configured at the site scope use this syntax: -Filter "site:\*". -To return a collection of all the per-user policies, use this syntax: -Filter "tag:\*". - -```yaml -Type: String -Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the client policy data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -154,20 +162,22 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose client policies are being returned. -For example: +For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: `Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsClientVersionConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsClientVersionConfiguration.md similarity index 92% rename from skype/skype-ps/skype/Get-CsClientVersionConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsClientVersionConfiguration.md index 62a9a4f591..56cf81f7db 100644 --- a/skype/skype-ps/skype/Get-CsClientVersionConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClientVersionConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csclientversionconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsClientVersionConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csclientversionconfiguration +schema: 2.0.0 +title: Get-CsClientVersionConfiguration --- # Get-CsClientVersionConfiguration @@ -55,7 +56,7 @@ The technology relies on self-reporting from client applications, and does not a ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsClientVersionConfiguration ``` @@ -63,7 +64,7 @@ Get-CsClientVersionConfiguration In the first example, the Get-CsClientVersionConfiguration cmdlet is called without specifying any additional parameters. This causes the Get-CsClientVersionConfiguration cmdlet to return a collection of all the client version configuration settings currently in use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClientVersionConfiguration -Identity site:Redmond ``` @@ -71,7 +72,7 @@ Get-CsClientVersionConfiguration -Identity site:Redmond In this example, the Get-CsClientVersionConfiguration cmdlet returns all the client version configuration settings that have the Identity site:Redmond. Because Identities must be unique, this command will never return more than one item. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClientVersionConfiguration -Filter "site:*" ``` @@ -80,7 +81,7 @@ Example 3 returns all the client version configuration settings that have been a This is done by including the Filter parameter and the filter value "site:*". That filter value instructs the Get-CsClientVersionConfiguration cmdlet to return only the settings that have an Identity that begins with the string value "site:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsClientVersionConfiguration | Where-Object {$_.Enabled -eq $False} ``` @@ -93,7 +94,30 @@ This collection is then piped to the Where-Object cmdlet, which applies a filter ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters in order to return a collection (or collections) of client version configuration settings. +To return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. +To return a collection of all the settings that have the string value "EMEA" somewhere in their Identity (the only property you can filter for) use this syntax: -Filter *EMEA*. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the unique identifier for the collection of client version configuration settings you want to return. To refer to the global settings, use this syntax: -Identity global. To refer to a collection configured at the site scope, use syntax similar to this: -Identity site:Redmond. @@ -105,8 +129,7 @@ If this parameter is not specified then the Get-CsClientVersionConfiguration cmd ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -115,32 +138,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters in order to return a collection (or collections) of client version configuration settings. -To return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. -To return a collection of all the settings that have the string value "EMEA" somewhere in their Identity (the only property you can filter for) use this syntax: -Filter *EMEA*. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the client version configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsClientVersionPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsClientVersionPolicy.md similarity index 91% rename from skype/skype-ps/skype/Get-CsClientVersionPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsClientVersionPolicy.md index 79e4188c89..ddaeb4af53 100644 --- a/skype/skype-ps/skype/Get-CsClientVersionPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClientVersionPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csclientversionpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsClientVersionPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csclientversionpolicy +schema: 2.0.0 +title: Get-CsClientVersionPolicy --- # Get-CsClientVersionPolicy @@ -51,7 +52,7 @@ Client version policies enforced in your organization do not override the client ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsClientVersionPolicy ``` @@ -59,7 +60,7 @@ Get-CsClientVersionPolicy In the first example, the Get-CsClientVersionPolicy cmdlet is called without specifying any additional parameters. This causes the Get-CsClientVersionPolicy cmdlet to return a collection of all the client version policies configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClientVersionPolicy -Identity site:Redmond ``` @@ -67,7 +68,7 @@ Get-CsClientVersionPolicy -Identity site:Redmond In Example 2, the Get-CsClientVersionPolicy cmdlet returns all the client version policies that have the Identity site:Redmond. Because Identities must be unique, this command will never return more than one item. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClientVersionPolicy -Filter site:* ``` @@ -75,7 +76,7 @@ Get-CsClientVersionPolicy -Filter site:* Example 3 returns all the client version policies that have been configured at the site scope. This is done by including the Filter parameter and the filter value "site:*"; that value instructs the Get-CsClientVersionPolicy cmdlet to return only those policies that have an Identity beginning with the string value "site:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsClientVersionPolicy | Select-Object -ExpandProperty Rules ``` @@ -88,7 +89,32 @@ When this property is expanded, detailed information about each rule (including ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards when specifying the policy (or policies) to be retrieved. +For example, this syntax returns all the policies that have been configured at the site scope: -Filter "site:*". +This syntax returns all the policies that have been configured at the per-user scope: -Filter "tag:*". + +You cannot use both the Filter and the Identity parameters in the same command. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the policy to be returned. To return the global policy, use this syntax: -Identity global. To return a policy configured at the site scope, use syntax similar to this: -Identity "site:Redmond". @@ -103,8 +129,7 @@ If this parameter is not included then all of the client version policies config ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -113,34 +138,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the policy (or policies) to be retrieved. -For example, this syntax returns all the policies that have been configured at the site scope: -Filter "site:*". -This syntax returns all the policies that have been configured at the per-user scope: -Filter "tag:*". - -You cannot use both the Filter and the Identity parameters in the same command. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the client version policy data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,6 +157,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose client version policies are being returned. For example: @@ -162,8 +172,7 @@ You can return the tenant ID for each of your Skype for Business Online tenants ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsClientVersionPolicyRule.md b/skype/skype-ps/SkypeForBusiness/Get-CsClientVersionPolicyRule.md similarity index 90% rename from skype/skype-ps/skype/Get-CsClientVersionPolicyRule.md rename to skype/skype-ps/SkypeForBusiness/Get-CsClientVersionPolicyRule.md index 88381a0d58..7bb962de56 100644 --- a/skype/skype-ps/skype/Get-CsClientVersionPolicyRule.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClientVersionPolicyRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csclientversionpolicyrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsClientVersionPolicyRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csclientversionpolicyrule +schema: 2.0.0 +title: Get-CsClientVersionPolicyRule --- # Get-CsClientVersionPolicyRule @@ -38,21 +39,21 @@ Before the user can log on to Skype for Business Server, the system will check t If a rule exists, Skype for Business Server will then take the action specified by the rule. That action must be one of the following: -- Allow: +- Allow: The user will be allowed to log on. -- AllowAndUpgrade: +- AllowAndUpgrade: The user will be allowed to log on, and his or her copy of Communicator 2007 R2 will automatically be upgraded to the latest version of Skype for Business. Upgrades are carried out using either Microsoft Update or Windows Server Update Services, depending on how you have configured your system. -- AllowWithUrl: +- AllowWithUrl: The user will be allowed to log on, and a message will be displayed pointing the user to a URL where the latest version of Skype for Business can be downloaded and installed. The URL must point to a website that you have created yourself; no such site is created for you when you install Skype for Business Server. -- Block: +- Block: The user will not be allowed to log on. -- BlockAndUpgrade: +- BlockAndUpgrade: The user will not be allowed to log on, but his or her copy of Communicator 2007 R2 will automatically be upgraded to the latest version of Skype for Business. The user can then try to log on by using the new client application. Upgrades are carried out using either Microsoft Update or Windows Server Update Services, depending on how you have configured your system. -- BlockWithUrl: +- BlockWithUrl: The user will not be allowed to log on, but a message will be displayed pointing him or her to a URL where the latest version of Skype for Business can be downloaded and installed. The URL must point to a website that you have created yourself; no such site is created for you when you install Skype for Business Server. @@ -69,21 +70,21 @@ Client version policies enforced in your organization do not override the client ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsClientVersionPolicyRule ``` Example 1 returns information about all of the client version policy rules currently in use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClientVersionPolicyRule -Identity "Global/2336c611-a243-4c5d-994b-eea8a524d0e4" ``` In Example 2, information about a single client version policy rule is returned: the rule with the Identity Global/2336c611-a243-4c5d-994b-eea8a524d0e4. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClientVersionPolicyRule -Filter "Global/*" ``` @@ -92,7 +93,7 @@ Example 3 returns all the client version policy rules that have been configured To do this, the command uses the Filter parameter and the filter value "Global/*". That filter value returns only those rules that have an Identity that begins with the string value "Global/". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsClientVersionPolicyRule | Where-Object {$_.Enabled -eq $False} ``` @@ -101,7 +102,7 @@ The command shown in Example 4 returns all the client version policy rules that To do this, the command first calls the Get-CsClientVersionPolicy cmdlet in order to return a collection of all the available client policy rules. This collection is then piped to the Where-Object cmdlet, which picks out the rules where the Enabled property is equal to False. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsClientVersionPolicyRule | Where-Object {$_.Action -eq "Block"} ``` @@ -114,56 +115,62 @@ This collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS -### -Identity -Unique identifier for the client version policy rule to be retrieved. -The Identity of a client version rule consists of the scope where the rule has been configured plus a globally unique identifier (GUID). -That means that a rule will have an Identity similar to this: site:Redmond/1987d3c2-4544-489d-bbe3-59f79f530a83. -Because GUIDs are difficult to remember and to work with, the Examples section in this Help topic lists alternate ways that you can identify the rules to be returned. +### -Filter -If this parameter is not specified all of the client version policy rules configured for use will be returned. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters when specifying the client version policy rules to be returned. +For example, to return all the rules configured for the Redmond site, use this syntax: + +`-Filter "site:Redmond/*"` + +You cannot use both the Filter and the Identity parameters in the same command. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when specifying the client version policy rules to be returned. -For example, to return all the rules configured for the Redmond site, use this syntax: +### -Identity -`-Filter "site:Redmond/*"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You cannot use both the Filter and the Identity parameters in the same command. +Unique identifier for the client version policy rule to be retrieved. +The Identity of a client version rule consists of the scope where the rule has been configured plus a globally unique identifier (GUID). +That means that a rule will have an Identity similar to this: site:Redmond/1987d3c2-4544-489d-bbe3-59f79f530a83. +Because GUIDs are difficult to remember and to work with, the Examples section in this Help topic lists alternate ways that you can identify the rules to be returned. + +If this parameter is not specified all of the client version policy rules configured for use will be returned. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the client version policy rule data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -173,6 +180,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose client version policy rules are being returned. For example: @@ -185,8 +195,7 @@ You can return the tenant ID for each of your Skype for Business Online tenants ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsCloudCallDataConnector.md b/skype/skype-ps/SkypeForBusiness/Get-CsCloudCallDataConnector.md similarity index 95% rename from skype/skype-ps/skype/Get-CsCloudCallDataConnector.md rename to skype/skype-ps/SkypeForBusiness/Get-CsCloudCallDataConnector.md index 9908ff7acb..6384869d65 100644 --- a/skype/skype-ps/skype/Get-CsCloudCallDataConnector.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCloudCallDataConnector.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cscloudcalldataconnector applicable: Skype for Business Server 2019 -title: Get-CsCloudCallDataConnector -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cscloudcalldataconnector +schema: 2.0.0 +title: Get-CsCloudCallDataConnector --- # Get-CsCloudCallDataConnector @@ -38,13 +39,15 @@ This example returns the CloudCallDataConnector settings stored on-premises. Not ## PARAMETERS ### -LocalStore + +> Applicable: Skype for Business Server 2019 + Retrieves the Call Data Connector data from the local replica of the Central Management store, rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None diff --git a/skype/skype-ps/skype/Get-CsCloudCallDataConnectorConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsCloudCallDataConnectorConfiguration.md similarity index 96% rename from skype/skype-ps/skype/Get-CsCloudCallDataConnectorConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsCloudCallDataConnectorConfiguration.md index 2e03619361..09f31f994c 100644 --- a/skype/skype-ps/skype/Get-CsCloudCallDataConnectorConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCloudCallDataConnectorConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cscloudcalldataconnectorconfiguration applicable: Skype for Business Server 2019 -title: Get-CsCloudCallDataConnectorConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cscloudcalldataconnectorconfiguration +schema: 2.0.0 +title: Get-CsCloudCallDataConnectorConfiguration --- # Get-CsCloudCallDataConnectorConfiguration @@ -69,6 +70,9 @@ That collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2019 + Enables you to use wildcard characters to return a collection of CloudCallDataConnector configuration settings. For example, to return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. To return a collection of all the settings that have the string value "Western" somewhere in their Identity, use this syntax: -Filter Western . @@ -77,7 +81,6 @@ To return a collection of all the settings that have the string value "Western" Type: String Parameter Sets: Filter Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -86,6 +89,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2019 + Indicates the unique identifier for the collection of CloudCallDataConnector configuration settings you want to return. To refer to the global settings, use this syntax: -Identity global. To refer to a collection configured at the site scope, use syntax similar to this: -Identity site:Redmond. @@ -98,7 +104,6 @@ If this parameter is not specified, the Get-CsCloudCallDataConnectorConfiguratio Type: XdsIdentity Parameter Sets: Identity Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: 1 Default value: None @@ -107,13 +112,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2019 + Retrieves the CloudCallDataConnector configuration data from the local replica of the Central Management store, rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None diff --git a/skype/skype-ps/skype/Get-CsCloudMeetingPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsCloudMeetingPolicy.md similarity index 89% rename from skype/skype-ps/skype/Get-CsCloudMeetingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsCloudMeetingPolicy.md index 0cec065b8a..622d027149 100644 --- a/skype/skype-ps/skype/Get-CsCloudMeetingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCloudMeetingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cscloudmeetingpolicy applicable: Skype for Business Online -title: Get-CsCloudMeetingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/get-cscloudmeetingpolicy +schema: 2.0.0 +title: Get-CsCloudMeetingPolicy --- # Get-CsCloudMeetingPolicy @@ -31,14 +33,14 @@ Get-CsCloudMeetingPolicy [-Tenant ] [-Filter ] [-LocalStore] [ Applicable: Skype for Business Online + @{Text=} ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -67,16 +71,18 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + Specifies the identity of the hybrid public switched telephone network (PSTN) site. -For example: +For example: `-Identity "SeattlePSTN"` ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 2 @@ -86,13 +92,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Online + Retrieves the information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -102,12 +110,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. -For example: +For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` -You can find your tenant ID by running this command: +You can find your tenant ID by running this command: `Get-CsTenant | Select-Object DisplayName, TenantID` @@ -118,8 +129,7 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsClsAgentStatus.md b/skype/skype-ps/SkypeForBusiness/Get-CsClsAgentStatus.md similarity index 86% rename from skype/skype-ps/skype/Get-CsClsAgentStatus.md rename to skype/skype-ps/SkypeForBusiness/Get-CsClsAgentStatus.md index cf595df96b..0a4d096971 100644 --- a/skype/skype-ps/skype/Get-CsClsAgentStatus.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClsAgentStatus.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csclsagentstatus applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsClsAgentStatus -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csclsagentstatus +schema: 2.0.0 +title: Get-CsClsAgentStatus --- # Get-CsClsAgentStatus @@ -26,7 +27,7 @@ The Get-CsClsAgentStatus cmdlet returns information about the ClsAgent, includin ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsClsAgentStatus ``` @@ -35,7 +36,7 @@ Returns information about the ClsAgent service on the local machine. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClsAgentStatus -DefaultXml ``` @@ -47,14 +48,16 @@ Returns the default.xml file as an XmlDocument object. ## PARAMETERS ### -CacheFileLocalFolders + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the path to search for log files stored on disk. By default the CacheFileLocalFolders path from the Get-CsClsConfiguration cmdlet is used. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -64,13 +67,15 @@ Accept wildcard characters: False ``` ### -DefaultXml + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + If specified, the cmdlet will return the default.xml file as an XmlDocument object for debugging purposes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsClsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsClsConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsClsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsClsConfiguration.md index d64818736f..07fad4b30b 100644 --- a/skype/skype-ps/skype/Get-CsClsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csclsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsClsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csclsconfiguration +schema: 2.0.0 +title: Get-CsClsConfiguration --- # Get-CsClsConfiguration @@ -50,21 +51,21 @@ The functions carried out by the Get-CsClsConfiguration cmdlet are not available ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsClsConfiguration ``` The command shown in Example 1 returns information about all the centralized logging configuration settings currently in use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClsConfiguration -Identity "site:Redmond" ``` In Example 2, information is returned for a single collection of centralized logging configuration settings: the collection applied to the Redmond site. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClsConfiguration -Identity "site:Redmond" | Select-Object -ExpandProperty Scenarios ``` @@ -74,7 +75,7 @@ In order to do this, the command first retrieves all the centralized logging pro Those property values are then piped to the Select-Object cmdlet, which uses the ExpandProperty parameter to "expand" the values found in the Scenarios property. When you expand a property you simply display all the information stored in that property in an easy-to-read fashion. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsClsConfiguration | Where-Object {$_.EtlFileRolloverMinutes -gt 60} ``` @@ -83,7 +84,7 @@ In Example 4, information is returned for all the centralizing logging configura To carry out this task, the command first calls the Get-CsClsConfiguration cmdlet without any parameters; this returns a collection of all the centralized logging configuration settings in the organization. That collection is then piped to the Where-Object cmdlet, which picks out only those settings where the EtlFileRolloverMinutes property is greater than (-gt) 60 minutes. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsClsConfiguration | Where-Object {$_.Scenarios.Name -match "HybridVoice"} ``` @@ -96,6 +97,9 @@ That collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return a collection (or collections) of centralized logging configuration settings. For example, to return a collection of all the settings configured at the site scope, use this syntax: @@ -104,8 +108,7 @@ For example, to return a collection of all the settings configured at the site s ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -115,6 +118,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the unique identifier for the collection of centralized logging configuration settings you want to return. To refer to the global settings use this syntax: @@ -132,8 +138,7 @@ If this parameter is not specified, then the Get-CsClsConfiguration cmdlet retur ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -143,13 +148,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the centralized logging configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsClsRegion.md b/skype/skype-ps/SkypeForBusiness/Get-CsClsRegion.md similarity index 90% rename from skype/skype-ps/skype/Get-CsClsRegion.md rename to skype/skype-ps/SkypeForBusiness/Get-CsClsRegion.md index 2fbc717fd3..cc64c832df 100644 --- a/skype/skype-ps/skype/Get-CsClsRegion.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClsRegion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csclsregion applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsClsRegion -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csclsregion +schema: 2.0.0 +title: Get-CsClsRegion --- # Get-CsClsRegion @@ -45,21 +46,21 @@ The functions carried out by the Get-CsClsRegion cmdlet are not available in the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsClsRegion ``` The command shown in Example 1 returns information for all the centralized logging regions configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClsRegion -Identity "global/US" ``` In Example 2, information is returned only for the centralized logging region that has the Identity global/US. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClsRegion -Filter "global/*" ``` @@ -67,7 +68,7 @@ Get-CsClsRegion -Filter "global/*" Example 3 returns information about all the centralized logging regions configured at the global scope. This is done by calling the Get-CsClsRegion cmdlet along with the Filter parameter; the filter value "global/*" limits the returned data to regions configured at the global scope. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsClsRegion | Where-Object {$_.OtherRegionAccess -match "Europe"} ``` @@ -80,6 +81,9 @@ This collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return a centralized logging region (or regions). For example, to return a collection of all the settings configured at the global scope, use this syntax: @@ -88,8 +92,7 @@ For example, to return a collection of all the settings configured at the global ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the centralized logging region to be returned. A region identity consists of the scope where the region was created followed by the region name. For example, to return a region named US created at the global scope, use the following syntax: @@ -110,8 +116,7 @@ If this parameter is not specified then the Get-CsClsRegion cmdlet returns infor ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -121,13 +126,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the centralized logging configuration data from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsClsScenario.md b/skype/skype-ps/SkypeForBusiness/Get-CsClsScenario.md similarity index 91% rename from skype/skype-ps/skype/Get-CsClsScenario.md rename to skype/skype-ps/SkypeForBusiness/Get-CsClsScenario.md index b6d5b31459..52531b94bb 100644 --- a/skype/skype-ps/skype/Get-CsClsScenario.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClsScenario.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csclsscenario applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsClsScenario -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csclsscenario +schema: 2.0.0 +title: Get-CsClsScenario --- # Get-CsClsScenario @@ -46,21 +47,21 @@ The functions carried out by the Get-CsClsScenario cmdlet are not available in t ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsClsScenario ``` The command shown in Example 1 returns information about all the centralized logging scenarios currently in use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClsScenario -Identity "global/VoiceMail" ``` Example 2 returns information about a single centralized logging scenario: the VoiceMail scenario included in the global settings collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClsScenario | Where-Object {$_.Provider.Name -match "AsMcu"} ``` @@ -69,7 +70,7 @@ Example 3 returns information about all the default scenarios currently in use. To do this, the command first calls the Get-CsClsScenario cmdlet without any parameters; that returns a collection of all the available scenarios. That collection is then piped to the Where-Object cmdlet, which picks out only those scenarios that contain (-match) a Provider named "AsMcu". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsClsScenario -Identity "global/VoiceMail" | Select-Object -ExpandProperty Provider ``` @@ -83,6 +84,9 @@ In turn, that causes all the data stored in the Provider property to be displaye ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcards in order to return one or scenarios. For example, to return all the HybridVoice scenarios, regardless of the scope where these scenarios have been configured, use this syntax: @@ -93,8 +97,7 @@ You cannot use both the Identity parameter and the Filter parameter in the same ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -104,6 +107,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the scenario to be returned. A scenario consists of two parts: the scope where the scenario is configured (that is, the collection of centralized logging configuration settings where the scenario can be found) and the scenario name. For example: @@ -121,8 +127,7 @@ If this parameter is not specified then the Get-CsClsScenario cmdlet will return ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -132,13 +137,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the scenario data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsClsSearchTerm.md b/skype/skype-ps/SkypeForBusiness/Get-CsClsSearchTerm.md similarity index 91% rename from skype/skype-ps/skype/Get-CsClsSearchTerm.md rename to skype/skype-ps/SkypeForBusiness/Get-CsClsSearchTerm.md index df614416c4..04f2ac31d7 100644 --- a/skype/skype-ps/skype/Get-CsClsSearchTerm.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClsSearchTerm.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csclssearchterm applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsClsSearchTerm -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csclssearchterm +schema: 2.0.0 +title: Get-CsClsSearchTerm --- # Get-CsClsSearchTerm @@ -48,21 +49,21 @@ The functions carried out by the Get-CsClsSearchTerm cmdlet are not available in ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsClsSearchTerm ``` The command shown in Example 1 returns information about all the search terms currently in use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClsSearchTerm -Identity "global/Phone" ``` In Example 2, information is returned for a single search term: the Phone search term found in the global collection of centralized logging configuration settings. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClsSearchTerm | Where-Object {$_.Type -eq "URI"} ``` @@ -71,7 +72,7 @@ The command shown in Example 3 returns information for all the URI search terms. To do this, the command first calls the Get-CsClsSearchTerm cmdlet without any parameters; this returns a collection of all the available search terms. That collection is then piped to the Where-Object cmdlet, which picks out only those terms where the Type property is equal to (-eq) URI. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsClsSearchTerm | Where-Object {$_.Inserts -match "ItemE164"} ``` @@ -84,6 +85,9 @@ That collection is then piped to the Where-Object cmdlet, which selects any term ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcards in order to return one or search terms. For example, to return all the CallID search terms, regardless of the scope where these terms have been configured, use this syntax: @@ -94,8 +98,7 @@ You cannot use both the Identity parameter and the Filter parameter in the same ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -105,6 +108,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the search term to be returned. A search term consists of two parts: the scope where the term is configured (that is, the collection of centralized logging configuration settings where the term can be found) and the term name. For example: @@ -122,8 +128,7 @@ If this parameter is not specified then the Get-CsClsSearchTerm cmdlet will retu ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -133,13 +138,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the search term data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsClsSecurityGroup.md b/skype/skype-ps/SkypeForBusiness/Get-CsClsSecurityGroup.md similarity index 90% rename from skype/skype-ps/skype/Get-CsClsSecurityGroup.md rename to skype/skype-ps/SkypeForBusiness/Get-CsClsSecurityGroup.md index 7c79d2ab0a..3a9852a7c4 100644 --- a/skype/skype-ps/skype/Get-CsClsSecurityGroup.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsClsSecurityGroup.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csclssecuritygroup applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsClsSecurityGroup -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csclssecuritygroup +schema: 2.0.0 +title: Get-CsClsSecurityGroup --- # Get-CsClsSecurityGroup @@ -45,21 +46,21 @@ The functions carried out by the Get-CsClsSecurityGroup cmdlet are not available ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsClsSecurityGroup ``` The command shown in Example 1 returns information about all the centralized logging security groups configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClsSecurityGroup -Identity "global/HelpDesk" ``` In Example 2, information is returned for a single centralized logging security group: the group with the Identity global/helpdesk. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClsSecurityGroup -Filter "global/*" ``` @@ -67,7 +68,7 @@ Get-CsClsSecurityGroup -Filter "global/*" Example 3 returns information for all the centralized logging security groups configured at the global scope. To do this, the Filter parameter is included along with the filter value "global/*"; that filter value limits the returned data to groups configured at the global scope. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsClsSecurityGroup | Where-Object {$_.AccessLevel -eq "RedmondSupport"} ``` @@ -80,6 +81,9 @@ That collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return a centralized logging security group (or groups). For example, to return a collection of all the groups configured at the global scope, use this syntax: @@ -88,8 +92,7 @@ For example, to return a collection of all the groups configured at the global s ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -99,6 +102,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the centralized logging security group to be returned. A security group identity consists of the scope where the group was created followed by the group name. For example, to return a group named HelpDesk created at the global scope, use the following syntax: @@ -110,8 +116,7 @@ If this parameter is not specified then the Get-CsClsSecurityGroup cmdlet return ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -121,13 +126,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the centralized logging configuration data from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsCommonAreaPhone.md b/skype/skype-ps/SkypeForBusiness/Get-CsCommonAreaPhone.md similarity index 89% rename from skype/skype-ps/skype/Get-CsCommonAreaPhone.md rename to skype/skype-ps/SkypeForBusiness/Get-CsCommonAreaPhone.md index 97dc27f37a..1ee123d288 100644 --- a/skype/skype-ps/skype/Get-CsCommonAreaPhone.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCommonAreaPhone.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cscommonareaphone applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsCommonAreaPhone -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cscommonareaphone +schema: 2.0.0 +title: Get-CsCommonAreaPhone --- # Get-CsCommonAreaPhone @@ -47,7 +48,7 @@ Optional parameters provide different ways for you to filter information; for ex ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsCommonAreaPhone ``` @@ -55,7 +56,7 @@ Get-CsCommonAreaPhone The command shown in Example 1 returns information about all the common area phones configured for use in the organization. This is done by calling the Get-CsCommonAreaPhone cmdlet without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsCommonAreaPhone -Filter {DisplayName -eq "Building 14 Lobby"} ``` @@ -63,7 +64,7 @@ Get-CsCommonAreaPhone -Filter {DisplayName -eq "Building 14 Lobby"} In Example 2, the common area phone with the Active Directory display name "Building 14 Lobby" is returned. This task is carried out by including the Filter parameter and the filter value {DisplayName -eq "Building 14 Lobby"}; that filter value limits returned objects to common area phones where the DisplayName property is equal to "Building 14 Lobby". -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsCommonAreaPhone -Filter {DisplayName -like "Building 14*"} ``` @@ -72,7 +73,7 @@ Example 3 returns all the common area phones that have an Active Directory displ To do this, the Get-CsCommonAreaPhone cmdlet is called, along with the Filter parameter and the filter value {DisplayName -like "Building 14*"}. The filter value uses the -like operator and the wildcard string "Building 14*" to limit returned data to phones where the DisplayName property begins with "Building 14" (for example, "Building 14 Lobby", "Building 14 Cafeteria", etc.). -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsCommonAreaPhone -Filter {LineUri -eq "tel:+14255551234"} ``` @@ -80,7 +81,7 @@ Get-CsCommonAreaPhone -Filter {LineUri -eq "tel:+14255551234"} In Example 4, a single common area phone is returned: the phone that has a LineUri property equal to "tel:+14255551234". Because LineUris must be unique, this command will never return more than a single item. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsCommonAreaPhone -Filter {DialPlan -eq $Null} ``` @@ -89,7 +90,7 @@ The command shown in Example 5 returns information about all the common area pho This is done by using the Filter parameter and the filter value {DialPlan -eq $Null}; that limits returned data to phones where the DialPlan property is equal to a null value. If a common area phone has not explicitly been assigned a dial plan, then it automatically uses the global dial plan or, if one exists, the dial plan assigned to the site. -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsCommonAreaPhone -OU "ou=Telecommunications,dc=litwareinc,dc=com" ``` @@ -100,25 +101,10 @@ To do this, the Get-CsCommonAreaPhone cmdlet is called along with the OU paramet ## PARAMETERS -### -Identity -Unique identifier for the common area phone. -Common area phones are identified using the Active Directory distinguished name (DN) of the associated contact object. -By default, common area phones use a globally unique identifier (GUID) as their common name, which means phones will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. +### -Credential -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Credential Enables you to run the Get-CsCommonAreaPhone cmdlet under alternate credentials. This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with contact objects. @@ -128,8 +114,7 @@ For details, see the Get-Credential cmdlet help topic. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,14 +124,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to retrieve contact information. To connect to a particular domain controller, include the DomainController parameter followed by the Fully Qualified Domain Name (FQDN) of that computer (for example, atl-cs-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -156,6 +143,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on attributes specific to Skype for Business Server. For example, you can limit returned data to common area phone contact objects that have been assigned a specific voice policy, or contacts that have not been assigned a specific voice policy. @@ -164,8 +154,7 @@ The Filter parameter uses the same Windows PowerShell filtering syntax that is u ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -174,7 +163,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the common area phone. +Common area phones are identified using the Active Directory distinguished name (DN) of the associated contact object. +By default, common area phones use a globally unique identifier (GUID) as their common name, which means phones will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + ### -LdapFilter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business Server). For example, you can limit returned data to contact objects that have been assigned to a specific department or are located in a specific building. @@ -188,8 +200,7 @@ In the preceding filter, "l" (a lowercase L) represents the Active Directory att ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -199,19 +210,21 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to return contact objects from a specific Active Directory organizational unit (OU). The OU parameter returns data from both the specified OU and any of its child OUs. For example, if the Finance OU has two child OUs -- AccountsPayable and AccountsReceivable -- common area phone information will be returned from each of these OUs. -When specifying an OU, use the distinguished name of that container; for example: +When specifying an OU, use the distinguished name of that container; for example: `-OU "OU=Finance,dc=litwareinc,dc=com"` ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -221,6 +234,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the number of records returned by a command. For example, to return seven common area phones (regardless of how many common area phones are in your forest) include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which seven phones will be returned. @@ -232,8 +248,7 @@ If set to 0 the command will run, but no data will be returned. ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsComputer.md b/skype/skype-ps/SkypeForBusiness/Get-CsComputer.md similarity index 84% rename from skype/skype-ps/skype/Get-CsComputer.md rename to skype/skype-ps/SkypeForBusiness/Get-CsComputer.md index 295846eabe..093d9727ac 100644 --- a/skype/skype-ps/skype/Get-CsComputer.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsComputer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cscomputer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsComputer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cscomputer +schema: 2.0.0 +title: Get-CsComputer --- # Get-CsComputer @@ -37,14 +38,14 @@ Alternatively, you can use optional parameters such as Identity, Filter, or Pool ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsComputer ``` In Example 1 the Get-CsComputer cmdlet is used to return information about all the computers that perform service roles within your Skype for Business Server 2015 infrastructure. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsComputer -Filter "*.litwareinc.com" ``` @@ -52,14 +53,14 @@ Get-CsComputer -Filter "*.litwareinc.com" The command shown in Example 2 uses the Filter parameter to return only those service role computers that are part of the litwareinc.com domain. The wildcard string *.litwareinc.com restricts the returned information to computers that have an FQDN that ends with the string value ".litwareinc.com". -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsComputer -Identity "atl-cs-001.litwareinc.com" ``` In Example 3, the Identity parameter is used to limit the returned data to the one computer that has the FQDN atl-cs-001.litwareinc.com. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsComputer -Pool "atl-cs-001.litwareinc.com" ``` @@ -69,9 +70,31 @@ In Example 4, the Pool parameter is used to return information about all the com ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters when specifying the Identity of the computer (or computers) to be returned. +For example, this command returns information about all the computers that have an Identity that begins with the string value "atl-": -Filter "atl-*". + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of the computer to be returned. -For example: +For example: `-Identity "atl-cs-001.litwareinc.com".` @@ -80,8 +103,7 @@ If this parameter is not specified, all of the computers running Skype for Busin ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -90,15 +112,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when specifying the Identity of the computer (or computers) to be returned. -For example, this command returns information about all the computers that have an Identity that begins with the string value "atl-": -Filter "atl-*". +### -Local + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, returns information only for the local computer. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -108,30 +131,16 @@ Accept wildcard characters: False ``` ### -Pool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a Skype for Business Server pool. When you use this parameter, information about all the computers in the specified pool will be returned. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Local -When present, returns information only for the local computer. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsConferenceDirectory.md b/skype/skype-ps/SkypeForBusiness/Get-CsConferenceDirectory.md similarity index 89% rename from skype/skype-ps/skype/Get-CsConferenceDirectory.md rename to skype/skype-ps/SkypeForBusiness/Get-CsConferenceDirectory.md index aaeb78a46a..df088d1429 100644 --- a/skype/skype-ps/skype/Get-CsConferenceDirectory.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsConferenceDirectory.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csconferencedirectory applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsConferenceDirectory -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csconferencedirectory +schema: 2.0.0 +title: Get-CsConferenceDirectory --- # Get-CsConferenceDirectory @@ -42,14 +43,14 @@ The Get-CsConferenceDirectory cmdlet enables you to return information about all ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsConferenceDirectory ``` The command shown in Example 1 returns information about all the conference directories configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsConferenceDirectory -Identity 2 ``` @@ -57,7 +58,7 @@ Get-CsConferenceDirectory -Identity 2 Example 2 returns information about the conference directory with the Identity 2. Because identities must be unique this command will never return more than a single conference directory. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsConferenceDirectory | Where-Object {$_.ServiceID -match "UserServer:atl-cs-001.litwareinc.com"} ``` @@ -69,49 +70,55 @@ This collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS -### -Identity -Numeric identifier (for example, 7) of the conference directory to be returned. -If this parameter is omitted, then the Get-CsConferenceDirectory cmdlet returns information about all the conference directories in use in your organization. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards to specify the Identity of the conference directory (or directories) to be retrieved. +Because directory Identities are numeric, this parameter might be of minimal value. +However, this syntax will return all the conference directories that have an Identity that begins with the number 3: -Filter "3*". ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards to specify the Identity of the conference directory (or directories) to be retrieved. -Because directory Identities are numeric, this parameter might be of minimal value. -However, this syntax will return all the conference directories that have an Identity that begins with the number 3: -Filter "3*". +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Numeric identifier (for example, 7) of the conference directory to be returned. +If this parameter is omitted, then the Get-CsConferenceDirectory cmdlet returns information about all the conference directories in use in your organization. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the conference directory data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsConferenceDisclaimer.md b/skype/skype-ps/SkypeForBusiness/Get-CsConferenceDisclaimer.md similarity index 90% rename from skype/skype-ps/skype/Get-CsConferenceDisclaimer.md rename to skype/skype-ps/SkypeForBusiness/Get-CsConferenceDisclaimer.md index 6ce2b822e0..8514eca701 100644 --- a/skype/skype-ps/skype/Get-CsConferenceDisclaimer.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsConferenceDisclaimer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csconferencedisclaimer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsConferenceDisclaimer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csconferencedisclaimer +schema: 2.0.0 +title: Get-CsConferenceDisclaimer --- # Get-CsConferenceDisclaimer @@ -40,7 +41,7 @@ The Get-CsConferenceDisclaimer cmdlet enables you to view the body and header of ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CSConferenceDisclaimer ``` @@ -51,25 +52,10 @@ Because you are limited to a single disclaimer (configured at the global scope), ## PARAMETERS -### -Identity -Unique Identity of the conference disclaimer. -Because you can only have a single, global instance of the conference disclaimer, you do not need to specify an Identity when calling the Get-CsConferenceDisclaimer cmdlet. -You can, however, use the following syntax to reference the global disclaimer: -Identity global. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Filter -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Filter Enables you to use wildcard values when referencing a conference disclaimer. Because you can only have a single, global instance of the conference disclaimer, there is really no reason to ever use the Filter parameter. However, you can use the following syntax to reference the global disclaimer: -Filter "g*". @@ -78,8 +64,7 @@ That syntax brings back all the conference disclaimers that have an Identity tha ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -88,14 +73,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique Identity of the conference disclaimer. +Because you can only have a single, global instance of the conference disclaimer, you do not need to specify an Identity when calling the Get-CsConferenceDisclaimer cmdlet. +You can, however, use the following syntax to reference the global disclaimer: -Identity global. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the conference disclaimer data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsConferencingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsConferencingConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsConferencingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsConferencingConfiguration.md index 381a5744ae..a168b5a68b 100644 --- a/skype/skype-ps/skype/Get-CsConferencingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsConferencingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csconferencingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsConferencingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csconferencingconfiguration +schema: 2.0.0 +title: Get-CsConferencingConfiguration --- # Get-CsConferencingConfiguration @@ -48,7 +49,7 @@ The Get-CsConferencingConfiguration cmdlet provides a way for administrators to ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsConferencingConfiguration ``` @@ -56,7 +57,7 @@ Get-CsConferencingConfiguration Example 1 returns information about all the conferencing configuration settings currently in use in the organization. This is done by calling the Get-CsConferencingConfiguration cmdlet without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsConferencingConfiguration -Identity site:Redmond ``` @@ -64,7 +65,7 @@ Get-CsConferencingConfiguration -Identity site:Redmond In Example 2, conferencing configuration information is returned for the Redmond site (-Identity site:Redmond). Because Identities must be unique, this command will always return, at most, a single collection of conferencing configuration settings. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsConferencingConfiguration -Filter "site:*" ``` @@ -72,7 +73,7 @@ Get-CsConferencingConfiguration -Filter "site:*" The command shown in Example 3 returns information about all the conferencing configuration settings that have been applied at the site scope. To do this, the Get-CsConferencingConfiguration cmdlet is called along with the Filter parameter; the filter value "site:*" ensures that only settings that have an Identity that begins with the string value 'site:" are returned. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsConferencingConfiguration | Where-Object {$_.Organization -ne "Litwareinc"} ``` @@ -81,7 +82,7 @@ Example 4 returns information about all the conferencing configuration settings To carry out this task, the command first calls the Get-CsConferencingConfiguration cmdlet without any parameters; this returns a collection of all the conferencing configuration settings used in the organization. The resulting collection is then piped to the Where-Object cmdlet, which selects only those settings where the Organization property is not equal to Litwareinc. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsConferencingConfiguration | Where-Object {$_.MaxContentStorageMB -gt 100} ``` @@ -94,55 +95,61 @@ This collection is then piped to the Where-Object cmdlet, which picks out those ## PARAMETERS -### -Identity -Unique identifier for the collection of conferencing configuration settings to be retrieved. -To retrieve the global settings, use this syntax: -Identity global. -To retrieve settings configured at the site scope, use syntax similar to this: -Identity "site:Redmond". -To retrieve settings configured at the service scope, use syntax similar to this: -Identity "service:ConferencingServer:atl-cs-001.litwareinc.com". +### -Filter -If this parameter is not included, then the Get-CsConferencingConfiguration cmdlet will return all the conferencing configuration settings currently in use in your organization. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards when specifying the Identity of the conferencing configuration settings to be returned. +For example, this syntax returns all the settings configured at the site scope: -Filter "site:*". +This syntax returns all the settings configured at the service scope: -Filter "service:*". + +Note that you cannot use both the Identity and the Filter parameters in the same command. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the Identity of the conferencing configuration settings to be returned. -For example, this syntax returns all the settings configured at the site scope: -Filter "site:*". -This syntax returns all the settings configured at the service scope: -Filter "service:*". +### -Identity -Note that you cannot use both the Identity and the Filter parameters in the same command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the collection of conferencing configuration settings to be retrieved. +To retrieve the global settings, use this syntax: -Identity global. +To retrieve settings configured at the site scope, use syntax similar to this: -Identity "site:Redmond". +To retrieve settings configured at the service scope, use syntax similar to this: -Identity "service:ConferencingServer:atl-cs-001.litwareinc.com". + +If this parameter is not included, then the Get-CsConferencingConfiguration cmdlet will return all the conferencing configuration settings currently in use in your organization. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the conferencing configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsConferencingPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsConferencingPolicy.md similarity index 91% rename from skype/skype-ps/skype/Get-CsConferencingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsConferencingPolicy.md index 570ad8b1b5..6d7be65e0c 100644 --- a/skype/skype-ps/skype/Get-CsConferencingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsConferencingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csconferencingpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsConferencingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-csconferencingpolicy +schema: 2.0.0 +title: Get-CsConferencingPolicy --- # Get-CsConferencingPolicy @@ -53,7 +55,7 @@ The Get-CsConferencingPolicy cmdlet provides a way for you to return information ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsConferencingPolicy ``` @@ -61,7 +63,7 @@ Get-CsConferencingPolicy The first example returns a collection of all the conferencing policies configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsConferencingPolicy -Identity "Global" ``` @@ -69,7 +71,7 @@ Get-CsConferencingPolicy -Identity "Global" In Example 2, the Identity parameter is used to limit the retrieved information to conferencing policies that have an identity equal to Global. Because policy Identities must be unique, this command returns a single policy: the Global conferencing policy. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsConferencingPolicy -Filter "tag:*" ``` @@ -77,7 +79,7 @@ Get-CsConferencingPolicy -Filter "tag:*" Example 3 uses the Filter parameter to return a collection of all the conferencing policies that have been configured at the per-user scope. The wildcard value "tag:*" tells Windows PowerShell to limit the returned data to conferencing policies that have an identity beginning with the string value "tag:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsConferencingPolicy | Where-Object {$_.MaxMeetingSize -gt 100} ``` @@ -88,7 +90,7 @@ That collection is then piped to the Where-Object cmdlet, which applies a filter -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsConferencingPolicy | Where-Object {$_.AllowExternalUsersToSaveContent -eq $True -and $_.AllowExternalUserControl -eq $True} ``` @@ -98,7 +100,7 @@ To do this, the command calls the Get-CsConferencingPolicy cmdlet without any ad That collection is then piped to the Where-Object cmdlet, which picks out only those policies where both AllowExternalUsersToSaveContent and AllowExternalUserControl are True. The -and operator tells the Where-Object cmdlet that an object must meet all the specified criteria in order to be returned. -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsConferencingPolicy | Where-Object {$_.AllowExternalUsersToSaveContent -eq $True -or $_.AllowExternalUserControl -eq $True} ``` @@ -109,7 +111,7 @@ To do this, the command calls the Get-CsConferencingPolicy cmdlet without any ad That collection is then piped to the Where-Object cmdlet, which picks out only those policies where either AllowExternalUsersToSaveContent and/or AllowExternalUserControl are equal to True. The -or operator tells the Where-Object cmdlet that an object must meet just one of the specified criteria in order to be returned. -### -------------------------- Example 7 -------------------------- +### Example 7 ``` Get-CsConferencingPolicy -ApplicableTo "kenmyer@litwareinc.com" ``` @@ -121,31 +123,35 @@ Note that this command requires the Office 365 UsageLocation property to be conf ## PARAMETERS -### -Identity -Unique identifier for the conferencing policy to be retrieved. -Conferencing policies can be configured at the global scope or at the per-user scope. -To retrieve the global policy, use this syntax: -Identity global. -To retrieve a per-user policy use syntax similar to this: -Identity SalesConferencingPolicy. +### -ApplicableTo -If this parameter is not included, the Get-CsConferencingPolicy cmdlet will return a collection of all the conferencing policies configured for use in your organization. +> Applicable: Skype for Business Online -Note that wildcards are not allowed when specifying an Identity. -Use the Filter parameter if you need to use wildcards when specifying a conferencing policy. +Returns a list of the conferencing policies that can be assigned to the specified user. +For example, to return a collection of policies that can be assigned to the user kenmyer@litwareinc.com, use this command: + +`Get-CsConferencingPolicy -ApplicableTo "kenmyer@litwareinc.com"` + +The ApplicableTo parameter is useful because it's possible that only some of the available per-user conferencing policies can be assigned to a given user. +This is due to the fact that different licensing agreements and different country/region restrictions might limit the policies that can be assigned to a user. +For example, if Ken Myer works in China, country/region restrictions might limit his access to policies A, B, D, and E, Meanwhile, similar restrictions might limit Pilar Ackerman, who works in the United States, to policies A, B, C, and F. +If you call Get-CsConferencingPolicy without using the ApplicableTo parameter you will get back a collection of all the available policies, including any policies that can't actually be assigned to a specific user. ```yaml -Type: XdsIdentity -Parameter Sets: Identity, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: UserIdParameter +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` - ### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters when specifying the conferencing policy (or policies) to be returned. For example, this syntax returns all the policies configured at the per-user scope @@ -154,8 +160,7 @@ For example, this syntax returns all the policies configured at the per-user sco ```yaml Type: String Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -164,40 +169,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -Retrieves the conferencing policy data from the local replica of the Central Management store rather than from the Central Management store itself. +### -Identity -This parameter is not used with Skype for Business Online. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the conferencing policy to be retrieved. +Conferencing policies can be configured at the global scope or at the per-user scope. +To retrieve the global policy, use this syntax: -Identity global. +To retrieve a per-user policy use syntax similar to this: -Identity SalesConferencingPolicy. + +If this parameter is not included, the Get-CsConferencingPolicy cmdlet will return a collection of all the conferencing policies configured for use in your organization. + +Note that wildcards are not allowed when specifying an Identity. +Use the Filter parameter if you need to use wildcards when specifying a conferencing policy. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity, (All) +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplicableTo -Returns a list of the conferencing policies that can be assigned to the specified user. -For example, to return a collection of policies that can be assigned to the user kenmyer@litwareinc.com, use this command: +### -Include -`Get-CsConferencingPolicy -ApplicableTo "kenmyer@litwareinc.com"` +> Applicable: Skype for Business Online -The ApplicableTo parameter is useful because it's possible that only some of the available per-user conferencing policies can be assigned to a given user. -This is due to the fact that different licensing agreements and different country/region restrictions might limit the policies that can be assigned to a user. -For example, if Ken Myer works in China, country/region restrictions might limit his access to policies A, B, D, and E, Meanwhile, similar restrictions might limit Pilar Ackerman, who works in the United States, to policies A, B, C, and F. -If you call Get-CsConferencingPolicy without using the ApplicableTo parameter you will get back a collection of all the available policies, including any policies that can't actually be assigned to a specific user. +PARAMVALUE: Automatic | All | SubscriptionDefaults | TenantDefinedOnly ```yaml -Type: UserIdParameter +Type: PolicyFilter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -205,14 +212,19 @@ Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Include -PARAMVALUE: Automatic | All | SubscriptionDefaults | TenantDefinedOnly + +### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Retrieves the conferencing policy data from the local replica of the Central Management store rather than from the Central Management store itself. + +This parameter is not used with Skype for Business Online. ```yaml -Type: PolicyFilter +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -222,13 +234,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + PARAMVALUE: Guid ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsConfigurationStoreLocation.md b/skype/skype-ps/SkypeForBusiness/Get-CsConfigurationStoreLocation.md similarity index 89% rename from skype/skype-ps/skype/Get-CsConfigurationStoreLocation.md rename to skype/skype-ps/SkypeForBusiness/Get-CsConfigurationStoreLocation.md index fdc95a47a5..7465101e31 100644 --- a/skype/skype-ps/skype/Get-CsConfigurationStoreLocation.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsConfigurationStoreLocation.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csconfigurationstorelocation applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsConfigurationStoreLocation -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csconfigurationstorelocation +schema: 2.0.0 +title: Get-CsConfigurationStoreLocation --- # Get-CsConfigurationStoreLocation @@ -34,14 +35,14 @@ The Get-CsConfigurationStoreLocation cmdlet is used to report back the SQL Serve ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsConfigurationStoreLocation ``` The command shown in Example 1 returns the SQL Server path to the computer (or pool) hosting the Central Management store. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsConfigurationStoreLocation -Report "C:\Logs\ConfigurationStore.html" ``` @@ -52,6 +53,9 @@ Example 2 is a variation of the command shown in Example 1; in this case, howeve ## PARAMETERS ### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of a domain controller where global settings are stored. If global settings are stored in the Active Directory System container, then this parameter must point to the root domain controller. If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. @@ -59,8 +63,7 @@ If global settings are stored in the Configuration container, then any domain co ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -70,16 +73,18 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +For example: `-Report "C:\Logs\ConfigurationStore.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsConversationHistoryConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsConversationHistoryConfiguration.md similarity index 92% rename from skype/skype-ps/skype/Get-CsConversationHistoryConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsConversationHistoryConfiguration.md index 8c4b36089d..c8acde4688 100644 --- a/skype/skype-ps/skype/Get-CsConversationHistoryConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsConversationHistoryConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csconversationhistoryconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsConversationHistoryConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csconversationhistoryconfiguration +schema: 2.0.0 +title: Get-CsConversationHistoryConfiguration --- # Get-CsConversationHistoryConfiguration @@ -38,7 +39,7 @@ There is no option for creating additional conversation history settings at the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsConversationHistoryConfiguration ``` @@ -50,6 +51,9 @@ Note that you will always get back just one collection of settings; that's becau ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard values when referencing a collection of conversation history configuration settings. Because you can only have a single, global instance of these settings there is no reason to use the Filter parameter. However, if you prefer you can use the following syntax to reference the global settings: @@ -61,8 +65,7 @@ That syntax brings back all the conversation history configuration settings that ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -72,6 +75,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique Identity of the conversation history configuration settings. Because you can only have a single, global instance of these settings, you do not need to specify an Identity when calling the Get-CsConversationHistoryConfiguration cmdlet. If you prefer, however, you can use the following syntax to reference the global settings: @@ -81,8 +87,7 @@ If you prefer, however, you can use the following syntax to reference the global ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -92,13 +97,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the conversation history configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsCpsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsCpsConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Get-CsCpsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsCpsConfiguration.md index 2859c7b997..cdf9fb0879 100644 --- a/skype/skype-ps/skype/Get-CsCpsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsCpsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cscpsconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsCpsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cscpsconfiguration +schema: 2.0.0 +title: Get-CsCpsConfiguration --- # Get-CsCpsConfiguration @@ -42,21 +43,21 @@ In addition, Call Park service can be configured to play music on hold to the ca ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsCpsConfiguration ``` Example 1 retrieves a collection of all the Call Park service configurations that have been defined for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsCpsConfiguration -Identity site:Redmond1 ``` Example 2 retrieves only the Call Park service configurations with the Identity site:Redmond1. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsCpsConfiguration -Filter site:* ``` @@ -64,7 +65,7 @@ Get-CsCpsConfiguration -Filter site:* In Example 3, the Filter parameter is used to return all the Call Park service configurations that have been configured at the site scope. The wildcard string site:* tells the Get-CsCpsConfiguration cmdlet to return only those settings where the Identity begins with the string value site:. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsCpsConfiguration -Filter *:re* ``` @@ -72,7 +73,7 @@ Get-CsCpsConfiguration -Filter *:re* As in Example 3, in this example we use the Filter parameter to retrieve a subset of all the defined Call Park service configurations. In this case, we filter on the string *:re*, which will return Call Park configurations for all sites with names beginning with the letters re, such as Redmond1, Redmond2, and RemoteComputer. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsCpsConfiguration | Where-Object {$_.EnableMusicOnHold -eq $False} ``` @@ -84,47 +85,53 @@ That collection is then piped to the Where-Object cmdlet, which, in turn, applie ## PARAMETERS -### -Identity -The unique identifier of the Call Park service configuration you want to retrieve. -This identifier will be either Global or site:\, where \ is the name of the site to which the configuration applies. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to do a wildcard search to retrieve only those configurations with Identity values matching the wildcard string. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Allows you to do a wildcard search to retrieve only those configurations with Identity values matching the wildcard string. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the Call Park service configuration you want to retrieve. +This identifier will be either Global or site:\, where \ is the name of the site to which the configuration applies. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the Call Park service information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsDatabaseMirrorState.md b/skype/skype-ps/SkypeForBusiness/Get-CsDatabaseMirrorState.md similarity index 92% rename from skype/skype-ps/skype/Get-CsDatabaseMirrorState.md rename to skype/skype-ps/SkypeForBusiness/Get-CsDatabaseMirrorState.md index ab7cc8b8ab..2bd1eb0f1b 100644 --- a/skype/skype-ps/skype/Get-CsDatabaseMirrorState.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDatabaseMirrorState.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csdatabasemirrorstate applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsDatabaseMirrorState -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csdatabasemirrorstate +schema: 2.0.0 +title: Get-CsDatabaseMirrorState --- # Get-CsDatabaseMirrorState @@ -47,7 +48,7 @@ The functions carried out by the Get-CsDatabaseMirrorState cmdlet are not availa ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsDatabaseMirrorState -PoolFqdn "atl-cs-001.litwareinc.com" -DatabaseType Monitoring ``` @@ -57,26 +58,10 @@ The command shown in Example 1 returns the state of the database mirror assigned ## PARAMETERS -### -PoolFqdn -Fully qualified domain name of the pool whose database mirroring state is being checked. -For example: - -`-PoolFqdn "atl-cs-001.litwareinc.com"` - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -DatabaseType -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -DatabaseType Type of database whose mirror state is being checked. Allowed values for Lync Server 2013 are: @@ -106,8 +91,7 @@ Allowed values for Skype for Business Server 2015 are: ```yaml Type: DatabaseNameType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -117,13 +101,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Retrieves the backup mirror state from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -132,7 +118,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Fully qualified domain name of the pool whose database mirroring state is being checked. +For example: + +`-PoolFqdn "atl-cs-001.litwareinc.com"` + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Report + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: @@ -141,8 +151,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsDeviceUpdateConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsDeviceUpdateConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Get-CsDeviceUpdateConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsDeviceUpdateConfiguration.md index dcc4810931..6bc9e83a26 100644 --- a/skype/skype-ps/skype/Get-CsDeviceUpdateConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDeviceUpdateConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csdeviceupdateconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsDeviceUpdateConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csdeviceupdateconfiguration +schema: 2.0.0 +title: Get-CsDeviceUpdateConfiguration --- # Get-CsDeviceUpdateConfiguration @@ -43,7 +44,7 @@ You can use the Get-CsDeviceUpdateConfiguration cmdlet to return information abo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsDeviceUpdateConfiguration ``` @@ -51,14 +52,14 @@ Get-CsDeviceUpdateConfiguration The command shown in Example 1 returns a collection of all the device update configuration settings currently in use in the organization. Calling the Get-CsDeviceUpdateConfiguration cmdlet without any additional parameters returns all the device update settings currently in use. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsDeviceUpdateConfiguration -Identity Global ``` In Example 2, information is returned for the global device update configuration settings. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsDeviceUpdateConfiguration -Filter site:* ``` @@ -66,7 +67,7 @@ Get-CsDeviceUpdateConfiguration -Filter site:* Example 3 demonstrates the use of the Filter parameter. The filter value "site:*" returns a collection of all the device update configuration settings applied at the site scope; that's because these settings all have an Identity that begins with the string value "site:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsDeviceUpdateConfiguration | Where-Object {$_.MaxLogFileSize -gt 2048000} ``` @@ -75,7 +76,7 @@ Example 4 returns all the device update configuration settings where the MaxLogF To do this, the Get-CsDeviceUpdateConfiguration cmdlet is used to return a collection of all the device update configuration settings currently in use. That collection is then piped to the Where-Object cmdlet, which picks out only those settings where the MaxLogFileSize property is greater than 2048000. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsDeviceUpdateConfiguration | Where-Object {$_.ValidLogFileTypes -like "*Watson*"} ``` @@ -87,7 +88,31 @@ That collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Provides a way for you to use wildcard characters when specifying device update configuration settings. +For example, to return a collection of all the configuration settings that have been applied at the site scope, use this syntax: -Filter "site:*". +To return all the settings that have the term "EMEA" in their Identity, use this syntax: -Filter "*EMEA*". +Note that the Filter parameter acts only on the Identity of the settings; you cannot filter on other device update configuration properties. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the device update configuration settings to be retrieved. To refer to the global settings, use this syntax: -Identity global. To refer to site settings, use syntax similar to this: -Identity site:Redmond. @@ -97,8 +122,7 @@ If you need to use wildcards, use the Filter parameter instead. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -107,33 +131,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Provides a way for you to use wildcard characters when specifying device update configuration settings. -For example, to return a collection of all the configuration settings that have been applied at the site scope, use this syntax: -Filter "site:*". -To return all the settings that have the term "EMEA" in their Identity, use this syntax: -Filter "*EMEA*". -Note that the Filter parameter acts only on the Identity of the settings; you cannot filter on other device update configuration properties. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the device update configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsDeviceUpdateRule.md b/skype/skype-ps/SkypeForBusiness/Get-CsDeviceUpdateRule.md similarity index 88% rename from skype/skype-ps/skype/Get-CsDeviceUpdateRule.md rename to skype/skype-ps/SkypeForBusiness/Get-CsDeviceUpdateRule.md index 0e5442fdfb..35795da63c 100644 --- a/skype/skype-ps/skype/Get-CsDeviceUpdateRule.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDeviceUpdateRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csdeviceupdaterule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsDeviceUpdateRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csdeviceupdaterule +schema: 2.0.0 +title: Get-CsDeviceUpdateRule --- # Get-CsDeviceUpdateRule @@ -42,7 +43,7 @@ The Get-CsDeviceUpdateRule cmdlet enables you to return information about the de ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsDeviceUpdateRule ``` @@ -50,14 +51,14 @@ Get-CsDeviceUpdateRule The command in Example 1 returns information about all the device update rules that have been applied in your organization. Calling the Get-CsDeviceUpdateRule cmdlet without any additional parameters always returns the complete collection of device update rules. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsDeviceUpdateRule -Identity service:WebServer:atl-cs-001.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9 ``` The command shown in Example 2 returns information about the device update rule with the Identity "WebServer:atl-cs-001.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9". -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsDeviceUpdateRule -Filter service:WebServer:atl-cs-001.litwareinc.com* ``` @@ -66,7 +67,7 @@ Example 3 returns information about all the device update rules configured for t To accomplish this task, the Filter parameter is used along with the filter value "WebServer:atl-cs-001.litwareinc.com*". That filter limits the returned data to device update rules that have an Identity that begins with the string value "service:WebServer:atl-cs-001.litwareinc.com." -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsDeviceUpdateRule | Where-Object {$_.Brand -eq "LG-Nortel"} ``` @@ -75,7 +76,7 @@ Example 4 returns all the device update rules where the Brand property is equal To do this, the Get-CsDeviceUpdateRule cmdlet is called in order to return a collection of all the device update rules in the organization. That collection is then piped to the Where-Object cmdlet, which selects only those rules where the Brand is equal to "LG-Nortel". -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsDeviceUpdateRule | Where-Object {$_.ApprovedVersion -eq $Null} ``` @@ -85,7 +86,7 @@ This is done by using the Get-CsDeviceUpdateRules cmdlet to return a collection In turn, the Where-Object cmdlet selects only those rules where the Approved property is equal to a null value. If the Approved property is null, it means that these rules are not approved. -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsDeviceUpdateRule | Where-Object {$_.ApprovedVersion -ne $Null -and $_.Brand -eq "LG-Nortel"} ``` @@ -97,56 +98,62 @@ That collection is then piped to the Where-Object cmdlet, which filters the coll ## PARAMETERS -### -Identity -Unique identifier for the device update rule. -The Identity of a device update rule is composed of two parts: the service scope where the rule has been applied (for example, service:WebServer:atl-cs-001.litwareinc.com) and the globally unique identifier (GUID) that was pre-assigned to the rule (for example, d5ce3c10-2588-420a-82ac-dc2d9b1222ff9). -Based on this, the Identity for a given device update rule will look something like this: +### -Filter -`"service:WebServer:atl-cs-001.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9 "` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Wildcards are not allowed when specifying an Identity. -Use the Filter parameter if you want to use wildcards when specifying a rule. +Enables you to use wildcards when specifying the Identity of a device update rule or set of rules. +For example, to return all the device update rules for WebServer:atl-cs-001.litwareinc.com use this filter value: + +`"service:WebServer:atl-cs-001.litwareinc.com*"` ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the Identity of a device update rule or set of rules. -For example, to return all the device update rules for WebServer:atl-cs-001.litwareinc.com use this filter value: +### -Identity -`"service:WebServer:atl-cs-001.litwareinc.com*"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the device update rule. +The Identity of a device update rule is composed of two parts: the service scope where the rule has been applied (for example, service:WebServer:atl-cs-001.litwareinc.com) and the globally unique identifier (GUID) that was pre-assigned to the rule (for example, d5ce3c10-2588-420a-82ac-dc2d9b1222ff9). +Based on this, the Identity for a given device update rule will look something like this: + +`"service:WebServer:atl-cs-001.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9 "` + +Wildcards are not allowed when specifying an Identity. +Use the Filter parameter if you want to use wildcards when specifying a rule. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the device update rule data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsDiagnosticConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsDiagnosticConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Get-CsDiagnosticConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsDiagnosticConfiguration.md index e828788cb7..3d1af085bd 100644 --- a/skype/skype-ps/skype/Get-CsDiagnosticConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDiagnosticConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csdiagnosticconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsDiagnosticConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csdiagnosticconfiguration +schema: 2.0.0 +title: Get-CsDiagnosticConfiguration --- # Get-CsDiagnosticConfiguration @@ -46,7 +47,7 @@ The Get-CsDiagnosticConfiguration cmdlet enables you to return information about ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsDiagnosticConfiguration ``` @@ -54,14 +55,14 @@ Get-CsDiagnosticConfiguration In Example 1, information is returned for all of the diagnostic configuration settings currently in use in the organization. This is done by calling the Get-CsDiagnosticConfiguration cmdlet without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsDiagnosticConfiguration -Identity site:Redmond ``` Example 2 returns information for the diagnostic configuration settings applied to the Redmond site (-Identity site:Redmond). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsDiagnosticConfiguration -Identity site:Redmond | Select-Object -ExpandProperty Filter ``` @@ -71,7 +72,7 @@ To do this, the command first uses the Get-CsDiagnosticConfiguration cmdlet to r This information is then piped to the Select-Object cmdlet, which uses the ExpandProperty parameter to "expand" the value of the Filter property. Expanding the Filter property enables you to access the properties and property values for the individual filters maintained in the diagnostic configuration settings. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsDiagnosticConfiguration -Identity global | Select-Object -ExpandProperty Filter | Where-Object {$_.Uri -contains "sip:diagnostics@litwareinc.com"} ``` @@ -81,7 +82,7 @@ To do this, the command first uses the Get-CsDiagnosticConfiguration cmdlet to r This information is then piped to the Select-Object cmdlet, which expands the Filter property. The individual filter objects are then piped to the Select-Object cmdlet, which extracts only those filters where the Uri property includes the SIP address sip:diagnostics@litwareinc.com. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsDiagnosticConfiguration -Identity global | Select-Object -ExpandProperty Filter | Where-Object {$_.Uri -notcontains "sip:diagnostics@litwareinc.com"} ``` @@ -94,53 +95,59 @@ Those filter objects are then piped to the Select-Object cmdlet, which selects o ## PARAMETERS -### -Identity -Unique identifier for the diagnostic configuration settings to be returned. -To return settings configured at the site scope, use syntax similar to this: -Identity "site:Redmond". -To return the global settings, use this syntax: -Identity global. +### -Filter -If this parameter is not specified, then all of the diagnostics configuration settings currently in use will be returned. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters when specifying the settings collection (or collections) to be returned. +For example, this syntax returns all the settings configured at the site scope: -Filter "site:*". + +Note that you cannot use both the Filter and the Identity parameters in the same command. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when specifying the settings collection (or collections) to be returned. -For example, this syntax returns all the settings configured at the site scope: -Filter "site:*". +### -Identity -Note that you cannot use both the Filter and the Identity parameters in the same command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the diagnostic configuration settings to be returned. +To return settings configured at the site scope, use syntax similar to this: -Identity "site:Redmond". +To return the global settings, use this syntax: -Identity global. + +If this parameter is not specified, then all of the diagnostics configuration settings currently in use will be returned. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the diagnostic configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsDiagnosticHeaderConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsDiagnosticHeaderConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsDiagnosticHeaderConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsDiagnosticHeaderConfiguration.md index 70f111e8de..6b1fca5bdd 100644 --- a/skype/skype-ps/skype/Get-CsDiagnosticHeaderConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDiagnosticHeaderConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csdiagnosticheaderconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsDiagnosticHeaderConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csdiagnosticheaderconfiguration +schema: 2.0.0 +title: Get-CsDiagnosticHeaderConfiguration --- # Get-CsDiagnosticHeaderConfiguration @@ -51,7 +52,7 @@ The Get-CsDiagnosticHeaderConfiguration cmdlet provides a way for you to retriev ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsDiagnosticHeaderConfiguration ``` @@ -59,14 +60,14 @@ Get-CsDiagnosticHeaderConfiguration The preceding command returns information about all the diagnostic header configuration settings currently in use in the organization. This is done by calling the Get-CsDiagnosticHeaderConfiguration cmdlet without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsDiagnosticHeaderConfiguration -Identity site:Redmond ``` In Example 2, a single collection of diagnostic header configuration settings is returned: the collection that has the Identity site:Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsDiagnosticHeaderConfiguration -Filter "service:*" ``` @@ -74,7 +75,7 @@ Get-CsDiagnosticHeaderConfiguration -Filter "service:*" The command shown in Example 3 returns all the diagnostic header settings that have been configured at the service scope. This is done by calling the Get-CsDiagnosticHeaderConfiguration cmdlet and the Filter parameter; the filter value "service:*" ensures that the only settings that are returned are those that have an Identity that begins with the characters "service:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsDiagnosticHeaderConfiguration | Where-Object {$_.SendToExternalNetworks -eq $True} ``` @@ -83,7 +84,7 @@ Example 4 returns all the diagnostic header configuration settings that allow se To perform this task, the command first calls the Get-CsDiagnosticHeaderConfiguration cmdlet without any parameters; this returns a collection of all the diagnostic header settings currently in use. This collection is then piped to the Where-Object cmdlet, which selects only those settings where the SendToExternalNetworks property is equal to True. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsDiagnosticHeaderConfiguration | Where-Object {$_.SendToExternalNetworks -eq $True -or $_.SendToOutsideUnauthenticatedUsers -eq $True} ``` @@ -100,55 +101,61 @@ To require that settings meet both of the specified criteria, use the -and opera ## PARAMETERS -### -Identity -Unique identifier for the diagnostic header configuration settings to be returned. -To return settings configured at the site scope, use syntax similar to this: -Identity "site:Redmond". -To return settings configured at the service scope, use syntax like this: -Identity "service:EdgeServer:atl-edge-001.litwareinc.com". -To return the global settings, use this syntax: -Identity global. +### -Filter -If this parameter is not specified, then all the diagnostic header configuration settings currently in use will be returned. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters when specifying the settings collection (or collections) to be returned. +For example, this syntax returns all the settings configured at the site scope: -Filter "site:*". +This syntax returns all the settings configured at the service scope: -Filter "service:*". + +Note that you cannot use both the Filter and the Identity parameters in the same command. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when specifying the settings collection (or collections) to be returned. -For example, this syntax returns all the settings configured at the site scope: -Filter "site:*". -This syntax returns all the settings configured at the service scope: -Filter "service:*". +### -Identity -Note that you cannot use both the Filter and the Identity parameters in the same command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the diagnostic header configuration settings to be returned. +To return settings configured at the site scope, use syntax similar to this: -Identity "site:Redmond". +To return settings configured at the service scope, use syntax like this: -Identity "service:EdgeServer:atl-edge-001.litwareinc.com". +To return the global settings, use this syntax: -Identity global. + +If this parameter is not specified, then all the diagnostic header configuration settings currently in use will be returned. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the diagnostic header configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsDialInConferencingAccessNumber.md b/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingAccessNumber.md similarity index 90% rename from skype/skype-ps/skype/Get-CsDialInConferencingAccessNumber.md rename to skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingAccessNumber.md index fe50bf5290..d1c92eb424 100644 --- a/skype/skype-ps/skype/Get-CsDialInConferencingAccessNumber.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingAccessNumber.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csdialinconferencingaccessnumber applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsDialInConferencingAccessNumber -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csdialinconferencingaccessnumber +schema: 2.0.0 +title: Get-CsDialInConferencingAccessNumber --- # Get-CsDialInConferencingAccessNumber @@ -59,7 +60,7 @@ This is simply the way the cmdlet handles imported dial-in conferencing access n ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsDialInConferencingAccessNumber ``` @@ -67,7 +68,7 @@ Get-CsDialInConferencingAccessNumber The command shown in Example 1 returns a collection of all the dial-in conferencing access numbers configured for use in the organization. Calling the Get-CsDialInConferencingAccessNumber cmdlet without any additional parameters always returns a collection of all the available dial-in access numbers. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsDialInConferencingAccessNumber -Identity sip:RedmondDialIn@litwareinc.com ``` @@ -75,7 +76,7 @@ Get-CsDialInConferencingAccessNumber -Identity sip:RedmondDialIn@litwareinc.com In Example 2, the dial-in conferencing access number with the Identity sip:RedmondDialIn@litwareinc.com is returned. Because identities must be unique, this command will never return more than one access number. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsDialInConferencingAccessNumber -Region "Redmond" ``` @@ -85,21 +86,21 @@ To do this, the Get-CsDialInConferencingAccessNumber cmdlet is called along with Specifying "Redmond" as the parameter value causes the Get-CsDialInConferencingAccessNumber cmdlet to return all the numbers where "Redmond" appears in the list of associated regions. For example, an access number that only listed Redmond as a region would be returned, as would an access number that listed both Redmond and Portland. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsDialInConferencingAccessNumber -Region $Null ``` Example 4 returns all the dial-in conferencing access numbers that are not associated with a region (that is, where the Regions property is empty). -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsDialInConferencingAccessNumber -Region site:USA/Redmond ``` The command shown in Example 5 returns all the dial-in conferencing access numbers for the Redmond region that have been scoped to the USA site (that is, the site with the SiteId site:USA). -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsDialInConferencingAccessNumber -Filter {DisplayName -like "*Seattle*"} ``` @@ -107,7 +108,7 @@ Get-CsDialInConferencingAccessNumber -Filter {DisplayName -like "*Seattle*"} In Example 6, the Filter parameter is used in order to return a collection of all the dial-in conferencing access numbers that include the string value "Seattle" somewhere in their DisplayName. The filter value {DisplayName -like "*Seattle*"} limits the returned data to access numbers where the DisplayName includes the word "Seattle" (for example, Seattle Access Number; Dial-In Number for Seattle; Tacoma/Seattle Access Number; etc.). -### -------------------------- Example 7 -------------------------- +### Example 7 ``` Get-CsDialInConferencingAccessNumber -Filter {LineUri -like "tel:+1425*"} ``` @@ -119,7 +120,7 @@ To return all the phone numbers for area code 425 or for the area code 206, use `{LineUri -like "tel:+1425*" -or LineUri -like "tel:+1206*"}` -### -------------------------- Example 8 -------------------------- +### Example 8 ``` Get-CsDialInConferencingAccessNumber | Where-Object {$_.PrimaryLanguage -eq "it-IT"} ``` @@ -128,7 +129,7 @@ Example 8 returns a collection of all the dial-in conferencing access numbers wh To carry out this task, the Get-CsDialInConferencingAccessNumber cmdlet is first called in order to return a collection of all the access numbers configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those numbers where the PrimaryLanguage property is equal to Italian ("it-It"). -### -------------------------- Example 9 -------------------------- +### Example 9 ``` Get-CsDialInConferencingAccessNumber | Where-Object {$_.SecondaryLanguages -contains "fr-FR"} ``` @@ -140,26 +141,10 @@ This collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS -### -Identity -SIP address of the dial-in conferencing access number (that is, the contact object that represents the number) to be retrieved. -You must include the "sip:" prefix when specifying the Identity; for example: -Identity sip:RedmondDialIn@litwareinc.com. - -If this parameter is not specified, then the Get-CsDialInConferencingAccessNumber cmdlet will return all the dial-in conferencing access numbers configured for use in your organization. - -```yaml -Type: UserIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Credential -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Credential Enables you to run the Get-CsDialInConferencingAccessNumber cmdlet under alternate credentials; this might be required if the account you used to log on to Windows does not have the necessary privileges required to work with contact objects. To use the Credential parameter you must first create a PSCredential object by using the Get-Credential cmdlet. @@ -168,8 +153,7 @@ For details, see the Get-Credential cmdlet help topic. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,14 +163,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to retrieve contact information. To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-mcs-001) or its fully qualified domain name (for example, atl-mcs-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -196,6 +182,9 @@ Accept wildcard characters: False ``` ### -EmptyRegion + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns information about the dial plans that are associated with a region that is not associated with at least one dial-in conferencing access number. For example, suppose the Bellevue dial plan is associated with the Bellevue region, but no access numbers have been configured for the Bellevue region. The Bellevue region would thus be considered an empty region. @@ -205,8 +194,7 @@ This parameter cannot be used in conjunction with any other parameter. ```yaml Type: SwitchParameter Parameter Sets: EmptyRegion -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -216,6 +204,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on specific attributes for Skype for Business Server. For example, you can limit returned data to dial-in conferencing numbers that have the string value "Redmond" in their display name, or toll-free dial-in conferencing numbers that use the 1-800 prefix. @@ -225,8 +216,7 @@ For example, a filter that returns only access numbers that have the 1-800 prefi ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -235,7 +225,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address of the dial-in conferencing access number (that is, the contact object that represents the number) to be retrieved. +You must include the "sip:" prefix when specifying the Identity; for example: -Identity sip:RedmondDialIn@litwareinc.com. + +If this parameter is not specified, then the Get-CsDialInConferencingAccessNumber cmdlet will return all the dial-in conferencing access numbers configured for use in your organization. + +```yaml +Type: UserIdParameter +Parameter Sets: Identity +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + ### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to return access numbers from a specific Active Directory organizational unit (OU). This includes data from both the specified OU and any of its child OUs. For example, if the Finance OU has two child OUs, AccountsPayable and AccountsReceivable, access number information will be returned from each of these three OUs. @@ -245,8 +259,7 @@ When specifying an OU, use the distinguished name of that container; for example ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -256,6 +269,9 @@ Accept wildcard characters: False ``` ### -Region + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns all the dial-in conferencing access numbers associated with the specified dial plan region. For example, to return all the dial-in numbers for the Northwest region, use this syntax: -Region Northwest. @@ -273,8 +289,7 @@ For details, see the Set-CsDialInConferencingAccessNumber cmdlet help topic. ```yaml Type: String Parameter Sets: Region -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -284,6 +299,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the number of records returned by a command. For example, to return just seven access numbers (regardless of how many access numbers are in your forest), simply include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which seven items will be returned. @@ -295,8 +313,7 @@ If set to 0 the command will run, but no data will be returned. ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsDialInConferencingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Get-CsDialInConferencingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingConfiguration.md index 1a86bff077..26c0cfa460 100644 --- a/skype/skype-ps/skype/Get-CsDialInConferencingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csdialinconferencingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsDialInConferencingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csdialinconferencingconfiguration +schema: 2.0.0 +title: Get-CsDialInConferencingConfiguration --- # Get-CsDialInConferencingConfiguration @@ -40,7 +41,7 @@ These conference "join behaviors" are managed using dial-in conferencing configu ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsDialInConferencingConfiguration ``` @@ -48,14 +49,14 @@ Get-CsDialInConferencingConfiguration Example 1 returns a collection of all the dial-in conferencing configuration settings currently in use in the organization. Calling the Get-CsDialInConferencingConfiguration cmdlet without any additional parameters always returns the complete collection of dial-in conferencing settings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsDialInConferencingConfiguration -Identity site:Redmond ``` Example 2 returns the dial-in conferencing configuration settings with the Identity site:Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsDialInConferencingConfiguration -Filter "site:*" ``` @@ -64,7 +65,7 @@ In Example 3, the Filter parameter is used to return all the dial-in conferencin The filter value "site:*" instructs the Get-CsDialInConferencingConfiguration cmdlet to return only those settings where the Identity begins with the string value "site:". By design, any dial-conferencing settings that have an Identity beginning with "site:" represent settings configured at the site scope. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsDialInConferencingConfiguration | Where-Object {$_.EnableNameRecording -eq $False} ``` @@ -76,7 +77,31 @@ That collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Provides a way for you to use wildcard characters when specifying dial-in conferencing configuration settings. +For example, to return a collection of all the configuration settings that have been applied at the site scope use this syntax: -Filter "site:*". +To return all the settings that have the term "EMEA" in their Identity use this syntax: -Filter "*EMEA*". +Note that the Filter parameter acts only on the Identity of the settings; you cannot filter on other dial-in conferencing configuration properties. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the dial-in conferencing configuration settings to be retrieved. To refer to the global settings, use this syntax: -Identity global. To refer to site settings, use syntax similar to this: -Identity site:Redmond. @@ -88,8 +113,7 @@ If called without any parameters the Get-CsDialInConferencingConfiguration cmdle ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -98,33 +122,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Provides a way for you to use wildcard characters when specifying dial-in conferencing configuration settings. -For example, to return a collection of all the configuration settings that have been applied at the site scope use this syntax: -Filter "site:*". -To return all the settings that have the term "EMEA" in their Identity use this syntax: -Filter "*EMEA*". -Note that the Filter parameter acts only on the Identity of the settings; you cannot filter on other dial-in conferencing configuration properties. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the dial-in conferencing data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsDialInConferencingDtmfConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingDtmfConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsDialInConferencingDtmfConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingDtmfConfiguration.md index 7656e7a355..c5ddf7d9fe 100644 --- a/skype/skype-ps/skype/Get-CsDialInConferencingDtmfConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingDtmfConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csdialinconferencingdtmfconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsDialInConferencingDtmfConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csdialinconferencingdtmfconfiguration +schema: 2.0.0 +title: Get-CsDialInConferencingDtmfConfiguration --- # Get-CsDialInConferencingDtmfConfiguration @@ -44,14 +45,14 @@ The Get-CsDialInConferencingDtmfConfiguration cmdlet enables you to retrieve a l ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsDialInConferencingDtmfConfiguration -Identity site:Redmond ``` The command show in Example 1 returns the DTMF settings for the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsDialInConferencingDtmfConfiguration | Select-Object Identity, HelpCommand ``` @@ -60,7 +61,7 @@ Example 2 returns a collection of all the DTMF settings, and then, for each item To do this, the Get-CsDialInConferencingDtmfConfiguration cmdlet is called in order to return a collection of all the property values for all the DTMF settings currently in use in the organization. That collection is then piped to the Select-Object cmdlet, which picks two properties (Identity and HelpCommand) to be displayed on the screen. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsDialInConferencingDtmfConfiguration -Filter "site:*" ``` @@ -70,7 +71,7 @@ This is done by including the Filter parameter and the filter value "site:*". That filter value limits the returned data to settings that have an Identity that begins with the characters "site:". By definition, those are settings configured at the site scope. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsDialInConferencingDtmfConfiguration | Where-Object {$_.AdmitAll -ne 8} ``` @@ -82,7 +83,30 @@ This collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters in order to return a collection (or collections) of DTMF configuration settings. +To return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. +To return a collection of all the settings that have the string value "EMEA" somewhere in their Identity (the only property you can filter for), use this syntax: -Filter *EMEA*. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the unique identifier for the collection of DTMF settings you want to return. To refer to the global settings, use this syntax: -Identity global. To refer to a collection configured at the site scope, use syntax similar to this: -Identity site:Redmond. @@ -94,8 +118,7 @@ If this parameter is not specified, then the Get-CsDialInConferencingDtmfConfigu ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -104,32 +127,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters in order to return a collection (or collections) of DTMF configuration settings. -To return a collection of all the settings configured at the site scope, use this syntax: -Filter site:*. -To return a collection of all the settings that have the string value "EMEA" somewhere in their Identity (the only property you can filter for), use this syntax: -Filter *EMEA*. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the DTMF configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsDialInConferencingLanguageList.md b/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingLanguageList.md similarity index 92% rename from skype/skype-ps/skype/Get-CsDialInConferencingLanguageList.md rename to skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingLanguageList.md index 1f82e950cc..f53a2f370a 100644 --- a/skype/skype-ps/skype/Get-CsDialInConferencingLanguageList.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDialInConferencingLanguageList.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csdialinconferencinglanguagelist applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsDialInConferencingLanguageList -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csdialinconferencinglanguagelist +schema: 2.0.0 +title: Get-CsDialInConferencingLanguageList --- # Get-CsDialInConferencingLanguageList @@ -47,7 +48,7 @@ Note, too that the list of available languages is configured at the global scope ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` (Get-CsDialInConferencingLanguageList).Languages -contains "en-US" ``` @@ -57,7 +58,7 @@ In this example, the Get-CsDialInConferencingLanguageList cmdlet is called in or If it is, the Get-CsDialInConferencingLanguageList cmdlet will report back the value "True". If "en-US" cannot be found in the list of supported languages, then the cmdlet will report back the value "False". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` (Get-CsDialInConferencingLanguageList).Languages ``` @@ -71,49 +72,55 @@ After the information has been returned, standard "dot notation" (the object nam ## PARAMETERS -### -Identity -Indicates the dial-in conferencing language list to be returned. -At this point in time there is only one such object: global. -Because of this, you do not need to include this parameter when calling the Get-CsDialInConferencingLanguageList cmdlet. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters when specifying a dial-conferencing language list. +Because there is only one such object (global), you can return the language list without using either the Filter or the Identity parameter. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when specifying a dial-conferencing language list. -Because there is only one such object (global), you can return the language list without using either the Filter or the Identity parameter. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the dial-in conferencing language list to be returned. +At this point in time there is only one such object: global. +Because of this, you do not need to include this parameter when calling the Get-CsDialInConferencingLanguageList cmdlet. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the languages list from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsDialPlan.md b/skype/skype-ps/SkypeForBusiness/Get-CsDialPlan.md similarity index 88% rename from skype/skype-ps/skype/Get-CsDialPlan.md rename to skype/skype-ps/SkypeForBusiness/Get-CsDialPlan.md index bd10f2446f..a36027dcb4 100644 --- a/skype/skype-ps/skype/Get-CsDialPlan.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsDialPlan.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csdialplan applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsDialPlan -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-csdialplan +schema: 2.0.0 +title: Get-CsDialPlan --- # Get-CsDialPlan @@ -40,14 +42,14 @@ Note: You can use the Get-CsDialPlan cmdlet to retrieve specific information abo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsDialPlan ``` Example 1 returns a collection of all the dial plans configured for use in your organization; this is done by calling the Get-CsDialPlan cmdlet without any additional parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsDialPlan -Identity RedmondDialPlan ``` @@ -55,7 +57,7 @@ Get-CsDialPlan -Identity RedmondDialPlan In Example 2, the Identity parameter is used to limit the retrieved data to dial plans that have a per-user dial plan with the Identity RedmondDialPlan. Because identities must be unique, this command will return only the specified dial plan. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsDialPlan -Identity site:Redmond ``` @@ -63,7 +65,7 @@ Get-CsDialPlan -Identity site:Redmond Example 3 is identical to Example 2 except that instead of retrieving a per-user dial plan, we're retrieving a dial plan assigned to a site. We do that by specifying the value site: followed by the site name (in this case Redmond) of the site we want to retrieve. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsDialPlan -Filter tag:* ``` @@ -71,7 +73,7 @@ Get-CsDialPlan -Filter tag:* This example uses the Filter parameter to return a collection of all the dial plans that have been configured at the per-user scope. (Settings configured at the per-user, or tag, scope can be directly assigned to users and groups.) The wildcard string tag:* instructs the cmdlet to return only those dial plans that have an identity beginning with the string value tag:, which identifies a dial plan as a per-user dial plan. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsDialPlan | Select-Object -ExpandProperty NormalizationRules ``` @@ -82,7 +84,7 @@ To see all of these rules, this sample command first uses the Get-CsDialPlan cmd That collection is then piped to the Select-Object cmdlet; in turn, the ExpandProperty parameter of the Select-Object cmdlet is used to "expand" the values found in the NormalizationRules property. Expanding the values simply means that all the normalization rules will be listed out individually on the screen, the same output that would be seen if the Get-CsVoiceNormalizationRule cmdlet had been called. -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsDialPlan | Where-Object {$_.Description -match "Redmond"} ``` @@ -94,46 +96,52 @@ That collection is then piped to the Where-Object cmdlet, which applies a filter ## PARAMETERS -### -Identity -The unique identifier designating the scope, and for per-user scope a name, to identify the dial plan you want to retrieve. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Performs a wildcard search that allows you to narrow down your results to only dial plans with identities that match the given wildcard string. ```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter, (All) +Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Performs a wildcard search that allows you to narrow down your results to only dial plans with identities that match the given wildcard string. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier designating the scope, and for per-user scope a name, to identify the dial plan you want to retrieve. ```yaml -Type: String -Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: (All) +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the dial plan information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -143,13 +151,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + {{Fill Tenant Description}} ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsEffectivePolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsEffectivePolicy.md similarity index 92% rename from skype/skype-ps/skype/Get-CsEffectivePolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsEffectivePolicy.md index 117520586f..0492c3e4a7 100644 --- a/skype/skype-ps/skype/Get-CsEffectivePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsEffectivePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cseffectivepolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsEffectivePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cseffectivepolicy +schema: 2.0.0 +title: Get-CsEffectivePolicy --- # Get-CsEffectivePolicy @@ -63,14 +64,14 @@ The functions carried out by the Get-CsEffectivePolicy cmdlet are not directly a ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsEffectivePolicy - Identity "Ken Myer" ``` The command shown in Example 1 returns the effective policies for the user with the Active Directory display name Ken Myer. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` "Ken Myer","Pilar Ackerman" | Get-CsEffectivePolicy ``` @@ -78,7 +79,7 @@ The command shown in Example 1 returns the effective policies for the user with In the preceding command, effective policy information is returned for users with the display names Ken Myer and Pilar Ackerman. Policy information for multiple users can be returned by piping multiple user Identities to the Get-CsEffectivePolicy cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsUser -Filter {ConferencingPolicy -eq "RedmondConferencingPolicy"} | Get-CsEffectivePolicy ``` @@ -87,7 +88,7 @@ In Example 3, effective policy information is returned for all the users who hav To do this, the command first uses the Get-CsUser cmdlet to return a collection of users who have been assigned RedmondConferencingPolicy; the Filter parameter and the filter value {ConferencingPolicy -eq "RedmondConferencingPolicy"} limits the returned data to users who have been assigned the RedmondConferencingPolicy per-user conferencing policy. That collection of user accounts is then piped to the Get-CsEffectivePolicy cmdlet, which displays effective policy information for each user in the collection. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsUser -Filter {ConferencingPolicy -eq "RedmondConferencingPolicy"} | Get-CsEffectivePolicy | Select-Object Identity, MobilityPolicy ``` @@ -96,7 +97,7 @@ Example 4 is a variation of the command shown in Example 3. In this example, effective policy information is again returned for all the users who have been assigned the conferencing policy RedmondConferencingPolicy; in this case, however, the returned information is limited to the user Identity and mobility policy. This is done by returning all the effective policy information and then piping that data to the Select-Object cmdlet, which, in turn, is used to limit the displayed data to the Identity and MobilityPolicy properties. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsUser -LdapFilter "Department=Finance" | Get-CsEffectivePolicy ``` @@ -108,28 +109,10 @@ That collection is then piped to the Get-CsEffectivePolicy cmdlet, which display ## PARAMETERS -### -Identity -Indicates the Identity of the user account whose effective policy settings are being calculated. -User Identities are typically specified by using one of the following formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). -You can also reference a user account by using the user's Active Directory distinguished name. - -You can use the asterisk (*) wildcard character when using the Display Name as the user Identity. -For example, the Identity "* Smith" returns all the users who have a display name that ends with the string value " Smith". - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Credential -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Credential Enables you to run the Get-CsEffectivePolicy cmdlet under alternate credentials. This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with user objects. @@ -139,8 +122,7 @@ For details, see the Get-Credential cmdlet help topic. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,6 +132,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to retrieve user information. To connect to a particular domain controller, include the DomainController parameter followed by the fully qualified domain name (FQDN). For example: @@ -159,8 +144,7 @@ For example: ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -169,7 +153,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the user account whose effective policy settings are being calculated. +User Identities are typically specified by using one of the following formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). +You can also reference a user account by using the user's Active Directory distinguished name. + +You can use the asterisk (*) wildcard character when using the Display Name as the user Identity. +For example, the Identity "* Smith" returns all the users who have a display name that ends with the string value " Smith". + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + ### -ResultSize + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the number of records returned by the cmdlet. For example, to return seven users (regardless of the number of users that are in your forest) include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which seven users will be returned. @@ -181,8 +191,7 @@ If you set the ResultSize to 7 but you have only three users in your forest, the ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsEnhancedEmergencyServiceDisclaimer.md b/skype/skype-ps/SkypeForBusiness/Get-CsEnhancedEmergencyServiceDisclaimer.md similarity index 88% rename from skype/skype-ps/skype/Get-CsEnhancedEmergencyServiceDisclaimer.md rename to skype/skype-ps/SkypeForBusiness/Get-CsEnhancedEmergencyServiceDisclaimer.md index 36aa47f5ad..dea8f2265d 100644 --- a/skype/skype-ps/skype/Get-CsEnhancedEmergencyServiceDisclaimer.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsEnhancedEmergencyServiceDisclaimer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csenhancedemergencyservicedisclaimer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsEnhancedEmergencyServiceDisclaimer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csenhancedemergencyservicedisclaimer +schema: 2.0.0 +title: Get-CsEnhancedEmergencyServiceDisclaimer --- # Get-CsEnhancedEmergencyServiceDisclaimer @@ -39,7 +40,7 @@ This message will be displayed only if the LocationRequired property of the user ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsEnhancedEmergencyServiceDisclaimer ``` @@ -49,47 +50,53 @@ This command retrieves the text of the enhanced emergency service disclaimer. ## PARAMETERS -### -Identity -This will always be Global. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter allows for wildcard searches of the Identity. +However, since the only valid value for Identity is Global, this parameter is not useful for this cmdlet. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -This parameter allows for wildcard searches of the Identity. -However, since the only valid value for Identity is Global, this parameter is not useful for this cmdlet. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This will always be Global. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the disclaimer information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsExUmContact.md b/skype/skype-ps/SkypeForBusiness/Get-CsExUmContact.md similarity index 86% rename from skype/skype-ps/skype/Get-CsExUmContact.md rename to skype/skype-ps/SkypeForBusiness/Get-CsExUmContact.md index e674e05256..9a090c35e2 100644 --- a/skype/skype-ps/skype/Get-CsExUmContact.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsExUmContact.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csexumcontact applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsExUmContact -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csexumcontact +schema: 2.0.0 +title: Get-CsExUmContact --- # Get-CsExUmContact @@ -33,21 +34,21 @@ This cmdlet retrieves one or more of these contacts. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsExUmContact ``` This example retrieves all Exchange UM contacts defined within a Skype for Business Server 2015 deployment. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsExUmContact -Identity sip:exum1@fabrikam.com ``` This example retrieves the Exchange UM contact with the SIP address sip:exum1@fabrikam.com -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsExUmContact -Filter {Enabled -eq $False} ``` @@ -56,7 +57,7 @@ In this example, we use the Filter parameter to retrieve all Exchange UM contact We do this by filtering on the Enabled property to see if the value of this property is equal to (-eq) False ($False). Contacts returned by this command will not function. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsExUmContact -Filter {LineURI -like "tel:555*"} ``` @@ -64,7 +65,7 @@ Get-CsExUmContact -Filter {LineURI -like "tel:555*"} This command filters on the LineURI property to retrieve all Exchange UM contacts with a LineURI beginning with tel:555. In other words, it retrieves all contacts with a phone number that begins with 555. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsExUmContact -OU "OU=ExUmContacts,DC=Vdomain,DC=com" ``` @@ -74,37 +75,39 @@ The command in this example uses the OU parameter to retrieve all Exchange UM co ## PARAMETERS -### -Identity -The unique identifier of the contact object you want to retrieve. -Contact identities can be specified using one of four formats: 1) the contact's SIP address; 2) the contact's user principal name (UPN); 3) the contact's domain name and logon name, in the form domain\logon (for example, litwareinc\exum1); and, 4) the contact's Active Directory display name (for example, Team Auto Attendant). +### -Credential -Full data type: Microsoft.Rtc.Management.AD.UserIdParameter +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to run the cmdlet under alternate credentials; this might be required if the account you used to log on to Windows does not have the necessary privileges required to work with contact objects. + +To use the Credential parameter, you must first create a PSCredential object by calling the Get-Credential cmdlet. ```yaml -Type: UserIdParameter +Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to limit the returned data by filtering on Skype for Business Server-specific attributes. -For example, you can limit returned data to contacts that have line URIs beginning with "tel:555". +### -DomainController -The Filter parameter uses a subset of the Windows PowerShell filtering syntax used by the Where-Object cmdlet. -For example, a filter that returns only contacts who have been enabled for Enterprise Voice would look like this: {EnterpriseVoiceEnabled -eq $True}, with EnterpriseVoiceEnabled representing the Active Directory attribute; -eq representing the comparison operator (equal to); and $True (a built-in Windows PowerShell variable) representing the filter value. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to connect to the specified domain controller in order to retrieve contact information. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-mcs-001) or its fully qualified domain name (for example, atl-mcs-001.litwareinc.com). + +Full data type: Microsoft.Rtc.Management.Deploy.Fqdn ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -113,16 +116,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LdapFilter -Enables you to limit the returned data by filtering "generic" Active Directory attributes (that is, attributes that are not specific to Skype for Business Server). +### -Filter -The LdapFilter parameter uses LDAP query language when creating filters. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to limit the returned data by filtering on Skype for Business Server-specific attributes. +For example, you can limit returned data to contacts that have line URIs beginning with "tel:555". + +The Filter parameter uses a subset of the Windows PowerShell filtering syntax used by the Where-Object cmdlet. +For example, a filter that returns only contacts who have been enabled for Enterprise Voice would look like this: {EnterpriseVoiceEnabled -eq $True}, with EnterpriseVoiceEnabled representing the Active Directory attribute; -eq representing the comparison operator (equal to); and $True (a built-in Windows PowerShell variable) representing the filter value. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,35 +138,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Credential -Enables you to run the cmdlet under alternate credentials; this might be required if the account you used to log on to Windows does not have the necessary privileges required to work with contact objects. +### -Identity -To use the Credential parameter, you must first create a PSCredential object by calling the Get-Credential cmdlet. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the contact object you want to retrieve. +Contact identities can be specified using one of four formats: 1) the contact's SIP address; 2) the contact's user principal name (UPN); 3) the contact's domain name and logon name, in the form domain\logon (for example, litwareinc\exum1); and, 4) the contact's Active Directory display name (for example, Team Auto Attendant). + +Full data type: Microsoft.Rtc.Management.AD.UserIdParameter ```yaml -Type: PSCredential +Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -DomainController -Enables you to connect to the specified domain controller in order to retrieve contact information. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-mcs-001) or its fully qualified domain name (for example, atl-mcs-001.litwareinc.com). +### -LdapFilter -Full data type: Microsoft.Rtc.Management.Deploy.Fqdn +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to limit the returned data by filtering "generic" Active Directory attributes (that is, attributes that are not specific to Skype for Business Server). + +The LdapFilter parameter uses LDAP query language when creating filters. ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -169,6 +180,9 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the retrieved information to a specific Active Directory organizational unit (OU). Note that this returns data from the specified OU and any child OUs. @@ -177,8 +191,7 @@ When specifying an OU, use the distinguished name of that container; for example ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -188,6 +201,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the number of records returned by a command. For example, to return just seven contacts (regardless of how many contacts are in your forest) simply include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which seven contacts will be returned. @@ -201,8 +217,7 @@ Full data type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsExternalAccessPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsExternalAccessPolicy.md similarity index 91% rename from skype/skype-ps/skype/Get-CsExternalAccessPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsExternalAccessPolicy.md index 5fa4d707b7..190dc44063 100644 --- a/skype/skype-ps/skype/Get-CsExternalAccessPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsExternalAccessPolicy.md @@ -1,12 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csexternalaccesspolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsExternalAccessPolicy -schema: 2.0.0 author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-csexternalaccesspolicy +schema: 2.0.0 +title: Get-CsExternalAccessPolicy --- # Get-CsExternalAccessPolicy @@ -55,7 +57,7 @@ The Get-CsExternalAccessPolicy cmdlet provides a way for you to return informati ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Get-CsExternalAccessPolicy ``` @@ -63,7 +65,7 @@ Get-CsExternalAccessPolicy Example 1 returns a collection of all the external access policies configured for use in your organization. Calling the Get-CsExternalAccessPolicy cmdlet without any additional parameters always returns the complete collection of external access policies. -### -------------------------- EXAMPLE 2 -------------------------- (Skype for Business Online) +### EXAMPLE 2 (Skype for Business Online) ``` Get-CsExternalAccessPolicy -Identity "tag:RedmondExternalAccessPolicy" ``` @@ -71,7 +73,7 @@ Get-CsExternalAccessPolicy -Identity "tag:RedmondExternalAccessPolicy" Example 2 uses the Identity parameter to return the external access policy that has the Identity tag:RedmondExternalAccessPolicy. Because access policy Identities must be unique, this command will never return more than one item. -### -------------------------- EXAMPLE 2 -------------------------- (Skype for Business Server 2015) +### EXAMPLE 2 (Skype for Business Server 2015) ``` Get-CsExternalAccessPolicy -Identity site:Redmond ``` @@ -79,7 +81,7 @@ Get-CsExternalAccessPolicy -Identity site:Redmond Example 2 uses the Identity parameter to return the external access policy that has the Identity site:Redmond. Because access policy Identities must be unique, this command will never return more than one item. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsExternalAccessPolicy -Filter tag:* ``` @@ -87,7 +89,7 @@ Get-CsExternalAccessPolicy -Filter tag:* The command shown in Example 3 uses the Filter parameter to return all of the external access policies that have been configured at the per-user scope; the parameter value "tag:*" limits returned data to those policies that have an Identity that begins with the string value "tag:". By definition, any policy that has an Identity beginning with "tag:" is a policy that has been configured at the per-user scope. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True} ``` @@ -96,7 +98,7 @@ In Example 4, the Get-CsExternalAccessPolicy cmdlet and the Where-Object cmdlet To do this, the Get-CsExternalAccessPolicy cmdlet is first used to return a collection of all the external access policies currently in use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those policies where the EnableFederationAccess property is equal to True. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True -and $_.EnablePublicCloudAccess -eq $True} ``` @@ -106,7 +108,7 @@ In order to perform this task, the command first uses the Get-CsExternalAccessPo That collection is then piped to the Where-Object cmdlet, which picks out only those policies that meet two criteria: the EnableFederationAccess property must be equal to True and the EnablePublicCloudAccess property must also be equal to True. Only policies in which both EnableFederationAccess and EnablePublicCloudAccess are True will be returned and displayed on the screen. -### -------------------------- EXAMPLE 6 -------------------------- +### EXAMPLE 6 ``` Get-CsExternalAccessPolicy -ApplicableTo "kenmyer@litwareinc.com" ``` @@ -119,32 +121,39 @@ NOTE: This command requires the Office 365 UsageLocation property to be configur ## PARAMETERS -### -Identity -Unique Identity assigned to the policy when it was created. -External access policies can be assigned at the global, site, or per-user scope. -To refer to the global instance use this syntax: -Identity global. -To refer to a policy at the site scope, use this syntax: -Identity site:Redmond. -To refer to a policy at the per-user scope, use syntax similar to this: -Identity RedmondPolicy. +### -ApplicableTo -Note that wildcard characters such as the asterisk (*) cannot be used with the Identity parameter. -To do a wildcard search for policies, use the Filter parameter instead. +> Applicable: Skype for Business Online -If neither the Identity nor Filter parameters are specified, then the Get-CsExternalAccessPolicy cmdlet will bring back a collection of all the external access policies configured for use in the organization. +Returns a list of the external access policies that can be assigned to the specified user. +For example, to return a collection of policies that can be assigned to the user kenmyer@litwareinc.com, use this command: + +`Get-CsExternalAccessPolicy -ApplicableTo "kenmyer@litwareinc.com"` + +The ApplicableTo parameter is useful because it's possible that only some of the available per-user external access policies can be assigned to a given user. +This is due to the fact that different licensing agreements and different country/region restrictions might limit the policies that can be assigned to a user. +For example, if Ken Myer works in China, country/region restrictions might limit his access to policies A, B, D, and E, Meanwhile, similar restrictions might limit Pilar Ackerman, who works in the United States, to policies A, B, C, and F. +If you call Get-CsExternalAccessPolicy without using the ApplicableTo parameter you will get back a collection of all the available policies, including any policies that can't actually be assigned to a specific user. + +The ApplicableTo parameter applies only to Skype for Business Online. +This parameter is not intended for use with the on-premises version of Skype for Business Server 2015. ```yaml -Type: XdsIdentity -Parameter Sets: Identity, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: UserIdParameter +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + **Below Content Applies To:** Lync Server 2010, Lync Server 2013, Skype for Business Server 2015 Enables you to do a wildcard search for external access policies. @@ -174,8 +183,7 @@ Note that the Filter parameter can only be applied to the policy Identity. ```yaml Type: String Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,43 +192,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -Retrieves the external access policy data from the local replica of the Central Management store rather than from the Central Management store itself. +### -Identity -NOTE: This parameter is not used with Skype for Business Online. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique Identity assigned to the policy when it was created. +External access policies can be assigned at the global, site, or per-user scope. +To refer to the global instance use this syntax: -Identity global. +To refer to a policy at the site scope, use this syntax: -Identity site:Redmond. +To refer to a policy at the per-user scope, use syntax similar to this: -Identity RedmondPolicy. + +Note that wildcard characters such as the asterisk (*) cannot be used with the Identity parameter. +To do a wildcard search for policies, use the Filter parameter instead. + +If neither the Identity nor Filter parameters are specified, then the Get-CsExternalAccessPolicy cmdlet will bring back a collection of all the external access policies configured for use in the organization. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity, (All) +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplicableTo -Returns a list of the external access policies that can be assigned to the specified user. -For example, to return a collection of policies that can be assigned to the user kenmyer@litwareinc.com, use this command: +### -Include -`Get-CsExternalAccessPolicy -ApplicableTo "kenmyer@litwareinc.com"` +> Applicable: Skype for Business Online -The ApplicableTo parameter is useful because it's possible that only some of the available per-user external access policies can be assigned to a given user. -This is due to the fact that different licensing agreements and different country/region restrictions might limit the policies that can be assigned to a user. -For example, if Ken Myer works in China, country/region restrictions might limit his access to policies A, B, D, and E, Meanwhile, similar restrictions might limit Pilar Ackerman, who works in the United States, to policies A, B, C, and F. -If you call Get-CsExternalAccessPolicy without using the ApplicableTo parameter you will get back a collection of all the available policies, including any policies that can't actually be assigned to a specific user. - -The ApplicableTo parameter applies only to Skype for Business Online. -This parameter is not intended for use with the on-premises version of Skype for Business Server 2015. +PARAMVALUE: Automatic | All | SubscriptionDefaults | TenantDefinedOnly ```yaml -Type: UserIdParameter +Type: PolicyFilter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -229,14 +237,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Include -PARAMVALUE: Automatic | All | SubscriptionDefaults | TenantDefinedOnly +### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Retrieves the external access policy data from the local replica of the Central Management store rather than from the Central Management store itself. + +NOTE: This parameter is not used with Skype for Business Online. ```yaml -Type: PolicyFilter +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -246,13 +258,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsExternalUserCommunicationPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsExternalUserCommunicationPolicy.md similarity index 90% rename from skype/skype-ps/skype/Get-CsExternalUserCommunicationPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsExternalUserCommunicationPolicy.md index f3dc30cd98..82394896f7 100644 --- a/skype/skype-ps/skype/Get-CsExternalUserCommunicationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsExternalUserCommunicationPolicy.md @@ -1,20 +1,22 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csexternalusercommunicationpolicy applicable: Skype for Business Online -title: Get-CsExternalUserCommunicationPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/get-csexternalusercommunicationpolicy +schema: 2.0.0 +title: Get-CsExternalUserCommunicationPolicy --- # Get-CsExternalUserCommunicationPolicy ## SYNOPSIS -Returns information about one or more external user communication policies configured for your organization. +Returns information about one or more external user communication policies configured for your organization. ## SYNTAX @@ -27,28 +29,28 @@ This cmdlet retrieves external user communication policy information. External u ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` PS C:\> Get-CsExternalUserCommunicationPolicy ``` This example displays all the external user communication policies that have been defined for an organization along with the settings for each. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` PS C:\> Get-CsExternalUserCommunicationPolicy -Identity BlockExternalP2PFileTransfer ``` This example uses the Identity parameter to retrieve the external user communication policy settings for the policy named BlockExternalP2PFileTransfer. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` PS C:\> Get-CsExternalUserCommunicationPolicy -Filter tag* ``` This example uses the Filter parameter to retrieve all the external user communication policies along with the settings for each. All per-user external user communication policies have an Identity in the format `tag:`. - -### -------------------------- Example 4 ------------------------ + +### Example 4 ``` PS C:\> Get-CsExternalUserCommunicationPolicy -Filter Block* ``` @@ -58,13 +60,15 @@ This example uses the Filter parameter to retrieve all the external user communi ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Online + This parameter accepts a wildcard string and returns all external user communication policies with identities matching that string. For example, a Filter value of tag:* will return all external user communication policies excluding Global policy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -74,13 +78,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + Unique identifier for the external user communication policy to be created. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 1 @@ -89,13 +95,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -105,6 +113,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" @@ -118,8 +129,7 @@ If you are using a remote session of Windows PowerShell and are connected only t ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsFIPSConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsFIPSConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsFIPSConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsFIPSConfiguration.md index 4a4f0b69d7..8376382b76 100644 --- a/skype/skype-ps/skype/Get-CsFIPSConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsFIPSConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csfipsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsFIPSConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csfipsconfiguration +schema: 2.0.0 +title: Get-CsFIPSConfiguration --- # Get-CsFIPSConfiguration @@ -46,7 +47,7 @@ The functions carried out by the Get-CsFIPSConfiguration cmdlet are not availabl ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsFIPSConfiguration ``` @@ -58,6 +59,9 @@ Note that there is only a single, global instance of FIPS configuration settings ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard values when referencing a collection of FIPS configuration settings. Because you can only have a single, global instance of these settings there is no reason to use the Filter parameter. However, if you prefer you can use the following syntax to reference the global settings: @@ -69,8 +73,7 @@ That syntax brings back all the FIPS configuration settings that have an Identit ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -80,6 +83,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique Identity of the FIPS configuration settings. Because you can only have a single, global instance of these settings, you do not need to specify an Identity when calling the Get-CsFIPSConfiguration cmdlet. If you prefer, however, you can use the following syntax to reference the global settings: @@ -89,8 +95,7 @@ If you prefer, however, you can use the following syntax to reference the global ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -100,13 +105,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the FIPS configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,6 +123,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose FIPS configuration settings are to be retrieved. For example: @@ -129,8 +139,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsFileTransferFilterConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsFileTransferFilterConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Get-CsFileTransferFilterConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsFileTransferFilterConfiguration.md index 388bc6c94d..6e35a7af5e 100644 --- a/skype/skype-ps/skype/Get-CsFileTransferFilterConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsFileTransferFilterConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csfiletransferfilterconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsFileTransferFilterConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csfiletransferfilterconfiguration +schema: 2.0.0 +title: Get-CsFileTransferFilterConfiguration --- # Get-CsFileTransferFilterConfiguration @@ -40,7 +41,7 @@ File transfer filter configurations include the list of file extensions that are ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsFileTransferFilterConfiguration ``` @@ -48,7 +49,7 @@ Get-CsFileTransferFilterConfiguration The command shown in Example 1 returns a collection of all the file transfer filter configurations in use in your organization. This is the default behavior any time you call the Get-CsFileTransferFilterConfiguration cmdlet without any additional parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsFileTransferFilterConfiguration -Identity site:Redmond ``` @@ -56,7 +57,7 @@ Get-CsFileTransferFilterConfiguration -Identity site:Redmond Example 2 returns a single file transfer filter configuration: the configuration that has the Identity site:Redmond. Because identities must be unique, this command can never return more than one configuration. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsFileTransferFilterConfiguration -Filter site:* @@ -65,7 +66,7 @@ Get-CsFileTransferFilterConfiguration -Filter site:* Example 3 uses the Filter parameter to return a collection of all the file transfer filter configurations at the site level. The Filter value "site:*" instructs the Get-CsFileTransferFilterConfiguration cmdlet to return only those configurations that have an Identity that begins with the string value "site:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsFileTransferFilterConfiguration | Where-Object {$_.Extensions -contains ".xls"} ``` @@ -74,7 +75,7 @@ The command shown in Example 4 returns only those file transfer filter configura To do this, the Get-CsFileTransferFilterConfiguration cmdlet is first used to return a collection of all the configurations in use in your organization. That collection is then piped to the Where-Object cmdlet, which applies a filter that restricts the returned data to those configurations where the Extensions property includes (-contains) the string value ".xls". -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsFileTransferFilterConfiguration | Where-Object {$_.Enabled -eq $False} ``` @@ -83,7 +84,7 @@ Example 5 returns all the file transfer filter configurations that are currently To accomplish this task, the Get-CsFileTransferFilterConfiguration cmdlet is used to return a collection of all the configurations in use in your organization. This collection is then piped to the Where-Object cmdlet, which, in turn, selects only those configuration where the Enabled property is equal to (-eq) False ($False). -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsFileTransferFilterConfiguration -Identity Global | Select-Object -ExpandProperty Extensions ``` @@ -96,7 +97,30 @@ That results in the complete list of file extensions being displayed on the scre ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards when specifying the file transfer filter configurations to be returned. +For example, to return all the file transfer filter configurations at the site scope, use this syntax: -Filter "site:*". +By design, file transfer filter configurations that have an Identity (the only property you can filter for) that begins with the string value "site:" were configured at the site scope. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the file transfer filter configuration you want to retrieve. To refer to the global settings, use this syntax: -Identity global. To refer to settings configured at the site scope, use syntax similar to this: -Identity site:Redmond. @@ -106,8 +130,7 @@ If you want to use wildcards, use the Filter parameter instead. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -116,32 +139,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the file transfer filter configurations to be returned. -For example, to return all the file transfer filter configurations at the site scope, use this syntax: -Filter "site:*". -By design, file transfer filter configurations that have an Identity (the only property you can filter for) that begins with the string value "site:" were configured at the site scope. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the file transfer filter configuration from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsGraphPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsGraphPolicy.md similarity index 92% rename from skype/skype-ps/skype/Get-CsGraphPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsGraphPolicy.md index 69cd22f5e8..154a57f4ef 100644 --- a/skype/skype-ps/skype/Get-CsGraphPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsGraphPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csgraphpolicy applicable: Skype for Business Online -title: Get-CsGraphPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/get-csgraphpolicy +schema: 2.0.0 +title: Get-CsGraphPolicy --- # Get-CsGraphPolicy @@ -17,7 +19,7 @@ Use the `Get-CsGraphPolicy` cmdlet to return information about one or more graph ## SYNTAX ``` -Get-CsGraphPolicy [[-Identity] ] [-Filter ] [-LocalStore] [-Tenant ] +Get-CsGraphPolicy [[-Identity] ] [-Filter ] [-LocalStore] [-Tenant ] [] ``` @@ -30,7 +32,7 @@ Get-CsAdminRole | Where-Object {$_.Cmdlets -Match "Get-CsGraphPolicy"} ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsGraphPolicy ``` @@ -41,13 +43,15 @@ This example returns all predefined graph policies in your organization. ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Online + This parameter accepts a wildcard string and returns all graph policies with identities matching that string. For example, a Filter value of "\*Enabled\*" will return all policies which contain the string "Enabled". ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -57,13 +61,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + Specifies the identity of the predefined graph policy to return. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 2 @@ -73,13 +79,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -89,6 +97,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" @@ -102,8 +113,7 @@ If you are using a remote session of Windows PowerShell and are connected only t ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsGroupPickupUserOrbit.md b/skype/skype-ps/SkypeForBusiness/Get-CsGroupPickupUserOrbit.md similarity index 88% rename from skype/skype-ps/skype/Get-CsGroupPickupUserOrbit.md rename to skype/skype-ps/SkypeForBusiness/Get-CsGroupPickupUserOrbit.md index 199078925f..abf8eb78ee 100644 --- a/skype/skype-ps/skype/Get-CsGroupPickupUserOrbit.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsGroupPickupUserOrbit.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csgrouppickupuserorbit applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsGroupPickupUserOrbit -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csgrouppickupuserorbit +schema: 2.0.0 +title: Get-CsGroupPickupUserOrbit --- # Get-CsGroupPickupUserOrbit @@ -25,14 +26,14 @@ Get-CsGroupPickupUserOrbit [-User] [-Force] [] ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsGroupPickupUserOrbit -User sip:ken.myer@contoso.com ``` The following example gets the group pickup orbit number of a user specified by SIP address. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsGroupPickupUserOrbit "Ken Myer" ``` @@ -41,7 +42,7 @@ The following example gets the group pickup orbit number by using the display na User is a positional parameter. The first parameter after the cmdlet is assumed to be the User parameter value. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsUser "Ken Myer" | Get-CsGroupPickupUserOrbit ``` @@ -51,7 +52,28 @@ The following example gets the group pickup orbit numbers by piping the output o ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -User + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the user whose group pickup orbit number will be retrieved. Because User is a positional parameter, the -User syntax is not required. The first parameter after the cmdlet is assumed to be the User parameter value. @@ -63,7 +85,6 @@ You can also reference a user account by using the user's Active Directory disti Type: String Parameter Sets: (All) Aliases: DisplayName, SipAddress, Identity -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 1 @@ -72,22 +93,6 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 - -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). diff --git a/skype/skype-ps/skype/Get-CsHealthMonitoringConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsHealthMonitoringConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsHealthMonitoringConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsHealthMonitoringConfiguration.md index ce017ff110..7662cca761 100644 --- a/skype/skype-ps/skype/Get-CsHealthMonitoringConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsHealthMonitoringConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cshealthmonitoringconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsHealthMonitoringConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cshealthmonitoringconfiguration +schema: 2.0.0 +title: Get-CsHealthMonitoringConfiguration --- # Get-CsHealthMonitoringConfiguration @@ -50,21 +51,21 @@ The Get-CsHealthMonitoringConfiguration cmdlet provides a way for you to retriev ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsHealthMonitoringConfiguration ``` Example 1 returns all the health monitoring configuration settings currently in use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsHealthMonitoringConfiguration -Identity atl-cs-001.litwareinc.com ``` The command shown in Example 2 returns a single collection of health monitoring configuration settings: the settings that have the Identity atl-cs-001.litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsHealthMonitoringConfiguration -Filter *.litwareinc.com ``` @@ -72,7 +73,7 @@ Get-CsHealthMonitoringConfiguration -Filter *.litwareinc.com Example 3 returns all the health monitoring configuration settings that have been created for the domain litwareinc.com. To do this, the Get-CsHealthMonitoringConfiguration cmdlet is called along with the Filter parameter; the filter value "*.litwareinc.com" ensures that only those settings that have an Identity that ends with the string value ".litwareinc.com" will be returned. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsHealthMonitoringConfiguration | Where-Object {$_.FirstTestUserSipUri -eq "sip:kenmyer@litwareinc.com" -or $_.SecondTestUserSipUri -eq " sip:kenmyer@litwareinc.com"} ``` @@ -85,50 +86,56 @@ As a result, any collection of settings where Ken Myer's SIP address is used for ## PARAMETERS -### -Identity -Fully qualified domain name (FQDN) of the pool where the health monitoring configuration settings have been assigned. -For example: -Identity atl-cs-001.litwareinc.com. +### -Filter -If this parameter is not included, then the Get-CsHealthMonitoringConfiguration cmdlet will return information about all the health monitoring configuration settings currently in use. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters when specifying the health monitoring configuration settings to be retrieved. +For example, this syntax returns all the settings configured for the litwareinc.com domain: -Filter "*.litwareinc.com". ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when specifying the health monitoring configuration settings to be retrieved. -For example, this syntax returns all the settings configured for the litwareinc.com domain: -Filter "*.litwareinc.com". +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the pool where the health monitoring configuration settings have been assigned. +For example: -Identity atl-cs-001.litwareinc.com. + +If this parameter is not included, then the Get-CsHealthMonitoringConfiguration cmdlet will return information about all the health monitoring configuration settings currently in use. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the health monitoring configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsHostedVoicemailPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsHostedVoicemailPolicy.md similarity index 86% rename from skype/skype-ps/skype/Get-CsHostedVoicemailPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsHostedVoicemailPolicy.md index 7910736a0e..98aeaefd14 100644 --- a/skype/skype-ps/skype/Get-CsHostedVoicemailPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsHostedVoicemailPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cshostedvoicemailpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsHostedVoicemailPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-cshostedvoicemailpolicy +schema: 2.0.0 +title: Get-CsHostedVoicemailPolicy --- # Get-CsHostedVoicemailPolicy @@ -39,21 +41,21 @@ You can call the Get-CsUser cmdlet and check the HostedVoiceMail property to det ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsHostedVoicemailPolicy ``` This command returns all defined hosted voice mail policies for the Skype for Business Server 2015 implementation. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsHostedVoicemailPolicy -Identity ExRedmond ``` This command returns the policy settings for the per-user hosted voice mail policy ExRedmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsHostedVoicemailPolicy -Filter tag:* ``` @@ -62,48 +64,54 @@ This command returns the policy settings for all per-user hosted voice mail poli ## PARAMETERS -### -Identity -The unique identifier for the hosted voice mail policy you want to retrieve. -The Identity includes the scope (in the case of global), the scope and site (for a site policy, such as site:Redmond), or the policy name (for a per-user policy, such as HVUserPolicy). +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter allows you to do a wildcard search on the Identity of the hosted voice mail policy. +This will retrieve all instances of a hosted voice mail policy where the Identity matches the wildcard pattern specified in the Filter value. ```yaml -Type: XdsIdentity -Parameter Sets: Identity, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter, (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -This parameter allows you to do a wildcard search on the Identity of the hosted voice mail policy. -This will retrieve all instances of a hosted voice mail policy where the Identity matches the wildcard pattern specified in the Filter value. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier for the hosted voice mail policy you want to retrieve. +The Identity includes the scope (in the case of global), the scope and site (for a site policy, such as site:Redmond), or the policy name (for a per-user policy, such as HVUserPolicy). ```yaml -Type: String -Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity, (All) +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the hosted voice mail policy from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsHostingProvider.md b/skype/skype-ps/SkypeForBusiness/Get-CsHostingProvider.md similarity index 90% rename from skype/skype-ps/skype/Get-CsHostingProvider.md rename to skype/skype-ps/SkypeForBusiness/Get-CsHostingProvider.md index 3e5f2a3e66..c2e6080cbb 100644 --- a/skype/skype-ps/skype/Get-CsHostingProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsHostingProvider.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cshostingprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsHostingProvider -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-cshostingprovider +schema: 2.0.0 +title: Get-CsHostingProvider --- # Get-CsHostingProvider @@ -53,7 +55,7 @@ Note that you cannot federate with a hosting provider if your Edge Servers are c ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsHostingProvider ``` @@ -61,7 +63,7 @@ Get-CsHostingProvider Example 1 returns a collection of all the hosting providers configured for use in the organization. Calling the Get-CsHostingProvider cmdlet without any additional parameters returns the complete collection of hosting providers. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsHostingProvider -Identity Fabrikam.com ``` @@ -69,14 +71,14 @@ Get-CsHostingProvider -Identity Fabrikam.com Example 2 returns the hosting provider that has the Identity Fabrikam.com. Because Identities must be unique among hosting providers, this command will never return more than a single item. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsHostingProvider -Filter *.org ``` The command shown in Example 3 returns a collection of all the hosting providers that have an Identity that ends with the string value ".org" (for example, fabrikam.org and contoso.org). -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsHostingProvider | Where-Object {$_.Enabled -eq $True} ``` @@ -85,7 +87,7 @@ In Example 4, all the hosting providers that are currently enabled for use are r To do this, the Get-CsHostingProvider cmdlet is first called in order to return a collection of all the hosting providers currently configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those providers where the Enabled property is equal to True. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsHostingProvider | Where-Object {$_.Enabled -eq $True -and $_.EnabledSharedAddressSpace -eq $True} ``` @@ -94,7 +96,7 @@ Example 5 returns all the hosting providers that have a shared address space and (Split domain simply means that some of your Skype for Business Server 2015 accounts are maintained on-premises while other accounts are maintained by a hosting provider.) To carry out this task, the command first uses the Get-CsHostingProvider cmdlet to return a collection of all the currently configured hosting providers. This collection is then piped to the Where-Object cmdlet, which selects only those providers that meet two criteria: 1) the Enabled property is equal to True; and, 2) the EnabledSharedAddressSpace property is equal to True. -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsHostingProvider | Select-Object * ``` @@ -106,51 +108,57 @@ To see the values for these properties, the information returned by the Get-CsHo ## PARAMETERS -### -Identity -Unique identifier for the hosting provider to be returned. -The Identity might be the fully qualified domain name (FQDN) of the hosting provider (for example, fabrikam.com) or perhaps the name of the company providing the services (Fabrikam, Inc.). +### -Filter -If this parameter is not specified, the Get-CsHostingProvider cmdlet will return a collection of all the hosting providers configured for use in your organization. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard values to return one or more hosting providers. +For example, to return all the hosting providers that have an identity that ends with the string value ".com" use this syntax: -Filter "*.com". +To return all the hosting providers that have an Identity that begins with the string "Fabri" use this syntax: -Filter "Fabri*". ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter, (All) +Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard values to return one or more hosting providers. -For example, to return all the hosting providers that have an identity that ends with the string value ".com" use this syntax: -Filter "*.com". -To return all the hosting providers that have an Identity that begins with the string "Fabri" use this syntax: -Filter "Fabri*". +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the hosting provider to be returned. +The Identity might be the fully qualified domain name (FQDN) of the hosting provider (for example, fabrikam.com) or perhaps the name of the company providing the services (Fabrikam, Inc.). + +If this parameter is not specified, the Get-CsHostingProvider cmdlet will return a collection of all the hosting providers configured for use in your organization. ```yaml -Type: String -Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: (All) +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the hosting provider data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsHybridApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/Get-CsHybridApplicationEndpoint.md similarity index 90% rename from skype/skype-ps/skype/Get-CsHybridApplicationEndpoint.md rename to skype/skype-ps/SkypeForBusiness/Get-CsHybridApplicationEndpoint.md index 4fe4251dd1..5061321cf0 100644 --- a/skype/skype-ps/skype/Get-CsHybridApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsHybridApplicationEndpoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cshybridapplicationendpoint applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsHybridApplicationEndpoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cshybridapplicationendpoint +schema: 2.0.0 +title: Get-CsHybridApplicationEndpoint --- # Get-CsHybridApplicationEndpoint @@ -29,21 +30,21 @@ The `Get-CsHybridApplicationEndpoint` cmdlet provides numerous ways for you to f ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` -PS C:\> Get-CsHybridApplicationEndpoint +PS C:\> Get-CsHybridApplicationEndpoint ``` This example displays all the hybrid application endpoints that have been defined for an organization along with the settings for each. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Get-CsHybridApplicationEndpoint -Identity "CN={4f6c99fe-7999-4088-ac4d-e88e0b3d3820},OU=Redmond,DC=litwareinc,DC=com" ``` This example uses the Identity parameter to retrieve the hybrid application endpoint settings for a specific endpoint. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> Get-CsHybridApplicationEndpoint -Filter {DisplayName -like "*bot*"} ``` @@ -53,6 +54,9 @@ This example uses the Filter parameter to retrieve all the hybrid application en ## PARAMETERS ### -Credential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to run the Get-CsHybridApplicationEndpoint cmdlet under alternate credentials. This might be required if the account you used to log on to the Windows does not have the necessary privileges required to work with user objects. To use the Credential parameter you must first create a PSCredential object by using the [Get-Credential](https://learn.microsoft.com/powershell/module/microsoft.powershell.security/get-credential?view=powershell-6) cmdlet. For details, see the Get-Credential cmdlet help topic. @@ -61,7 +65,6 @@ To use the Credential parameter you must first create a PSCredential object by u Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -71,13 +74,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to retrieve user information. To connect to a particular domain controller, include the DomainController parameter followed by the fully qualified domain name (FQDN) (for example, atl-cs-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on Skype for Business Server 2015-specific attributes. For example, you can limit returned data to endpoints with specific word in their DisplayName attribute. The Filter parameter uses the same Windows PowerShell filtering syntax that is used by the Where-Object cmdlet. For example, a filter that returns only endpoints with a value in their LineURI attribute would look like this, with LineURI representing the Active Directory attribute, -ne representing the comparison operator (not equal to), and $null (a built-in Windows PowerShell variable) representing the filter value: @@ -97,7 +105,6 @@ The Filter parameter uses the same Windows PowerShell filtering syntax that is u Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique application Id for the endpoint you want to get. ```yaml Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: 0 @@ -123,6 +132,9 @@ Accept wildcard characters: False ``` ### -LdapFilter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business Server 2015). For example, you can limit returned data to endpoints which work in a specific department, or endpoints which have a specified manager or job title. The LdapFilter parameter uses the LDAP query language when creating filters. For example, a filter that returns only endpoints which belongs in the city of Redmond would look like this: "l=Redmond", with "l" (a lowercase L) representing the Active Directory attribute (locality); "=" representing the comparison operator (equal to); and "Redmond" representing the filter value. @@ -131,7 +143,6 @@ The LdapFilter parameter uses the LDAP query language when creating filters. For Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -141,6 +152,9 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to return information about endpoints in a specific organizational unit (OU) or container. The OU parameter returns data from both the specified OU and any of its child OUs. For example, if the Finance OU has two child OUs--AccountsPayable and AccountsReceivable--endpoints will be returned from each of these three OUs. When specifying an OU, use the distinguished name (DN) of that container; for example: -OU "OU=Finance,dc=litwareinc,dc=com". To return endpoints accounts from the Users container, use this syntax: @@ -151,7 +165,6 @@ When specifying an OU, use the distinguished name (DN) of that container; for ex Type: OUIdParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -161,6 +174,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the number of records returned by the cmdlet. For example, to return seven endpoints (regardless of the number of endpoints that are in your forest) include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which seven endpoints will be returned. The result size can be set to any whole number between 0 and 2147483647, inclusive. If set to 0 the command will run, but no data will be returned. If you set the ResultSize to 7 but you have only three endpoints in your forest, the command will return those three endpoints, and then complete without error. @@ -169,7 +185,6 @@ The result size can be set to any whole number between 0 and 2147483647, inclusi Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsHybridMediationServer.md b/skype/skype-ps/SkypeForBusiness/Get-CsHybridMediationServer.md similarity index 92% rename from skype/skype-ps/skype/Get-CsHybridMediationServer.md rename to skype/skype-ps/SkypeForBusiness/Get-CsHybridMediationServer.md index 22a1a60c23..fd38bd26e3 100644 --- a/skype/skype-ps/skype/Get-CsHybridMediationServer.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsHybridMediationServer.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cshybridmediationserver applicable: Skype for Business Online -title: Get-CsHybridMediationServer -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/get-cshybridmediationserver +schema: 2.0.0 +title: Get-CsHybridMediationServer --- # Get-CsHybridMediationServer @@ -33,7 +35,7 @@ If the user has licenses assigned, the warning message will be shown as guidance ## EXAMPLES -### -------------------------- Example 1 -------------------------- (Skype for Business Online) +### Example 1 (Skype for Business Online) ``` Get-CsHybridMediationServer -Fqdn MediationServer.Contoso.com ``` @@ -44,14 +46,16 @@ This example gets the FQDN of a mediation server access proxy. ## PARAMETERS ### -Identity + +> Applicable: Skype for Business Online + Specifies the identity of the hybrid public switched telephone network (PSTN) site. For example: -Identity "SeattlePSTN". ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 1 @@ -60,14 +64,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. +### -Tenant + +> Applicable: Skype for Business Online + +Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. +For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308". +You can find your tenant ID by running this command: Get-CsTenant | Select-Object DisplayName, TenantID If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online, you do not have to include the Tenant parameter. +The tenant ID will be determined by your connection and credentials. +The Tenant parameter is primarily for use in a hybrid deployment. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -76,18 +86,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. -For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308". -You can find your tenant ID by running this command: Get-CsTenant | Select-Object DisplayName, TenantID If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online, you do not have to include the Tenant parameter. -The tenant ID will be determined by your connection and credentials. -The Tenant parameter is primarily for use in a hybrid deployment. +### -Confirm + +> Applicable: Skype for Business Online + +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -97,6 +105,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -104,7 +115,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsHybridPSTNAppliance.md b/skype/skype-ps/SkypeForBusiness/Get-CsHybridPSTNAppliance.md similarity index 89% rename from skype/skype-ps/skype/Get-CsHybridPSTNAppliance.md rename to skype/skype-ps/SkypeForBusiness/Get-CsHybridPSTNAppliance.md index 35c6ae3de8..6a0c011f06 100644 --- a/skype/skype-ps/skype/Get-CsHybridPSTNAppliance.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsHybridPSTNAppliance.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cshybridpstnappliance applicable: Skype for Business Online -title: Get-CsHybridPSTNAppliance -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/get-cshybridpstnappliance +schema: 2.0.0 +title: Get-CsHybridPSTNAppliance --- # Get-CsHybridPSTNAppliance @@ -20,7 +22,7 @@ Use the `Get-CsHybridPSTNAppliance` cmdlet to retrieve information about your Sk ## SYNTAX ``` -Get-CsHybridPSTNAppliance [-Name ] [-LocalStore] [[-Identity] ] +Get-CsHybridPSTNAppliance [-Name ] [-LocalStore] [[-Identity] ] [-Tenant ] [-Filter ] [-SiteName ] [] ``` @@ -36,28 +38,28 @@ Get-CsAdminRole | Where-Object {$_.Cmdlets -Match "\"} ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsHybridPSTNAppliance ``` The command shown in Example 1 returns information for all the Skype for Business Cloud Connector Edition appliances. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsHybridPSTNAppliance -SiteName "SeattlePSTN" ``` The command shown in Example 2 returns information for all the Skype for Business Cloud Connector Edition appliances in the given site. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsHybridPSTNAppliance -Name "CCE1" ``` The command shown in Example 3 returns information for the Skype for Business Cloud Connector Edition appliance with the given name. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsHybridPSTNAppliance -SiteName "SeattlePSTN" -Name "CCE1" ``` @@ -68,13 +70,15 @@ The command shown in Example 4 returns information for the Skype for Business Cl ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Online + This parameter accepts a wildcard string and returns all hybrid PSTN appliances with identities matching that string. For example, a Filter value of "CCE*" will return all appliances which start with the string "CCE". ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -84,13 +88,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + Specifies the identity of the Skype for Business Cloud Connector Edition appliance. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 2 @@ -100,13 +106,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -116,13 +124,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Skype for Business Online + Name of Skype for Business Cloud Connector Edition appliance. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -132,13 +142,15 @@ Accept wildcard characters: False ``` ### -SiteName + +> Applicable: Skype for Business Online + Name of Skype for Business Cloud Connector Edition site that the appliance belongs to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -148,6 +160,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" @@ -161,8 +176,7 @@ If you are using a remote session of Windows PowerShell and are connected only t ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsHybridPSTNSite.md b/skype/skype-ps/SkypeForBusiness/Get-CsHybridPSTNSite.md similarity index 92% rename from skype/skype-ps/skype/Get-CsHybridPSTNSite.md rename to skype/skype-ps/SkypeForBusiness/Get-CsHybridPSTNSite.md index 3bfc36476a..8da19c3995 100644 --- a/skype/skype-ps/skype/Get-CsHybridPSTNSite.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsHybridPSTNSite.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cshybridpstnsite applicable: Skype for Business Online -title: Get-CsHybridPSTNSite -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/get-cshybridpstnsite +schema: 2.0.0 +title: Get-CsHybridPSTNSite --- # Get-CsHybridPSTNSite @@ -40,14 +42,14 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsHybridPSTNSite ``` The command shown in Example 1 returns information for all the PSTN sites. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsHybridPSTNSite -Identity "SeattlePSTN" ``` @@ -58,14 +60,16 @@ The command shown in Example 2 returns information for the PSTN site with the gi ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Online + Enables you to limit the returned data by filtering on (PSTN) site specific attributes. The Filter parameter uses the same filtering syntax that is used by the Where-Object cmdlet. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -75,14 +79,16 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + Specifies the identity of the hybrid public switched telephone network (PSTN) site. For example: -Identity "SeattlePSTN". ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 2 @@ -92,13 +98,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Online + Retrieves the information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -108,6 +116,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Specifies the global unique identifier (GUID) of the Skype for Business Online tenant account on which the cmdlet will operate. For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308". @@ -120,8 +131,7 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsIPPhonePolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsIPPhonePolicy.md similarity index 87% rename from skype/skype-ps/skype/Get-CsIPPhonePolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsIPPhonePolicy.md index 7ae4ac2e57..e43e70482e 100644 --- a/skype/skype-ps/skype/Get-CsIPPhonePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsIPPhonePolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csipphonepolicy applicable: Skype for Business Server 2019 -title: Get-CsIPPhonePolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/get-csipphonepolicy +schema: 2.0.0 +title: Get-CsIPPhonePolicy --- # Get-CsIPPhonePolicy @@ -26,7 +28,7 @@ IP phone policies are applied each time a user accesses the system via an IP pho ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` PS C:\> Get-CsIPPhonePolicy ``` @@ -36,13 +38,15 @@ This example returns the global IP phone policy along with all their settings. ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -52,13 +56,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -68,13 +74,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -84,13 +92,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsImConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsImConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Get-CsImConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsImConfiguration.md index b174055e0f..cd94b8d5cf 100644 --- a/skype/skype-ps/skype/Get-CsImConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsImConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csimconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsImConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csimconfiguration +schema: 2.0.0 +title: Get-CsImConfiguration --- # Get-CsImConfiguration @@ -32,7 +33,7 @@ Use the Get-CsImConfiguration cmdlet to retrieve information about Instant Messa ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsImConfiguration ``` @@ -42,13 +43,15 @@ This example returns information for all Instant Messaging (IM) configurations i ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return a collection of items. For instance the following usage specifies all the site scoped IM configurations: -Filter "site:*" . Filter and Identity are mutually exclusive. ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -58,14 +61,16 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier specifying the scope and, in some cases the name, of the IM configuration. If this parameter is omitted, all IM configurations for the organization are returned. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -75,13 +80,15 @@ Accept wildcard characters: False ``` ### -LocalStore -Presence of this switch causes the cmdlet to retrieve information from the local replica of the Central Management store, rather than from Central Management store itself. + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Presence of this switch causes the cmdlet to retrieve information from the local replica of the Central Management store, rather than from Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -91,13 +98,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsImFilterConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsImFilterConfiguration.md similarity index 84% rename from skype/skype-ps/skype/Get-CsImFilterConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsImFilterConfiguration.md index fec8ca39e9..0877573ff1 100644 --- a/skype/skype-ps/skype/Get-CsImFilterConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsImFilterConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csimfilterconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsImFilterConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-csimfilterconfiguration +schema: 2.0.0 +title: Get-CsImFilterConfiguration --- # Get-CsImFilterConfiguration @@ -43,7 +45,7 @@ You can also specify an Identity to show the settings for a specific site (or th ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsImFilterConfiguration ``` @@ -51,7 +53,7 @@ Get-CsImFilterConfiguration The command shown in Example 1 returns a collection of all the IM hyperlink filters configured for use in your organization. This is the behavior any time you call the Get-CsImFilterConfiguration cmdlet without any additional parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsImFilterConfiguration -Identity site:Redmond ``` @@ -59,7 +61,7 @@ Get-CsImFilterConfiguration -Identity site:Redmond Example 2 returns settings for one IM filter: the settings that have the Identity site:Redmond. Because identities must be unique, this command can never return more than one configuration. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsImFilterConfiguration -Filter site:* ``` @@ -67,7 +69,7 @@ Get-CsImFilterConfiguration -Filter site:* Example 3 uses the Filter parameter to return a collection of all the IM filters that have been configured at the site level. The wildcard string site:* instructs the Get-CsImFilterConfiguration cmdlet to return only those IM filter configurations that have an Identity that begins with the string value site:. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` (Get-CsImFilterConfiguration -Identity Global).Prefixes ``` @@ -80,30 +82,41 @@ That tells Windows PowerShell to first carry out the command enclosed in parenth ## PARAMETERS -### -Identity -The unique identifier of the settings you want to retrieve. -This will be either global or site:\, where \ is the name of the site to which these settings apply, such as site:Redmond. +### -Filter -Full Data Type: Microsoft.Rtc.Management.Xds.XdsIdentity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Performs a wildcard search for configurations matching a given Identity pattern. +For example, returns all settings with identities beginning with site* (all site-specific settings). ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter, (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the settings you want to retrieve. +This will be either global or site:\, where \ is the name of the site to which these settings apply, such as site:Redmond. + +Full Data Type: Microsoft.Rtc.Management.Xds.XdsIdentity + ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -112,31 +125,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Performs a wildcard search for configurations matching a given Identity pattern. -For example, returns all settings with identities beginning with site* (all site-specific settings). - -```yaml -Type: String -Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the IM filter configuration from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsImTranslationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsImTranslationConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Get-CsImTranslationConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsImTranslationConfiguration.md index 4c07855098..4cce44ad49 100644 --- a/skype/skype-ps/skype/Get-CsImTranslationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsImTranslationConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csimtranslationconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsImTranslationConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csimtranslationconfiguration +schema: 2.0.0 +title: Get-CsImTranslationConfiguration --- # Get-CsImTranslationConfiguration @@ -32,7 +33,7 @@ This cmdlet is reserved for internal Microsoft use. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` This cmdlet is reserved for internal Microsoft use. ``` @@ -43,13 +44,15 @@ This cmdlet is reserved for internal Microsoft use. ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -59,13 +62,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -75,13 +80,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsKerberosAccountAssignment.md b/skype/skype-ps/SkypeForBusiness/Get-CsKerberosAccountAssignment.md similarity index 90% rename from skype/skype-ps/skype/Get-CsKerberosAccountAssignment.md rename to skype/skype-ps/SkypeForBusiness/Get-CsKerberosAccountAssignment.md index 769b89632e..5be7e6aa13 100644 --- a/skype/skype-ps/skype/Get-CsKerberosAccountAssignment.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsKerberosAccountAssignment.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cskerberosaccountassignment applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsKerberosAccountAssignment -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cskerberosaccountassignment +schema: 2.0.0 +title: Get-CsKerberosAccountAssignment --- # Get-CsKerberosAccountAssignment @@ -46,21 +47,21 @@ The Get-CsKerberosAccountAssignment cmdlet provides a way for you to return info ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsKerberosAccountAssignment ``` The command shown in Example 1 returns information about all the Kerberos account assignments currently in use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsKerberosAccountAssignment -Identity "site:Redmond" ``` Example 2 returns information about a single Kerberos account assignment: the account assignment for the Redmond site. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsKerberosAccountAssignment -Filter "*Redmond*" ``` @@ -68,7 +69,7 @@ Get-CsKerberosAccountAssignment -Filter "*Redmond*" In Example 3, information is returned for all the Kerberos accounts that have been assigned to sites that have the string value "Redmond" somewhere in their site Identity. To do this, the Filter parameter is included along with the filter value "*Redmond". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsKerberosAccountAssignment | Where-Object {$_.UserAccount -match "litwareinc"} ``` @@ -81,53 +82,59 @@ This collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS -### -Identity -Unique identifier of the site where the Kerberos account was assigned; for example: -Identity "site:Redmond". -(Note that this is the Identity of the site, not of the computer account.) You cannot use wildcards when specifying the site identity. -To employ wildcards, use the Filter parameter instead. +### -Filter -If neither the Identity nor the Filter parameter is included, then the Get-CsKerberosAccountAssignment cmdlet returns all the Kerberos account assignments configured for use in the organization. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters when specifying the Kerberos account assignment (or assignments) to be returned. +For example, this syntax returns all the account assignments that include the string value "Europe": -Filter "*Europe*". + +You cannot use both the Identity and the Filter parameters in the same command. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters when specifying the Kerberos account assignment (or assignments) to be returned. -For example, this syntax returns all the account assignments that include the string value "Europe": -Filter "*Europe*". +### -Identity -You cannot use both the Identity and the Filter parameters in the same command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier of the site where the Kerberos account was assigned; for example: -Identity "site:Redmond". +(Note that this is the Identity of the site, not of the computer account.) You cannot use wildcards when specifying the site identity. +To employ wildcards, use the Filter parameter instead. + +If neither the Identity nor the Filter parameter is included, then the Get-CsKerberosAccountAssignment cmdlet returns all the Kerberos account assignments configured for use in the organization. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the Kerberos assignment data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsLisCivicAddress.md b/skype/skype-ps/SkypeForBusiness/Get-CsLisCivicAddress.md similarity index 93% rename from skype/skype-ps/skype/Get-CsLisCivicAddress.md rename to skype/skype-ps/SkypeForBusiness/Get-CsLisCivicAddress.md index c1fd4ffdb0..6c0655889e 100644 --- a/skype/skype-ps/skype/Get-CsLisCivicAddress.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsLisCivicAddress.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csliscivicaddress applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsLisCivicAddress -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csliscivicaddress +schema: 2.0.0 +title: Get-CsLisCivicAddress --- # Get-CsLisCivicAddress @@ -36,7 +37,7 @@ This flag can be automatically updated by running the Test-CsLisCivicAddress cmd ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsLisCivicAddress ``` @@ -46,7 +47,7 @@ The Get-CsLisCivicAddress cmdlet does not accept any parameters (other than the Therefore any call to the Get-CsLisCivicAddress cmdlet will always return all civic addresses. See Example 2 for a command that will allow you to retrieve more specific results. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLisCivicAddress | Where-Object {$_.City -eq "Redmond"} ``` @@ -55,7 +56,7 @@ In this example, all the civic addresses in the city of Redmond are retrieved. The example begins with a call to the Get-CsLisCivicAddress cmdlet, which retrieves a collection of all civic addresses in the location database. This collection is then piped to the Where-Object cmdlet, which will return only those items in the collection with a City property value equal to (-eq) Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsLisCivicAddress | Where-Object {$_.MSAGValid -eq $true} ``` diff --git a/skype/skype-ps/skype/Get-CsLisLocation.md b/skype/skype-ps/SkypeForBusiness/Get-CsLisLocation.md similarity index 91% rename from skype/skype-ps/skype/Get-CsLisLocation.md rename to skype/skype-ps/SkypeForBusiness/Get-CsLisLocation.md index 7b91277e0f..d32a8a25aa 100644 --- a/skype/skype-ps/skype/Get-CsLisLocation.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsLisLocation.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cslislocation applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsLisLocation -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cslislocation +schema: 2.0.0 +title: Get-CsLisLocation --- # Get-CsLisLocation @@ -34,14 +35,14 @@ The Get-CsLisCivicAddress cmdlet retrieves only address information. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsLisLocation ``` Calling the Get-CsLisLocation cmdlet with no parameters retrieves all locations defined within the location configuration database. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLisLocation -Unreferenced ``` @@ -49,7 +50,7 @@ Get-CsLisLocation -Unreferenced The Unreferenced parameter doesn't accept a value. It's simply a switch that tells the Get-CsLisLocation cmdlet to return only those locations that are not associated with a port, switch, subnet, or wireless access point. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsLisLocation | Where-Object {$_.Location -ceq "NorthCampus"} ``` @@ -64,14 +65,16 @@ That means that in this case only locations with Location values of NorthCampus ## PARAMETERS ### -Unreferenced + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Including this parameter will retrieve only the locations that were not associated with a port, subnet, switch, or wireless access point. In other words, including this parameter retrieves all locations that either were created by calling the Set-CsLisLocation cmdlet or that were assigned to a Location Information Server (LIS) port, subnet, switch, or wireless access point that no longer exists. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsLisPort.md b/skype/skype-ps/SkypeForBusiness/Get-CsLisPort.md similarity index 95% rename from skype/skype-ps/skype/Get-CsLisPort.md rename to skype/skype-ps/SkypeForBusiness/Get-CsLisPort.md index 3eec392209..c1858bed1e 100644 --- a/skype/skype-ps/skype/Get-CsLisPort.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsLisPort.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cslisport applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsLisPort -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cslisport +schema: 2.0.0 +title: Get-CsLisPort --- # Get-CsLisPort @@ -38,14 +39,14 @@ To narrow down the information retrieved, you must pipe the output from this cmd ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsLisPort ``` Example 1 retrieves all Location Information Server (LIS) ports and any associated locations that have been defined in the Skype for Business Server deployment. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLisPort | Where-Object {$_.City -eq "Redmond"} ``` diff --git a/skype/skype-ps/skype/Get-CsLisServiceProvider.md b/skype/skype-ps/SkypeForBusiness/Get-CsLisServiceProvider.md similarity index 96% rename from skype/skype-ps/skype/Get-CsLisServiceProvider.md rename to skype/skype-ps/SkypeForBusiness/Get-CsLisServiceProvider.md index 2efdc5c58d..3f27b8d9d6 100644 --- a/skype/skype-ps/skype/Get-CsLisServiceProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsLisServiceProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cslisserviceprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsLisServiceProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cslisserviceprovider +schema: 2.0.0 +title: Get-CsLisServiceProvider --- # Get-CsLisServiceProvider @@ -31,7 +32,7 @@ This cmdlet retrieves information about a provider, including the name of the pr ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsLisServiceProvider ``` diff --git a/skype/skype-ps/skype/Get-CsLisSubnet.md b/skype/skype-ps/SkypeForBusiness/Get-CsLisSubnet.md similarity index 95% rename from skype/skype-ps/skype/Get-CsLisSubnet.md rename to skype/skype-ps/SkypeForBusiness/Get-CsLisSubnet.md index 070908d63a..6b3fd067a9 100644 --- a/skype/skype-ps/skype/Get-CsLisSubnet.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsLisSubnet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cslissubnet applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsLisSubnet -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cslissubnet +schema: 2.0.0 +title: Get-CsLisSubnet --- # Get-CsLisSubnet @@ -38,14 +39,14 @@ To narrow down the information retrieved, you must pipe the output from this cmd ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsLisSubnet ``` Example 1 retrieves all Location Information Server (LIS) subnets that have been defined in the Skype for Business Server deployment. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLisSubnet | Where-Object {$_.Subnet -eq "192.0.10.0"} ``` diff --git a/skype/skype-ps/skype/Get-CsLisSwitch.md b/skype/skype-ps/SkypeForBusiness/Get-CsLisSwitch.md similarity index 94% rename from skype/skype-ps/skype/Get-CsLisSwitch.md rename to skype/skype-ps/SkypeForBusiness/Get-CsLisSwitch.md index b4fbab5b8d..941e41d5dd 100644 --- a/skype/skype-ps/skype/Get-CsLisSwitch.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsLisSwitch.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cslisswitch applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsLisSwitch -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cslisswitch +schema: 2.0.0 +title: Get-CsLisSwitch --- # Get-CsLisSwitch @@ -38,14 +39,14 @@ To narrow down the information retrieved you must pipe the output from this cmdl ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsLisSwitch ``` Example 1 retrieves all Location Information Server (LIS) switches that have been defined in the Skype for Business Server deployment. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLisSwitch | Where-Object {$_.ChassisID -eq "99-99-99-99-99-99"} ``` @@ -56,7 +57,7 @@ The command begins by calling the Get-CsLisSwitch cmdlet to retrieve all switch This collection of switch locations is piped to the Where-Object cmdlet. The Where-Object cmdlet checks the ChassisID property of each item in the collection and returns the item with the ChassisID value 99-99-99-99-99-99. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsLisSwitch | Where-Object {$_.City -eq "Redmond"} ``` diff --git a/skype/skype-ps/skype/Get-CsLisWirelessAccessPoint.md b/skype/skype-ps/SkypeForBusiness/Get-CsLisWirelessAccessPoint.md similarity index 94% rename from skype/skype-ps/skype/Get-CsLisWirelessAccessPoint.md rename to skype/skype-ps/SkypeForBusiness/Get-CsLisWirelessAccessPoint.md index 469f7a2244..e5f0deb14b 100644 --- a/skype/skype-ps/skype/Get-CsLisWirelessAccessPoint.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsLisWirelessAccessPoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csliswirelessaccesspoint applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsLisWirelessAccessPoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csliswirelessaccesspoint +schema: 2.0.0 +title: Get-CsLisWirelessAccessPoint --- # Get-CsLisWirelessAccessPoint @@ -38,14 +39,14 @@ To narrow down the information retrieved, you must pipe the output from this cmd ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsLisWirelessAccessPoint ``` Example 1 retrieves all Location Information Server (LIS) WAPs that have been defined in the Skype for Business Server deployment. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLisWirelessAccessPoint | Where-Object {$_.BSSID -eq "99-99-99-99-99-99"} ``` @@ -56,7 +57,7 @@ The command begins by calling the Get-CsLisWirelessAccessPoint cmdlet to retriev This collection of WAP locations is piped to the Where-Object cmdlet. The Where-Object cmdlet checks the BSSID property of each item in the collection and returns the item with the BSSID value 99-99-99-99-99-99. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsLisWirelessAccessPoint | Where-Object {$_.City -eq "Redmond"} ``` diff --git a/skype/skype-ps/skype/Get-CsLocationPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsLocationPolicy.md similarity index 88% rename from skype/skype-ps/skype/Get-CsLocationPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsLocationPolicy.md index 06e3d908b0..1997327a22 100644 --- a/skype/skype-ps/skype/Get-CsLocationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsLocationPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cslocationpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsLocationPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cslocationpolicy +schema: 2.0.0 +title: Get-CsLocationPolicy --- # Get-CsLocationPolicy @@ -39,7 +40,7 @@ This cmdlet retrieves one or more location policies. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsLocationPolicy ``` @@ -47,7 +48,7 @@ Get-CsLocationPolicy Example 1 returns a collection of all the location policies currently in use in your organization. This is done simply by calling the Get-CsLocationPolicy cmdlet without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLocationPolicy -Identity Reno ``` @@ -55,7 +56,7 @@ Get-CsLocationPolicy -Identity Reno The command shown in Example 2 returns only those location policies that have an Identity equal to Reno. Because identities must be unique, this command will only return, at most, one location policy. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsLocationPolicy -Filter tag:* ``` @@ -64,7 +65,7 @@ Example 3 uses the Filter parameter to return all the location policies that hav (Policies configured at the per-user scope can be directly assigned to users and network sites.) The wildcard string tag:* tells the Get-CsLocationPolicy cmdlet that the returned data should be limited to those location policies that have an Identity that begins with the string value tag:. Even though you don't need to specify the tag: prefix when retrieving an individual policy, you can use that prefix to filter on all per-user policies. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsLocationPolicy | Where-Object {$_.EnhancedEmergencyServicesEnabled -eq $False} ``` @@ -76,49 +77,55 @@ That collection is then piped to the Where-Object cmdlet; in turn, the Where-Obj ## PARAMETERS -### -Identity -The unique identifier of the location policy you want to retrieve. -To retrieve the global location policy, use a value of Global. -For a policy created at the site scope, this value will be in the form site:\, where site name is the name of a site defined in the Skype for Business Server deployment (for example, site:Redmond). -For a policy created at the per-user scope, this value will simply be the name of the policy, such as Reno. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A string containing wildcard characters that will retrieve location policies based on matching the Identity value of the policy to the wildcard string. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -A string containing wildcard characters that will retrieve location policies based on matching the Identity value of the policy to the wildcard string. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the location policy you want to retrieve. +To retrieve the global location policy, use a value of Global. +For a policy created at the site scope, this value will be in the form site:\, where site name is the name of a site defined in the Skype for Business Server deployment (for example, site:Redmond). +For a policy created at the per-user scope, this value will simply be the name of the policy, such as Reno. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the location policy information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,6 +135,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose location policies are being returned. For example: @@ -140,8 +150,7 @@ You can return the tenant ID for each of your Skype for Business Online tenants ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsManagementConnection.md b/skype/skype-ps/SkypeForBusiness/Get-CsManagementConnection.md similarity index 87% rename from skype/skype-ps/skype/Get-CsManagementConnection.md rename to skype/skype-ps/SkypeForBusiness/Get-CsManagementConnection.md index be0b6e4a2d..16291f1a88 100644 --- a/skype/skype-ps/skype/Get-CsManagementConnection.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsManagementConnection.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csmanagementconnection applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsManagementConnection -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csmanagementconnection +schema: 2.0.0 +title: Get-CsManagementConnection --- # Get-CsManagementConnection @@ -35,32 +36,15 @@ By comparison, the Get-CsConfigurationStoreLocation cmdlet always returns inform ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsManagementConnection ``` The command in Example 1 returns information about the management connection to the Central Management store. - ## PARAMETERS -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 - -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). diff --git a/skype/skype-ps/skype/Get-CsManagementStoreReplicationStatus.md b/skype/skype-ps/SkypeForBusiness/Get-CsManagementStoreReplicationStatus.md similarity index 91% rename from skype/skype-ps/skype/Get-CsManagementStoreReplicationStatus.md rename to skype/skype-ps/SkypeForBusiness/Get-CsManagementStoreReplicationStatus.md index a9c3ebe4b8..db73ab42d6 100644 --- a/skype/skype-ps/skype/Get-CsManagementStoreReplicationStatus.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsManagementStoreReplicationStatus.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csmanagementstorereplicationstatus applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsManagementStoreReplicationStatus -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csmanagementstorereplicationstatus +schema: 2.0.0 +title: Get-CsManagementStoreReplicationStatus --- # Get-CsManagementStoreReplicationStatus @@ -36,14 +37,14 @@ The Get-CsManagementStoreReplicationStatus cmdlet enables you to verify the repl ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsManagementStoreReplicationStatus ``` In Example 1, the Get-CsManagementStoreReplicationStatus cmdlet is called without any parameters; that returns the replication status (up to date or not up to date) for all Skype for Business Server computers. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsManagementStoreReplicationStatus | Where-Object {$_.UpToDate -eq $False} ``` @@ -52,14 +53,14 @@ Example 2 returns a collection of all the computers where replication is not up This is done by first using the Get-CsManagementStoreReplicationStatus cmdlet to retrieve a collection containing the replication status for all the servers. This collection is then piped to the Where-Object cmdlet, which applies a filter that limits the returned data to computers where the UpToDate property is equal to False. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsManagementStoreReplicationStatus -ReplicaFqdn atl-cs-001.litwareinc.com ``` In Example 3, returned data is limited to a single computer: atl-cs-001.litwareinc.com/ -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsManagementStoreReplicationStatus | Where-Object {$_.LastUpdateCreation -lt "8/11/2018 8:00 PM"} ``` @@ -78,7 +79,7 @@ The dates specified in this example use the U.S. English format for date-time values. Dates should be specified using a format compatible with your Regional and Language Options. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsManagementStoreReplicationStatus -CentralManagementStoreStatus ``` @@ -89,36 +90,40 @@ This includes the fully qualified domains names of the Active Master and the Fil ## PARAMETERS -### -ReplicaFqdn -Fully qualified domain name (FQDN) of the computer for which the replication status is to be checked. -For example: -ReplicaFqdn "atl-cs-001.litwareinc.com". +### -CentralManagementStoreStatus -If this parameter is not included, then replication status information for all your Skype for Business Server computers will be returned. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns additional information about the current status of the Central Management store, including a list of active replicas and deleted replicas, as well as the location of the Active Master and the File Transfer Agent services. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -CentralManagementStoreStatus -Returns additional information about the current status of the Central Management store, including a list of active replicas and deleted replicas, as well as the location of the Active Master and the File Transfer Agent services. +### -ReplicaFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the computer for which the replication status is to be checked. +For example: -ReplicaFqdn "atl-cs-001.litwareinc.com". + +If this parameter is not included, then replication status information for all your Skype for Business Server computers will be returned. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False diff --git a/skype/skype-ps/skype/Get-CsMcxConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsMcxConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsMcxConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsMcxConfiguration.md index 8a44cb988e..af369bb85c 100644 --- a/skype/skype-ps/skype/Get-CsMcxConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsMcxConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csmcxconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsMcxConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csmcxconfiguration +schema: 2.0.0 +title: Get-CsMcxConfiguration --- # Get-CsMcxConfiguration @@ -44,21 +45,21 @@ The Get-CsMcxConfiguration cmdlet provides a way for administrators to retrieve ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsMcxConfiguration ``` The command shown in Example 1 returns information about all the Mobility Service configuration settings currently in use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMcxConfiguration -Identity "global" ``` In Example 2, information is returned only for the global collection of Mobility Service configuration settings. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsMcxConfiguration -Filter "service:*" ``` @@ -67,7 +68,7 @@ Example 3 returns information about all the Mobility Service configuration setti To do this, the Filter parameter is included along with the string value "service:*". That filter value returns all the Mobility Service configuration settings that have an Identity that begins with the string value "service:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsMcxConfiguration | Where-Object {$_.ExposedWebURL -eq "External"} ``` @@ -76,7 +77,7 @@ In Example 4, the only Mobility Service configuration settings returned are thos To do this, the command first calls the Get-CsMcxConfiguration cmdlet without any parameters in order to return a collection of all the Mobility Service configuration settings currently in use in the organization. That collection is then piped to the Where-Object cmdlet, which picks out only those settings where the ExposedWebURL property is equal to (-eq) External. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsMcxConfiguration | Where-Object {$_.SessionExpirationInterval -lt 259200} ``` @@ -89,6 +90,9 @@ That collection is then piped to the Where-Object cmdlet, which, in turn, select ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return a collection of Mobility Service configuration settings. For example, to return a collection of all the settings configured at the site scope, use this syntax: @@ -101,8 +105,7 @@ To return a collection of all the settings configured at the service scope, use ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -112,6 +115,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the unique identifier for the collection of Mobility Service configuration settings you want to return. To refer to the global settings, use this syntax: @@ -133,8 +139,7 @@ If this parameter is not specified, then the Get-CsMcxConfiguration cmdlet retur ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -144,13 +149,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the Mobility Service configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsMediaConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsMediaConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Get-CsMediaConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsMediaConfiguration.md index 226f87551c..c15f6e72b6 100644 --- a/skype/skype-ps/skype/Get-CsMediaConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsMediaConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csmediaconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsMediaConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csmediaconfiguration +schema: 2.0.0 +title: Get-CsMediaConfiguration --- # Get-CsMediaConfiguration @@ -35,14 +36,14 @@ This cmdlet retrieves one or more collections of settings that define media inte ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsMediaConfiguration ``` Example 1 returns all the media configurations in use in your organization; this is done simply by invoking the Get-CsMediaConfiguration cmdlet without any additional parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMediaConfiguration -Identity site:Redmond1 ``` @@ -50,7 +51,7 @@ Get-CsMediaConfiguration -Identity site:Redmond1 Example 2 returns only the media configuration that has the Identity site:Redmond1. Because identities must be unique, specifying an Identity ensures that you will never retrieve more than one item. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsMediaConfiguration -Filter site:* ``` @@ -58,7 +59,7 @@ Get-CsMediaConfiguration -Filter site:* In Example 3, the Filter parameter is used to return all the media configurations at the site scope. The wildcard string site:* ensures that Windows PowerShell will return only those media configurations that have identities beginning with the string value site:. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsMediaConfiguration | Where-Object {$_.EncryptionLevel -eq "SupportEncryption"} ``` @@ -67,7 +68,7 @@ In this example, the Get-CsMediaConfiguration cmdlet and the Where-Object cmdlet To do this, the command first uses the Get-CsMediaConfiguration cmdlet to retrieve all the media configurations in use in your organization. This information is then piped to the Where-Object cmdlet, which applies a filter that restricts the returned data to those configurations where the EncryptionLevel property is equal to (-eq) SupportEncryption. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsMediaConfiguration -Filter *:*med* ``` @@ -78,47 +79,53 @@ For example, this command will retrieve media configuration settings defined for ## PARAMETERS -### -Identity -The unique identifier of the media configuration you want to retrieve. -This identifier specifies the scope at which this configuration is applied (global, site, or service). +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter filters the results of the Get operation based on the wildcard value passed to this parameter. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -This parameter filters the results of the Get operation based on the wildcard value passed to this parameter. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the media configuration you want to retrieve. +This identifier specifies the scope at which this configuration is applied (global, site, or service). ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the media configuration information from the local replica of the Central Management store, rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsMeetingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsMeetingConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Get-CsMeetingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsMeetingConfiguration.md index 431f2547ca..767643f840 100644 --- a/skype/skype-ps/skype/Get-CsMeetingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsMeetingConfiguration.md @@ -1,16 +1,18 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csmeetingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsMeetingConfiguration -schema: 2.0.0 +audience: ITPro author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau +ms.localizationpriority: medium ms.reviewer: rogupta -manager: bulenteg -audience: ITPro -ms.topic: reference -ms.localizationpriority: medium +ms.topic: reference +online version: https://learn.microsoft.com/powershell/module/skype/get-csmeetingconfiguration +schema: 2.0.0 +title: Get-CsMeetingConfiguration --- # Get-CsMeetingConfiguration @@ -46,21 +48,21 @@ When used in on-premises environments, the Get-CsMeetingConfiguration cmdlet ena ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsMeetingConfiguration ``` The command shown in Example 1 returns a collection of all the meeting configuration settings currently in use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMeetingConfiguration -Identity site:Redmond ``` In Example 2, only one collection of meeting configuration settings is returned: the settings that have the Identity site:Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsMeetingConfiguration -Filter "service:*" ``` @@ -68,7 +70,7 @@ Get-CsMeetingConfiguration -Filter "service:*" Example 3 returns all the meeting configuration settings that have been configured at the service scope. This is done by including the Filter parameter and the filter value "service:*", which limits returned data to settings where the Identity property begins with the characters "service:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsMeetingConfiguration | Where-Object {$_.AdmitAnonymousUsersByDefault -eq $True} ``` @@ -80,7 +82,39 @@ That collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters in order to return a collection of meeting configuration settings. +Because each tenant is limited to a single, global collection of meeting configuration settings there is no need to use the Filter parameter. +However, this is valid syntax for the Get-CsMeetingConfiguration cmdlet: + +`Get-CsMeetingConfiguration " -Filter "g*"` + +This parameter can be used as follows when using Skype for Business Server (on-premises). + +To return a collection of all the settings configured at the site scope, use this syntax: +`-Filter site:*` +To return a collection of all the settings that have the string value "EMEA" somewhere in their Identity (the only property you can filter on) use this syntax: +`-Filter *EMEA*` + +```yaml +Type: String +Parameter Sets: Filter, (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the collection of meeting configuration settings to be returned. Because each tenant is limited to a single, global collection of meeting configuration settings there is no need include this parameter when calling the Get-CsMeetingConfiguration cmdlet. If you do choose to use the Identity parameter you must also include the Tenant parameter for Online environments. @@ -88,7 +122,7 @@ For example: `Get-CsMeetingConfiguration -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" -Identity "global"` -This parameter can be used as follows when using Skype for Business Server (on-premises). To refer to the global settings, use this syntax: +This parameter can be used as follows when using Skype for Business Server (on-premises). To refer to the global settings, use this syntax: `-Identity global` To refer to a collection configured at the site scope, use syntax similar to this: @@ -105,8 +139,7 @@ If you need to use wildcards, then include the Filter parameter instead. ```yaml Type: XdsIdentity Parameter Sets: Identity, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -115,25 +148,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters in order to return a collection of meeting configuration settings. -Because each tenant is limited to a single, global collection of meeting configuration settings there is no need to use the Filter parameter. -However, this is valid syntax for the Get-CsMeetingConfiguration cmdlet: +### -LocalStore -`Get-CsMeetingConfiguration " -Filter "g*"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -This parameter can be used as follows when using Skype for Business Server (on-premises). +Retrieves the meeting configuration data from the local replica of the Central Management store rather than from the Central Management store itself. -To return a collection of all the settings configured at the site scope, use this syntax: -`-Filter site:*` -To return a collection of all the settings that have the string value "EMEA" somewhere in their Identity (the only property you can filter on) use this syntax: -`-Filter *EMEA*` +This parameter is not used with Skype for Business Online. ```yaml -Type: String -Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -143,6 +169,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose meeting configuration settings are to be retrieved. For example: @@ -160,26 +189,7 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -Retrieves the meeting configuration data from the local replica of the Central Management store rather than from the Central Management store itself. - -This parameter is not used with Skype for Business Online. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsMeetingRoom.md b/skype/skype-ps/SkypeForBusiness/Get-CsMeetingRoom.md similarity index 89% rename from skype/skype-ps/skype/Get-CsMeetingRoom.md rename to skype/skype-ps/SkypeForBusiness/Get-CsMeetingRoom.md index 4401dd0254..b71238345b 100644 --- a/skype/skype-ps/skype/Get-CsMeetingRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsMeetingRoom.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csmeetingroom applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsMeetingRoom -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-csmeetingroom +schema: 2.0.0 +title: Get-CsMeetingRoom --- # Get-CsMeetingRoom @@ -49,21 +51,21 @@ The functions carried out by the Get-CsMeetingRoom cmdlet are not available in t ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsMeetingRoom ``` The command shown in Example 1 returns information about all the meeting rooms configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMeetingRoom -Identity "sip:RedmondMeetingRoom@litwareinc.com" ``` Example 2 returns information for a single meeting room: the system with the SIP address sip:RedmondMeetingRoom@litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsMeetingRoom -Filter {VoicePolicy -eq "RedmondVoicePolicy"} ``` @@ -76,6 +78,9 @@ That filter value limits the returned data to meeting rooms where the VoicePolic ## PARAMETERS ### -Credential + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to run the Get-CsMeetingRoom cmdlet under alternate credentials. This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with contact objects. @@ -85,8 +90,7 @@ For details, see the Get-Credential cmdlet help topic. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,14 +100,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to retrieve meeting room information. To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -113,6 +119,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on Skype for Business-specific attributes. For example, you can limit returned data to meeting rooms that have been assigned a specific voice policy, or rooms that have not been assigned a specific voice policy. @@ -124,8 +133,7 @@ For example, a filter that returns only rooms that have been assigned the voice ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,6 +143,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the meeting room to be retrieved. Meeting room Identities are typically specified using one of four formats: 1) the room's SIP address; 2) the room's user principal name (UPN); 3) the room's domain name and logon name, in the form domain\logon (for example, litwareinc\room14); and, 4) the room's Active Directory display name (for example, Room 14). @@ -146,8 +157,7 @@ For example, the Identity "*Redmond*" returns all the rooms that have a display ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -157,6 +167,9 @@ Accept wildcard characters: False ``` ### -LdapFilter + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business). For example, you can limit returned data to meeting rooms belonging to a specific department.The LdapFilter parameter uses the LDAP query language when creating filters. For example, a filter that returns only meeting rooms found in the city of Redmond would look like this: @@ -168,8 +181,7 @@ In that syntax, "l" (a lowercase L) represents the Active Directory attribute (l ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,6 +191,9 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to return information about meeting rooms in a specific organizational unit (OU) or container. The OU parameter returns data from both the specified OU and any of its child OUs. For example, if the Finance OU has two child OUs -- AccountsPayable and AccountsReceivable -- meeting rooms will be returned from each of these three OUs. @@ -190,8 +205,7 @@ When specifying an OU, use the distinguished name (DN) of that container; for ex ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -201,6 +215,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + **Below Content Applies To:** Lync Server 2013, Skype for Business Server 2015 Enables you to limit the number of records returned by the cmdlet. @@ -214,8 +231,7 @@ If you set the ResultSize to 7 but you have only three meeting rooms in your for ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsMobilityPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsMobilityPolicy.md similarity index 89% rename from skype/skype-ps/skype/Get-CsMobilityPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsMobilityPolicy.md index c59665485e..f22671fdfd 100644 --- a/skype/skype-ps/skype/Get-CsMobilityPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsMobilityPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csmobilitypolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsMobilityPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-csmobilitypolicy +schema: 2.0.0 +title: Get-CsMobilityPolicy --- # Get-CsMobilityPolicy @@ -52,21 +54,21 @@ Mobility policies can be configured at the global, site, or the per-user scope, ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsMobilityPolicy ``` The command shown in Example 1 returns information about all the mobility policies configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMobilityPolicy -Identity "site:Redmond" ``` Example 2 returns information about a single mobility policy: the policy with the Identity site:Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsMobilityPolicy -Filter "tag:*" ``` @@ -75,7 +77,7 @@ In Example 3, information is returned for all of your per-user mobility policies To do this, the Filter parameter is included along with the filter value "tag:*"; this returns any policy that has an Identity that begins with the string value "tag:". By definition, any policy that has an identity beginning with that string value is a per-user policy. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsMobilityPolicy | Where-Object {$_.EnableOutsideVoice -eq $False} ``` @@ -87,7 +89,28 @@ This collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS +### -ApplicableTo + +> Applicable: Skype for Business Online + +{{Fill ApplicableTo Description}} + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters when indicating the policy (or policies) to be returned. For example, to return all the policies configured at the site scope use this syntax: @@ -100,8 +123,7 @@ To return a collection of all the per-user policies, use this syntax: ```yaml Type: String Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -111,6 +133,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the mobility policy to be returned. To refer to the global policy, use this syntax: @@ -129,8 +154,7 @@ If this parameter is not specified, then the Get-CsMobilityPolicy cmdlet returns ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -139,30 +163,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -Retrieves the mobility policy data from the local replica of the Central Management store rather than from the Central Management store itself. +### -Include -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicableTo -{{Fill ApplicableTo Description}} +{{Fill Include Description}} ```yaml -Type: UserIdParameter +Type: PolicyFilter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: +Accepted values: Automatic, All, SubscriptionDefaults, TenantDefinedOnly Required: False Position: Named @@ -171,15 +182,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Include -{{Fill Include Description}} +### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Retrieves the mobility policy data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml -Type: PolicyFilter +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Accepted values: Automatic, All, SubscriptionDefaults, TenantDefinedOnly -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -189,13 +201,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + {{Fill Tenant Description}} ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsNetworkBandwidthPolicyProfile.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkBandwidthPolicyProfile.md similarity index 86% rename from skype/skype-ps/skype/Get-CsNetworkBandwidthPolicyProfile.md rename to skype/skype-ps/SkypeForBusiness/Get-CsNetworkBandwidthPolicyProfile.md index de1572dc01..c1e422d1af 100644 --- a/skype/skype-ps/skype/Get-CsNetworkBandwidthPolicyProfile.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkBandwidthPolicyProfile.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkbandwidthpolicyprofile applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsNetworkBandwidthPolicyProfile -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkbandwidthpolicyprofile +schema: 2.0.0 +title: Get-CsNetworkBandwidthPolicyProfile --- # Get-CsNetworkBandwidthPolicyProfile @@ -37,14 +38,14 @@ As part of call admission control (CAC), a bandwidth policy is used to define ba ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsNetworkBandwidthPolicyProfile ``` Calling the Get-CsNetworkBandwidthPolicyProfile cmdlet without any parameters will retrieve all bandwidth policy profiles defined within the Skype for Business Server deployment. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkBandwidthPolicyProfile -Identity LowBWProfile ``` @@ -52,7 +53,7 @@ Get-CsNetworkBandwidthPolicyProfile -Identity LowBWProfile This example retrieves the bandwidth policy profile with the Identity LowBWProfile. Because identities must be unique this will return, at most, one profile. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsNetworkBandwidthPolicyProfile -Filter *50MB* ``` @@ -64,47 +65,53 @@ For example, this would retrieve profiles with identities such as "BW profile fo ## PARAMETERS -### -Identity -A string value that uniquely identifies the bandwidth policy profile you want to retrieve. -Specifying an Identity will retrieve, at most, one profile. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A string containing wildcards that is used to retrieve bandwidth policy profiles that have Identity values that match the wildcard pattern. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -A string containing wildcards that is used to retrieve bandwidth policy profiles that have Identity values that match the wildcard pattern. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A string value that uniquely identifies the bandwidth policy profile you want to retrieve. +Specifying an Identity will retrieve, at most, one profile. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the network bandwidth policy profile from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsNetworkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Get-CsNetworkConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsNetworkConfiguration.md index 5914281385..5e390e6370 100644 --- a/skype/skype-ps/skype/Get-CsNetworkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsNetworkConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkconfiguration +schema: 2.0.0 +title: Get-CsNetworkConfiguration --- # Get-CsNetworkConfiguration @@ -38,7 +40,7 @@ For example, to retrieve the network regions, it will usually be easier to call ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsNetworkConfiguration ``` @@ -46,7 +48,7 @@ Get-CsNetworkConfiguration This example retrieves the network configuration settings. These settings are defined only at the global scope, so only one item will be returned. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` (Get-CsNetworkConfiguration).MediaBypassSettings ``` @@ -58,46 +60,52 @@ This command first retrieves that configuration by calling the Get-CsNetworkConf ## PARAMETERS -### -Identity -This will always be Global. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Because there will only ever be one network configuration, you do not need this parameter for this cmdlet. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter, (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Because there will only ever be one network configuration, you do not need this parameter for this cmdlet. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +This will always be Global. ```yaml -Type: String -Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the network configuration from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -107,13 +115,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + {{Fill Tenant Description}} ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsNetworkInterRegionRoute.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterRegionRoute.md similarity index 87% rename from skype/skype-ps/skype/Get-CsNetworkInterRegionRoute.md rename to skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterRegionRoute.md index c65e85e16f..1322f9b4fe 100644 --- a/skype/skype-ps/skype/Get-CsNetworkInterRegionRoute.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterRegionRoute.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkinterregionroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsNetworkInterRegionRoute -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkinterregionroute +schema: 2.0.0 +title: Get-CsNetworkInterRegionRoute --- # Get-CsNetworkInterRegionRoute @@ -37,21 +38,21 @@ This cmdlet retrieves information about these route associations. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsNetworkInterRegionRoute -Identity NA_APAC_Route ``` Example 1 retrieves the route with the Identity NA_APAC_Route. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkInterRegionRoute -Filter *APAC* ``` In Example 2, we use the Filter parameter to retrieve all routes that contain the string APAC anywhere within the Identity. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsNetworkInterRegionRoute | Where-Object {$_.NetworkRegionLinks -eq "NA_EMEA"} ``` @@ -62,7 +63,7 @@ Calling this cmdlet with no parameters retrieves all routes defined with the CAC This collection of routes is then piped to the Where-Object cmdlet. The Where-Object cmdlet takes the collection and retrieves all items in the collection that have the value NA_EMEA within their NetworkRegionLinks list. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsNetworkInterRegionRoute | Where-Object {$_.NetworkRegionID1 -eq "NorthAmerica" -or $_.NetworkRegionID2 -eq "NorthAmerica"} ``` @@ -77,48 +78,54 @@ It does this by checking to see if the route has a NetworkRegionID1 value equal ## PARAMETERS -### -Identity -The unique identifier for the network region route you want to retrieve. -Network region routes are created only at the global scope, so this identifier does not need to specify a scope. -Instead, it contains a string that is a unique name that identifies a particular route. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A string that allows you to retrieve routes based on matching the Identity values to the wildcard string passed as a value to this parameter. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -A string that allows you to retrieve routes based on matching the Identity values to the wildcard string passed as a value to this parameter. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier for the network region route you want to retrieve. +Network region routes are created only at the global scope, so this identifier does not need to specify a scope. +Instead, it contains a string that is a unique name that identifies a particular route. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the network interregion route information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsNetworkInterSitePolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterSitePolicy.md similarity index 87% rename from skype/skype-ps/skype/Get-CsNetworkInterSitePolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterSitePolicy.md index 447ed6ca95..3fcea915b3 100644 --- a/skype/skype-ps/skype/Get-CsNetworkInterSitePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterSitePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkintersitepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsNetworkInterSitePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkintersitepolicy +schema: 2.0.0 +title: Get-CsNetworkInterSitePolicy --- # Get-CsNetworkInterSitePolicy @@ -36,7 +37,7 @@ This cmdlet retrieves one or more network site policies that associate bandwidth ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsNetworkInterSitePolicy ``` @@ -45,7 +46,7 @@ Calling the Get-CsNetworkInterSitePolicy cmdlet with no parameters retrieves all -### -------------------------- Example 2 -------------------------- (Lync Server 2010) +### Example 2 (Lync Server 2010) ``` Get-CsNetworkInterSitePolicy -Identity Reno_Portland ``` @@ -54,7 +55,7 @@ This example retrieves the network site policy with the Identity Reno_Portland. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsNetworkInterSitePolicy -Filter *Reno* ``` @@ -64,7 +65,7 @@ The wildcard characters (*) within the value passed to the Filter parameter sign -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsNetworkInterSitePolicy | Where-Object {$_.BWPolicyProfileID -eq $null} ``` @@ -79,48 +80,54 @@ It does this by comparing to see if the BWPolicyProfileID property of each site ## PARAMETERS -### -Identity -The unique identifier of the network site policy you want to retrieve. -Network site policies are created only at the global scope, so this identifier does not need to specify a scope. -Instead, it contains a string that is a unique name that identifies that policy. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A string containing wildcard characters that will search for policies with Identity values matching the wildcard string. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -A string containing wildcard characters that will search for policies with Identity values matching the wildcard string. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the network site policy you want to retrieve. +Network site policies are created only at the global scope, so this identifier does not need to specify a scope. +Instead, it contains a string that is a unique name that identifies that policy. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the network inter-site policy information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsNetworkInterface.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterface.md similarity index 89% rename from skype/skype-ps/skype/Get-CsNetworkInterface.md rename to skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterface.md index cce4863773..c5a10c1dc2 100644 --- a/skype/skype-ps/skype/Get-CsNetworkInterface.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkInterface.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkinterface applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsNetworkInterface -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkinterface +schema: 2.0.0 +title: Get-CsNetworkInterface --- # Get-CsNetworkInterface @@ -38,21 +39,21 @@ The Get-CsNetworkInterface cmdlet provides a way for administrators to return in ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsNetworkInterface ``` Example 1 returns information for all the network interfaces configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkInterface -Identity atl-cs-001.litwareinc.com/Primary/1 ``` The command shown in Example 2 returns information about a single network interface: the interface that has the Identity atl-cs-001.litwareinc.com.com/Primary/1. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsNetworkInterface -Filter "*.litwareinc.com*" ``` @@ -61,7 +62,7 @@ In Example 3, information is returned for all the network interfaces in the doma To do this, the Filter parameter is included, along with the filter value "*.litwareinc.com*". This filter value limits the returned data to interfaces that have an Identity that includes the string value "litwareinc.com". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsNetworkInterface | Where-Object {$_.IPAddress -eq "192.168.0.240"} ``` @@ -70,7 +71,7 @@ Example 4 returns information about all the network interfaces configured for th To do this, the command first calls the Get-CsNetworkInterface cmdlet without any parameters; this returns a collection of all the network interfaces configured for use in the organization. That collection is then piped to the Where-Object cmdlet, which picks out only those interfaces where the IPAddress property is equal to 192.168.0.240. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsNetworkInterface | Where-Object {$_.IPAddress -like "192.168.0.*"} ``` @@ -78,7 +79,7 @@ Get-CsNetworkInterface | Where-Object {$_.IPAddress -like "192.168.0.*"} The command shown in Example 5 is a variation of the command shown in Example 4; in this case, however, information is returned for all the network interfaces configured for the subnet "192.168.0.*". This is done by retrieving a collection of all the network interfaces, piping that collection to the Where-Object cmdlet, and then picking out only those interfaces where IPAddress starts with the string value "192.168.0.". -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsNetworkInterface | Where-Object {$_.Interface -eq "External"} ``` @@ -90,40 +91,31 @@ This collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS -### -Identity -Unique identifier for the network interface to be returned. -A network interface Identity consists of three parts: - -- The fully qualified domain name (FQDN) of the computer itself (for example, atl-cs-001.litwareinc.com). -- The network interface "side" (Primary; Internal; External; public switched telephone network). -- The side indicates the type of traffic the port is used for. - -The network interface number for that particular side. +### -ComputerFqdn -For example: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-Identity "atl-cs-001.litwareinc.com/Primary/1"` - -The Identity, ComputerFqdn, and Filter parameters must be used separately; for example, you cannot run a command that uses both ComputerFqdn and Identity. -In addition, you cannot use wildcard characters when specifying the Identity. -To employ wildcards, use the Filter parameter. +FQDN of the computer for which network interface information is to be returned. +For example, to return network interface information for the computer atl-cs-001.litwareinc.com (and only for that computer) use this syntax: -If neither the Identity, ComputerFqdn, nor Filter parameters are used, then the Get-CsNetworkInterface cmdlet returns information about all the network interfaces currently in use on your computers running a Skype for Business Server service or server role. +`-ComputerFqdn atl-cs-001.litwareinc.com` ```yaml -Type: NetworkInterfaceIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Fqdn +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcards when specifying the network interface (or interfaces) to be returned. For example, this syntax returns information about the Primary network interface used on all of your computers running a Skype for Business Server service or server role: @@ -132,8 +124,7 @@ For example, this syntax returns information about the Primary network interface ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -142,20 +133,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ComputerFqdn -FQDN of the computer for which network interface information is to be returned. -For example, to return network interface information for the computer atl-cs-001.litwareinc.com (and only for that computer) use this syntax: +### -Identity -`-ComputerFqdn atl-cs-001.litwareinc.com` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the network interface to be returned. +A network interface Identity consists of three parts: + +- The fully qualified domain name (FQDN) of the computer itself (for example, atl-cs-001.litwareinc.com). +- The network interface "side" (Primary; Internal; External; public switched telephone network). +- The side indicates the type of traffic the port is used for. + +The network interface number for that particular side. + +For example: + +`-Identity "atl-cs-001.litwareinc.com/Primary/1"` + +The Identity, ComputerFqdn, and Filter parameters must be used separately; for example, you cannot run a command that uses both ComputerFqdn and Identity. +In addition, you cannot use wildcard characters when specifying the Identity. +To employ wildcards, use the Filter parameter. + +If neither the Identity, ComputerFqdn, nor Filter parameters are used, then the Get-CsNetworkInterface cmdlet returns information about all the network interfaces currently in use on your computers running a Skype for Business Server service or server role. ```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: NetworkInterfaceIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/skype/skype-ps/skype/Get-CsNetworkRegion.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkRegion.md similarity index 86% rename from skype/skype-ps/skype/Get-CsNetworkRegion.md rename to skype/skype-ps/SkypeForBusiness/Get-CsNetworkRegion.md index bac9faa045..82d5aa6d3c 100644 --- a/skype/skype-ps/skype/Get-CsNetworkRegion.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkRegion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkregion applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsNetworkRegion -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkregion +schema: 2.0.0 +title: Get-CsNetworkRegion --- # Get-CsNetworkRegion @@ -38,14 +39,14 @@ Use this cmdlet to retrieve information about one or more network regions, inclu ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsNetworkRegion ``` Example 1 retrieves all network regions defined for the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkRegion -Identity NorthAmerica ``` @@ -53,14 +54,14 @@ Get-CsNetworkRegion -Identity NorthAmerica Example 2 retrieves the network regions with the Identity NorthAmerica. Because identities are unique, this command retrieves at most one network region. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsNetworkRegion | Where-Object {$_.CentralSite -eq "site:Redmond"} ``` This example retrieves all network regions with identities that end with the string "America." This would retrieve regions with identities such as NorthAmerica, SouthAmerica, and CentralAmerica. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsNetworkRegion | Where-Object {$_.CentralSite -eq "site:Redmond"} ``` @@ -73,49 +74,55 @@ The Where-Object cmdlet filters this collection to return only those items (netw ## PARAMETERS -### -Identity -The unique identifier of the network region you want to retrieve. -The Identity will be in the form of a string that uniquely identifies that region. -(Note that the Identity is the same as the NetworkRegionID.) +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter allows you to perform a wildcard search on the Identity of all network regions configured for the organization. +Use the wildcard character to filter on any part of the Identity. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -This parameter allows you to perform a wildcard search on the Identity of all network regions configured for the organization. -Use the wildcard character to filter on any part of the Identity. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the network region you want to retrieve. +The Identity will be in the form of a string that uniquely identifies that region. +(Note that the Identity is the same as the NetworkRegionID.) ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the network region information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsNetworkRegionLink.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkRegionLink.md similarity index 87% rename from skype/skype-ps/skype/Get-CsNetworkRegionLink.md rename to skype/skype-ps/SkypeForBusiness/Get-CsNetworkRegionLink.md index 9c7f1775f6..cd5d855566 100644 --- a/skype/skype-ps/skype/Get-CsNetworkRegionLink.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkRegionLink.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkregionlink applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsNetworkRegionLink -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworkregionlink +schema: 2.0.0 +title: Get-CsNetworkRegionLink --- # Get-CsNetworkRegionLink @@ -36,21 +37,21 @@ This cmdlet retrieves one or more region links that are defined within the netwo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsNetworkRegionLink ``` Example 1 retrieves all network region links defined within a Skype for Business Server 2015 deployment. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkRegionLink -Identity NA_EMEA ``` Example 2 retrieves information about (at most) one network region link, the link with the Identity NA_EMEA. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsNetworkRegionLink -Filter *EMEA* ``` @@ -60,7 +61,7 @@ Notice the * characters, one before the string EMEA and one after. This means any character or characters can precede or follow the string; the string EMEA simply must be included in the Identity somewhere. This will retrieve links with names such as NA_EMEA, EMEA_APAC, and EMEA2_SA. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsNetworkRegionLink | Where-Object {$_.NetworkRegionID1 -eq "EMEA" -or $_.NetworkRegionID2 -eq "EMEA"} ``` @@ -74,49 +75,55 @@ If either of these properties is equal to EMEA--in other words if either Network ## PARAMETERS -### -Identity -The unique identifier of the network region link you want to retrieve. -Network region links are created only at the global scope, so this identifier does not need to specify a scope. -Instead, it contains a string that is a unique name that identifies that link. -(Note that this value is the same as the NetworkRegionLinkID.) +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Accepts a wildcard string that is used to retrieve network links based on matching the value of the Identity to the wildcard string. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Accepts a wildcard string that is used to retrieve network links based on matching the value of the Identity to the wildcard string. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the network region link you want to retrieve. +Network region links are created only at the global scope, so this identifier does not need to specify a scope. +Instead, it contains a string that is a unique name that identifies that link. +(Note that this value is the same as the NetworkRegionLinkID.) ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the network region link information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsNetworkSite.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkSite.md similarity index 86% rename from skype/skype-ps/skype/Get-CsNetworkSite.md rename to skype/skype-ps/SkypeForBusiness/Get-CsNetworkSite.md index 63eaeaaf8c..e7523784b6 100644 --- a/skype/skype-ps/skype/Get-CsNetworkSite.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkSite.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworksite applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsNetworkSite -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworksite +schema: 2.0.0 +title: Get-CsNetworkSite --- # Get-CsNetworkSite @@ -36,7 +37,7 @@ This cmdlet retrieves the settings for one or more existing sites. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsNetworkSite ``` @@ -45,14 +46,14 @@ Calling the Get-CsNetworkSite cmdlet with no parameters will return all network -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkSite -Identity Redmond ``` This command retrieves the site with the Identity (and, by definition, the NetworkSiteID) Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsNetworkSite -Filter NA* ``` @@ -61,7 +62,7 @@ The command in Example 3 calls the Get-CsNetworkSite cmdlet with the Filter para The value of the Filter parameter is NA*, meaning that this command will retrieve all sites with an Identity beginning with the string NA and followed by any number of characters. This will return sites such as NARedmond, NAVancouver, and NAChicago. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsNetworkSite | Where-Object {$_.NetworkRegionID -eq "NorthAmerica"} ``` @@ -73,49 +74,55 @@ This collection of sites is then piped to the Where-Object cmdlet, which filters ## PARAMETERS -### -Identity -The unique identifier of the network site you want to retrieve. -Sites are created only at the global scope, so you do not need to specify a scope. -Instead, you need to specify only the site ID. -(Note that this is the same value as the NetworkSiteID for the network site.) +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A wildcard string that allows you to retrieve multiple sites based on matching the site Identity to the Filter value. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -A wildcard string that allows you to retrieve multiple sites based on matching the site Identity to the Filter value. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the network site you want to retrieve. +Sites are created only at the global scope, so you do not need to specify a scope. +Instead, you need to specify only the site ID. +(Note that this is the same value as the NetworkSiteID for the network site.) ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the network site information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsNetworkSubnet.md b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkSubnet.md similarity index 84% rename from skype/skype-ps/skype/Get-CsNetworkSubnet.md rename to skype/skype-ps/SkypeForBusiness/Get-CsNetworkSubnet.md index aca38d63a4..454f6c3919 100644 --- a/skype/skype-ps/skype/Get-CsNetworkSubnet.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsNetworkSubnet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworksubnet applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsNetworkSubnet -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csnetworksubnet +schema: 2.0.0 +title: Get-CsNetworkSubnet --- # Get-CsNetworkSubnet @@ -36,28 +37,28 @@ Use this cmdlet to retrieve information about the subnet, including the Identity ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsNetworkSubnet ``` This example retrieves all subnets within the Skype for Business Server deployment. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkSubnet -Identity 172.11.15.0 ``` This example retrieves all information about the subnet with the Identity (the Subnet ID) 172.11.15.0. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsNetworkSubnet -Filter 172.11.* ``` This example retrieves all subnets with identities that begin with 172.11. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsNetworkSubnet | Where-Object {$_.NetworkSiteID -eq "Vancouver"} ``` @@ -70,49 +71,55 @@ The Where-Object cmdlet takes that collection and narrows it down to only those ## PARAMETERS -### -Identity -The unique subnet ID of the subnet you want to retrieve. -This value will be an IP address (such as 174.11.12.0). +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Use this parameter to perform a wildcard search of all subnets based on Identity. +For example, the Filter value 172.11.* will retrieve all subnets with an Identity beginning with 172.11. +(such as 172.11.10.0, 172.11.25.0, etc.). ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Use this parameter to perform a wildcard search of all subnets based on Identity. -For example, the Filter value 172.11.* will retrieve all subnets with an Identity beginning with 172.11. -(such as 172.11.10.0, 172.11.25.0, etc.). +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique subnet ID of the subnet you want to retrieve. +This value will be an IP address (such as 174.11.12.0). ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the network subnet information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsOAuthConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsOAuthConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsOAuthConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsOAuthConfiguration.md index b2c5cfbfdd..c7cb34d9a0 100644 --- a/skype/skype-ps/skype/Get-CsOAuthConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsOAuthConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csoauthconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsOAuthConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-csoauthconfiguration +schema: 2.0.0 +title: Get-CsOAuthConfiguration --- # Get-CsOAuthConfiguration @@ -45,7 +47,7 @@ The functions carried out by the Get-CsOAuthConfiguration cmdlet are not availab ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOAuthConfiguration ``` @@ -56,6 +58,9 @@ The command shown in Example 1 returns information for the OAuth configuration s ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard values when referencing a collection of OAuth configuration settings. Because you can only have a single, global instance of these settings there is no reason to use the Filter parameter. However, if you prefer you can use the following syntax to reference the global settings: @@ -67,8 +72,7 @@ That syntax brings back all the OAuth configuration settings that have an Identi ```yaml Type: String Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -78,6 +82,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Unique Identity of the OAuth configuration settings. Because you can only have a single, global instance of these settings, you do not need to specify an Identity when calling the Get-CsOAuthConfiguration cmdlet. If you prefer, however, you can use the following syntax to reference the global settings: @@ -87,8 +94,7 @@ If you prefer, however, you can use the following syntax to reference the global ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -98,13 +104,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the OAuth configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -114,6 +122,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose OAuth configuration settings are to be retrieved. For example: @@ -127,8 +138,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsOAuthServer.md b/skype/skype-ps/SkypeForBusiness/Get-CsOAuthServer.md similarity index 88% rename from skype/skype-ps/skype/Get-CsOAuthServer.md rename to skype/skype-ps/SkypeForBusiness/Get-CsOAuthServer.md index d8186132f4..c95a5a12ca 100644 --- a/skype/skype-ps/skype/Get-CsOAuthServer.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsOAuthServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csoauthserver applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsOAuthServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csoauthserver +schema: 2.0.0 +title: Get-CsOAuthServer --- # Get-CsOAuthServer @@ -44,14 +45,14 @@ The functions carried out by the Get-CsOAuthServer cmdlet are not available in t ## EXAMPLES -### -------------------------- Example 1 -------------------------- (Skype for Business Server 2015) +### Example 1 (Skype for Business Server 2015) ``` Get-CsOAuthServer ``` Example 1 returns information about all the OAuth servers configured for use in the organization. -### -------------------------- Example 2 -------------------------- (Skype for Business Server 2015) +### Example 2 (Skype for Business Server 2015) ``` Get-CsOAuthServer -Identity "Office 365" ``` @@ -62,6 +63,9 @@ In Example 2, information is returned for the OAuth server that has the Identity ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return one or more OAuth servers. For example, to return all of the OAuth servers that have an Identity that includes the string value "Microsoft" use this syntax: @@ -70,8 +74,7 @@ For example, to return all of the OAuth servers that have an Identity that inclu ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -81,6 +84,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the OAuth server to be returned. For example: @@ -91,8 +97,7 @@ If neither the Identity parameter nor the Filter parameter is included in the co ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -102,13 +107,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the OAuth service data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -118,6 +125,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose OAuth server settings are to be retrieved. For example: @@ -131,8 +141,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsOutboundCallingNumberTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Get-CsOutboundCallingNumberTranslationRule.md similarity index 91% rename from skype/skype-ps/skype/Get-CsOutboundCallingNumberTranslationRule.md rename to skype/skype-ps/SkypeForBusiness/Get-CsOutboundCallingNumberTranslationRule.md index 5583f31ca1..3dcb2c38cd 100644 --- a/skype/skype-ps/skype/Get-CsOutboundCallingNumberTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsOutboundCallingNumberTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csoutboundcallingnumbertranslationrule applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsOutboundCallingNumberTranslationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csoutboundcallingnumbertranslationrule +schema: 2.0.0 +title: Get-CsOutboundCallingNumberTranslationRule --- # Get-CsOutboundCallingNumberTranslationRule @@ -46,21 +47,21 @@ Double-click appropriate entry in the Name column and then, in the Edit Trunk Co ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOutboundCallingNumberTranslationRule ``` The command shown in Example 1 returns information about all the outbound calling number translation rules currently configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsOutboundCallingNumberTranslationRule -Identity "site:Redmond/SevenDigit" ``` In Example 2, information is returned only for the outbound calling number translation rule that has the Identity "site:Redmond/SevenDigit." -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsOutboundCallingNumberTranslationRule -Identity "site:Redmond" ``` @@ -68,7 +69,7 @@ Get-CsOutboundCallingNumberTranslationRule -Identity "site:Redmond" Example 3 returns information for all the outbound calling number translation rules configured for the Redmond site. This is done by setting the value of the Identity parameter to the Identity of the Redmond site (site:Redmond). -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsOutboundCallingNumberTranslationRule -Identity "site:Redmond" | Where-Object {$_.Priority -eq 0} ``` @@ -81,6 +82,9 @@ This collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Performs a wildcard search that allows you to return only those outbound translation rules that have Identities that match the wildcard string. For example, this syntax returns all the translation rules that include the string value "Redmond": @@ -93,8 +97,7 @@ To return all the translation rules configured at the site scope use this syntax ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -104,6 +107,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the outbound calling number translation rule you want to retrieve. The Identity consists of the scope followed by a unique name within each scope; for example: @@ -118,8 +124,7 @@ If neither the Identity parameter nor the Filter parameter is specified the Get- ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -129,13 +134,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the outbound calling number translation rule data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsOutboundTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Get-CsOutboundTranslationRule.md similarity index 88% rename from skype/skype-ps/skype/Get-CsOutboundTranslationRule.md rename to skype/skype-ps/SkypeForBusiness/Get-CsOutboundTranslationRule.md index 8b9c66c91c..2d793c2d88 100644 --- a/skype/skype-ps/skype/Get-CsOutboundTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsOutboundTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csoutboundtranslationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsOutboundTranslationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csoutboundtranslationrule +schema: 2.0.0 +title: Get-CsOutboundTranslationRule --- # Get-CsOutboundTranslationRule @@ -44,21 +45,21 @@ The rule is automatically associated with the trunk configuration with the same ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsOutboundTranslationRule ``` This example retrieves all outbound translation rules for the Skype for Business Server deployment. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsOutboundTranslationRule -Identity "site:Redmond/Prefix Redmond" ``` This example retrieves a single outbound translation rule: the rule with Identity site:Redmond/Prefix Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsOutboundTranslationRule -Filter site:* ``` @@ -69,48 +70,54 @@ The command calls the Get-CsOutboundTranslationRule cmdlet with a Filter of site ## PARAMETERS -### -Identity -The unique identifier for the outbound translation rule you want to retrieve. -The Identity consists of the scope followed by a unique name within each scope (for example, site:Redmond/OutboundRule1). -Specifying a value for Identity will return at most one outbound translation rule. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Performs a wildcard search on Identity that allows you to narrow down your results to only those outbound translation rules whose identities match the given wildcard string. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Performs a wildcard search on Identity that allows you to narrow down your results to only those outbound translation rules whose identities match the given wildcard string. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier for the outbound translation rule you want to retrieve. +The Identity consists of the scope followed by a unique name within each scope (for example, site:Redmond/OutboundRule1). +Specifying a value for Identity will return at most one outbound translation rule. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the outbound translation rule from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPartnerApplication.md b/skype/skype-ps/SkypeForBusiness/Get-CsPartnerApplication.md similarity index 90% rename from skype/skype-ps/skype/Get-CsPartnerApplication.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPartnerApplication.md index d88eef5d7f..973036641a 100644 --- a/skype/skype-ps/skype/Get-CsPartnerApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPartnerApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspartnerapplication applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPartnerApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cspartnerapplication +schema: 2.0.0 +title: Get-CsPartnerApplication --- # Get-CsPartnerApplication @@ -46,21 +47,21 @@ Skype for Business Server Control Panel: The functions carried out by the Get-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPartnerApplication ``` The command shown in Example 1 returns information about all the partner applications configured for use in the organization -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPartnerApplication -Identity "MicrosoftExchange" ``` Example 2 returns information for the partner application that has the Identity MicrosoftExchange. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPartnerApplication | Where-Object {$_.ApplicationIdentifier -eq "microsoft.exchange"} ``` @@ -68,7 +69,7 @@ Get-CsPartnerApplication | Where-Object {$_.ApplicationIdentifier -eq "microsoft In Example 3, information is returned for all the partner applications that have an application identifier equal to "microsoft.exchange." In order to do this, the command first calls the Get-CsPartnerApplication cmdlet without any parameters; that returns a collection of all the configured partner applications. That collection is then piped to the Where-Object cmdlet, which picks out only those partner applications where the ApplicationIdentifier property is equal to "microsoft.exchange." -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPartnerApplication | Where-Object {$_.Enabled -eq $False} ``` @@ -81,6 +82,9 @@ That collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard values to return one or more partner applications. For example, to return all the partner applications that have an Identity that includes the string value "Microsoft" use this syntax: @@ -91,8 +95,7 @@ You cannot use both the Filter parameter and the Identity parameter in the same ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the partner application. For example: @@ -112,8 +118,7 @@ If neither the identity parameter nor the Filter parameter are included in the c ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -123,13 +128,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the partner application data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,6 +146,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account where whose partner application settings are to be retrieved. For example: @@ -152,8 +162,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPersistentChatAddin.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatAddin.md similarity index 92% rename from skype/skype-ps/skype/Get-CsPersistentChatAddin.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatAddin.md index 72d85cb632..72efa06771 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatAddin.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatAddin.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchataddin applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPersistentChatAddin -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchataddin +schema: 2.0.0 +title: Get-CsPersistentChatAddin --- # Get-CsPersistentChatAddin @@ -46,21 +47,21 @@ To view Persistent Chat add-in information in Skype for Business Server Control ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPersistentChatAddin ``` Example 1 returns information about all the Persistent Chat add-ins configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatAddin -Identity "atl-cs-001.litwareinc.com\ITPersistentChatAddin" ``` In Example 2, information is returned for a specific Persistent Chat add-in: the add-in with the Identity atl-cs-001.litwareinc.com\ITPersistentChatAddin. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatAddin -PersistentChatPoolFqdn "atl-cs-001.litwareinc.com" ``` @@ -71,6 +72,9 @@ Example 3 returns information for all the Persistent Chat add-ins configured for ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the Persistent Chat add-in to be returned. The Identity is composed of the fully qualified domain name of the Persistent Chat pool where the add-in is located, a "\" character, and the add-in name. For example: @@ -82,8 +86,7 @@ If this parameter is not specified then the Get-CsPersistentChatAddin cmdlet ret ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 1 @@ -93,6 +96,9 @@ Accept wildcard characters: False ``` ### -PersistentChatPoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Fully qualified domain name for the Persistent Chat pool. If this parameter is used then only Persistent Chat add-ins found on the specified pool will be returned. If this parameter is not used then the Get-CsPersistentChatAddin cmdlet will return add-ins from all your Persistent Chat pools. @@ -103,8 +109,7 @@ For example: ```yaml Type: String Parameter Sets: Pool -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPersistentChatCategory.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatCategory.md similarity index 92% rename from skype/skype-ps/skype/Get-CsPersistentChatCategory.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatCategory.md index e00444b74c..af379d0685 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatCategory.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatCategory.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatcategory applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPersistentChatCategory -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatcategory +schema: 2.0.0 +title: Get-CsPersistentChatCategory --- # Get-CsPersistentChatCategory @@ -49,21 +50,21 @@ To view Persistent Chat categories in Skype for Business Server Control Panel, c ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPersistentChatCategory ``` The command shown in Example 1 returns information for all the Persistent Chat categories configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatCategory -PersistentChatPoolFqdn "atl-cs-001.litwareinc.com" ``` In Example 2, information is returned for all the Persistent Chat categories configured for use on the pool atl-cs-001.litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatCategory | Where-Object {$_.Invites -eq $False} ``` @@ -72,7 +73,7 @@ Example 3 returns information for all the Persistent Chat categories where the I To do this, the command first uses the Get-CsPersistentChatCategory cmdlet to return a collection of all the Persistent Chat categories. This collection is then piped to the Where-Object cmdlet, which picks out only those categories where the Invites property is set to False ($False). -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPersistentChatCategory | Where-Object {$_.Creators -contains "Ken Myer"} ``` @@ -84,7 +85,29 @@ This collection is then piped to the Where-Object cmdlet, which picks out any ca ## PARAMETERS +### -AsObject + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +When specified, Active Directory display names are used when showing users who are on the AllowedMembers, DeniedMembers, or Creators lists. +When not specified, SIP addresses are used when showing these users. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the chat room category. The Identity consists of the Persistent Chat pool were the category is located followed by the category Name; for example: @@ -93,8 +116,7 @@ The Identity consists of the Persistent Chat pool were the category is located f ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 1 @@ -103,24 +125,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AsObject -When specified, Active Directory display names are used when showing users who are on the AllowedMembers, DeniedMembers, or Creators lists. -When not specified, SIP addresses are used when showing these users. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -PersistentChatPoolFqdn -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -PersistentChatPoolFqdn Fully qualified domain name of the Persistent Chat pool that hosts Persistent Chat categories. If you use the PoolFqdn parameter without including the Name parameter, information will be returned for all the Persistent Chat categories on the specified pool. If you leave off both the Name and PoolFqdn parameters, then information will be returned for all your Persistent Chat categories. @@ -128,8 +136,7 @@ If you leave off both the Name and PoolFqdn parameters, then information will be ```yaml Type: String Parameter Sets: Pool -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPersistentChatComplianceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatComplianceConfiguration.md similarity index 92% rename from skype/skype-ps/skype/Get-CsPersistentChatComplianceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatComplianceConfiguration.md index cf19471a4f..87f6621c0f 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatComplianceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatComplianceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatcomplianceconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPersistentChatComplianceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatcomplianceconfiguration +schema: 2.0.0 +title: Get-CsPersistentChatComplianceConfiguration --- # Get-CsPersistentChatComplianceConfiguration @@ -45,21 +46,21 @@ The functions carried out by the Get-CsPersistentChatComplianceConfiguration cmd ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPersistentChatComplianceConfiguration ``` The command shown in Example 1 returns information about all the Persistent Chat compliance configuration settings currently in use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatComplianceConfiguration -Identity "site:Redmond" ``` In Example 2, information is returned for the Persistent Chat compliance configuration settings applied to the Redmond site. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatComplianceConfiguration -Filter "service:*" ``` @@ -67,7 +68,7 @@ Get-CsPersistentChatComplianceConfiguration -Filter "service:*" Example 3 returns information about all the Persistent Chat compliance configuration settings applied to the service scope. This is done by including the Filter parameter and the filter value "service:*". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPersistentChatComplianceConfiguration | Where-Object {$_.OneChatRoomPerOutputFile -eq $True} ``` @@ -76,7 +77,7 @@ In Example 4, information is returned for all the Persistent Chat compliance con To do this, the command first uses the Get-CsPersistentChatComplianceConfiguration to return a collection consisting of all the Persistent Chat compliance configuration settings. That collection is then piped to the Where-Object cmdlet, which picks out only those settings where the OneChatRoomPerOutputFile property is equal to True ($True). -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsPersistentChatComplianceConfiguration | Where-Object {$_.CustomConfiguration -ne $Null} ``` @@ -89,6 +90,9 @@ That collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to use wildcards when specifying the collection (or collections) of Persistent Chat compliance settings to be returned. For example, this syntax returns all the settings policies configured at the service scope: @@ -99,8 +103,7 @@ The Filter and Identity parameters cannot be used in the same command. ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -110,6 +113,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the Persistent Chat compliance settings to be returned. To return the global collection, use this syntax: @@ -130,8 +136,7 @@ If neither the Identity parameter nor the Filter parameter are included in a com ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 2 @@ -141,13 +146,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Retrieves the Persistent Chat compliance data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPersistentChatConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatConfiguration.md similarity index 92% rename from skype/skype-ps/skype/Get-CsPersistentChatConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatConfiguration.md index 7fd56a3f4c..437d32cd97 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPersistentChatConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatconfiguration +schema: 2.0.0 +title: Get-CsPersistentChatConfiguration --- # Get-CsPersistentChatConfiguration @@ -44,21 +45,21 @@ To view Persistent Chat configuration information in the Skype for Business Serv ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPersistentChatConfiguration ``` The command shown in Example 1 returns information for all the Persistent Chat configuration settings in use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatConfiguration -Identity "site:Redmond" ``` In Example 2, information is returned for a specified set of Persistent Chat configuration settings: the settings applied to the Redmond site. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatConfiguration -Filter "service:*" ``` @@ -66,7 +67,7 @@ Get-CsPersistentChatConfiguration -Filter "service:*" Example 3 returns information for all the Persistent Chat configuration settings applied to the site scope. This is done by including the Filter parameter and the filter value "service:*". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPersistentChatConfiguration | Where-Object {$_.DefaultChatHistory -gt 30} ``` @@ -75,7 +76,7 @@ In Example 4, information is returned for all the Persistent Chat configuration To carry out this task the command first uses the Get-CsPersistentChatConfiguration cmdlet to return a collection of all the Persistent Chat configuration settings. This collection is then piped to the Where-Object cmdlet, which picks out only those settings where the DefaultChatHistory property is greater than (-gt) 30. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsPersistentChatConfiguration | Where-Object {$_.RoomManagementUrl -eq $Null} ``` @@ -88,6 +89,9 @@ In turn, this collection is piped to the Where-Object cmdlet, which selects any ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to use wildcards when specifying the collection (or collections) of Persistent Chat configuration settings to be returned. For example, this syntax returns all the settings configured at the service scope: @@ -98,8 +102,7 @@ The Filter and Identity parameters cannot be used in the same command. ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -109,6 +112,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the Persistent Chat configuration settings to be returned. To return the global collection, use this syntax: @@ -129,8 +135,7 @@ If neither the Identity parameter nor the Filter parameter are included in a com ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 2 @@ -140,13 +145,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Retrieves the Persistent Chat configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPersistentChatEligiblePrincipal.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatEligiblePrincipal.md similarity index 92% rename from skype/skype-ps/skype/Get-CsPersistentChatEligiblePrincipal.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatEligiblePrincipal.md index f4405e37b0..a441059408 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatEligiblePrincipal.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatEligiblePrincipal.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchateligibleprincipal applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPersistentChatEligiblePrincipal -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchateligibleprincipal +schema: 2.0.0 +title: Get-CsPersistentChatEligiblePrincipal --- # Get-CsPersistentChatEligiblePrincipal @@ -50,21 +51,21 @@ The functions carried out by the Get-CsPersistentChatEligiblePrincipal cmdlet ar ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPersistentChatEligiblePrincipal -PersistentChatPoolFqdn "atl-persistentchat-001.litwareinc.com" -Category "ITChat" ``` The command shown in Example 1 returns information about the eligible principals for the Persistent Chat category ITChat. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatEligiblePrincipal -PersistentChatPoolFqdn "atl-persistentchat-001.litwareinc.com" -Room "HelpDeskChatRoom" -Presenters ``` In Example 2, information is returned for all the eligible presenters for the chat room HelpDeskChatRoom. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatEligiblePrincipal -PersistentChatPoolFqdn "atl-persistentchat-001.litwareinc.com" -Room "HelpDeskChatRoom" -Presenters | Where-Object {$_.PersistentChatPrincipalType -ne "user"} ``` @@ -77,14 +78,16 @@ That collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS ### -Category + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Name of the Group Chat category for which eligible principals are to be returned. You must use either the Category or the Room parameter when calling the Get-CsPersistentChatEligiblePrincipal cmdlet; however, you cannot use both of those parameters in the same command. ```yaml Type: String Parameter Sets: Category -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: Named @@ -93,24 +96,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Room -Name of the Group Chat room for which eligible principals are to be returned. -You must use either the Category or the Room parameter when calling the Get-CsPersistentChatEligiblePrincipal cmdlet; however, you cannot use both of those parameters in the same command. - -```yaml -Type: String -Parameter Sets: Room -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -Filter -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -Filter Provides a way to filter for eligible principals by using a wildcard search. For example: @@ -121,8 +110,7 @@ Note that the Filter parameter can only filter on user SIP addresses. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -132,6 +120,9 @@ Accept wildcard characters: False ``` ### -PersistentChatPoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Fully qualified domain name of the persistent Chat pool. For example: @@ -140,8 +131,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -151,6 +141,9 @@ Accept wildcard characters: False ``` ### -Presenters + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When included in the command, returns the eligible presenters for a Persistent Chat chat room. When not included in the command, the Get-CsPersistentChatEligiblePrincipal cmdlet returns eligible members and managers instead. @@ -159,8 +152,7 @@ This parameter can only be used along with the Room parameter, and can only retu ```yaml Type: SwitchParameter Parameter Sets: Room -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -170,6 +162,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to limit the number of records returned by the cmdlet. For example, to return seven Persistent Chat principals (regardless of the number of users that are in your forest) include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which seven principals will be returned. @@ -181,8 +176,7 @@ If you set the ResultSize to 7 but you have only three principals in your forest ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -191,6 +185,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Room + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Name of the Group Chat room for which eligible principals are to be returned. +You must use either the Category or the Room parameter when calling the Get-CsPersistentChatEligiblePrincipal cmdlet; however, you cannot use both of those parameters in the same command. + +```yaml +Type: String +Parameter Sets: Room +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). diff --git a/skype/skype-ps/skype/Get-CsPersistentChatEndpoint.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatEndpoint.md similarity index 91% rename from skype/skype-ps/skype/Get-CsPersistentChatEndpoint.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatEndpoint.md index 04e98b3f03..ba737482aa 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatEndpoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatendpoint applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPersistentChatEndpoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatendpoint +schema: 2.0.0 +title: Get-CsPersistentChatEndpoint --- # Get-CsPersistentChatEndpoint @@ -44,14 +45,14 @@ The functions carried out by the Get-CsPersistentChatEndpoint cmdlet are not ava ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPersistentChatEndpoint ``` The command shown in Example 1 returns information about all the Persistent Chat endpoints configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatEndpoint -Identity "sip:pce@litwareinc.com" ``` @@ -59,7 +60,7 @@ Get-CsPersistentChatEndpoint -Identity "sip:pce@litwareinc.com" Example 2 uses the Filter parameter to return information for the Persistent Chat endpoint that has the Identity "sip:pce@litwareinc.com". In this case, the SIP address is used as the Identity. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatEndpoint -PersistentChatPoolFqdn atl-pcpool-001.litwareinc.com ``` @@ -71,6 +72,9 @@ This is done by including the PoolFqdn parameter followed by the fully qualified ## PARAMETERS ### -Credential + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to run the Get-CsPersistentChatEndpoint cmdlet under alternate credentials. This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with user objects. @@ -79,8 +83,7 @@ To use the Credential parameter you must first create a PSCredential object by u ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -90,6 +93,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to connect to the specified domain controller in order to retrieve user information. To connect to a particular domain controller, include the DomainController parameter followed by the fully qualified domain name (FQDN). For example: @@ -99,8 +105,7 @@ For example: ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -110,6 +115,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to limit the returned data by filtering on Skype for Business Server-specific attributes. For example, you can limit returned data to Persistent Chat endpoints that have been assigned a specific voice policy, or endpoints have not been assigned a specific voice policy. @@ -121,8 +129,7 @@ For example, a filter that returns only endpoints that have been assigned a per- ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -132,6 +139,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the Persistent Chat endpoint to be returned. Endpoint Identities are typically specified using the endpoint's SIP address or display name; for example: @@ -144,8 +154,7 @@ However, you can also use the full Identity of the endpoint; for example: ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 1 @@ -155,14 +164,16 @@ Accept wildcard characters: False ``` ### -LdapFilter + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business Server). Because Persistent Chat endpoints have very few non-Skype for Business Server attributes this parameter is of minimal value. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -172,14 +183,16 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to return information about user accounts in a specific organizational unit (OU) or container. Because new Persistent Chat endpoints are all created in the same Active Directory container (ApplicationContacts/RTC Service/Services/Configuration) this parameter is of minimal value. ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -189,13 +202,15 @@ Accept wildcard characters: False ``` ### -PersistentChatPoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Fully qualified domain name of the Persistent Chat pool associated with the Persistent Chat endpoint. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -205,6 +220,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to limit the number of records returned by the cmdlet. For example, to return seven contacts (regardless of the number of users that are in your forest) include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which seven users will be returned. @@ -216,8 +234,7 @@ If you set the ResultSize to 7 but you have only three contacts in your forest, ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPersistentChatPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatPolicy.md similarity index 92% rename from skype/skype-ps/skype/Get-CsPersistentChatPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatPolicy.md index 7c0e9ecc89..8619285d1e 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatpolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPersistentChatPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatpolicy +schema: 2.0.0 +title: Get-CsPersistentChatPolicy --- # Get-CsPersistentChatPolicy @@ -45,21 +46,21 @@ To view Persistent Chat policy information in the Skype for Business Server Cont ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPersistentChatPolicy ``` The command shown in Example 1 returns information about all the Persistent Chat policies configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatPolicy -Identity "RedmondPersistentChatPolicy" ``` In Example 2, information is returned only for the per-user Persistent Chat policy with the Identity RedmondPersistentChatPolicy. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatPolicy -Filter "site:*" ``` @@ -67,7 +68,7 @@ Get-CsPersistentChatPolicy -Filter "site:*" In Example 3, information is returned for all the Persistent Chat policies configured at the site scope. This is done by including the Filter parameter and the parameter value "site:*". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPersistentChatPolicy | Where-Object {$_.EnablePersistentChat -eq $True} ``` @@ -80,6 +81,9 @@ This collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to do a wildcard search for Persistent Chat policies. For example, to find all the policies configured at the site scope, use this syntax: @@ -90,8 +94,7 @@ You cannot use both the Filter parameter and the Identity parameter in the same ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identity assigned to the policy when it was created. Persistent Chat policies can be assigned at the global, site, or per-user scope. To refer to the global instance, use this syntax: @@ -123,8 +129,7 @@ If neither the Identity nor the Filter parameter is specified the Get-CsPersiste ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 2 @@ -134,13 +139,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Retrieves the Persistent Chat policy data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -150,6 +157,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose Persistent Chat policies are being returned. For example: @@ -162,8 +172,7 @@ You can return the tenant ID for each of your Skype for Business Online tenants ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPersistentChatRoom.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatRoom.md similarity index 88% rename from skype/skype-ps/skype/Get-CsPersistentChatRoom.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatRoom.md index b2f79623d0..01eada4708 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatRoom.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatroom applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPersistentChatRoom -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatroom +schema: 2.0.0 +title: Get-CsPersistentChatRoom --- # Get-CsPersistentChatRoom @@ -46,21 +47,21 @@ The Get-CsPersistentChatRoom cmdlet provides a way to return information about a ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPersistentChatRoom ``` The command shown in Example 1 returns information about the Persistent Chat chat rooms configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatRoom -Identity "atl-cs-001.litwareinc.com\ITChatRoom" ``` Example 2 returns information for a single Persistent Chat chat room: the room with the Identity atl-cs-001.litwareinc.com\ITChatRoom. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatRoom -PersistentChatPoolFqdn "atl-cs-001.litwareinc.com" ``` @@ -71,6 +72,9 @@ In Example 3, information is returned for all the Persistent Chat chat rooms con ## PARAMETERS ### -Addin + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Returns chat rooms associated with the specified chat room add-in. Note that you can only specify one add-in per command. @@ -78,8 +82,7 @@ Note that you can only specify one add-in per command. ```yaml Type: String Parameter Sets: All -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -89,14 +92,16 @@ Accept wildcard characters: False ``` ### -AsObject + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When specified, Active Directory display names are used when showing users who are on the Managers or Presenters lists. When not specified, SIP addresses are used when showing these users. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -106,6 +111,9 @@ Accept wildcard characters: False ``` ### -Category + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Returns information for all the Persistent Chat chat rooms in the specified category. For example: @@ -117,8 +125,7 @@ In addition, you cannot use the PersistentChatPoolFqdn, Filter, or Identity para ```yaml Type: String Parameter Sets: All -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -128,13 +135,15 @@ Accept wildcard characters: False ``` ### -ChatContentExceedsMB + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Returns chat rooms whose cumulative chat content exceeds the specified value (in megabytes). ```yaml Type: Int32 Parameter Sets: All -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -144,13 +153,15 @@ Accept wildcard characters: False ``` ### -Disabled + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to search for active chat rooms (by using the parameter value $False) or disabled chat rooms (by using the parameter value $True). ```yaml Type: Boolean Parameter Sets: All -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -160,6 +171,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to return information for Persistent Chat chat rooms based on the Name and/or the Description of the room. To return information for a chat room with a specific name, use syntax similar to this: @@ -170,8 +184,7 @@ That syntax returns information only for chat rooms that have the name ITChat. ```yaml Type: String Parameter Sets: All -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -181,6 +194,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique Identifier for the Persistent Chat chat room being returned. The Identity for a chat room consists of the Persistent Chat pool where the room has been configured plus the name of the room; for example: @@ -192,8 +208,7 @@ If you call the Get-CsPersistentChatRoom cmdlet without any parameters the cmdle ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 1 @@ -203,13 +218,15 @@ Accept wildcard characters: False ``` ### -Invitations + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Returns chat rooms that use invitations (by using the parameter value Inherit) or chat rooms that do not use invitations (by using the parameter value False). ```yaml Type: ChatRoomInvitations Parameter Sets: All -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -219,6 +236,9 @@ Accept wildcard characters: False ``` ### -Manager + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Returns chat rooms managed by the specified user. For example: @@ -229,8 +249,7 @@ Note that you can only specify a single manager per command. ```yaml Type: String Parameter Sets: All -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -240,6 +259,9 @@ Accept wildcard characters: False ``` ### -Member + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Returns chat rooms that the specified user is a member of. For example: @@ -250,8 +272,7 @@ Note that you can only specify a single member per command. ```yaml Type: String Parameter Sets: All -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -261,6 +282,9 @@ Accept wildcard characters: False ``` ### -PersistentChatPoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Returns information about all the Persistent Chat chat rooms configured on the specified Persistent Chat pool. For example: @@ -271,8 +295,7 @@ You cannot use the Category, Filter, or Identity parameters in any command that ```yaml Type: String Parameter Sets: All -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -282,6 +305,9 @@ Accept wildcard characters: False ``` ### -Privacy + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to return chat rooms that meet the specified privacy setting. Allowed values are: @@ -292,8 +318,7 @@ Allowed values are: ```yaml Type: ChatRoomPrivacy Parameter Sets: All -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -303,6 +328,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to limit the number of records returned by the cmdlet. For example, to return seven chat rooms (regardless of the number of rooms in your forest) include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which seven rooms will be returned. @@ -314,8 +342,7 @@ If you set the ResultSize to 7 but you have only three rooms in your forest, the ```yaml Type: Int32 Parameter Sets: All -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -325,6 +352,9 @@ Accept wildcard characters: False ``` ### -SearchDescription + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to search for the specified text value in either the chat room Name or the chat room Description. To search both the Name and the Description, include the SearchDescription parameter along with the Filter parameter. For example: @@ -334,8 +364,7 @@ For example: ```yaml Type: SwitchParameter Parameter Sets: All -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -345,6 +374,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Returns chat rooms by room type. Allowed values are: @@ -354,8 +386,7 @@ Allowed values are: ```yaml Type: ChatRoomType Parameter Sets: All -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPersistentChatState.md b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatState.md similarity index 90% rename from skype/skype-ps/skype/Get-CsPersistentChatState.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatState.md index 232ca51c32..cfc1b966a4 100644 --- a/skype/skype-ps/skype/Get-CsPersistentChatState.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPersistentChatState.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatstate applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPersistentChatState -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cspersistentchatstate +schema: 2.0.0 +title: Get-CsPersistentChatState --- # Get-CsPersistentChatState @@ -40,21 +41,21 @@ The functions carried out by the Get-CsPersistentChatState cmdlet are not availa ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPersistentChatState ``` The command shown in Example 1 returns the state of all the Persistent Chat servers configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatState -Identity "PersistentChatServer:atl-gc-001.litwareinc.com" ``` {Enter description for Example 2} -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatState -Filter "*.litwareinc.com" ``` @@ -63,7 +64,7 @@ Example 3 returns state information for all Persistent Chat servers in the domai To do this, the Filter parameter is included along with the filter value "*.litwareinc.com". That filter value causes the Get-CsPersistentChatState cmdlet to return information for all the Persistent Chat servers that have an Identity that ends with the string value ".litwareinc.com". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPersistentChatState | Where-Object {$_.PoolState -eq "FailedOver"} ``` @@ -76,6 +77,9 @@ That collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to use wildcards when retrieving one or more Persistent Chat states. For example, to return all the Persistent Chat states for the domain litwareinc.com, use this syntax: @@ -86,8 +90,7 @@ You cannot use both the Filter parameter and the Identity parameter in the same ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the Persistent Chat pool. For example: @@ -107,8 +113,7 @@ If this parameter is omitted then the Get-CsPersistentChatState cmdlet returns i ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 2 @@ -118,13 +123,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Retrieves the Persistent Chat state data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPinPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsPinPolicy.md similarity index 89% rename from skype/skype-ps/skype/Get-CsPinPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPinPolicy.md index a72edbf43e..088c368b47 100644 --- a/skype/skype-ps/skype/Get-CsPinPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPinPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspinpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPinPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cspinpolicy +schema: 2.0.0 +title: Get-CsPinPolicy --- # Get-CsPinPolicy @@ -41,7 +42,7 @@ You can use the Get-CsPinPolicy cmdlet to retrieve information about the PIN pol ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPinPolicy ``` @@ -49,14 +50,14 @@ Get-CsPinPolicy The command shown in Example 1 returns a collection of all the PIN policies configured for use in the organization. Calling the Get-CsPinPolicy cmdlet without any parameters always returns the complete set of PIN policies. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPinPolicy -Identity "site:Redmond" ``` Example 2 returns a single PIN policy: the policy with the Identity site:Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPinPolicy -Filter "tag:*" ``` @@ -64,7 +65,7 @@ Get-CsPinPolicy -Filter "tag:*" The command shown in Example 3 uses the Filter parameter to return all the policies that have been configured at the per-user scope. This is done by using the filter value "tag:*"; this value instructs the Get-CsPinPolicy cmdlet to return only those policies that have an Identity that begins with the characters "tag:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPinPolicy | Where-Object {$_.AllowCommonPatterns -eq $True} ``` @@ -73,7 +74,7 @@ Example 4 returns all the PIN policies where the AllowCommonPatterns property is In this example, the Get-CsPinPolicy cmdlet is first called without any additional parameters; that returns a collection of all the PIN policies configured for use in the organization. That collection is then passed to the Where-Object cmdlet, which picks out only those policies where the AllowCommonPatterns property is equal to True. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsPinPolicy | Where-Object {$_.PinLifetime -gt 30} ``` @@ -85,7 +86,31 @@ That means only policies that have PIN expiration times of more than 30 days wil ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to do a wildcard search for PIN policies. +For example, to find all the policies configured at the site scope, use this Filter: site:*. +To find the site policies Seattle, Seville, and Saskatoon (all of which start with the letter "S") use this Filter: site:S*. +Note that this parameter can only filter on the Identity property. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identity assigned to the policy when it was created. PIN policies can be assigned at the global, site, or per-user scope. To refer to the global instance, use this syntax: @@ -108,8 +133,7 @@ If neither the Identity nor the Filter parameter is specified the Get-CsPinPolic ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -118,33 +142,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to do a wildcard search for PIN policies. -For example, to find all the policies configured at the site scope, use this Filter: site:*. -To find the site policies Seattle, Seville, and Saskatoon (all of which start with the letter "S") use this Filter: site:S*. -Note that this parameter can only filter on the Identity property. - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the PIN policy data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -154,6 +161,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose PIN policies are being returned. For example: @@ -166,8 +176,7 @@ You can return the tenant ID for each of your Skype for Business Online tenants ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPlatformServiceSettings.md b/skype/skype-ps/SkypeForBusiness/Get-CsPlatformServiceSettings.md similarity index 91% rename from skype/skype-ps/skype/Get-CsPlatformServiceSettings.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPlatformServiceSettings.md index 556e9c6bbe..b667c37195 100644 --- a/skype/skype-ps/skype/Get-CsPlatformServiceSettings.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPlatformServiceSettings.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csplatformservicesettings applicable: Skype for Business Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPlatformServiceSettings -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csplatformservicesettings +schema: 2.0.0 +title: Get-CsPlatformServiceSettings --- # Get-CsPlatformServiceSettings @@ -34,7 +35,7 @@ The `Get-CsPlatformServiceSettings` cmdlet shows you which of these features are ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` PS C:\> Get-CsPlatformServiceSettings ``` @@ -44,6 +45,9 @@ This example shows you which of the Skype for Business on Mac features are enabl ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return one or more Platform Service Settings configurations. For example, to return all of the Platform Service Settings configurations with the word Test in their names use this syntax: @@ -53,7 +57,6 @@ For example, to return all of the Platform Service Settings configurations with Type: String Parameter Sets: Filter Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the Platform Service Settings to be returned. ```yaml Type: XdsIdentity Parameter Sets: Identity Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: 1 @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the Platform Service Settings configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPool.md b/skype/skype-ps/SkypeForBusiness/Get-CsPool.md similarity index 88% rename from skype/skype-ps/skype/Get-CsPool.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPool.md index 8c56497961..1aa8e945cc 100644 --- a/skype/skype-ps/skype/Get-CsPool.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPool.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspool applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPool -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cspool +schema: 2.0.0 +title: Get-CsPool --- # Get-CsPool @@ -41,14 +42,14 @@ The Get-CsPool cmdlet enables you to retrieve information about each pool in use ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPool ``` Example 1 returns all the pools found in your deployment of Skype for Business Server. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPool | Select-Object -ExpandProperty Computers ``` @@ -59,14 +60,14 @@ The ExpandProperty parameter is then used to "expand" the value of the Computers The Computers property is an array of objects representing each computer in the pool. When you expand the Computers property you get back detailed information about each of these computers. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPool -Identity atl-cs-001.litwareinc.com ``` In Example 3, the Identity parameter is used to restrict the returned data to the pool that has the Identity atl-cs-001.litwareinc.com. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPool -Site "Redmond" ``` @@ -74,7 +75,7 @@ Get-CsPool -Site "Redmond" Example 4 returns all the pools found in the Redmond site. To do this, the command uses the Site parameter; the parameter value "Redmond" limits the returned data to pools where the Site property is equal to Redmond. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsPool | Where-Object {$_.Services.Count -eq 0} ``` @@ -87,49 +88,56 @@ If the Count equals 0, that means that there are no Skype for Business Server se ## PARAMETERS -### -Identity -Fully qualified domain name (FQDN) of the pool to be returned. -For example: +### -Filter -`-Identity atl-cs-001.litwareinc.com` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -If this parameter is not present, then all the pools in your organization will be returned. +Enables you to use wildcards when specifying the Identity of the pool (or pools) to be returned. +For example, this syntax returns all the pools that have an Identity that ends with the string value ".fabrikam.com": + +`-Filter "*.fabrikam.com"` + +Note that you cannot use both the Filter and the Identity parameters in the same command. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the Identity of the pool (or pools) to be returned. -For example, this syntax returns all the pools that have an Identity that ends with the string value ".fabrikam.com": +### -Identity -`-Filter "*.fabrikam.com"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that you cannot use both the Filter and the Identity parameters in the same command. +Fully qualified domain name (FQDN) of the pool to be returned. +For example: + +`-Identity atl-cs-001.litwareinc.com` + +If this parameter is not present, then all the pools in your organization will be returned. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Site + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns all the pools found on the specified site. The site in question should be referenced using the site's DisplayName (for example, Redmond) rather than the site Identity (for example, site:Redmond). For example: @@ -143,8 +151,7 @@ You can retrieve the display names for your sites by running this command: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPoolBackupRelationship.md b/skype/skype-ps/SkypeForBusiness/Get-CsPoolBackupRelationship.md similarity index 88% rename from skype/skype-ps/skype/Get-CsPoolBackupRelationship.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPoolBackupRelationship.md index d29e9701e9..4bfce89855 100644 --- a/skype/skype-ps/skype/Get-CsPoolBackupRelationship.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPoolBackupRelationship.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspoolbackuprelationship applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPoolBackupRelationship -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cspoolbackuprelationship +schema: 2.0.0 +title: Get-CsPoolBackupRelationship --- # Get-CsPoolBackupRelationship @@ -33,7 +34,7 @@ The functions carried out by the Get-CsPoolBackupRelationship cmdlet are not ava ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPoolBackupRelationship -PoolFqdn "atl-cs-001.litwareinc.com" ``` @@ -43,33 +44,34 @@ The command shown in Example returns information about the backup relationship a ## PARAMETERS -### -PoolFqdn -Fully qualified domain name of the pool whose backup relationship is being checked. -For example: +### -Force -`-PoolFqdn "atl-cs-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Retrieves the backup relationship data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -78,16 +80,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -Retrieves the backup relationship data from the local replica of the Central Management store rather than from the Central Management store itself. +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool whose backup relationship is being checked. +For example: + +`-PoolFqdn "atl-cs-001.litwareinc.com"` ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False diff --git a/skype/skype-ps/skype/Get-CsPoolFabricState.md b/skype/skype-ps/SkypeForBusiness/Get-CsPoolFabricState.md similarity index 81% rename from skype/skype-ps/skype/Get-CsPoolFabricState.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPoolFabricState.md index 2e915d6108..a34a431763 100644 --- a/skype/skype-ps/skype/Get-CsPoolFabricState.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPoolFabricState.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspoolfabricstate applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPoolFabricState -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cspoolfabricstate +schema: 2.0.0 +title: Get-CsPoolFabricState --- # Get-CsPoolFabricState @@ -56,7 +57,7 @@ The functions carried out by the Get-CsPoolFabricState cmdlet are not available ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPoolFabricState -PoolFqdn "atl-cs-001.litwareinc.com" ``` @@ -64,7 +65,7 @@ Get-CsPoolFabricState -PoolFqdn "atl-cs-001.litwareinc.com" The command shown in Example 1 returns the fabric state for the pool atl-cs-001.litwareinc.com. Because the Type parameter was not included, state information for all the services on the pool will be returned. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPoolFabricState -PoolFqdn "atl-cs-001.litwareinc.com" -Type MCU ``` @@ -75,46 +76,52 @@ This is done by including the Type parameter and the parameter value "MCU". ## PARAMETERS -### -PoolFqdn -Fully qualified domain name of the pool being checked. -You must supply the FQDN of a pool when calling this cmdlet; for example: +### -Force -`-PoolFqdn "atl-cs-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -HealthState + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: String + ```yaml Type: String Parameter Sets: PoolFqdn -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -OutputCsvFile + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: String ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: PoolFqdn +Aliases: Required: False Position: Named @@ -123,55 +130,56 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool being checked. +You must supply the FQDN of a pool when calling this cmdlet; for example: + +`-PoolFqdn "atl-cs-001.litwareinc.com"` ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: PoolFqdn +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -Specifies the service type to be returned. -Allowed values are: +### -RoutingGroup -* All (returns information for all services) -* MCUFactory (returns information for the MCU factory service) -* ConferenceDirectory (returns information for the Conference Directory service) +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -LYSS (returns information for the Lync Server Storage service) - -You can only specify a single type per command. +Globally unique identifier (GUID) of the Windows Fabric routing group to be returned. +Routing groups are used to specify the servers that users log onto. ```yaml -Type: FabricEnumerationType -Parameter Sets: (All), PoolFqdn -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: RoutingGroup +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -ServiceName + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: String ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: PoolFqdn +Aliases: Required: False Position: Named @@ -180,24 +188,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RoutingGroup -Globally unique identifier (GUID) of the Windows Fabric routing group to be returned. -Routing groups are used to specify the servers that users log onto. +### -ShowAll + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: SwitchParameter ```yaml -Type: String -Parameter Sets: RoutingGroup -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: PoolFqdn +Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose Windows Fabric pool state is being returned. For example: @@ -210,8 +222,7 @@ You can return the tenant ID for each of your Skype for Business Online tenants ```yaml Type: Guid Parameter Sets: Tenant -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -220,35 +231,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserUri -Enables you to check the Windows fabric state for the pool used by a specific user. -For example, to check the Windows fabric state for the user Ken Myer use this syntax: +### -Type -`-UserUri "sip:kenmyer@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that you can only specify one user URI per command. +Specifies the service type to be returned. +Allowed values are: -```yaml -Type: UserIdParameter -Parameter Sets: User -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +* All (returns information for all services) +* MCUFactory (returns information for the MCU factory service) +* ConferenceDirectory (returns information for the Conference Directory service) -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +LYSS (returns information for the Lync Server Storage service) -### -HealthState -PARAMVALUE: String +You can only specify a single type per command. ```yaml -Type: String -Parameter Sets: PoolFqdn -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: FabricEnumerationType +Parameter Sets: (All), PoolFqdn +Aliases: Required: False Position: Named @@ -257,30 +258,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutputCsvFile -PARAMVALUE: String +### -UserUri + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to check the Windows fabric state for the pool used by a specific user. +For example, to check the Windows fabric state for the user Ken Myer use this syntax: + +`-UserUri "sip:kenmyer@litwareinc.com"` + +Note that you can only specify one user URI per command. ```yaml -Type: String -Parameter Sets: PoolFqdn -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: UserIdParameter +Parameter Sets: User +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ServiceName -PARAMVALUE: String +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String -Parameter Sets: PoolFqdn -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -289,14 +299,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowAll -PARAMVALUE: SwitchParameter +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter -Parameter Sets: PoolFqdn -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -316,7 +328,7 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### String +### String String value representing the fabric state. diff --git a/skype/skype-ps/skype/Get-CsPoolUpgradeReadinessState.md b/skype/skype-ps/SkypeForBusiness/Get-CsPoolUpgradeReadinessState.md similarity index 91% rename from skype/skype-ps/skype/Get-CsPoolUpgradeReadinessState.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPoolUpgradeReadinessState.md index db2ff87bbf..453c843f74 100644 --- a/skype/skype-ps/skype/Get-CsPoolUpgradeReadinessState.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPoolUpgradeReadinessState.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspoolupgradereadinessstate applicable: Lync Server 2013, Skype for Business Server 2015 -title: Get-CsPoolUpgradeReadinessState -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cspoolupgradereadinessstate +schema: 2.0.0 +title: Get-CsPoolUpgradeReadinessState --- # Get-CsPoolUpgradeReadinessState @@ -38,7 +39,7 @@ In Skype for Business Server 2019, Get-CsPoolUpgradeReadinessState cmdlet was re ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPoolUpgradeReadinessState ``` @@ -49,14 +50,16 @@ Note that this command must be executed on a Front End server located within the ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -65,14 +68,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -SkipIdleSecondaryVerification + +> Applicable: Skype for Business Server 2015 + +When included in the command, Get-CsPoolUpgradeReadinessState returns even if replicas are still being built. +By default, Get-CsPoolUpgradeReadinessState waits until the replicas have been built before completing. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -81,14 +87,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: cf Required: False Position: Named @@ -97,15 +105,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipIdleSecondaryVerification -When included in the command, Get-CsPoolUpgradeReadinessState returns even if replicas are still being built. -By default, Get-CsPoolUpgradeReadinessState waits until the replicas have been built before completing. +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPresenceManagementState.md b/skype/skype-ps/SkypeForBusiness/Get-CsPresenceManagementState.md similarity index 90% rename from skype/skype-ps/skype/Get-CsPresenceManagementState.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPresenceManagementState.md index 73930cdaf6..a426aef51b 100644 --- a/skype/skype-ps/skype/Get-CsPresenceManagementState.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPresenceManagementState.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspresencemanagementstate applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPresenceManagementState -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cspresencemanagementstate +schema: 2.0.0 +title: Get-CsPresenceManagementState --- # Get-CsPresenceManagementState @@ -29,7 +30,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPresenceManagementState -Fqdn "atl-mcs-001.litwareinc.com" ``` @@ -40,13 +41,15 @@ This example returns the management state of a pool specified by its fully quali ## PARAMETERS ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The Force parameter is not implemented for this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -56,6 +59,9 @@ Accept wildcard characters: False ``` ### -Fqdn + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the computer or pool to report. The computer or pool should be referenced by using its fully qualified domain name (FQDN). For example, -ComputerName "atl-mcs-001.litwareinc.com". @@ -65,8 +71,7 @@ If FQDN is not specified, the settings for the local machine will be modified. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 diff --git a/skype/skype-ps/skype/Get-CsPresencePolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsPresencePolicy.md similarity index 89% rename from skype/skype-ps/skype/Get-CsPresencePolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPresencePolicy.md index f4d0e7294a..05410e5438 100644 --- a/skype/skype-ps/skype/Get-CsPresencePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPresencePolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspresencepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPresencePolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-cspresencepolicy +schema: 2.0.0 +title: Get-CsPresencePolicy --- # Get-CsPresencePolicy @@ -52,7 +54,7 @@ The Get-CsPresencePolicy cmdlet provides a way for you to return information abo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPresencePolicy ``` @@ -60,14 +62,14 @@ Get-CsPresencePolicy The command shown in Example 1 returns information about all the presence policies configured for use in the organization. This is done by calling the Get-CsPresencePolicy cmdlet without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPresencePolicy -Identity "RedmondPresencePolicy" ``` Example 2 returns a single per-user presence policy: the policy with the Identity RedmondPresencePolicy. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPresencePolicy -Filter "site:*" ``` @@ -75,7 +77,7 @@ Get-CsPresencePolicy -Filter "site:*" Example 3 returns information about all the presence policies that have been configured at the site scope. To do this, the command uses the Filter parameter and the filter value "site:*"; that filter value limits returned data to all the presence policies that have an Identity that begins with the string value "site:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPresencePolicy | Where-Object {$_.MaxPromptedSubscriber -le 100} ``` @@ -87,7 +89,33 @@ This collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards when specifying the policy (or policies) to be returned. +For example, this syntax returns all the presence policies configured at the site scope: + +`-Filter "site:*"` + +The Filter and Identity parameters cannot be used in the same command. + +```yaml +Type: String +Parameter Sets: Filter, (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the presence policy to be retrieved. To return the global policy, use this syntax: @@ -108,8 +136,7 @@ If neither the Identity nor the Filter parameters are specified, then the Get-Cs ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -118,35 +145,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the policy (or policies) to be returned. -For example, this syntax returns all the presence policies configured at the site scope: - -`-Filter "site:*"` - -The Filter and Identity parameters cannot be used in the same command. - -```yaml -Type: String -Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the presence policy data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -156,6 +164,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose presence policies are being returned. For example: @@ -168,8 +179,7 @@ You can return the tenant ID for each of your Skype for Business Online tenants ```yaml Type: Guid Parameter Sets: Identity, Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPresenceProvider.md b/skype/skype-ps/SkypeForBusiness/Get-CsPresenceProvider.md similarity index 89% rename from skype/skype-ps/skype/Get-CsPresenceProvider.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPresenceProvider.md index 8051cd503e..e1e2328865 100644 --- a/skype/skype-ps/skype/Get-CsPresenceProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPresenceProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspresenceprovider applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPresenceProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cspresenceprovider +schema: 2.0.0 +title: Get-CsPresenceProvider --- # Get-CsPresenceProvider @@ -41,21 +42,21 @@ The functions carried out by the Get-CsPresenceProvider cmdlet are not available ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPresenceProvider ``` The command shown in Example 1 returns information about all the presence providers configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPresenceProvider -Identity "global/fabrikam.com" ``` Example 2 returns information about a single presence provider: the provider with the Identity global/fabrikam.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPresenceProvider -Filter "site:*" ``` @@ -64,7 +65,7 @@ In Example 3, information is returned for all the presence providers configured To do this, the Filter parameter is used along with the filter value "site:*". That filter value limits returned data to presence providers that have an Identity that begins with the string value "site:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPresenceProvider | Where-Object {$_.Fqdn -match "fabrikam.com"} ``` @@ -77,6 +78,9 @@ That collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcards when specifying the Identity of the presence provider (or providers) to be returned. For example, to return all the presence providers configured at the service scope use this filter value: @@ -87,8 +91,7 @@ You cannot use both the Filter parameter and the Identity parameter in the same ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -98,6 +101,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the presence provider. The Identity of a presence provider is composed of two parts: the scope (Parent) where the provider has been applied (for example, service:UserServer:atl-cs-001.litwareinc.com) and the provider's fully qualified domain name. For example, to retrieve a single presence provider use syntax similar to this: @@ -114,8 +120,7 @@ If neither the Identity nor the Filter parameters are included, then the Get-CsP ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -125,13 +130,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the allowed domains from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPrivacyConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsPrivacyConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Get-CsPrivacyConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPrivacyConfiguration.md index f008d70f24..84b2781792 100644 --- a/skype/skype-ps/skype/Get-CsPrivacyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPrivacyConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csprivacyconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPrivacyConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-csprivacyconfiguration +schema: 2.0.0 +title: Get-CsPrivacyConfiguration --- # Get-CsPrivacyConfiguration @@ -49,21 +51,21 @@ The Get-CsPrivacyConfiguration cmdlet enables you to retrieve information about ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPrivacyConfiguration ``` The command shown in Example 1 returns all the privacy configuration settings currently in use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPrivacyConfiguration -Identity site:Redmond ``` Example 2 returns a single collection of privacy configuration settings: the settings that have the Identity site:Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPrivacyConfiguration -Filter "site:*" ``` @@ -72,7 +74,7 @@ In Example 3, information is returned for all the privacy configuration settings To do this, the Filter parameter is included, along with the filter value "site:*". That filter value ensures that only settings where the Identity (the only property you can filter on) begins with the characters "site:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPrivacyConfiguration | Where-Object {$_.EnablePrivacyMode -eq $True} ``` @@ -84,7 +86,35 @@ This collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards to return one or more collections of privacy configuration settings. +For example, to return all the settings configured at the site scope, you can use this syntax: + +`-Filter "site:*"` + +To return all the settings configured at the service scope, use this syntax: + +`-Filter "service:*"` + +```yaml +Type: String +Parameter Sets: Filter, (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the privacy configuration settings to be retrieved. To return the global settings, use this syntax: @@ -103,8 +133,7 @@ If this parameter is not specified then the Get-CsPrivacyConfiguration cmdlet re ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -113,21 +142,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards to return one or more collections of privacy configuration settings. -For example, to return all the settings configured at the site scope, you can use this syntax: - -`-Filter "site:*"` +### -LocalStore -To return all the settings configured at the service scope, use this syntax: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -`-Filter "service:*"` +Retrieves the privacy configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml -Type: String -Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -137,6 +161,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose privacy configuration settings are to be retrieved. For example: @@ -154,24 +181,7 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -Retrieves the privacy configuration data from the local replica of the Central Management store rather than from the Central Management store itself. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsProxyConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsProxyConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Get-CsProxyConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsProxyConfiguration.md index 8ab2e40fe6..468053803d 100644 --- a/skype/skype-ps/skype/Get-CsProxyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsProxyConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csproxyconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsProxyConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csproxyconfiguration +schema: 2.0.0 +title: Get-CsProxyConfiguration --- # Get-CsProxyConfiguration @@ -40,7 +41,7 @@ The Get-CsProxyConfiguration cmdlet enables you to return information about any ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsProxyConfiguration ``` @@ -48,7 +49,7 @@ Get-CsProxyConfiguration The command shown in Example 1 returns a collection of all the proxy configuration settings currently in use in the organization. This is done by calling the Get-CsProxyConfiguration cmdlet without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsProxyConfiguration -Identity "service:EdgeServer:atl-cs-001.litwareinc.com" ``` @@ -56,7 +57,7 @@ Get-CsProxyConfiguration -Identity "service:EdgeServer:atl-cs-001.litwareinc.com In Example 2, information about the proxy configuration settings that have the Identity service:EdgeServer:atl-cs-001.litwareinc.com is returned. Because Identities must be unique, this command will never return more than one collection of settings. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsProxyConfiguration -Filter "service:*" ``` @@ -64,7 +65,7 @@ Get-CsProxyConfiguration -Filter "service:*" Example 3 returns information about all of the proxy settings that have been configured at the service scope. To do this, the command calls the Get-CsProxyConfiguration cmdlet along with the Filter parameter; the filter value "service:*" ensures that only those settings that have an Identity that begins with the string value "service:" will be returned. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsProxyConfiguration | Where-Object {$_.UseCertificateForClientToProxyAuth -eq $False} ``` @@ -73,7 +74,7 @@ Example 4 returns information about the proxy configuration settings that do not To carry out this task, the command first uses the Get-CsProxyConfiguration cmdlet to return a collection of all the proxy configuration settings currently in use. This collection is then piped to the Where-Object cmdlet, which selects only those settings where the UseCertificateForClientToProxyAuth property is equal to False. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsProxyConfiguration | Where-Object {$_.MaxClientMessageBodySizeKb -lt 5000} ``` @@ -85,7 +86,33 @@ This collection is then piped to the Where-Object cmdlet, which picks out those ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards when specifying the proxy configuration settings to be returned. +For example, this syntax returns all the settings configured at the service scope: + +`-Filter "service:*"` + +You cannot use both the Filter and the Identity parameters in the same command. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the proxy server configuration settings to be returned. To return the global settings, use this syntax: @@ -103,8 +130,7 @@ If this parameter is not included, the Get-CsProxyConfiguration cmdlet returns a ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -113,35 +139,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the proxy configuration settings to be returned. -For example, this syntax returns all the settings configured at the service scope: - -`-Filter "service:*"` - -You cannot use both the Filter and the Identity parameters in the same command. +### -LocalStore -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore Retrieves the proxy configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPstnUsage.md b/skype/skype-ps/SkypeForBusiness/Get-CsPstnUsage.md similarity index 88% rename from skype/skype-ps/skype/Get-CsPstnUsage.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPstnUsage.md index 3905df1116..120359142d 100644 --- a/skype/skype-ps/skype/Get-CsPstnUsage.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPstnUsage.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspstnusage applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPstnUsage -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cspstnusage +schema: 2.0.0 +title: Get-CsPstnUsage --- # Get-CsPstnUsage @@ -42,14 +43,14 @@ Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Get-CsPstnUsage"} ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPstnUsage ``` This command returns the list of global PSTN usages available within the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` (Get-CsPstnUsage).Usage ``` @@ -73,7 +74,7 @@ International Restricted -### -------------------------- Example 3 -------------------------- +### Example 3 ``` (Get-CsPstnUsage).Usage | ForEach-Object {if ($_ -like "*tern*") {$_}} ``` @@ -89,48 +90,54 @@ The If statement compares the current usage string to the string "*tern*" (the * ## PARAMETERS -### -Identity -The level at which these settings are applied. -The only identity that can be applied to PSTN usages is Global. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Filter parameter allows you to retrieve only those PSTN usages with an Identity matching a particular wildcard string. +However, the only Identity available to PSTN usages is Global, so this parameter is not useful for this cmdlet. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -The Filter parameter allows you to retrieve only those PSTN usages with an Identity matching a particular wildcard string. -However, the only Identity available to PSTN usages is Global, so this parameter is not useful for this cmdlet. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The level at which these settings are applied. +The only identity that can be applied to PSTN usages is Global. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the PSTN usage information from the local data store rather than the main Central Management store. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPublicProvider.md b/skype/skype-ps/SkypeForBusiness/Get-CsPublicProvider.md similarity index 90% rename from skype/skype-ps/skype/Get-CsPublicProvider.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPublicProvider.md index e896dc4205..29ac757812 100644 --- a/skype/skype-ps/skype/Get-CsPublicProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPublicProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspublicprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPublicProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cspublicprovider +schema: 2.0.0 +title: Get-CsPublicProvider --- # Get-CsPublicProvider @@ -45,7 +46,7 @@ In order to federate with a public provider you need to create and enable a new ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPublicProvider ``` @@ -53,7 +54,7 @@ Get-CsPublicProvider The command shown in Example 1 returns a collection of all the public providers that are configured for use in the organization. Calling the Get-CsPublicProvider cmdlet without any additional parameters always returns the complete collection of public providers. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPublicProvider -Identity "Skype" ``` @@ -61,7 +62,7 @@ Get-CsPublicProvider -Identity "Skype" In Example 2, all the public providers that have the Identity Skype are returned. Because Identities must be unique among public providers (and among hosting providers), this command will always return, at most, a single item. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPublicProvider -Filter W* ``` @@ -69,7 +70,7 @@ Get-CsPublicProvider -Filter W* Example 3 returns all the public providers that have an Identity that begins with the letter W. This is done by including the Filter parameter and the filter value "W*". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPublicProvider | Where-Object {$_.Enabled -eq $False} ``` @@ -78,7 +79,7 @@ The command shown in Example 4 returns a collection of all the public providers To do this, the command first calls the Get-CsPublicProvider cmdlet to return a collection of all the public providers configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those providers where the Enabled property is equal to False. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsPublicProvider | Where-Object {$_.VerificationLevel -ne "AlwaysVerifiable"} ``` @@ -91,27 +92,10 @@ The net effect: only providers where the VerificationLevel property is set to ei ## PARAMETERS -### -Identity -Unique identifier for the public provider to be returned. -The Identity is typically the name of the web site providing the services. - -You cannot use wildcards when specifying the Identity. -To use wildcards to return one or more public providers, use the Filter parameter instead. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Filter -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Filter Enables you to use wildcard values in order to return one or more public providers. For example, to return a collection of all the public providers that have an Identity that begins with the letter Y, use this syntax: @@ -124,8 +108,7 @@ To return a collection of all the public providers that include the string value ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,14 +117,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the public provider to be returned. +The Identity is typically the name of the web site providing the services. + +You cannot use wildcards when specifying the Identity. +To use wildcards to return one or more public providers, use the Filter parameter instead. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the public provider data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsPushNotificationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsPushNotificationConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsPushNotificationConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsPushNotificationConfiguration.md index c691ad8fc7..580c605952 100644 --- a/skype/skype-ps/skype/Get-CsPushNotificationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsPushNotificationConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cspushnotificationconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsPushNotificationConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-cspushnotificationconfiguration +schema: 2.0.0 +title: Get-CsPushNotificationConfiguration --- # Get-CsPushNotificationConfiguration @@ -51,21 +53,21 @@ The `Get-CsPushNotificationConfiguration` cmdlet provides a way for you to retur ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPushNotificationConfiguration ``` Skype for Business Server example 1 returns information about all the push notification settings configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPushNotificationConfiguration -Identity "site:Redmond" ``` Skype for Business Server example 2 returns information about a single collection of push notification settings: the settings configured for the Redmond site. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPushNotificationConfiguration -Filter "site:*" ``` @@ -73,7 +75,7 @@ Get-CsPushNotificationConfiguration -Filter "site:*" In Skype for Business Server example 3, the command returns all the push notification settings assigned to the site scope. To do this, the command uses the Filter parameter and the filter value "site:*"; that filter value returns only those settings that have an Identity that begins with the string value "site:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPushNotificationConfiguration | Where-Object {$_.EnableApplePushNotificationService -eq $False} ``` @@ -82,7 +84,7 @@ In Skype for Business Server example 4 returns all the push notification setting To do this, the command first uses the Get-CsPushNotificationConfiguration cmdlet to return a collection of all the push notification settings currently in use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those settings where the EnableApplePushNotificationService property is equal to (-eq) False. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsPushNotificationConfiguration | Where-Object {$_.EnableApplePushNotificationService -eq $False -and $_.EnableMicrosoftPushNotificationService -eq $False} ``` @@ -100,6 +102,9 @@ To restrict the returned data to settings where both services have been disabled ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return a collection (or collections) of push notification configuration settings. To return a collection of all the settings configured at the site scope, use this syntax: @@ -112,8 +117,7 @@ To return a collection of all the settings that have the string value "Canada" s ```yaml Type: String Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -123,6 +127,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the unique identifier for the collection of push notification settings you want to return. To refer to the global settings use this syntax: @@ -140,8 +147,7 @@ If this parameter is not specified, then the Get-CsPushNotificationConfiguration ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -151,13 +157,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the push notification configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,6 +175,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose push notification configuration settings are to be modified. For example: @@ -183,8 +194,7 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsQoEConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsQoEConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Get-CsQoEConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsQoEConfiguration.md index df091a86aa..eb9fce4d99 100644 --- a/skype/skype-ps/skype/Get-CsQoEConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsQoEConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csqoeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsQoEConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csqoeconfiguration +schema: 2.0.0 +title: Get-CsQoEConfiguration --- # Get-CsQoEConfiguration @@ -39,21 +40,21 @@ QoE is part of the Monitoring Server role; therefore Monitoring Server must be d ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsQoEConfiguration ``` This example uses the Get-CsQoEConfiguration cmdlet to return a collection of all the QoE settings configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsQoEConfiguration -Identity site:Redmond ``` Example 2 uses the Identity parameter to ensure that the Get-CsQoEConfiguration cmdlet returns only the QoE settings with the Identity site:Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsQoEConfiguration -Filter site:* ``` @@ -62,7 +63,7 @@ In Example 3 the Filter parameter is used to return all the QoE settings that ha The wildcard "site:*" returns all the QoE settings that have an Identity beginning with the string value site:. Settings that meet those criteria are settings that have been configured at the site scope. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsQoEConfiguration | Where-Object {$_.KeepQoEDataForDays -lt 30} ``` @@ -74,24 +75,10 @@ That collection is then piped to the Where-Object cmdlet, which applies a filter ## PARAMETERS -### -Identity -The unique identifier of the settings you want to retrieve. -Possible values are global and site:\, where \ is the name of the site in your Skype for Business Server deployment to which you want to apply the changes. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Filter -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Filter Enables you to use wildcard characters in order to return a collection (or multiple collections) of QoE configuration settings. To return a collection of all the settings configured at the site scope, use this syntax: @@ -104,8 +91,7 @@ To return a collection of all the settings that have the string value "Western" ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -114,14 +100,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the settings you want to retrieve. +Possible values are global and site:\, where \ is the name of the site in your Skype for Business Server deployment to which you want to apply the changes. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the settings from the local replica of the Central Management store. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsRegistrarConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsRegistrarConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Get-CsRegistrarConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsRegistrarConfiguration.md index e5b7e3c765..591c212bdb 100644 --- a/skype/skype-ps/skype/Get-CsRegistrarConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsRegistrarConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csregistrarconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsRegistrarConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csregistrarconfiguration +schema: 2.0.0 +title: Get-CsRegistrarConfiguration --- # Get-CsRegistrarConfiguration @@ -43,21 +44,21 @@ Registrar configuration settings are used to help manage endpoints and endpoint ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsRegistrarConfiguration ``` The command shown in Example 1 returns a collection of all the Registrar configuration settings currently in use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsRegistrarConfiguration -Identity site:Redmond ``` Example 2 returns a single collection of Registrar configuration settings: the settings configured for the Redmond site (-Identity site:Redmond). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsRegistrarConfiguration -Filter "service:*" ``` @@ -65,7 +66,7 @@ Get-CsRegistrarConfiguration -Filter "service:*" In Example 3, information is returned for all the Registrar configuration settings assigned at the service scope. To do this, the command uses the Filter parameter and the filter value "service:*"; that filter value ensures that only settings that have an Identity that begins with the string value "service:" will be returned. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsRegistrarConfiguration | Where-Object {$_.EnableDHCPServer -eq $True} ``` @@ -74,7 +75,7 @@ Example 4 returns information about the Registrar configuration settings that en To carry out this task, the command first calls the Get-CsRegistrarConfiguration cmdlet without any parameters; that returns a collection of all the Registrar configuration settings currently in use. This collection is then piped to the Where-Object cmdlet, which selects only those settings where the EnableDHCPServer property is equal to True. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsRegistrarConfiguration | Where-Object {$_.MaxEndpointsPerUser -gt 8} ``` @@ -86,7 +87,35 @@ This collection is then piped to the Where-Object cmdlet, which picks out those ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards in order to return one or more collections of Registrar configuration settings. +For example, to return all the settings configured at the site scope, use this syntax: + +`-Filter "site:*"` + +To return all the settings configured at the service scope, use this syntax: + +`-Filter "service:*"` + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the Registrar configuration settings to be returned. To return the global settings, use this syntax: @@ -105,8 +134,7 @@ If this parameter is omitted then the Get-CsRegistrarConfiguration cmdlet return ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -115,37 +143,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards in order to return one or more collections of Registrar configuration settings. -For example, to return all the settings configured at the site scope, use this syntax: - -`-Filter "site:*"` - -To return all the settings configured at the service scope, use this syntax: - -`-Filter "service:*"` - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the Registrar configuration settings data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsReportingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsReportingConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Get-CsReportingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsReportingConfiguration.md index 6a67e67c54..e598155cdb 100644 --- a/skype/skype-ps/skype/Get-CsReportingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsReportingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csreportingconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsReportingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csreportingconfiguration +schema: 2.0.0 +title: Get-CsReportingConfiguration --- # Get-CsReportingConfiguration @@ -38,21 +39,21 @@ The functions carried out by the Get-CsReportingConfiguration cmdlet are not ava ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsReportingConfiguration ``` The command shown in Example 1 returns information for all the reporting configuration settings currently in use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsReportingConfiguration -Identity "Service:MonitoringDatabase:atl-sql-001.litwareinc.com" ``` In Example 2, information is returned for a single collection of reporting configuration settings: the settings with the Identity "Service:MonitoringDatabase:atl-sql-001.litwareinc.com". -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsReportingConfiguration -Filter "*.litwareinc.com" ``` @@ -60,7 +61,7 @@ Get-CsReportingConfiguration -Filter "*.litwareinc.com" In Example 3, information is returned for all the reporting configuration settings that have an Identity that ends in ".litwareinc.com". To do this, the command uses the Filter parameter and the filter value "*.litwareinc.com". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsReportingConfiguration | Where-Object {$_.ReportingUrl -like "*_ARCHINST*"} ``` @@ -73,6 +74,9 @@ This collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters when specifying the reporting configuration settings to be returned. For example, this syntax returns all the settings configured at the service scope: @@ -83,8 +87,7 @@ Note that you cannot use both the Filter and the Identity parameters in the same ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service Identity of the monitoring database associated with the reporting configuration settings. For example: @@ -104,8 +110,7 @@ If you do not include either the Identity parameter or the Filter parameter in y ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -115,13 +120,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the reporting configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsRgsAgentGroup.md b/skype/skype-ps/SkypeForBusiness/Get-CsRgsAgentGroup.md similarity index 90% rename from skype/skype-ps/skype/Get-CsRgsAgentGroup.md rename to skype/skype-ps/SkypeForBusiness/Get-CsRgsAgentGroup.md index c55cfb40ac..e8f3721061 100644 --- a/skype/skype-ps/skype/Get-CsRgsAgentGroup.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsRgsAgentGroup.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csrgsagentgroup applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsRgsAgentGroup -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csrgsagentgroup +schema: 2.0.0 +title: Get-CsRgsAgentGroup --- # Get-CsRgsAgentGroup @@ -38,7 +39,7 @@ The Get-CsRgsAgentGroup cmdlet provides a way for you to return information abou ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsRgsAgentGroup ``` @@ -46,21 +47,21 @@ Get-CsRgsAgentGroup Example 1 returns all the Response Group agent groups configured for use in the organization. This is done by calling Get-CsRgsAgentGroup without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsRgsAgentGroup -Identity service:ApplicationServer:atl-cs-001.litwareinc.com ``` The command shown in Example 2 returns all the Response Group agent groups configured for use on the service ApplicationServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsRgsAgentGroup -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" ``` The command shown in Example 3 returns a single Response Group agent group: the group named Help Desk found on the service ApplicationServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsRgsAgentGroup -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Where-Object {$_.RoutingMethod -eq "RoundRobin"} ``` @@ -69,7 +70,7 @@ In Example 4, information is returned for all the Response Group agent groups on To do this, the command first uses Get-CsRgsAgentGroup to return a collection of all the agent groups on ApplicationServer:atl-cs-001.litwareinc.com. This collection is then piped to the Where-Object cmdlet, which selects only those groups where the RoutingMethod property is equal to "RoundRobin". -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsRgsAgentGroup -Identity Service:ApplicationServer:atl-cs-001.litwareinc.com | Where-Object {$_.RoutingMethod -ne "RoundRobin"} ``` @@ -82,6 +83,9 @@ This collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents either the Identity of the service where the Response Group agent group is hosted or the full Identity of the agent group itself. If you specify the service Identity (for example, service:ApplicationServer:atl-cs-001.litwareinc.com) then all the agent groups hosted on that service will be returned. If you specify the Identity of the group, then only the specified agent group will be returned. @@ -95,8 +99,7 @@ If called without any parameters, Get-CsRgsAgentGroup returns a collection of al ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -106,13 +109,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique name given to the agent group at the time the group was created. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the pool that "owns" the agent group. The Owner pool ID and the Pool ID of an agent group are typically the same. However, if a group needs to temporarily be moved (perhaps in a disaster recovery procedure) then the Pool ID will change. @@ -130,8 +138,7 @@ However, the Owner ID will continue to point to the original pool. ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,14 +148,16 @@ Accept wildcard characters: False ``` ### -ShowAll + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, shows all the Response Group agent groups, including those groups where the Owner pool ID and the Pool ID are different. By default, Get-CsRgsAgentGroup only returns information about agent groups where the Owner pool ID and the Pool ID are identical. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsRgsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsRgsConfiguration.md similarity index 94% rename from skype/skype-ps/skype/Get-CsRgsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsRgsConfiguration.md index efecbe98eb..3019907f6b 100644 --- a/skype/skype-ps/skype/Get-CsRgsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsRgsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csrgsconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsRgsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csrgsconfiguration +schema: 2.0.0 +title: Get-CsRgsConfiguration --- # Get-CsRgsConfiguration @@ -37,7 +38,7 @@ However, the Examples section in this topic shows a way to work around this issu ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsRgsConfiguration -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" ``` @@ -45,7 +46,7 @@ Get-CsRgsConfiguration -Identity "service:ApplicationServer:atl-cs-001.litwarein Example 1 returns the Response Group configuration settings for the service ApplicationServer:atl-cs-001.litwareinc.com. Because there can only be one collection of settings per service, this command will never return more than a single item. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` (Get-CsRgsConfiguration -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com").DisableCallContext ``` @@ -60,7 +61,7 @@ For example, to display the value of the AgentRingbackGracePeriod property (and `(Get-CsRgsConfiguration -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com").AgentRingbackGracePeriod` -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsService -ApplicationServer | Where-Object {$_.Applications -contains "urn:application:RGS"} | ForEach-Object {Get-CsRgsConfiguration -Identity $_.Identity} ``` @@ -76,14 +77,16 @@ ForEach-Object then takes each server in the collection and uses Get-CsRgsConfig ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the service hosting the Response Group configuration settings; for example: -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com". If you do not include this parameter, Get-CsRgsConfiguration will prompt you to supply an Identity. ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 diff --git a/skype/skype-ps/skype/Get-CsRgsHolidaySet.md b/skype/skype-ps/SkypeForBusiness/Get-CsRgsHolidaySet.md similarity index 91% rename from skype/skype-ps/skype/Get-CsRgsHolidaySet.md rename to skype/skype-ps/SkypeForBusiness/Get-CsRgsHolidaySet.md index 2b7b8d3bf5..91ba05fdcf 100644 --- a/skype/skype-ps/skype/Get-CsRgsHolidaySet.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsRgsHolidaySet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csrgsholidayset applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsRgsHolidaySet -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csrgsholidayset +schema: 2.0.0 +title: Get-CsRgsHolidaySet --- # Get-CsRgsHolidaySet @@ -49,21 +50,21 @@ The Get-CsRgsHolidaySet provides a way for you to return information about the R ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsRgsHolidaySet ``` Example 1 returns information about all the holiday sets configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsRgsHolidaySet -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" ``` The command shown in Example 2 returns information about all the holiday sets configured for the service ApplicationServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsRgsHolidaySet -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -Name "2018 Holidays" ``` @@ -71,7 +72,7 @@ Get-CsRgsHolidaySet -Identity "service:ApplicationServer:atl-cs-001.litwareinc.c In Example 3, a single holiday set from the service ApplicationServer:atl-cs-001.litwareinc.com is returned: the set with the Name "2018 Holidays". Because Names must be unique for each service, this command will never return more than one item. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsRgsHolidaySet -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -Name "2018 Holidays"| Select-Object -ExpandProperty HolidayList ``` @@ -80,7 +81,7 @@ Example 4 displays detailed information for the holidays found in the holiday se To do this, the command first uses Get-CsRgsHolidaySet to retrieve the specified holiday set. This set is then passed to the Select-Object cmdlet, which uses the ExpandProperty parameter to show detailed information for each holiday in the set. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsRgsHolidaySet -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" | Select-Object Identity -ExpandProperty HolidayList | Where-Object {$_.Name -eq "Christmas Day"} | ForEach-Object {Get-CsRgsHolidaySet -Identity $_.Identity} ``` @@ -98,6 +99,9 @@ The net result is a list of all the holiday sets that include a Christmas Day ho ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents either the Identity of the service where the holiday set is hosted or the full Identity of the holiday set. If you specify the service Identity (for example, service:ApplicationServer:atl-cs-001.litwareinc.com), then all the holiday sets hosted on that service will be returned. If you specify the Identity of the holiday set, then only the specified set will be returned. @@ -111,8 +115,7 @@ If called without any parameters, Get-CsRgsHolidaySet returns a collection of al ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -122,13 +125,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique name given to the holiday set at the time the set was created. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,6 +143,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the pool that "owns" the holiday set. The Owner pool ID and the Pool ID of a holiday set are typically the same. However, if a holiday set needs to temporarily be moved (perhaps in a disaster recovery procedure) then the Pool ID will change. @@ -146,8 +154,7 @@ However, the Owner ID will continue to point to the original pool. ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -157,14 +164,16 @@ Accept wildcard characters: False ``` ### -ShowAll + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, shows all the Response Group holiday sets, including those sets where the Owner pool ID and the Pool ID are different. By default, Get-CsRgsHolidaySet only returns information about agent sets where the Owner pool ID and the Pool ID are identical. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsRgsHoursOfBusiness.md b/skype/skype-ps/SkypeForBusiness/Get-CsRgsHoursOfBusiness.md similarity index 90% rename from skype/skype-ps/skype/Get-CsRgsHoursOfBusiness.md rename to skype/skype-ps/SkypeForBusiness/Get-CsRgsHoursOfBusiness.md index 8f06475469..c5cffefeb1 100644 --- a/skype/skype-ps/skype/Get-CsRgsHoursOfBusiness.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsRgsHoursOfBusiness.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csrgshoursofbusiness applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsRgsHoursOfBusiness -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csrgshoursofbusiness +schema: 2.0.0 +title: Get-CsRgsHoursOfBusiness --- # Get-CsRgsHoursOfBusiness @@ -41,7 +42,7 @@ The Get-CsRgsHoursOfBusiness cmdlet provides a way for you to retrieve informati ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsRgsHoursOfBusiness ``` @@ -49,21 +50,21 @@ Get-CsRgsHoursOfBusiness Example 1 returns information about all the business hour collections configured for use in your organization. This is done by calling Get-CsRgsHoursOfBusiness without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsRgsHoursOfBusiness -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" ``` The command shown in Example 2 returns all the business hour collections configured for use on atl-cs-001.litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsRgsHoursOfBusiness -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -Name "Help Desk Business Hours" ``` Example 3 returns a single collection of business hours from atl-cs-001.litwareinc.com: the collection with the Name "Help Desk Business Hours". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsRgsHoursOfBusiness -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" | Where-Object {$_.SundayTimeRange1 -ne $Null -or $_.SundayTimeRange2 -ne $Null} ``` @@ -73,7 +74,7 @@ To do this, the command first calls Get-CsRgsHoursOfBusiness to return all the b This data is then piped to the Where-Object cmdlet, which selects only those items where one of the following two criteria is true: the SundayTimeRange1 property is not equal to a null value and/or the SundayTimeRange2 property is not equal to a null value. If a time range property is not null, then that means business hours have been configured for that time period. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsRgsHoursOfBusiness -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" | Where-Object {$_.MondayTimeRange1.OpenTime -le "08:00:00"} ``` @@ -83,7 +84,7 @@ In order to do this, the command first uses Get-CsRgsHoursOfBusiness to return a This data is then piped to the Where-Object cmdlet, which selects only those collections where the value of the MondayTimeRange1.OpenTime property is less than or equal to 8:00 A.M. (08:00:00). -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsRgsHoursOfBusiness -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" | Where-Object {$_.Custom -eq $False} ``` @@ -96,6 +97,9 @@ This data is then piped to the Where-Object cmdlet, which picks out only those c ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents either the Identity of the service where the business hours collection is hosted or the full Identity of the collection itself. If you specify the service Identity (for example, service:ApplicationServer:atl-cs-001.litwareinc.com), then all the business hours collections hosted on that service will be returned. If you specify the Identity of the collection, then only the specified business hours collection will be returned. @@ -109,8 +113,7 @@ If called without any parameters, Get-CsRgsHoursOfBusiness returns all the busin ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -120,13 +123,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique name given to the business hours collection at the time the collection was created. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -136,6 +141,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the pool that "owns" the business hours. The Owner pool ID and the Pool ID of a collection of business hours are typically the same. However, if a collection needs to temporarily be moved (perhaps in a disaster recovery procedure) then the Pool ID will change. @@ -144,8 +152,7 @@ However, the Owner ID will continue to point to the original pool. ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -155,14 +162,16 @@ Accept wildcard characters: False ``` ### -ShowAll + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, shows all the Response Group business hour collections, including those collections where the Owner pool ID and the Pool ID are different. By default, Get-CsRgsHoursOfBusiness only returns information about business hour collections where the Owner pool ID and the Pool ID are identical. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsRgsQueue.md b/skype/skype-ps/SkypeForBusiness/Get-CsRgsQueue.md similarity index 89% rename from skype/skype-ps/skype/Get-CsRgsQueue.md rename to skype/skype-ps/SkypeForBusiness/Get-CsRgsQueue.md index 80bee92147..5467636ce1 100644 --- a/skype/skype-ps/skype/Get-CsRgsQueue.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsRgsQueue.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csrgsqueue applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsRgsQueue -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csrgsqueue +schema: 2.0.0 +title: Get-CsRgsQueue --- # Get-CsRgsQueue @@ -36,7 +37,7 @@ The Get-CsRgsQueue cmdlet provides a way for you to return information about the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsRgsQueue ``` @@ -44,21 +45,21 @@ Get-CsRgsQueue The command shown in Example 1 returns information about all the Response Group queues configured for use in the organization. This is done by calling Get-CsRgsQueue without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com ``` The command shown in Example 2 returns information about all the Response Group queues located on the service ApplicationServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" ``` In Example 3, information is returned for a single Response Group queue: the queue named "Help Desk" located on the service ApplicationServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Select-Object -ExpandProperty TimeoutAction ``` @@ -68,7 +69,7 @@ To carry out this task, Get-CsRgsQueue is first used to return information about This information is then passed to the Select-Object cmdlet, which "expands" the value stored in the TimeoutAction property. When you expand the TimeoutAction property, you see the individual properties of the embedded object that make up the property value: Prompt; TargetQuestion; Target; TargetQueueID; and TargetUri. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Where-Object {$_.OverflowCandidate -eq "NewestCall"} ``` @@ -82,6 +83,9 @@ That collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents either the Identity of the service where the Response Group queue is hosted or the full Identity of the queue itself. If you specify the service Identity (for example, service:ApplicationServer:atl-cs-001.litwareinc.com), then all the Response Group queues hosted on that service will be returned. If you specify the Identity of the queue, then only the specified Response Group queue will be returned. @@ -95,8 +99,7 @@ If called without any parameters, Get-CsRgsQueue returns all the Response Group ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -106,13 +109,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique name given to the Response Group queue at the time the queue was created. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,6 +127,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the pool that "owns" the queue. The Owner pool ID and the Pool ID of a queue are typically the same. However, if a queue needs to temporarily be moved (perhaps in a disaster recovery procedure) then the Pool ID will change. @@ -130,8 +138,7 @@ However, the Owner ID will continue to point to the original pool. ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,14 +148,16 @@ Accept wildcard characters: False ``` ### -ShowAll + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, shows all the Response Group queues, including those queues where the Owner pool ID and the Pool ID are different. By default, Get-CsRgsQueue only returns information about queues where the Owner pool ID and the Pool ID are identical. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsRgsWorkflow.md b/skype/skype-ps/SkypeForBusiness/Get-CsRgsWorkflow.md similarity index 89% rename from skype/skype-ps/skype/Get-CsRgsWorkflow.md rename to skype/skype-ps/SkypeForBusiness/Get-CsRgsWorkflow.md index 2e3ca094e9..bcd41be0dd 100644 --- a/skype/skype-ps/skype/Get-CsRgsWorkflow.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsRgsWorkflow.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csrgsworkflow applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsRgsWorkflow -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csrgsworkflow +schema: 2.0.0 +title: Get-CsRgsWorkflow --- # Get-CsRgsWorkflow @@ -38,7 +39,7 @@ The Get-CsRgsWorkflow cmdlet provides a way for you to return information about ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsRgsWorkflow ``` @@ -46,14 +47,14 @@ Get-CsRgsWorkflow Example 1 returns information about all the workflows configured for use in your organization. This is done by calling Get-CsRgsWorkflow without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsRgsWorkflow -Identity service:ApplicationServer:atl-cs-001.litwareinc.com ``` Example 2 returns information about all the Response Group application workflows found on the service ApplicationServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsRgsWorkflow -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Select-Object -ExpandProperty DefaultAction ``` @@ -63,14 +64,14 @@ To carry out this task, Get-CsRgsWorkflow is first used to return information ab This information is then piped to the Select-Object cmdlet, which "expands" the value stored in the DefaultAction property. When you expand the value of DefaultAction, you see the individual properties of the embedded object stored in the DefaultAction property. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsRgsWorkflow -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "European Sales Support" ``` Example 4 returns information about a single Response Group workflow: the European Sales Supports workflow found on ApplicationServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsRgsWorkflow -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Where-Object {$_.Language -eq "en-Us"} ``` @@ -81,7 +82,7 @@ To do this, the command first calls Get-CsRgsWorkflow to return a collection of That collection is then piped to the Where-Object cmdlet, which selects only those workflows where the Language property is equal to U.S. English (en-US). -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsRgsWorkflow service:ApplicationServer:atl-cs-001.litwareinc.com | Where-Object {$_.CustomMusicOnHoldFile -eq $Null} ``` @@ -94,6 +95,9 @@ The returned data is then piped to Where-Object, which picks out only those item ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents either the Identity of the service where the Response Group workflow is hosted or the full Identity of the workflow itself. If you specify the service Identity (for example, service: ApplicationServer:atl-cs-001.litwareinc.com), then all the Response Group workflows hosted on that service will be returned. If you specify the Identity of the workflow, then only that one Response Group workflow will be returned. @@ -107,8 +111,7 @@ If called without any parameters, Get-CsRgsWorkflow returns a collection of all ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -118,13 +121,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique name given to the Response Group workflow at the time the workflow was created. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,6 +139,9 @@ Accept wildcard characters: False ``` ### -Owner + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the pool that "owns" the workflow. The Owner pool ID and the Pool ID of a workflow are typically the same. However, if a workflow needs to temporarily be moved (perhaps in a disaster recovery procedure) then the Pool ID will change. @@ -142,8 +150,7 @@ However, the Owner ID will continue to point to the original pool. ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -153,14 +160,16 @@ Accept wildcard characters: False ``` ### -ShowAll + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, shows all the Response Group workflows, including those workflows where the Owner pool ID and the Pool ID are different. By default, Get-CsRgsWorkflow only returns information about workflows where the Owner and Parent Pools are identical. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsRoutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsRoutingConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Get-CsRoutingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsRoutingConfiguration.md index a17cb208b0..7f54442604 100644 --- a/skype/skype-ps/skype/Get-CsRoutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsRoutingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsRoutingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csroutingconfiguration +schema: 2.0.0 +title: Get-CsRoutingConfiguration --- # Get-CsRoutingConfiguration @@ -37,7 +38,7 @@ To retrieve individual voice routes or to retrieve them as individual objects ra ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsRoutingConfiguration ``` @@ -48,47 +49,53 @@ To retrieve individual voice routes, use the Get-CsVoiceRoute cmdlet. ## PARAMETERS -### -Identity -The scope of the routing configuration to retrieve. -The only possible value is Global. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +There can be only one instance of this object, so this parameter does nothing. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -There can be only one instance of this object, so this parameter does nothing. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The scope of the routing configuration to retrieve. +The only possible value is Global. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the routing configuration from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsServerApplication.md b/skype/skype-ps/SkypeForBusiness/Get-CsServerApplication.md similarity index 88% rename from skype/skype-ps/skype/Get-CsServerApplication.md rename to skype/skype-ps/SkypeForBusiness/Get-CsServerApplication.md index 79fa934203..d1ab8b49e6 100644 --- a/skype/skype-ps/skype/Get-CsServerApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsServerApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csserverapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsServerApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csserverapplication +schema: 2.0.0 +title: Get-CsServerApplication --- # Get-CsServerApplication @@ -37,7 +38,7 @@ The Get-CsServerApplication cmdlet provides a way for administrators to return i ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsServerApplication ``` @@ -45,21 +46,21 @@ Get-CsServerApplication The command shown in Example 1 returns information about all the server applications currently in use in the organization. This is done by calling the Get-CsServerApplication cmdlet without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsServerApplication -Identity "service:EdgeServer:atl-edge-001.litwareinc.com" ``` In Example 2, information is returned for all the server applications running on the service EdgeServer:atl-edge-001.litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsServerApplication -Identity "service:Registrar:atl-cs-001.litwareinc.com/ExumRouting" ``` Example 3 returns information for a single server application: the application that has the Identity Registrar:atl-cs-001.litwareinc.com/ExumRouting". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsServerApplication -Filter "service:*:atl-cs-001.litwareinc.com*" ``` @@ -68,7 +69,7 @@ Example 4 returns all the server applications configured for use in the pool atl This is done by using the Filter parameter and the filter value "service:*:atl-cs-001.litwareinc.com*". The filter value limits the returned data to applications that have an Identity that begins with the characters "service:" and includes the characters ":atl-cs-001.litwareinc.com". -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsServerApplication | Where-Object {$_.Enabled -eq $False} ``` @@ -77,7 +78,7 @@ In Example 5, information is returned for all the server applications that are c To carry out this task, the command first calls the Get-CsServerApplication cmdlet to return a collection of all the server applications configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which selects only those applications where the Enabled property is equal to False. -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsServerApplication | Where-Object {$_.Critical -eq $True -and $_.Enabled -eq $False} ``` @@ -88,7 +89,7 @@ To do this, the command first calls the Get-CsServerApplication cmdlet without a This collection is then piped to the Where-Object cmdlet, which picks out only those applications that meet two criteria: the Critical property must be equal to True; and, the Enabled property must be equal to False. The -and operator ensures that only objects that meet both criteria will be returned. -### -------------------------- Example 7 -------------------------- +### Example 7 ``` Get-CsServerApplication | Where-Object {$_.Uri -like "*routing*"} ``` @@ -97,7 +98,7 @@ In Example 7, information is returned for any server application that has the st This task is accomplished by first using the Get-CsServerApplication cmdlet to retrieve all the server applications currently in use. The resulting collection is then piped to the Where-Object cmdlet, which selects only those applications in which the Uri property includes the string value "routing". -### -------------------------- Example 8 -------------------------- +### Example 8 ``` Get-CsServerApplication | Where-Object {$_.ScriptName -ne $Null} ``` @@ -110,7 +111,31 @@ If the ScriptName property is not equal to a null value that means that a script ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards when returning a server application or set of server applications. +For example, to return all the server applications that have the string value "IIMFilter" somewhere in their Identity use this syntax: + +`-Filter "*IIMFilter*"` + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the server application to be retrieved. Server application Identities are composed of the service where the application is hosted plus the application name. For example, the server application named QoEAgent might have an Identity similar to this: service: Registrar:atl-cs-001.litwareinc.com/QoEAgent. @@ -124,8 +149,7 @@ If this parameter is omitted, then all the server applications will be returned ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -134,33 +158,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when returning a server application or set of server applications. -For example, to return all the server applications that have the string value "IIMFilter" somewhere in their Identity use this syntax: - -`-Filter "*IIMFilter*"` - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the server application data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsServerPatchVersion.md b/skype/skype-ps/SkypeForBusiness/Get-CsServerPatchVersion.md similarity index 89% rename from skype/skype-ps/skype/Get-CsServerPatchVersion.md rename to skype/skype-ps/SkypeForBusiness/Get-CsServerPatchVersion.md index 707697cc6e..edd0ef20ce 100644 --- a/skype/skype-ps/skype/Get-CsServerPatchVersion.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsServerPatchVersion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csserverpatchversion applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsServerPatchVersion -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csserverpatchversion +schema: 2.0.0 +title: Get-CsServerPatchVersion --- # Get-CsServerPatchVersion @@ -22,12 +23,12 @@ Get-CsServerPatchVersion [-Report ] [] ``` ## DESCRIPTION -This cmdlet returns the Skype for Business Server version for each component installed on the server. It replaces the previous methods (Windows Registry and WMI Classes). +This cmdlet returns the Skype for Business Server version for each component installed on the server. It replaces the previous methods (Windows Registry and WMI Classes). You should have installed November 2015 Cumulative Update (6.0.9319.102) for Skype for Business Server 2015 or later. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsServerPatchVersion ``` @@ -38,13 +39,15 @@ This example returns the version for each component installed on the Skype for B ## PARAMETERS ### -Report + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Generates a log file with the result of the operation. You should specify the file name in html format. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsServerVersion.md b/skype/skype-ps/SkypeForBusiness/Get-CsServerVersion.md similarity index 97% rename from skype/skype-ps/skype/Get-CsServerVersion.md rename to skype/skype-ps/SkypeForBusiness/Get-CsServerVersion.md index 8335546002..b1200356d5 100644 --- a/skype/skype-ps/skype/Get-CsServerVersion.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsServerVersion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csserverversion applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsServerVersion -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csserverversion +schema: 2.0.0 +title: Get-CsServerVersion --- # Get-CsServerVersion @@ -46,7 +47,7 @@ If you need a very specific version number then you should use the Windows Contr ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsServerVersion ``` diff --git a/skype/skype-ps/skype/Get-CsService.md b/skype/skype-ps/SkypeForBusiness/Get-CsService.md similarity index 82% rename from skype/skype-ps/skype/Get-CsService.md rename to skype/skype-ps/SkypeForBusiness/Get-CsService.md index c0a5253689..4ecfc54541 100644 --- a/skype/skype-ps/skype/Get-CsService.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsService.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csservice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsService -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csservice +schema: 2.0.0 +title: Get-CsService --- # Get-CsService @@ -209,14 +210,14 @@ If you need to return information for multiple server roles, you can use the Get ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsService ``` The command shown in Example 1 returns information about all the Skype for Business Server services and server roles currently running in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsService -ApplicationServer ``` @@ -225,7 +226,7 @@ Example 2 returns information only about the Application service. You can return information for other services/server roles simply by using the appropriate parameter. For example, this command returns information about the file store: -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsService -PoolFqdn "atl-cs-001.litwareinc.com" | Select-Object Identity ``` @@ -234,7 +235,7 @@ Example 3 reports back the Identity for each service located on the pool atl-cs- To carry out this task, the command first calls the Get-CsService cmdlet and the PoolFqdn parameter to return only those services and server roles found on the pool atl-cs-001.litwareinc.com. This collection is then piped to the Select-Object cmdlet, which reports back the Identity of each item in the collection. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsService | Where-Object {$_.SiteID -eq "site:Redmond"} ``` @@ -243,7 +244,7 @@ In Example 4, information is returned for all the services/server roles found on This is done by first calling the Get-CsService cmdlet without any parameters in order to return a collection of all the services and server roles currently in use in the organization. This data is then piped to the Where-Object cmdlet, which picks out only those items where the SiteID property is equal to site:Redmond. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsService | Where-Object {$_.DependentServiceList -like "*Registrar*"} ``` @@ -257,51 +258,17 @@ The Where-Object cmdlet criteria is specified by using the -like operator and th ## PARAMETERS -### -Identity -Unique identifier of the specific service or server role to be returned. -For example: - -`-Identity "Registrar:atl-cs-001.litwareinc.com"` - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Filter -Enables you to use wildcards to specify the service (or services) to be returned. -You cannot use both the Identity and the Filter parameters in the same command. +### -ApplicationDatabase -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationDatabase Returns information about the Application databases used in your organization. Application databases are used by the Application service. ```yaml Type: SwitchParameter Parameter Sets: ApplicationDatabase -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -311,14 +278,16 @@ Accept wildcard characters: False ``` ### -ApplicationServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns information about the Application service. The Application service provides a way to run applications created by using the Microsoft Unified Communications Managed API (UCMA). ```yaml Type: SwitchParameter Parameter Sets: ApplicationServer -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -328,14 +297,16 @@ Accept wildcard characters: False ``` ### -ArchivingDatabase + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns information about the Archiving databases used in your organization. Archiving databases store transcripts of instant messaging sessions. ```yaml Type: SwitchParameter Parameter Sets: ArchivingDatabase -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -345,14 +316,34 @@ Accept wildcard characters: False ``` ### -ArchivingServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns information about the Archiving Servers used in your organization. Archiving Servers enable you to save the transcripts of instant messaging sessions. ```yaml Type: SwitchParameter Parameter Sets: ArchivingServer -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -BackupServer + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the backup servers used in your organization. + +```yaml +Type: SwitchParameter +Parameter Sets: BackupServer +Aliases: Required: False Position: Named @@ -362,14 +353,16 @@ Accept wildcard characters: False ``` ### -CentralManagement + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns information about the Central Management service used in your organization. The Central Management service is used to send configuration data to computers running Skype for Business Server services. ```yaml Type: SwitchParameter Parameter Sets: CentralManagement -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -379,14 +372,16 @@ Accept wildcard characters: False ``` ### -CentralManagementDatabase + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns information about the Central Management store used in your organization. The Central Management store maintains configuration information for Skype for Business Server. ```yaml Type: SwitchParameter Parameter Sets: CentralManagementDatabase -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -396,6 +391,9 @@ Accept wildcard characters: False ``` ### -ConferencingServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns information about the A/V Conferencing service used in your organization. The A/V Conferencing service is used to conduct meetings and conferences. @@ -403,7 +401,6 @@ The A/V Conferencing service is used to conduct meetings and conferences. Type: SwitchParameter Parameter Sets: ConferenceServer Aliases: ConferenceServer -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -413,6 +410,9 @@ Accept wildcard characters: False ``` ### -Director + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns information about the Directors used in your organization. Directors are empowered to handle user requests and user authentication, but do not house user accounts. Directors are typically used to handle requests from external users. @@ -420,8 +420,7 @@ Directors are typically used to handle requests from external users. ```yaml Type: SwitchParameter Parameter Sets: Director -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -431,14 +430,16 @@ Accept wildcard characters: False ``` ### -EdgeServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns information about the Edge Servers used in your organization. Edge Servers provide connectivity between your internal network and the Internet. ```yaml Type: SwitchParameter Parameter Sets: EdgeServer -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -448,14 +449,16 @@ Accept wildcard characters: False ``` ### -FileStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns information about the File Stores used in your organization. The File Store is used to maintain Skype for Business Server files, such as audio files used by the Announcement service. ```yaml Type: SwitchParameter Parameter Sets: FileStore -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -464,15 +467,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ManagementServer -Returns information about the Central Management Server used in your organization. -The Central Management Server is commonly collocated with the Front End Servers and is responsible for accessing information in the Central Management store. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards to specify the service (or services) to be returned. +You cannot use both the Identity and the Filter parameters in the same command. ```yaml -Type: SwitchParameter -Parameter Sets: ManagementServer -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False Position: Named @@ -481,15 +486,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MediationServer -Returns information about the Mediation Servers used in your organization. -Mediation Servers help provide a bridge between your Enterprise Voice network and the public switched telephone network (PSTN). +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier of the specific service or server role to be returned. +For example: + +`-Identity "Registrar:atl-cs-001.litwareinc.com"` + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LegalInterceptServer + +> Applicable: Lync Server 2013 + +Returns information about the legal intercept servers used in your organization. +Legal intercept servers provide real-time interception of instant messaging communications on Office 365. ```yaml Type: SwitchParameter -Parameter Sets: MediationServer -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LegalInterceptServer +Aliases: Required: False Position: Named @@ -498,15 +526,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MonitoringServer -Returns information about the Monitoring Servers used in your organization. -Monitoring Servers are used to track Enterprise Voice phone usage and call quality. +### -ManagementServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the Central Management Server used in your organization. +The Central Management Server is commonly collocated with the Front End Servers and is responsible for accessing information in the Central Management store. ```yaml Type: SwitchParameter -Parameter Sets: MonitoringServer -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ManagementServer +Aliases: Required: False Position: Named @@ -515,15 +545,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MonitoringDatabase -Returns information about the monitoring databases used in your organization. -Monitoring databases store Enterprise Voice phone usage and call quality information. +### -MediationServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the Mediation Servers used in your organization. +Mediation Servers help provide a bridge between your Enterprise Voice network and the public switched telephone network (PSTN). ```yaml Type: SwitchParameter -Parameter Sets: MonitoringDatabase -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: MediationServer +Aliases: Required: False Position: Named @@ -532,15 +564,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PoolFqdn -Fully qualified domain name (FQDN) of the pool hosting the service or server role. -If you use the PoolFqdn parameter without specifying a service-specific parameter, then all the services and server roles found on that pool will be returned. +### -MonitoringDatabase + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the monitoring databases used in your organization. +Monitoring databases store Enterprise Voice phone usage and call quality information. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: MonitoringDatabase +Aliases: Required: False Position: Named @@ -549,15 +583,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProvisionServer -Returns information about the Provision Server service used in your organization. -The Provision Server service is used to manage Lync Server certificates. +### -MonitoringServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the Monitoring Servers used in your organization. +Monitoring Servers are used to track Enterprise Voice phone usage and call quality. ```yaml Type: SwitchParameter -Parameter Sets: ProvisionServer -Aliases: -Applicable: Lync Server 2010 +Parameter Sets: MonitoringServer +Aliases: Required: False Position: Named @@ -566,15 +602,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProvisionDatabase -Returns information about the provision databases used in your organization. -Provision databases maintain information about Lync Server certificates. +### -PersistentChatComplianceDatabase + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the databases used for maintaining Persistent Chat compliance information. ```yaml Type: SwitchParameter -Parameter Sets: ProvisionDatabase -Aliases: -Applicable: Lync Server 2010 +Parameter Sets: PersistentChatComplianceDatabase +Aliases: Required: False Position: Named @@ -583,15 +620,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PstnGateway -Returns information about the public switched telephone network (PSTN) gateways used in your organization. -PSTN gateways translate signals from Enterprise Voice devices to signals that can be understood by PSTN devices, and vice-versa. +### -PersistentChatDatabase + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the databases used for maintaining Persistent Chat information. ```yaml Type: SwitchParameter -Parameter Sets: PstnGateway -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: PersistentChatDatabase +Aliases: Required: False Position: Named @@ -600,15 +638,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Registrar -Returns information about the Registrars used in your organization. -Registrars are used to authenticate users and to keep track of a user's current status. +### -PersistentChatServer + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the Persistent Chat servers used in your organization. ```yaml Type: SwitchParameter -Parameter Sets: Registrar -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: PersistentChatServer +Aliases: Required: False Position: Named @@ -617,15 +656,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TrustedApplicationPool -Returns information about the trusted application pools used in your organization. -Trusted applications pools host computers that run trusted applications. +### -PoolFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the pool hosting the service or server role. +If you use the PoolFqdn parameter without specifying a service-specific parameter, then all the services and server roles found on that pool will be returned. ```yaml -Type: SwitchParameter -Parameter Sets: TrustedApplicationPool -Aliases: ExternalServer -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -634,15 +675,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserDatabase -Returns information about the User database used in your organization. -User databases store data needed by the User Server service. +### -ProvisionDatabase + +> Applicable: Lync Server 2010 + +Returns information about the provision databases used in your organization. +Provision databases maintain information about Lync Server certificates. ```yaml Type: SwitchParameter -Parameter Sets: UserDatabase -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ProvisionDatabase +Aliases: Required: False Position: Named @@ -651,15 +694,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserServer -Returns information about the User Services service used in your organization. -The User Services service provides such things as user replication, in-band provisioning, presence publication and notification, and contact card exchange. +### -ProvisionServer + +> Applicable: Lync Server 2010 + +Returns information about the Provision Server service used in your organization. +The Provision Server service is used to manage Lync Server certificates. ```yaml Type: SwitchParameter -Parameter Sets: UserServer -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ProvisionServer +Aliases: Required: False Position: Named @@ -668,15 +713,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WebServer -Returns information about the Web Services service used in your organization. -The Web Services service host web-based applications such as the Address Book service. +### -PstnGateway + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the public switched telephone network (PSTN) gateways used in your organization. +PSTN gateways translate signals from Enterprise Voice devices to signals that can be understood by PSTN devices, and vice-versa. ```yaml Type: SwitchParameter -Parameter Sets: WebServer -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: PstnGateway +Aliases: Required: False Position: Named @@ -685,14 +732,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BackupServer -Returns information about the backup servers used in your organization. +### -Registrar + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the Registrars used in your organization. +Registrars are used to authenticate users and to keep track of a user's current status. ```yaml Type: SwitchParameter -Parameter Sets: BackupServer -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: Registrar +Aliases: Required: False Position: Named @@ -701,15 +751,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LegalInterceptServer -Returns information about the legal intercept servers used in your organization. -Legal intercept servers provide real-time interception of instant messaging communications on Office 365. +### -TrustedApplicationPool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the trusted application pools used in your organization. +Trusted applications pools host computers that run trusted applications. ```yaml Type: SwitchParameter -Parameter Sets: LegalInterceptServer -Aliases: -Applicable: Lync Server 2013 +Parameter Sets: TrustedApplicationPool +Aliases: ExternalServer Required: False Position: Named @@ -718,14 +770,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PersistentChatComplianceDatabase -Returns information about the databases used for maintaining Persistent Chat compliance information. +### -UserDatabase + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the User database used in your organization. +User databases store data needed by the User Server service. ```yaml Type: SwitchParameter -Parameter Sets: PersistentChatComplianceDatabase -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: UserDatabase +Aliases: Required: False Position: Named @@ -734,14 +789,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PersistentChatDatabase -Returns information about the databases used for maintaining Persistent Chat information. +### -UserServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the User Services service used in your organization. +The User Services service provides such things as user replication, in-band provisioning, presence publication and notification, and contact card exchange. ```yaml Type: SwitchParameter -Parameter Sets: PersistentChatDatabase -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: UserServer +Aliases: Required: False Position: Named @@ -750,14 +808,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PersistentChatServer -Returns information about the Persistent Chat servers used in your organization. +### -VideoGateway + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the video gateway service. +Video gateways provide a way to connect Skype for Business users to video teleconferencing devices. ```yaml Type: SwitchParameter -Parameter Sets: PersistentChatServer -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: VideoGateway +Aliases: Required: False Position: Named @@ -766,15 +827,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WacServer -Returns information about the Office Web Apps servers used with Microsoft Lync Server. -Office Web Apps server was previously known as "WacServer". +### -VideoInteropServer + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the video interoperability service. +The video interoperability service provides a way to seamless connect Skype for Business users to third-party video teleconferencing providers. ```yaml Type: SwitchParameter -Parameter Sets: WacServer -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: VideoInteropServer +Aliases: Required: False Position: Named @@ -783,15 +846,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VideoGateway -Returns information about the video gateway service. -Video gateways provide a way to connect Skype for Business users to video teleconferencing devices. +### -WacServer + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the Office Web Apps servers used with Microsoft Lync Server. +Office Web Apps server was previously known as "WacServer". ```yaml Type: SwitchParameter -Parameter Sets: VideoGateway -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: WacServer +Aliases: Required: False Position: Named @@ -800,15 +865,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VideoInteropServer -Returns information about the video interoperability service. -The video interoperability service provides a way to seamless connect Skype for Business users to third-party video teleconferencing providers. +### -WebServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns information about the Web Services service used in your organization. +The Web Services service host web-based applications such as the Address Book service. ```yaml Type: SwitchParameter -Parameter Sets: VideoInteropServer -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: WebServer +Aliases: Required: False Position: Named @@ -818,7 +885,10 @@ Accept wildcard characters: False ``` ### CommonParameters -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). +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 @@ -828,11 +898,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## OUTPUTS -### -The Get-CsService cmdlet returns different objects based on the parameters used when calling the cmdlet. -For example, if you include the MonitoringDatabase parameter, the Get-CsService cmdlet returns instances of the Microsoft.Rtc.Management.Xds.DisplayMonitoringDatabase object. -To determine the objects returned using other parameters, call the Get-CsService cmdlet using one of those parameters, and then pipe the returned object to the Get-Member cmdlet. -For example: +### Microsoft.Rtc.Management.Xds.DisplayMonitoringDatabase + +The Get-CsService cmdlet returns different objects based on the parameters used when calling the +cmdlet. For example, if you include the MonitoringDatabase parameter, the Get-CsService cmdlet +returns instances of the Microsoft.Rtc.Management.Xds.DisplayMonitoringDatabase object. To determine +the objects returned using other parameters, call the Get-CsService cmdlet using one of those +parameters, and then pipe the returned object to the Get-Member cmdlet. For example: `Get-CsService -Registrar | Get-Member` diff --git a/skype/skype-ps/skype/Get-CsSimpleUrlConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsSimpleUrlConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Get-CsSimpleUrlConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsSimpleUrlConfiguration.md index aa3aa23c6e..199e940b89 100644 --- a/skype/skype-ps/skype/Get-CsSimpleUrlConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsSimpleUrlConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cssimpleurlconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsSimpleUrlConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cssimpleurlconfiguration +schema: 2.0.0 +title: Get-CsSimpleUrlConfiguration --- # Get-CsSimpleUrlConfiguration @@ -62,7 +63,7 @@ The Get-CsSimpleUrlConfiguration cmdlet provides a way for you to retrieve infor ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsSimpleUrlConfiguration ``` @@ -70,14 +71,14 @@ Get-CsSimpleUrlConfiguration Example 1 returns information about all the simple URL configuration collections currently in use in the organization. This is achieved by calling the Get-CsSimpleUrlConfiguration cmdlet without any additional parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsSimpleUrlConfiguration -Identity "site:Redmond" ``` In Example 2, information is returned for a single simple URL configuration collection: the configuration with the Identity site:Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsSimpleUrlConfiguration -Filter "site:*" ``` @@ -85,7 +86,7 @@ Get-CsSimpleUrlConfiguration -Filter "site:*" Example 3 returns information for all the simple URL configuration collections that have been assigned to the site scope. To do this, the Get-CsSimpleUrlConfiguration cmdlet is called along with the Filter parameter; the filter value "site:*" limits the returned data to those collections that have an Identity that begins with the string value "site:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsSimpleUrlConfiguration | Select-Object -ExpandProperty SimpleUrl ``` @@ -95,7 +96,7 @@ To carry out this task, the command first calls the Get-CsSimpleUrlConfiguration This data is then piped to the Select-Object cmdlet, which uses the ExpandProperty parameter to "expand" the value of the SimpleUrl property. Expanding a property value displays all the data stored in that property in an easy-to-read format. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsSimpleUrlConfiguration | Select-Object -ExpandProperty SimpleUrl | Where-Object {$_.Component -eq "Meet"} ``` @@ -109,7 +110,33 @@ The filtered collection is then piped to the Where-Object cmdlet, which picks ou ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters to specify the simple URL collection (or collections) to be returned. +For example, this syntax returns all the simple URL collections that have been configured at the site scope: + +`-Filter "site:*"` + +Note that you cannot use both the Filter and the Identity parameters in the same command. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of simple URLs to be returned. To return the global collection, use this syntax: @@ -127,8 +154,7 @@ Calling the Get-CsSimpleUrlConfiguration cmdlet without any parameters returns a ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -137,19 +163,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters to specify the simple URL collection (or collections) to be returned. -For example, this syntax returns all the simple URL collections that have been configured at the site scope: +### -LocalStore -`-Filter "site:*"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that you cannot use both the Filter and the Identity parameters in the same command. +Retrieves the simple URL configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -159,6 +182,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account where whose Simple URL configuration settings are to be retrieved. For example: @@ -171,24 +197,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore -Retrieves the simple URL configuration data from the local replica of the Central Management store rather than from the Central Management store itself. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsSipDomain.md b/skype/skype-ps/SkypeForBusiness/Get-CsSipDomain.md similarity index 89% rename from skype/skype-ps/skype/Get-CsSipDomain.md rename to skype/skype-ps/SkypeForBusiness/Get-CsSipDomain.md index 0b57d1b663..cbcdd63297 100644 --- a/skype/skype-ps/skype/Get-CsSipDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsSipDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cssipdomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsSipDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cssipdomain +schema: 2.0.0 +title: Get-CsSipDomain --- # Get-CsSipDomain @@ -43,14 +44,14 @@ The Get-CsSipDomain cmdlet also identifies the default SIP domain for your organ ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsSipDomain ``` In Example 1, the Get-CsSipDomain cmdlet is called without any parameters; this returns information about all the SIP domains configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsSipDomain -Identity fabrikam.com ``` @@ -58,7 +59,7 @@ Get-CsSipDomain -Identity fabrikam.com The command shown in Example 2 returns information for any SIP domain that has the Identity fabrikam.com. Because SIP domain Identities must be unique, this command will never return more than a single item. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsSipDomain -Filter "f*" ``` @@ -66,7 +67,7 @@ Get-CsSipDomain -Filter "f*" Example 3 uses the Get-CsSipDomain cmdlet and the Filter parameter to return information about all the SIP domains that have an Identity that begins with the letter "f". For example: fabrikam.com; fabrikam.org; fabrikam-users.com; and so on. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsSipDomain | Where-Object {$_.IsDefault -eq $True} ``` @@ -78,35 +79,39 @@ This collection is then piped to the Where-Object cmdlet, which selects the one ## PARAMETERS -### -Identity -Fully qualified domain name (FQDN) of the SIP domain to be returned (for example, fabrikam.com). -If neither this parameter nor the Filter parameter is specified, then all the SIP domains authorized for use in your organization are returned. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards when specifying the Identities of the SIP domain (or domains) to be returned. +For example the filter value "*.org" returns a collection of all the authorized SIP domains that have an Identity that ends with the string value ".org". ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the Identities of the SIP domain (or domains) to be returned. -For example the filter value "*.org" returns a collection of all the authorized SIP domains that have an Identity that ends with the string value ".org". +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the SIP domain to be returned (for example, fabrikam.com). +If neither this parameter nor the Filter parameter is specified, then all the SIP domains authorized for use in your organization are returned. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/skype/skype-ps/skype/Get-CsSipResponseCodeTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Get-CsSipResponseCodeTranslationRule.md similarity index 91% rename from skype/skype-ps/skype/Get-CsSipResponseCodeTranslationRule.md rename to skype/skype-ps/SkypeForBusiness/Get-CsSipResponseCodeTranslationRule.md index ffac7c3b58..cbaa86af09 100644 --- a/skype/skype-ps/skype/Get-CsSipResponseCodeTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsSipResponseCodeTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cssipresponsecodetranslationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsSipResponseCodeTranslationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cssipresponsecodetranslationrule +schema: 2.0.0 +title: Get-CsSipResponseCodeTranslationRule --- # Get-CsSipResponseCodeTranslationRule @@ -53,7 +54,7 @@ The Get-CsSipResponseCodeTranslationRule cmdlet enables you to retrieve informat ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsSipResponseCodeTranslationRule ``` @@ -61,14 +62,14 @@ Get-CsSipResponseCodeTranslationRule The command shown in Example 1 returns a collection of all the response code translation rules configured for use in your organization. This is done by calling the Get-CsSipResponseCodeTranslationRule cmdlet without any parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsSipResponseCodeTranslationRule -Identity "PstnGateway:192.168.0.240/Rule404" ``` Example 2 returns a single response code translation rule: the rule with the Identity PstnGateway:192.168.0.240/Rule404. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsSipResponseCodeTranslationRule -Filter "site:*" ``` @@ -76,7 +77,7 @@ Get-CsSipResponseCodeTranslationRule -Filter "site:*" In Example 3, the Filter parameter is used to limit the returned data to all the response code translation rules configured at the site scope. The filter value "site:*" limits the returned data to rules that have an Identity that begins with the string value "site:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsSipResponseCodeTranslationRule | Where-Object {$_.ReceivedISUPCauseValue -eq -1} ``` @@ -89,7 +90,31 @@ That collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards when specifying the translation rule (or rules) to be returned. +For example, this syntax returns all the translation rules that have the string value "404" in their Identity: + +-Filter "*404*" + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the translation rule. The identity for a translation rule consists of two parts: the scope where the rule was configured, and the name given to the rule when it was created. For example, a translation rule named Rule404 that was created at the global scope would have an Identity that looked like this: global/Rule404. @@ -106,8 +131,7 @@ If this parameter is omitted, the Get-CsSipResponseCodeTranslationRule cmdlet re ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -116,33 +140,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the translation rule (or rules) to be returned. -For example, this syntax returns all the translation rules that have the string value "404" in their Identity: - --Filter "*404*" - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the SIP response code translation rule data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsSite.md b/skype/skype-ps/SkypeForBusiness/Get-CsSite.md similarity index 89% rename from skype/skype-ps/skype/Get-CsSite.md rename to skype/skype-ps/SkypeForBusiness/Get-CsSite.md index fca553017d..0de299322a 100644 --- a/skype/skype-ps/skype/Get-CsSite.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsSite.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cssite applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsSite -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cssite +schema: 2.0.0 +title: Get-CsSite --- # Get-CsSite @@ -43,21 +44,21 @@ The Get-CsSite cmdlet enables you to return information about all the sites in y ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsSite ``` Example 1 retrieves information for all your Skype for Business Server sites. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsSite -Identity "Redmond" ``` In Example 2, information is returned for a single site: the site with the Identity Redmond. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsSite | Where-Object {$_.SiteType -eq "CentralSite"} ``` @@ -66,7 +67,7 @@ The command shown in Example 3 returns information for your central site. To carry out this task, the command first calls the Get-CsSite cmdlet in order to return a collection of all the sites configured for use in your organization. This collection is then piped to the Where-Object cmdlet, which picks out the one site where the SiteType property is equal to "CentralSite". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsSite -Identity "Redmond" | Select-Object -ExpandProperty Pools ``` @@ -79,43 +80,47 @@ Expanding a property value means that all the values stored in that property wil ## PARAMETERS -### -Identity -Name of the site to be returned. -Note that you should specify just the site name; for example: +### -Filter -`-Identity "Redmond"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Do not use the format "site:Redmond" when specifying the Identity. +Enables you to use wildcards when specifying the Identity of the site (or sites) to be returned. +For example, this syntax returns all the pools that have an Identity that include the string value "Dublin": + +`-Filter "*Dublin*"` + +Note that you cannot use both Filter and Identity in the same command. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the Identity of the site (or sites) to be returned. -For example, this syntax returns all the pools that have an Identity that include the string value "Dublin": +### -Identity -`-Filter "*Dublin*"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that you cannot use both Filter and Identity in the same command. +Name of the site to be returned. +Note that you should specify just the site name; for example: + +`-Identity "Redmond"` + +Do not use the format "site:Redmond" when specifying the Identity. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/skype/skype-ps/skype/Get-CsSlaConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsSlaConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Get-CsSlaConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsSlaConfiguration.md index 6e91991f77..11dd5ebdc1 100644 --- a/skype/skype-ps/skype/Get-CsSlaConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsSlaConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csslaconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsSlaConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csslaconfiguration +schema: 2.0.0 +title: Get-CsSlaConfiguration --- # Get-CsSlaConfiguration @@ -24,8 +25,8 @@ Get-CsSlaConfiguration [-Identity] [-PassThru] [ Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: UserIdParameter -Indicates the identity of the Enterprise Voice user whose shared number information will be retrieved. +Indicates the identity of the Enterprise Voice user whose shared number information will be retrieved. User identities can be specified using one of five formats: SIP address @@ -87,8 +91,7 @@ Example: CN=KenMyer,CN=Users,DC=Atlanta,DC=Corp,DC=litware,DC=com ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -98,15 +101,17 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: SwitchParameter -The presence of the passthru switch causes the cmdlet to pass the current objects through the pipeline. +The presence of the passthru switch causes the cmdlet to pass the current objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsStaticRoutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsStaticRoutingConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Get-CsStaticRoutingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsStaticRoutingConfiguration.md index 58237d6f2b..8e393013e2 100644 --- a/skype/skype-ps/skype/Get-CsStaticRoutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsStaticRoutingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csstaticroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsStaticRoutingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csstaticroutingconfiguration +schema: 2.0.0 +title: Get-CsStaticRoutingConfiguration --- # Get-CsStaticRoutingConfiguration @@ -46,21 +47,21 @@ This includes the ability to return detailed information about each route assign ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsStaticRoutingConfiguration ``` The command shown in Example 1 returns information about all the static routing configuration collections in use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsStaticRoutingConfiguration -Identity "service:Registrar:atl-cs-001.litwareinc.com" ``` In Example 2, information about a single static routing configuration collection is returned: the collection with the Identity service:Registrar:atl-cs-001.litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsStaticRoutingConfiguration -Filter "service:*" ``` @@ -68,7 +69,7 @@ Get-CsStaticRoutingConfiguration -Filter "service:*" Example 3 uses the Filter parameter to return information about the static routing configuration collections assigned to the service scope. The filter value "service:*" limits the returned data to collections that have an identity that begins with the string value "service:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsStaticRoutingConfiguration | Select-Object -ExpandProperty Route ``` @@ -78,7 +79,7 @@ To do this, the command first calls the Get-CsStaticRoutingConfiguration cmdlet This information is then piped to the Select-Object cmdlet, which uses the ExpandProperty parameter to "expand" the value of the Route property. When you expand a property, all the objects and values contained within that property are displayed on the screen in easy-to-read fashion. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsStaticRoutingConfiguration | Select-Object -ExpandProperty Route | Where-Object {$_.MatchOnlyPhoneUri -eq $True} ``` @@ -91,7 +92,33 @@ These route objects are then piped to the Where-Object cmdlet, which picks out o ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards when specifying the static routing configuration collection (or collections) to be returned. +For example, this syntax returns all the static routing collections configured at the service scope: + +`-Filter "service:*"` + +Note that you cannot use both the Identity and the Filter parameters in the same command. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the static routing configuration collection. To return information about the global collection, use this syntax: @@ -109,8 +136,7 @@ If you do not include either the Identity or the Filter parameters then the Get- ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -119,35 +145,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the static routing configuration collection (or collections) to be returned. -For example, this syntax returns all the static routing collections configured at the service scope: - -`-Filter "service:*"` - -Note that you cannot use both the Identity and the Filter parameters in the same command. +### -LocalStore -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore Retrieves the static routing configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsStorageServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsStorageServiceConfiguration.md similarity index 92% rename from skype/skype-ps/skype/Get-CsStorageServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsStorageServiceConfiguration.md index c6356193a8..5e7dcc3af7 100644 --- a/skype/skype-ps/skype/Get-CsStorageServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsStorageServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csstorageserviceconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsStorageServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csstorageserviceconfiguration +schema: 2.0.0 +title: Get-CsStorageServiceConfiguration --- # Get-CsStorageServiceConfiguration @@ -42,21 +43,21 @@ Skype for Business Server Control Panel: The functions carried out by the Get-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsStorageServiceConfiguration ``` The command shown in Example 1 returns information about all the storage service configuration settings in use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsStorageServiceConfiguration -Identity "site:Redmond" ``` In Example 2, information is returned for a single collection of storage service configuration settings: the collection of settings applied to the Redmond site. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsStorageServiceConfiguration -Filter "service:*" ``` @@ -69,6 +70,9 @@ That filter value limits returned data to collections that have an Identity that ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcards when retrieving one or more collections of storage service configuration settings. For example, to return all the settings configured at the site scope, use this syntax: @@ -83,8 +87,7 @@ Note that you cannot use both the Filter parameter and the Identity parameter in ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -94,6 +97,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the storage service configuration settings to be returned. Storage service configuration settings can be applied to the global, site, or service scope (for the Registrar service only). To return a complete collection of storage service configuration settings, omit the Identity parameter altogether: @@ -116,8 +122,7 @@ To return settings at the service level, use syntax similar to this: ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -127,13 +132,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the storage service configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTeamsUpgradeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsTeamsUpgradeConfiguration.md similarity index 94% rename from skype/skype-ps/skype/Get-CsTeamsUpgradeConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTeamsUpgradeConfiguration.md index 4c98490cbe..8e1f2eb84d 100644 --- a/skype/skype-ps/skype/Get-CsTeamsUpgradeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTeamsUpgradeConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsupgradeconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsTeamsUpgradeConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsupgradeconfiguration +schema: 2.0.0 +title: Get-CsTeamsUpgradeConfiguration --- # Get-CsTeamsUpgradeConfiguration @@ -56,13 +58,15 @@ The above cmdlet lists the properties of TeamsUpgradeConfiguration. ### -Identity + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + {{Fill Identity Description}} ```yaml Type: XdsIdentity Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: 1 @@ -72,13 +76,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + Do not use ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named @@ -88,13 +94,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + {{Fill Tenant Description}} ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTeamsUpgradePolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsTeamsUpgradePolicy.md similarity index 94% rename from skype/skype-ps/skype/Get-CsTeamsUpgradePolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTeamsUpgradePolicy.md index 69d65757c9..75295a9c17 100644 --- a/skype/skype-ps/skype/Get-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTeamsUpgradePolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsupgradepolicy applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 -title: Get-CsTeamsUpgradePolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-csteamsupgradepolicy +schema: 2.0.0 +title: Get-CsTeamsUpgradePolicy --- # Get-CsTeamsUpgradePolicy @@ -129,46 +131,52 @@ List all on-premises instances (if any) of TeamsUpgradePolicy. ## PARAMETERS -### -Identity -If identity parameter is passed, this will return a specific instance. If no identity parameter is specified, the cmdlet returns all instances. +### -Filter + +> Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 + +{{Fill Filter Description}} ```yaml -Type: XdsIdentity +Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -{{Fill Filter Description}} + + +### -Identity + +> Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 + +If identity parameter is passed, this will return a specific instance. If no identity parameter is specified, the cmdlet returns all instances. ```yaml -Type: String +Type: XdsIdentity Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Tenant +> Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 -### -Tenant {{Fill Tenant Description}} ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTelemetryConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsTelemetryConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Get-CsTelemetryConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTelemetryConfiguration.md index 53ce0dee66..b0d5d540d9 100644 --- a/skype/skype-ps/skype/Get-CsTelemetryConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTelemetryConfiguration.md @@ -1,19 +1,20 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cstelemetryconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsTelemetryConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cstelemetryconfiguration +schema: 2.0.0 +title: Get-CsTelemetryConfiguration --- # Get-CsTelemetryConfiguration ## SYNOPSIS -Use the Get-CsTelemetryConfiguration cmdlet to return the settings on existing telemetry configurations. +Use the Get-CsTelemetryConfiguration cmdlet to return the settings on existing telemetry configurations. Telemetry returns a small set of Skype for Business operational data to Microsoft for quality tracking and product improvement. The data includes sign-in information, meeting joins, and other activity data. ## SYNTAX @@ -33,7 +34,7 @@ For privacy information, see the Skype for Business Privacy Statement (https://g ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTelemetryConfiguration -Identity Site:Redmond ``` @@ -44,6 +45,9 @@ This example returns the settings for the configuration scoped to the Redmond si ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return one or more collections of telemetry configuration settings. For example, to return all the settings that have been configured at the site scope use the following syntax: -Filter "site:*". The Filter and the Identity parameters are mutually exclusive. @@ -51,8 +55,7 @@ The Filter and the Identity parameters are mutually exclusive. ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier that includes the scope of the telemetry configuration. Telemetry configurations can be scoped at the Global, Site, or Service level. For example, "site:Redmond" (for site). @@ -79,8 +85,7 @@ You can combine the two commands to zero in on a single role in a single pool. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -90,13 +95,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTenantHybridConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsTenantHybridConfiguration.md similarity index 95% rename from skype/skype-ps/skype/Get-CsTenantHybridConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTenantHybridConfiguration.md index af7842ce10..c88bc865d6 100644 --- a/skype/skype-ps/skype/Get-CsTenantHybridConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTenantHybridConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cstenanthybridconfiguration applicable: Skype for Business Server 2019 -title: Get-CsTenantHybridConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/get-cstenanthybridconfiguration +schema: 2.0.0 +title: Get-CsTenantHybridConfiguration --- # Get-CsTenantHybridConfiguration @@ -57,14 +59,14 @@ However, you can't create or modify hybrid PSTN sites through the CsTenantHybrid ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTenantHybridConfiguration -Identity "Global" ``` The command shown in Example 1 returns the property values for the global collection of tenant hybrid configuration settings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsTenantHybridConfiguration -Tenant "bf19b7db-6960-41e5-a139-2aa373474354" ``` @@ -75,6 +77,9 @@ In Example 2, property values are returned for the custom tenant hybrid configur ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Online + Enables you to use wildcard characters in order to return a collection of tenant hybrid configuration settings. Because you are limited to a single, global collection of hybrid configuration settings there is no need to use the Filter parameter. However, this is valid syntax for the Get-CsTenantHybridConfiguration cmdlet: @@ -84,8 +89,7 @@ However, this is valid syntax for the Get-CsTenantHybridConfiguration cmdlet: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -95,6 +99,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + Unique Identity of the tenant hybrid configuration settings to be returned. Because you are limited to a single, global collection of hybrid configuration settings, the only collection that can be returned by using the Identity parameter is the global collection: @@ -105,8 +112,7 @@ To modify the settings for an individual tenant, use the Tenant parameter instea ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 2 @@ -116,13 +122,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Online + This parameter is not used with Skype for Business Online. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -132,6 +140,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Specifies the global unique identifier (GUID) of the Skype for Business Online tenant account on which the cmdlet will operate. For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308". @@ -144,8 +155,7 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTenantUpdateTimeWindow.md b/skype/skype-ps/SkypeForBusiness/Get-CsTenantUpdateTimeWindow.md similarity index 90% rename from skype/skype-ps/skype/Get-CsTenantUpdateTimeWindow.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTenantUpdateTimeWindow.md index 375176efc1..703f7c9055 100644 --- a/skype/skype-ps/skype/Get-CsTenantUpdateTimeWindow.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTenantUpdateTimeWindow.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cstenantupdatetimewindow applicable: Skype for Business Online -title: Get-CsTenantUpdateTimeWindow -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/get-cstenantupdatetimewindow +schema: 2.0.0 +title: Get-CsTenantUpdateTimeWindow --- # Get-CsTenantUpdateTimeWindow @@ -40,14 +42,14 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTenantUpdateTimeWindow ``` The command shown in Example 1 returns information for all the tenant update time windows. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsTenantUpdateTimeWindow -Identity "AlwaysOn" ``` @@ -58,13 +60,15 @@ The command shown in Example 2 returns information for the tenant update time wi ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Online + PARAMVALUE: String ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -74,13 +78,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + Specifies the identity of the tenant update time window. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 2 @@ -90,13 +96,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Online + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -106,13 +114,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + PARAMVALUE: Guid ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTestDevice.md b/skype/skype-ps/SkypeForBusiness/Get-CsTestDevice.md similarity index 88% rename from skype/skype-ps/skype/Get-CsTestDevice.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTestDevice.md index 079667d0d1..bf01fa1027 100644 --- a/skype/skype-ps/skype/Get-CsTestDevice.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTestDevice.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cstestdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsTestDevice -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cstestdevice +schema: 2.0.0 +title: Get-CsTestDevice --- # Get-CsTestDevice @@ -44,7 +45,7 @@ You can use the Get-CsTestDevice cmdlet to retrieve information about the test d ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTestDevice ``` @@ -52,21 +53,21 @@ Get-CsTestDevice Example 1 returns all the test devices in the organization. Calling the Get-CsTestDevice cmdlet without any additional parameters will return all the test devices currently in use. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsTestDevice -Identity site:Redmond/UCPhone ``` This example returns the test device named UCPhone that was assigned to the Redmond site. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsTestDevice -Identity site:Redmond ``` In Example 3, the command returns all the test devices configured for the Redmond site. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsTestDevice -Filter site:* ``` @@ -77,7 +78,37 @@ To do this, the command uses the Filter parameter; the filter value "site:*" lim ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Provides a way for you to use wildcard characters when specifying the test device (or devices) to be returned. +For example, to return all the test device collections that have been configured at the site scope, use this syntax: + +`-Filter "site:*"` + +To return all the devices that have the term "EMEA" in their Identity, use this syntax: + +`-Filter "*EMEA*"` + +Note that Filter acts only on the Identity of the test device collection; you cannot filter on other collection properties. + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the test device to be returned. To refer to an individual device named UCPhone (stored in the global collection), use this syntax: @@ -97,8 +128,7 @@ Note that you cannot use wildcards when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -107,39 +137,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Provides a way for you to use wildcard characters when specifying the test device (or devices) to be returned. -For example, to return all the test device collections that have been configured at the site scope, use this syntax: - -`-Filter "site:*"` - -To return all the devices that have the term "EMEA" in their Identity, use this syntax: - -`-Filter "*EMEA*"` - -Note that Filter acts only on the Identity of the test device collection; you cannot filter on other collection properties. +### -LocalStore -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -LocalStore Retrieves the test device data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTestUserCredential.md b/skype/skype-ps/SkypeForBusiness/Get-CsTestUserCredential.md similarity index 95% rename from skype/skype-ps/skype/Get-CsTestUserCredential.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTestUserCredential.md index 328d03a5ff..e7101cdd6b 100644 --- a/skype/skype-ps/skype/Get-CsTestUserCredential.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTestUserCredential.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cstestusercredential applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsTestUserCredential -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cstestusercredential +schema: 2.0.0 +title: Get-CsTestUserCredential --- # Get-CsTestUserCredential @@ -42,7 +43,7 @@ The functions carried out by the Get-CsTestUserCredential cmdlet are not availab ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTestUserCredential -SipAddress "sip:kenmyer@litewareinc.com" ``` @@ -50,7 +51,7 @@ Get-CsTestUserCredential -SipAddress "sip:kenmyer@litewareinc.com" The command shown in Example 1 returns information for the user sip:kenmyer@litwareinc.com provided that the user has been configured as a watcher node test user. If the user has not been configured as a test user then the Get-CsTestUserCredential cmdlet will return an error. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $ErrorActionPreference = "SilentlyContinue" @@ -74,6 +75,9 @@ The final command in the example resets the value of $ErrorActionPreference to " ## PARAMETERS ### -SipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address of the account being checked for test user credentials. For example: @@ -85,8 +89,7 @@ If you do not, you will be prompted to enter that address. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 diff --git a/skype/skype-ps/skype/Get-CsThirdPartyVideoSystem.md b/skype/skype-ps/SkypeForBusiness/Get-CsThirdPartyVideoSystem.md similarity index 89% rename from skype/skype-ps/skype/Get-CsThirdPartyVideoSystem.md rename to skype/skype-ps/SkypeForBusiness/Get-CsThirdPartyVideoSystem.md index eec5a7e4a6..8589dfeb3a 100644 --- a/skype/skype-ps/skype/Get-CsThirdPartyVideoSystem.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsThirdPartyVideoSystem.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csthirdpartyvideosystem applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsThirdPartyVideoSystem -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csthirdpartyvideosystem +schema: 2.0.0 +title: Get-CsThirdPartyVideoSystem --- # Get-CsThirdPartyVideoSystem @@ -34,21 +35,21 @@ Information about these contact objects can be returned by using the Get-CsThird ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsThirdPartyVideoSystem ``` The command shown in Example 1 returns a collection of all the third-party video systems configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsThirdPartyVideoSystem -Filter {DisplayName -eq "Redmond Video System"} ``` In Example 2, information is returned for a single third-party video system: the system with the Active Directory display name Redmond Video System. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsThirdPartyVideoSystem -OU "ou=Telecommunications,dc=litwareinc,dc=com" ``` @@ -59,23 +60,10 @@ Note that this command also returns information for any third-party video system ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Credential -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Credential Enables you to run the Get-CsThirdPartyVideoSystem cmdlet under alternate credentials. This might be required if the account you used to log on to the Windows does not have the necessary privileges required to work with contact objects. @@ -85,8 +73,7 @@ For details, see the Get-Credential cmdlet Help topic. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,14 +83,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to retrieve contact information. To connect to a particular domain controller, include the DomainController parameter followed by the fully qualified domain name (FQDN) of the computer; for example, atl-cs-001.litwareinc.com. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -113,6 +102,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on attributes specific to Skype for Business Server 2015. For example, you can limit returned data to third-party video system contact objects that have been assigned a specific voice policy, or contacts that have not been assigned a specific voice policy. @@ -124,8 +116,7 @@ For example, a filter that returns only video systems in the IT department would ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,6 +126,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the third-party video system. Video systems are identified by using the Active Directory distinguished name of the associated contact object. By default, video systems use a GUID (globally unique identifier) as their common name, which means systems will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. @@ -142,8 +136,7 @@ By default, video systems use a GUID (globally unique identifier) as their commo ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -153,6 +146,9 @@ Accept wildcard characters: False ``` ### -LdapFilter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business Server 2015). For example, you can limit returned data to contact objects that have been assigned to a specific department or are located in a specific building. @@ -166,8 +162,7 @@ In the preceding filter, "l" represents the Active Directory attribute (locality ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -177,6 +172,9 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to return contact objects from a specific Active Directory organizational unit (OU). The cmdlet will then return data from both the specified OU and any of its child OUs. For example, if the Finance OU has two child OUs -- AccountsPayable and AccountsReceivable - third-party video system information will be returned from each of these OUs. @@ -186,8 +184,7 @@ When specifying an OU, use the distinguished name of that container; for example ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -197,6 +194,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the number of records returned by a command. For example, to return 3 video systems (regardless of how many video systems are in your forest), include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which 7 systems will be returned. @@ -208,8 +208,25 @@ If set to 0 the command will run, but no data will be returned. ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -219,13 +236,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsThirdPartyVideoSystemPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsThirdPartyVideoSystemPolicy.md similarity index 91% rename from skype/skype-ps/skype/Get-CsThirdPartyVideoSystemPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsThirdPartyVideoSystemPolicy.md index 372623ffd8..d425214455 100644 --- a/skype/skype-ps/skype/Get-CsThirdPartyVideoSystemPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsThirdPartyVideoSystemPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csthirdpartyvideosystempolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsThirdPartyVideoSystemPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csthirdpartyvideosystempolicy +schema: 2.0.0 +title: Get-CsThirdPartyVideoSystemPolicy --- # Get-CsThirdPartyVideoSystemPolicy @@ -42,7 +43,7 @@ The Get-CsThirdPartyVideoSystem cmdlet provides a way for administrators to retu ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsThirdPartyVideoSystemPolicy @@ -50,14 +51,14 @@ Get-CsThirdPartyVideoSystemPolicy The command shown in Example 1 returns information about all the third-party video system policies currently configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsThirdPartyVideoSystemPolicy -Identity "RedmondVideoSystemPolicy" ``` In Example 2, information for a single third-party video system policy is returned: the per-user policy with the Identity RedmondVideoSystemPolicy. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsThirdPartyVideoSystemPolicy -Filter "site:*" ``` @@ -65,7 +66,7 @@ Get-CsThirdPartyVideoSystemPolicy -Filter "site:*" Example 3 returns information about all the third-party video system policies that have been configured at the site scope. To do this, the Filter parameter is included, along with the filter value "site:*". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsThirdPartVideoSystemPolicy | Where-Object {$_.SupportsSendingLowResolution -eq $True} ``` @@ -78,6 +79,9 @@ That collection is then pipe to the Where-Object cmdlet, which picks out only th ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to do a wildcard search for third-party video system policies. For example, to find all the policies configured at the site scope, use this syntax: @@ -92,8 +96,7 @@ Note that you can only filter on the Identity property. ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -103,6 +106,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identity assigned to the policy when it was created. Third-party video system policies can be assigned at the global, site, or per-user scope. To refer to the global instance, use this syntax: @@ -124,8 +130,7 @@ If neither the Identity nor the Filter parameter is specified the Get-CsThirdPar ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -135,13 +140,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the third-party video system policy data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -151,6 +158,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the third-party video system policies are being returned. For example: @@ -163,8 +173,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTopology.md b/skype/skype-ps/SkypeForBusiness/Get-CsTopology.md similarity index 89% rename from skype/skype-ps/skype/Get-CsTopology.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTopology.md index 4f487076f5..712a8ace49 100644 --- a/skype/skype-ps/skype/Get-CsTopology.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTopology.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cstopology applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsTopology -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cstopology +schema: 2.0.0 +title: Get-CsTopology --- # Get-CsTopology @@ -36,7 +37,7 @@ You can also use the AsXml parameter to return detailed information about your e ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTopology ``` @@ -44,7 +45,7 @@ Get-CsTopology Example 1 returns complete details for your Skype for Business Server topology. This is done by calling the Get-CsTopology cmdlet without any additional parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsTopology | Select-Object -ExpandProperty Machines ``` @@ -53,7 +54,7 @@ Example 2 returns information about the computers found in your Skype for Busine To do this, the command first calls the Get-CsTopology cmdlet to return the complete Skype for Business Server topology. This information is then piped to the Select-Object cmdlet, which uses the ExpandProperty parameter to extract and display detailed information for all the computers included in that topology. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsTopology -AsXML | Out-File C:\Logs\Topology.xml ``` @@ -66,14 +67,16 @@ That formatted data is then piped to the Out-File cmdlet, which saves the inform ## PARAMETERS ### -AsXml + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns topology information in XML format. By combining the Get-CsTopology cmdlet, the AsXml parameter, and the Out-File cmdlet, you can export your topology to an XML file. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -83,13 +86,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the topology data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTrunk.md b/skype/skype-ps/SkypeForBusiness/Get-CsTrunk.md similarity index 89% rename from skype/skype-ps/skype/Get-CsTrunk.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTrunk.md index 96dffbef9c..0526207d9f 100644 --- a/skype/skype-ps/skype/Get-CsTrunk.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTrunk.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cstrunk applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsTrunk -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cstrunk +schema: 2.0.0 +title: Get-CsTrunk --- # Get-CsTrunk @@ -49,28 +50,28 @@ The functions carried out by the Get-CsTrunk cmdlet are not available in the Sky ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTrunk ``` The command shown in Example 1 returns information for all the SIP trunks configured for use in your organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsTrunk -Identity "PstnGateway:192.168.0.240" ``` In Example 2, information is returned for a single SIP trunk: the trunk with the Identity PstnGateway:192.168.0.240. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsTrunk -PoolFqdn "atl-cs-001.litwareinc.com" ``` The command shown in Example 3 returns information for all the SIP trunks found on the pool atl-cs-001.litwareinc.com. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsTrunk | Where-Object {$_.Routable -eq $True} ``` @@ -83,6 +84,9 @@ This collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return a SIP trunk (or collection of SIP trunks). For example, to return a collection of all the SIP trunks configured as part of the PSTN gateway service use this syntax: @@ -91,8 +95,7 @@ For example, to return a collection of all the SIP trunks configured as part of ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the SIP trunk to be returned. For example: @@ -115,8 +121,7 @@ If this parameter is not specified, then Get-CsTrunk returns a collection of all ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -126,6 +131,9 @@ Accept wildcard characters: False ``` ### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name for the trunk or PSTN gateway as defined in the topology. For example: @@ -134,8 +142,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTrunkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsTrunkConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Get-CsTrunkConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTrunkConfiguration.md index c3be85f003..9f9c6b47e7 100644 --- a/skype/skype-ps/skype/Get-CsTrunkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTrunkConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cstrunkconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsTrunkConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cstrunkconfiguration +schema: 2.0.0 +title: Get-CsTrunkConfiguration --- # Get-CsTrunkConfiguration @@ -37,14 +38,14 @@ These settings configure such things as whether media bypass is enabled on this ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTrunkConfiguration ``` This example retrieves all trunk configurations for the Skype for Business Server deployment. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsTrunkConfiguration -Identity site:Redmond ``` @@ -52,7 +53,7 @@ Get-CsTrunkConfiguration -Identity site:Redmond This example retrieves the trunk configuration with the Identity site:Redmond. Because identities are unique, this command will return at most one object. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsTrunkConfiguration -Filter site:* ``` @@ -63,49 +64,55 @@ The Get-CsTrunkConfiguration cmdlet uses the Filter parameter to retrieve all tr ## PARAMETERS -### -Identity -The unique identifier of the trunk configuration you want to retrieve. -Trunk configurations can be defined at the Global scope, the Site scope, or at the Service scope for a PSTN Gateway service. -For example, site:Redmond (for site) or PstnGateway:Redmond.litwareinc.com (for service). +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter accepts a wildcard string and returns all trunk configurations with identities matching that string. +For example, a Filter value of site:* will return all trunk configurations defined at the site level. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -This parameter accepts a wildcard string and returns all trunk configurations with identities matching that string. -For example, a Filter value of site:* will return all trunk configurations defined at the site level. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the trunk configuration you want to retrieve. +Trunk configurations can be defined at the Global scope, the Site scope, or at the Service scope for a PSTN Gateway service. +For example, site:Redmond (for site) or PstnGateway:Redmond.litwareinc.com (for service). ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTrustedApplication.md b/skype/skype-ps/SkypeForBusiness/Get-CsTrustedApplication.md similarity index 89% rename from skype/skype-ps/skype/Get-CsTrustedApplication.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTrustedApplication.md index b4d37f606f..0ea5fbbd0f 100644 --- a/skype/skype-ps/skype/Get-CsTrustedApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTrustedApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cstrustedapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsTrustedApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cstrustedapplication +schema: 2.0.0 +title: Get-CsTrustedApplication --- # Get-CsTrustedApplication @@ -48,14 +49,14 @@ While this prefix is part of the Identity, it's not required when you specify th ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTrustedApplication ``` This example retrieves information about all trusted applications defined within the Skype for Business Server deployment. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsTrustedApplication -Identity TrustPool.litwareinc.com/tapp2 ``` @@ -64,7 +65,7 @@ Example 2 retrieves the trusted application with the Identity TrustPool.litwarei Notice that we were able to omit the urn:application: prefix. The Get-CsTrustedApplication cmdlet adds the prefix automatically and retrieves the correct application. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsTrustedApplication -Filter *trust* ``` @@ -74,7 +75,7 @@ In this case, with a Filter value of *trust*, the command will retrieve all trus This string can be contained within any part of the Identity, the pool FQDN, or the application ID. So this command will retrieve trusted applications with identities such as TrustedPool.litwareinc.com/urn:application:application1, Pool1.litwareinc.com/urn:application:trustedapp, and Pool1.litwareinc.com/urn:application:trust. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsTrustedApplication -ApplicationId tapp2 -TrustedApplicationPoolFqdn TrustPool.litwareinc.com ``` @@ -83,7 +84,7 @@ Example 4 will return the same results as Example 2 (where the Identity was spec The only difference between the two examples is that Example 2 retrieves the trusted application based on the Identity, which consists of the trusted pool FQDN followed by the application ID. In this example, the application ID and trusted pool FQDN are entered as values to two separate parameters: ApplicationId and TrustedApplicationPoolFqdn. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsTrustedApplication | Where-Object {$_.TrustedApplicationPoolFqdn -eq "TrustPool.litwareinc.com"} ``` @@ -96,25 +97,31 @@ This collection is then piped to the Where-Object cmdlet, which looks through th ## PARAMETERS -### -Identity -The unique identifier of the trusted application you want to retrieve. -Identity values must be entered in the format \/\, where pool FQDN is the FQDN of the pool on which the application resides, and application ID is the name of the application. -Note that if you specify an Identity, you cannot specify an ApplicationID or a TrustedApplicationPoolFqdn. +### -ApplicationId + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The name of the application. +This can include the application ID prefix, but doesn't need to. +For example, ApplicationId values of urn:application:tapp1 and tapp1 will both return the same application. +If you supply a value for ApplicationId, you cannot supply a value for the Identity, but you must supply a value for the TrustedApplicationPoolFqdn parameter. ```yaml -Type: ExternalApplicationIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A string that includes wildcards that enables you to retrieve trusted applications based on Identity values that match the given wildcard string. Identities consist of a trusted application pool FQDN followed by a slash (/) followed by the trusted application ID. The Filter value will match any part of the Identity, both the FQDN and the application ID. @@ -122,8 +129,7 @@ The Filter value will match any part of the Identity, both the FQDN and the appl ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,34 +138,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplicationId -The name of the application. -This can include the application ID prefix, but doesn't need to. -For example, ApplicationId values of urn:application:tapp1 and tapp1 will both return the same application. -If you supply a value for ApplicationId, you cannot supply a value for the Identity, but you must supply a value for the TrustedApplicationPoolFqdn parameter. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the trusted application you want to retrieve. +Identity values must be entered in the format \/\, where pool FQDN is the FQDN of the pool on which the application resides, and application ID is the name of the application. +Note that if you specify an Identity, you cannot specify an ApplicationID or a TrustedApplicationPoolFqdn. ```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: ExternalApplicationIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -TrustedApplicationPoolFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The FQDN of the trusted application pool on which the application will reside. If you supply a value for TrustedApplicationPoolFqdn, you cannot supply a value for the Identity, but you must supply a value for the ApplicationID parameter. ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTrustedApplicationComputer.md b/skype/skype-ps/SkypeForBusiness/Get-CsTrustedApplicationComputer.md similarity index 85% rename from skype/skype-ps/skype/Get-CsTrustedApplicationComputer.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTrustedApplicationComputer.md index 17ccc65a5d..13119c4fb3 100644 --- a/skype/skype-ps/skype/Get-CsTrustedApplicationComputer.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTrustedApplicationComputer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cstrustedapplicationcomputer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsTrustedApplicationComputer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cstrustedapplicationcomputer +schema: 2.0.0 +title: Get-CsTrustedApplicationComputer --- # Get-CsTrustedApplicationComputer @@ -40,21 +41,21 @@ You can use this cmdlet to retrieve computers based on the computer FQDN or to r ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTrustedApplicationComputer ``` Example 1 retrieves all computers that have been assigned to any trusted application pool within the Skype for Business Server deployment. -### -------------------------- Example 2 -------------------------- (Skype for Business Server 2015) +### Example 2 (Skype for Business Server 2015) ``` Get-CsTrustedApplicationComputer -Identity Trust1.litwareinc.com ``` Example 2 retrieves information about the computer with the FQDN Trust1.litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsTrustedApplicationComputer -Filter Trust* ``` @@ -63,14 +64,14 @@ This example uses the Filter parameter to do a wildcard search for all computers The Filter parameter searches the Identity property of all trusted application computers. The wildcard character (*) at the end of the string means that the Filter should look for identities that begin with the string Trust followed by any other characters. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsTrustedApplicationComputer -Pool TrustPool.litwareinc.com ``` Example 4 retrieves a list of all computers that have been assigned to the trusted application pool TrustPool.litwareinc.com. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsTrustedApplicationComputer | Where-Object {$_.Pool -like "*.litwareinc.com"} ``` @@ -87,46 +88,52 @@ A value will match that string if it begins with any set of characters and ends ## PARAMETERS -### -Identity -The fully qualified domain name (FQDN) of the computer you want to retrieve. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A string that includes wildcards that enables you to retrieve trusted computers based on Identity values that match the given wildcard string. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -A string that includes wildcards that enables you to retrieve trusted computers based on Identity values that match the given wildcard string. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The fully qualified domain name (FQDN) of the computer you want to retrieve. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Pool -The FQDN of the trusted application pool for which you want to retrieve computer information. +### -Local + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, returns information only for the local computer. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,14 +142,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Local -When present, returns information only for the local computer. +### -Pool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The FQDN of the trusted application pool for which you want to retrieve computer information. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTrustedApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/Get-CsTrustedApplicationEndpoint.md similarity index 84% rename from skype/skype-ps/skype/Get-CsTrustedApplicationEndpoint.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTrustedApplicationEndpoint.md index d41c6cd9e1..d2968772eb 100644 --- a/skype/skype-ps/skype/Get-CsTrustedApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTrustedApplicationEndpoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cstrustedapplicationendpoint applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsTrustedApplicationEndpoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cstrustedapplicationendpoint +schema: 2.0.0 +title: Get-CsTrustedApplicationEndpoint --- # Get-CsTrustedApplicationEndpoint @@ -33,14 +34,14 @@ This cmdlet retrieves one or more existing endpoint contact objects in Active Di ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsTrustedApplicationEndpoint ``` This example retrieves information about all trusted application endpoints defined within the Skype for Business Server deployment. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsTrustedApplicationEndpoint -Identity "sip:endpoint1@litwareinc.com" ``` @@ -48,7 +49,7 @@ Get-CsTrustedApplicationEndpoint -Identity "sip:endpoint1@litwareinc.com" Example 2 retrieves information about the application endpoint contact with the SIP address endpoint1@litwareinc.com. Note that the sip: prefix is required when using a SIP address as the Identity. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsTrustedApplicationEndpoint -Filter {DisplayName -like "*endpoint*"} ``` @@ -57,7 +58,7 @@ Example 3 retrieves all trusted application endpoints that have the string "endp To do this, the command uses the Filter parameter. The value of the parameter filters to find endpoint objects that have a display name (DisplayName) that contains (-like) the string endpoint (*endpoint* - the wildcard characters indicate that any characters can come before or after the string endpoint, meaning endpoint can be anywhere within the display name). -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsTrustedApplicationEndpoint -ApplicationId tapp2 | Select-Object SipAddress, DisplayName, OwnerUrn ``` @@ -70,34 +71,35 @@ The next part of this command pipes the returned object or objects to the Select ## PARAMETERS -### -Identity -The Identity (distinguished name), SIP address, or display name of the application endpoint to be retrieved. +### -ApplicationId + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The application ID of the trusted application for the endpoint you want to retrieve. ```yaml -Type: UserIdParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 1 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to limit the returned data by filtering on specific attributes for Skype for Business Server. -For example, you can limit returned data to contacts whose display names or SIP addresses match a certain wildcard pattern. +### -Credential -The Filter parameter uses the same Windows PowerShell filtering syntax that is used by the Where-Object cmdlet. -For example, a filter that returns only contacts that have been enabled for Enterprise Voice would look like this: {EnterpriseVoiceEnabled -eq $True}, with EnterpriseVoiceEnabled representing the Active Directory attribute, -eq representing the comparison operator (equal to), and $True (a built-in Windows PowerShell variable) representing the filter value. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Alternate credentials to be used to retrieve the endpoint. +You can retrieve a PSCredential object by calling the Get-Credential cmdlet. ```yaml -Type: String +Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -106,14 +108,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplicationId -The application ID of the trusted application for the endpoint you want to retrieve. +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to specify a domain controller. +If no domain controller is specified, the first available will be used. ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,15 +127,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Credential -Alternate credentials to be used to retrieve the endpoint. -You can retrieve a PSCredential object by calling the Get-Credential cmdlet. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to limit the returned data by filtering on specific attributes for Skype for Business Server. +For example, you can limit returned data to contacts whose display names or SIP addresses match a certain wildcard pattern. + +The Filter parameter uses the same Windows PowerShell filtering syntax that is used by the Where-Object cmdlet. +For example, a filter that returns only contacts that have been enabled for Enterprise Voice would look like this: {EnterpriseVoiceEnabled -eq $True}, with EnterpriseVoiceEnabled representing the Active Directory attribute, -eq representing the comparison operator (equal to), and $True (a built-in Windows PowerShell variable) representing the filter value. ```yaml -Type: PSCredential +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,31 +149,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Allows you to specify a domain controller. -If no domain controller is specified, the first available will be used. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity (distinguished name), SIP address, or display name of the application endpoint to be retrieved. ```yaml -Type: Fqdn +Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The OU in which the endpoint resides. ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -173,13 +186,15 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum number of endpoint records to retrieve. ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -189,13 +204,15 @@ Accept wildcard characters: False ``` ### -TrustedApplicationPoolFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The fully qualified domain name (FQDN) of the trusted application pool associated with the application for the endpoint you want to retrieve. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsTrustedApplicationPool.md b/skype/skype-ps/SkypeForBusiness/Get-CsTrustedApplicationPool.md similarity index 87% rename from skype/skype-ps/skype/Get-CsTrustedApplicationPool.md rename to skype/skype-ps/SkypeForBusiness/Get-CsTrustedApplicationPool.md index c790d1b493..db2c09a6f3 100644 --- a/skype/skype-ps/skype/Get-CsTrustedApplicationPool.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsTrustedApplicationPool.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cstrustedapplicationpool applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsTrustedApplicationPool -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cstrustedapplicationpool +schema: 2.0.0 +title: Get-CsTrustedApplicationPool --- # Get-CsTrustedApplicationPool @@ -70,14 +71,14 @@ This cmdlet retrieves one or more pools that have been defined as trusted applic ## EXAMPLES -### -------------------------- Example 1 ------------------------ (Lync Server 2010) +### Example 1 (Lync Server 2010) ``` Get-CsTrustedApplicationPool ``` Example 1 retrieves all pools within the Lync Server 2010 deployment that have been defined as trusted application pools. -### -------------------------- EXAMPLE 1 -------------------------- (Lync Server 2013) +### EXAMPLE 1 (Lync Server 2013) ``` ``` @@ -86,7 +87,7 @@ Example 1 retrieves all pools within the Lync Server deployment that have been d Get-CsTrustedApplicationPool -### -------------------------- EXAMPLE 1 -------------------------- (Skype for Business Server 2015) +### EXAMPLE 1 (Skype for Business Server 2015) ``` ``` @@ -95,14 +96,14 @@ Example 1 retrieves all pools within the Skype for Business Server 2015 deployme Get-CsTrustedApplicationPool -### -------------------------- Example 2 ------------------------ (Lync Server 2010) +### Example 2 (Lync Server 2010) ``` Get-CsTrustedApplicationPool -Identity TrustPool.litwareinc.com ``` In this example, we've used the Identity parameter to ensure we retrieve only one trusted application pool, in this case the pool with the FQDN TrustPool.litwareinc.com. -### -------------------------- EXAMPLE 2 -------------------------- (Lync Server 2013) +### EXAMPLE 2 (Lync Server 2013) ``` ``` @@ -111,7 +112,7 @@ In this example, we've used the Identity parameter to ensure we retrieve only on Get-CsTrustedApplicationPool -Identity TrustPool.litwareinc.com -### -------------------------- EXAMPLE 2 -------------------------- (Skype for Business Server 2015) +### EXAMPLE 2 (Skype for Business Server 2015) ``` ``` @@ -120,7 +121,7 @@ In this example, we've used the Identity parameter to ensure we retrieve only on Get-CsTrustedApplicationPool -Identity TrustPool.litwareinc.com -### -------------------------- Example 3 ------------------------ (Lync Server 2010) +### Example 3 (Lync Server 2010) ``` Get-CsTrustedApplicationPool -Filter *:TrustPool.* ``` @@ -130,7 +131,7 @@ The Filter parameter is used with a value of *:TrustPool.*. This filter string will search the Identity values of all trusted application pools for those that contain the string ":TrustPool.". For example, this command will retrieve the pool with the Identity value TrustedApplicationPool:TrustPool.litwareinc.com. -### -------------------------- EXAMPLE 3 -------------------------- (Lync Server 2013) +### EXAMPLE 3 (Lync Server 2013) ``` ``` @@ -142,7 +143,7 @@ For example, this command will retrieve the pool with the Identity value Trusted Get-CsTrustedApplicationPool -Filter *:TrustPool.* -### -------------------------- EXAMPLE 3 -------------------------- (Skype for Business Server 2015) +### EXAMPLE 3 (Skype for Business Server 2015) ``` ``` @@ -154,7 +155,7 @@ For example, this command will retrieve the pool with the Identity value Trusted Get-CsTrustedApplicationPool -Filter *:TrustPool.* -### -------------------------- Example 4 ------------------------ (Lync Server 2010) +### Example 4 (Lync Server 2010) ``` Get-CsTrustedApplicationPool | Where-Object {$_.ServiceId -like "Redmond1*"} ``` @@ -166,7 +167,7 @@ The example begins by calling Get-CsTrustedApplicationPool with no parameters, w This collection is then piped to the Where-Object cmdlet, which narrows down the collection to only those pools where the service ID ($_.ServiceId) matches the wildcard string (-like) Redmond1*. The result will be a collection of all trusted application pools with FQDNs beginning with the string Redmond1, such as Redmond1-ExternalServer-1, Redmond1-ExternalServer-2, and Redmond1-ExternalServer-3. -### -------------------------- EXAMPLE 4 -------------------------- (Lync Server 2013) +### EXAMPLE 4 (Lync Server 2013) ``` ``` @@ -180,7 +181,7 @@ The result will be a collection of all trusted application pools with FQDNs begi Get-CsTrustedApplicationPool | Where-Object {$_.ServiceId -like "Redmond1*"} -### -------------------------- EXAMPLE 4 -------------------------- (Skype for Business Server 2015) +### EXAMPLE 4 (Skype for Business Server 2015) ``` ``` @@ -196,48 +197,54 @@ Get-CsTrustedApplicationPool | Where-Object {$_.ServiceId -like "Redmond1*"} ## PARAMETERS -### -Identity -The fully qualified domain name (FQDN) or service ID of the pool for which you want to retrieve settings. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A string containing one or more wildcard characters that is used to search for a pool with an Identity that matches the wildcard string. +For example, specifying the string *Redmond* would retrieve all trusted application pools with identities containing the string Redmond, such as TrustedApplicationPool:Redmond.litwareinc.com. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -A string containing one or more wildcard characters that is used to search for a pool with an Identity that matches the wildcard string. -For example, specifying the string *Redmond* would retrieve all trusted application pools with identities containing the string Redmond, such as TrustedApplicationPool:Redmond.litwareinc.com. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The fully qualified domain name (FQDN) or service ID of the pool for which you want to retrieve settings. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -PoolFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The FQDN of the pool you want to retrieve. This behaves the same as the Identity parameter, except that Identity also accepts a service ID. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -251,12 +258,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.Xds.DisplayExternalServer Retrieves one or more objects of type Microsoft.Rtc.Management.Xds.DisplayExternalServer. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsUCPhoneConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsUCPhoneConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsUCPhoneConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUCPhoneConfiguration.md index 7441f11f69..fb35b58072 100644 --- a/skype/skype-ps/skype/Get-CsUCPhoneConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUCPhoneConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csucphoneconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsUCPhoneConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-csucphoneconfiguration +schema: 2.0.0 +title: Get-CsUCPhoneConfiguration --- # Get-CsUCPhoneConfiguration @@ -63,7 +65,7 @@ Phone configuration settings can be applied at either the global scope or at the ## EXAMPLES -### -------------------------- Example -------------------------- +### Example 1 ``` Get-CsUCPhoneConfiguration ``` @@ -71,7 +73,7 @@ Get-CsUCPhoneConfiguration The command shown in Example 1 returns all of the UC phone configuration settings currently in use in the organization. Calling the Get-CsUCPhoneConfiguration cmdlet without any parameters always returns a complete collection of phone configuration settings. -### -------------------------- Example -------------------------- +### Example 2 ``` Get-CsUCPhoneConfiguration -Identity site:Redmond ``` @@ -79,7 +81,7 @@ Get-CsUCPhoneConfiguration -Identity site:Redmond In Example 2, only the UC phone configuration settings that have the Identity site:Redmond are returned. Because Identities must be unique, this command will never return more than one collection of phone configuration settings. -### -------------------------- Example -------------------------- +### Example 3 ``` Get-CsUCPhoneConfiguration -Filter site:* ``` @@ -88,7 +90,7 @@ In Example 3, all the UC phone settings that have been configured at the site sc To do this, the Get-CsUCPhoneConfiguration cmdlet is called, along with the Filter parameter; the filter value "site:*" limits the returned data to settings where the Identity property (the only property you can filter on) begins with the string value "site:". By definition, any settings that have an Identity that begins with the string value "site:" are settings that have been configured at the site scope. -### -------------------------- Example -------------------------- +### Example 4 ``` Get-CsUCPhoneConfiguration | Where-Object {$_.SIPSecurityMode -eq "Medium"} ``` @@ -97,7 +99,7 @@ Example 4 returns the UC phone configuration settings where the SIP security mod (SIP security can be set to Low, Medium, or High.) To carry out this task, the command first uses the Get-CsUCPhoneConfiguration cmdlet without any additional parameters in order to return a collection of all the UC phone settings configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those settings where the SIPSecurityMode property is equal to Medium. -### -------------------------- Example -------------------------- +### Example 5 ``` Get-CsUCPhoneConfiguration | Where-Object {$_.EnforcePhoneLock -eq $False -or $_.MinPhonePinLength -lt 6} ``` @@ -113,7 +115,35 @@ Where-Object {$_.EnforcePhoneLock -eq $False -and $_.MinPhonePinLength -lt 6} ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcard characters in order to return a collection (or collections) of UC phone configuration settings. +To return a collection of all the settings configured at the site scope, use this syntax: + +-Filter site:* + +To return a collection of all the settings that have the string value "EMEA" somewhere in their Identity (the only property you can filter for), use this syntax: + +-Filter *EMEA* + +```yaml +Type: String +Parameter Sets: Filter, (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the unique identifier for the collection of unified communications (UC) phone configuration settings you want to return. To refer to the global settings use this syntax: @@ -131,8 +161,7 @@ If this parameter is not specified then the Get-CsUCPhoneConfiguration cmdlet re ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -141,37 +170,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcard characters in order to return a collection (or collections) of UC phone configuration settings. -To return a collection of all the settings configured at the site scope, use this syntax: - --Filter site:* - -To return a collection of all the settings that have the string value "EMEA" somewhere in their Identity (the only property you can filter for), use this syntax: - --Filter *EMEA* - -```yaml -Type: String -Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the UC phone configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -181,13 +189,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -201,15 +211,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Get-CsUCPhoneConfiguration cmdlet does not accept pipelined input. ## OUTPUTS ### System.Object -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.UcPhoneSettings The Get-CsUCPhoneConfiguration cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.UcPhoneSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsUICulture.md b/skype/skype-ps/SkypeForBusiness/Get-CsUICulture.md similarity index 86% rename from skype/skype-ps/skype/Get-CsUICulture.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUICulture.md index 071c8309d1..1644aec458 100644 --- a/skype/skype-ps/skype/Get-CsUICulture.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUICulture.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csuiculture applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsUICulture -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csuiculture +schema: 2.0.0 +title: Get-CsUICulture --- # Get-CsUICulture @@ -40,7 +41,7 @@ The Get-CsUICulture cmdlet provides a way for you to determine the culture curre ## EXAMPLES -### -------------------------- Example ------------------------ +### Example ``` Get-CsUICulture ``` @@ -49,34 +50,17 @@ The command shown in Example 1 returns basic information about the culture curre ## PARAMETERS -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 - -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. +### None The Get-CsUICulture cmdlet does not accept pipelined input. ## OUTPUTS -### +### System.Globalization.CultureInfo The Get-CsUICulture cmdlet returns instances of the System.Globalization.CultureInfo class. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsUnassignedNumber.md b/skype/skype-ps/SkypeForBusiness/Get-CsUnassignedNumber.md similarity index 86% rename from skype/skype-ps/skype/Get-CsUnassignedNumber.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUnassignedNumber.md index 903f8ebaea..fc52a586a6 100644 --- a/skype/skype-ps/skype/Get-CsUnassignedNumber.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUnassignedNumber.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csunassignednumber applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsUnassignedNumber -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csunassignednumber +schema: 2.0.0 +title: Get-CsUnassignedNumber --- # Get-CsUnassignedNumber @@ -39,14 +40,14 @@ This cmdlet retrieves one or more unassigned number ranges that define that rout ## EXAMPLES -### -------------------------- Example -------------------------- +### Example 1 ``` Get-CsUnassignedNumber ``` Example 1 returns a collection of all the unassigned numbers configured for use in your organization. -### -------------------------- Example -------------------------- +### Example 2 ``` Get-CsUnassignedNumber -Identity UNSet1 ``` @@ -54,7 +55,7 @@ Get-CsUnassignedNumber -Identity UNSet1 In Example 2, the Identity parameter is used to limit the retrieved data to unassigned numbers that have the Identity UNSet1. Because identities must be unique, this command will return only the specified unassigned number range. -### -------------------------- Example -------------------------- +### Example 3 ``` Get-CsUnassignedNumber -Filter *Redmond* ``` @@ -62,7 +63,7 @@ Get-CsUnassignedNumber -Filter *Redmond* This example uses the Filter parameter to return a collection of all the unassigned number settings with Identity values that include the string Redmond. For example, this command would return unassigned number setting with identities such as Redmond Numbers, Unassigned Redmond Numbers, UNRedmond, etc. -### -------------------------- Example -------------------------- +### Example 4 ``` Get-CsUnassignedNumber | Where-Object {$_.AnnouncementName -match "Welcome"} ``` @@ -73,46 +74,52 @@ That collection is then piped to the Where-Object cmdlet, which applies a filter ## PARAMETERS -### -Identity -The unique name of the unassigned number range to retrieve. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Performs a wildcard search that allows you to narrow down your results to only those unassigned number settings whose identities match the given wildcard string. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Performs a wildcard search that allows you to narrow down your results to only those unassigned number settings whose identities match the given wildcard string. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique name of the unassigned number range to retrieve. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the unassigned number information from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -126,12 +133,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange Returns an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsUpgradeDomainInfo.md b/skype/skype-ps/SkypeForBusiness/Get-CsUpgradeDomainInfo.md similarity index 92% rename from skype/skype-ps/skype/Get-CsUpgradeDomainInfo.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUpgradeDomainInfo.md index e8d813bd7c..8c68394ea4 100644 --- a/skype/skype-ps/skype/Get-CsUpgradeDomainInfo.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUpgradeDomainInfo.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csupgradedomaininfo applicable: Skype for Business Server 2019 -title: Get-CsUpgradeDomainInfo -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csupgradedomaininfo +schema: 2.0.0 +title: Get-CsUpgradeDomainInfo --- # Get-CsUpgradeDomainInfo @@ -32,7 +33,7 @@ The functions carried out by the Get-CsUpgradeDomainInfo cmdlet are not availabl ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsUpgradeDomainInfo ``` @@ -42,14 +43,16 @@ Note that this command must be executed on a Front End server located within the ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +> Applicable: Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -58,14 +61,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -QueryTimeout + +> Applicable: Skype for Business Server 2019 + +Query timeout period in minutes to retrieve the state of fabric services. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -74,14 +79,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -90,14 +97,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -QueryTimeout -Query timeout period in minutes to retrieve the state of fabric services. +### -WhatIf + +> Applicable: Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2019 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsUser.md b/skype/skype-ps/SkypeForBusiness/Get-CsUser.md similarity index 88% rename from skype/skype-ps/skype/Get-CsUser.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUser.md index c59d7c3028..e822eedffa 100644 --- a/skype/skype-ps/skype/Get-CsUser.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUser.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csuser applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsUser -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csuser +schema: 2.0.0 +title: Get-CsUser --- # Get-CsUser @@ -53,14 +54,14 @@ The LdapFilter parameter enables you to limit the returned data to users who fit ## EXAMPLES -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 1 ``` Get-CsUser ``` In the preceding example, the Get-CsUser cmdlet is called without any parameters in order to return a collection of all the domain users who have been enabled for Skype for Business Server 2015. -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 2 ``` Get-CsUser | Format-Table -Property DisplayName, SipAddress, EnterpriseVoiceEnabled -AutoSize ``` @@ -70,14 +71,14 @@ By default, the Get-CsUser cmdlet returns a very large number of properties and Therefore, in this example the retrieved data is piped to the Format-Table cmdlet. The Format-Table cmdlet then uses the Property parameter to select the properties DisplayName, SipAddress, and EnterpriseVoiceEnabled, and display those properties and their values in a table. -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 3 ``` Get-CsUser -Identity "Pilar Ackerman" ``` In Example 3, the Identity parameter is used to limit the returned data to the user account with the Identity (in this case, the display name) Pilar Ackerman. -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 4 ``` Get-CsUser -Identity "Pilar*" ``` @@ -85,7 +86,7 @@ Get-CsUser -Identity "Pilar*" In Example 4, the wildcard character (*) is used when specifying the user's Identity. That causes the Get-CsUser cmdlet to return all the users who have an Identity that begins with the string value "Pilar". -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 5 ``` Get-CsUser -Filter {VoicePolicy -ne $Null} ``` @@ -100,7 +101,7 @@ To return a collection of users who do have a voice policy assigned to them, use Get-CsUser -Filter {VoicePolicy -eq $Null} -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 6 ``` Get-CsUser -LdapFilter "Department=Finance" ``` @@ -108,7 +109,7 @@ Get-CsUser -LdapFilter "Department=Finance" Example 6 uses the LdapFilter parameter to limit the returned data to users who work in the Finance department. This is done by using the LDAP filter value "Department=Finance". -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 7 ``` Get-CsUser -LdapFilter "&(Department=Finance)(Title=Manager)" ``` @@ -117,7 +118,7 @@ Example 7 demonstrates the use of an AND query in conjunction with the LdapFilte This query (which uses the ampersand character "&" to indicate an AND query) specifies two conditions: "Department=Finance" and "Title=Manager". For a user account to be returned by this query, both conditions must be true: a user must work in the Finance department, and he or she must be a Manager. -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 8 ``` Get-CsUser -LdapFilter "|(Title=Supervisor)(Title=Manager)" ``` @@ -127,14 +128,14 @@ In the AND query shown in Example 7, both conditions had to be true in order for With an OR query, only one condition must be true for the account to be returned. In this case, a user account will be returned if the user is a Supervisor or if the user is a Manager. -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 9 ``` Get-CsUser -OU "ou=Finance,ou=North America,dc=litwareinc,dc=com" ``` Example 9 returns user account information for all the users with accounts in the Finance OU. -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 10 ``` Get-CsUser -UnassignedUser ``` @@ -143,28 +144,10 @@ Example 10 returns a collection of all the users who have been enabled for Skype ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be retrieved. -User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). -You can also reference a user account by using the user's Active Directory distinguished name. - -You can use the asterisk (*) wildcard character when using the Display Name as the user Identity. -For example, the Identity "* Smith" returns all the users who have a display name that ends with the string value " Smith". - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Credential -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Credential Enables you to run the Get-CsUser cmdlet under alternate credentials. This might be required if the account you used to log on to the Windows does not have the necessary privileges required to work with user objects. @@ -176,8 +159,7 @@ For details, see the Get-Credential cmdlet help topic. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -187,14 +169,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to retrieve user information. To connect to a particular domain controller, include the DomainController parameter followed by the fully qualified domain name (FQDN) (for example, atl-cs-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -204,6 +188,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on Skype for Business Server 2015-specific attributes. For example, you can limit returned data to users who have been assigned a specific voice policy, or users who have not been assigned a specific voice policy. @@ -217,8 +204,7 @@ For example, a filter that returns only users who have been enabled for Enterpri ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -227,17 +213,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OnOfficeCommunicationServer -Returns a collection of users homed on Office Communications Server 2007. -Users with accounts on the current version of the software will not be returned when you use this parameter. +### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Indicates the Identity of the user account to be retrieved. +User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). +You can also reference a user account by using the user's Active Directory distinguished name. + +You can use the asterisk (*) wildcard character when using the Display Name as the user Identity. +For example, the Identity "* Smith" returns all the users who have a display name that ends with the string value " Smith". ```yaml -Type: SwitchParameter +Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -LdapFilter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business Server 2015). +For example, you can limit returned data to users who work in a specific department, or users who have a specified manager or job title. + +The LdapFilter parameter uses the LDAP query language when creating filters. +For example, a filter that returns only users who work in the city of Redmond would look like this: "l=Redmond", with "l" (a lowercase L) representing the Active Directory attribute (locality); "=" representing the comparison operator (equal to); and "Redmond" representing the filter value. + + + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -247,6 +261,9 @@ Accept wildcard characters: False ``` ### -OnLyncServer + +> Applicable: Lync Server 2010, Lync Server 2013 + Returns a collection of users homed on Lync Server. Users with accounts on previous versions of the software will not be returned when you use this parameter. @@ -255,8 +272,7 @@ Users with accounts on previous versions of the software will not be returned wh ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013 +Aliases: Required: False Position: Named @@ -265,23 +281,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OU -Enables you to return information about user accounts in a specific organizational unit (OU) or container. -The OU parameter returns data from both the specified OU and any of its child OUs. -For example, if the Finance OU has two child OUs--AccountsPayable and AccountsReceivable--users will be returned from each of these three OUs. - -When specifying an OU, use the distinguished name (DN) of that container; for example: -OU "OU=Finance,dc=litwareinc,dc=com". -To return user accounts from the Users container, use this syntax: - --OU "cn=Users,dc=litwareinc,dc=com" +### -OnModernServer +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +PARAMVALUE: SwitchParameter ```yaml -Type: OUIdParameter +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: OnLyncServer Required: False Position: Named @@ -290,20 +299,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResultSize -Enables you to limit the number of records returned by the cmdlet. -For example, to return seven users (regardless of the number of users that are in your forest) include the ResultSize parameter and set the parameter value to 7. -Note that there is no way to guarantee which seven users will be returned. +### -OnOfficeCommunicationServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns a collection of users homed on Office Communications Server 2007. +Users with accounts on the current version of the software will not be returned when you use this parameter. + -The result size can be set to any whole number between 0 and 2147483647, inclusive. -If set to 0 the command will run, but no data will be returned. -If you set the ResultSize to 7 but you have only three users in your forest, the command will return those three users, and then complete without error. ```yaml -Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -312,20 +320,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LdapFilter -Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business Server 2015). -For example, you can limit returned data to users who work in a specific department, or users who have a specified manager or job title. +### -OU -The LdapFilter parameter uses the LDAP query language when creating filters. -For example, a filter that returns only users who work in the city of Redmond would look like this: "l=Redmond", with "l" (a lowercase L) representing the Active Directory attribute (locality); "=" representing the comparison operator (equal to); and "Redmond" representing the filter value. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to return information about user accounts in a specific organizational unit (OU) or container. +The OU parameter returns data from both the specified OU and any of its child OUs. +For example, if the Finance OU has two child OUs--AccountsPayable and AccountsReceivable--users will be returned from each of these three OUs. + +When specifying an OU, use the distinguished name (DN) of that container; for example: -OU "OU=Finance,dc=litwareinc,dc=com". +To return user accounts from the Users container, use this syntax: + +-OU "cn=Users,dc=litwareinc,dc=com" ```yaml -Type: String +Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -334,17 +347,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UnAssignedUser -Enables you to return a collection of all the users who have been enabled for Skype for Business Server 2015 but are not currently assigned to a Registrar pool. -Users are not allowed to log on to Skype for Business Server 2015 unless they are assigned to a Registrar pool. +### -ResultSize +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Enables you to limit the number of records returned by the cmdlet. +For example, to return seven users (regardless of the number of users that are in your forest) include the ResultSize parameter and set the parameter value to 7. +Note that there is no way to guarantee which seven users will be returned. + +The result size can be set to any whole number between 0 and 2147483647, inclusive. +If set to 0 the command will run, but no data will be returned. +If you set the ResultSize to 7 but you have only three users in your forest, the command will return those three users, and then complete without error. ```yaml -Type: SwitchParameter +Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -354,6 +372,9 @@ Accept wildcard characters: False ``` ### -UnAssignedUser + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to return a collection of all the users who have been enabled for Skype for Business Server 2015 but are not currently assigned to a Registrar pool. Users are not allowed to log on to Skype for Business Server 2015 unless they are assigned to a Registrar pool. @@ -362,8 +383,7 @@ Users are not allowed to log on to Skype for Business Server 2015 unless they ar ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -372,14 +392,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OnModernServer -PARAMVALUE: SwitchParameter +### -UnAssignedUser + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to return a collection of all the users who have been enabled for Skype for Business Server 2015 but are not currently assigned to a Registrar pool. +Users are not allowed to log on to Skype for Business Server 2015 unless they are assigned to a Registrar pool. + + ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: OnLyncServer -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -393,13 +418,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -String. +### System.String The Get-CsUser cmdlet accepts a pipelined string value representing the Identity of a user account that has been enabled for Skype for Business Server. ## OUTPUTS -### +###Microsoft.Rtc.Management.ADConnect.Schema.ADUser The Get-CsUser cmdlet returns instances of the Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsUserAcp.md b/skype/skype-ps/SkypeForBusiness/Get-CsUserAcp.md similarity index 90% rename from skype/skype-ps/skype/Get-CsUserAcp.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUserAcp.md index 430f4b037c..8af0a34e10 100644 --- a/skype/skype-ps/skype/Get-CsUserAcp.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUserAcp.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csuseracp applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsUserAcp -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-csuseracp +schema: 2.0.0 +title: Get-CsUserAcp --- # Get-CsUserAcp @@ -60,14 +62,14 @@ Note that the Get-CsUserAcp cmdlet returns audio conferencing provider informati ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Get-CsUserAcp ``` The command shown in Example 1 returns audio conferencing provider information for all the users in your organization. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsUserAcp -Identity "Ken Myer" ``` @@ -75,7 +77,7 @@ Get-CsUserAcp -Identity "Ken Myer" Example 2 returns audio conferencing provider information for a single user: the user with the Identity Ken Myer. In this case, the identity is specified by using the user's Active Directory display name. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsUserAcp -Filter {AcpInfo -ne $Null} ``` @@ -86,7 +88,7 @@ To return information about users who have not been assigned an audio conferenci {AcpInfo -eq $Null} -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` Get-CsUserAcp | Where-Object {$_.AcpInfo -match "Fabrikam ACP"} ``` @@ -95,7 +97,7 @@ Example 4 returns audio conferencing provider information for any user who has b To carry out this task the command first uses the Get-CsUserAcp cmdlet without any parameters in order to return audio conferencing provider information for all the users in your organization. This information is then piped to the Where-Object cmdlet, which picks out any user whose AcpInfo property includes (-match) the string value "Fabrikam ACP". -### -------------------------- EXAMPLE 5 -------------------------- +### EXAMPLE 5 ``` Get-CsUserAcp -Identity "Ken Myer" | Select-Object -ExpandProperty AcpInfo ``` @@ -107,30 +109,10 @@ When a property value is expanded, that means that all the information stored in ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be retrieved. -You can specify a user's identity using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory Domain Services display name (for example, Ken Myer). -You can also references a user account by using the user's Active Directory distinguished name. - -You can use the asterisk (*) wildcard character when using the Display Name as the user Identity. -For example, the Identity "* Smith" returns all the users with a display name that ends with the string value " Smith". - - +### -Credential -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Credential Enables you to run the Get-CsUserAcp cmdlet under alternate credentials. This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with contact objects. @@ -142,8 +124,7 @@ For details, see the Get-Credential cmdlet help topic. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -153,6 +134,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on attributes specific to Skype for Business Server 2015. For example, you can limit returned data to users who have been assigned a specific voice policy, or users who have not been assigned a specific voice policy. @@ -166,8 +150,7 @@ For example, a filter that returns only users who have been enabled for Enterpri ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -176,7 +159,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the user account to be retrieved. +You can specify a user's identity using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory Domain Services display name (for example, Ken Myer). +You can also references a user account by using the user's Active Directory distinguished name. + +You can use the asterisk (*) wildcard character when using the Display Name as the user Identity. +For example, the Identity "* Smith" returns all the users with a display name that ends with the string value " Smith". + + + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + ### -LdapFilter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the returned data by filtering on generic Active Directory attributes (that is, attributes that are not specific to Skype for Business Server 2015). For example, you can limit returned data to users who work in a specific department, or users who have a specified manager or job title. @@ -188,8 +199,7 @@ For example, a filter that returns only users who work in the city of Redmond wo ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -199,6 +209,9 @@ Accept wildcard characters: False ``` ### -ResultSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the number of records returned by a command. For example, to return seven users (regardless of how many users are in your forest) include the ResultSize parameter and set the parameter value to 7. Note that there is no way to guarantee which 7 users will be returned. @@ -212,8 +225,7 @@ If set to 0 the command will run, but no data will be returned. ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.Unlimited`1[System.UInt32] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -229,15 +241,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### Microsoft.Rtc.Management.AD.UserIdParameter -### -String. +### String The Get-CsUserAcp cmdlet accepts a pipelined string value representing the Identity of a user account that has been enabled for Skype for Business Server 2015. ## OUTPUTS -### System.Object - -### +### Microsoft.Rtc.Management.ADConnect.Schema.ADUserAcp The Get-CsUserAcp cmdlet returns instances of the Microsoft.Rtc.Management.ADConnect.Schema.ADUserAcp object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsUserCallForwardingSettings.md b/skype/skype-ps/SkypeForBusiness/Get-CsUserCallForwardingSettings.md similarity index 96% rename from skype/skype-ps/skype/Get-CsUserCallForwardingSettings.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUserCallForwardingSettings.md index 3fa9eb9579..fe2f34aaa0 100644 --- a/skype/skype-ps/skype/Get-CsUserCallForwardingSettings.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUserCallForwardingSettings.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csusercallforwardingsettings applicable: Skype for Business Server 2019 -title: Get-CsUserCallForwardingSettings -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csusercallforwardingsettings +schema: 2.0.0 +title: Get-CsUserCallForwardingSettings --- # Get-CsUserCallForwardingSettings @@ -44,6 +45,9 @@ This example returns the call forwarding settings for the specified user and dis ## PARAMETERS ### -User + +> Applicable: Skype for Business Server 2019CU1 + Specifies the identity of the target user. Acceptable values include: Example: jphillips@contoso.com @@ -53,7 +57,6 @@ Example: sip:jphillips@contoso.com Type: String Parameter Sets: (All) Aliases: DisplayName, SipAddress, Identity -Applicable: Skype for Business Server 2019CU1 Required: True Position: 0 diff --git a/skype/skype-ps/skype/Get-CsUserDatabaseState.md b/skype/skype-ps/SkypeForBusiness/Get-CsUserDatabaseState.md similarity index 89% rename from skype/skype-ps/skype/Get-CsUserDatabaseState.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUserDatabaseState.md index e213d9e530..2376ff3b50 100644 --- a/skype/skype-ps/skype/Get-CsUserDatabaseState.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUserDatabaseState.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csuserdatabasestate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsUserDatabaseState -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csuserdatabasestate +schema: 2.0.0 +title: Get-CsUserDatabaseState --- # Get-CsUserDatabaseState @@ -43,27 +44,27 @@ However, to run the Get-CsUserDatabaseState cmdlet remotely you will need to man ## EXAMPLES -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 1 ``` Get-CsUserDatabaseState ``` The command shown in Example 1 returns the online status of each user database configured for use in your organization. -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 2 ``` Get-CsUserDatabaseState -Identity "UserDatabase:atl-sql-001.litwareinc.com" ``` The command shown in Example 2 returns the online status of a single user database: the database with the Identity UserDatabase:atl-sql-001.litwareinc.com. -### -------------------------- EXAMPLE -------------------------- +### -------------------------- EXAMPLE 3. -------------------------- ``` Get-CsUserDatabaseState -RegistrarPool "atl-cs-001.litwareinc.com"\ ``` In Example 3, status information is returned for all the user databases located in the Registrar pool atl-cs-001.litwareinc.com. -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 4 ``` Get-CsUserDatabaseState | Where-Object {$_.Online -eq $True} ``` @@ -76,6 +77,9 @@ That collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the user database whose online status is to be returned. For example: @@ -89,8 +93,7 @@ If both parameters are omitted the Get-CsUserDatabaseState cmdlet returns inform ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -100,6 +103,9 @@ Accept wildcard characters: False ``` ### -RegistrarPool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the Registrar pool hosting the user databases whose online status is to be returned. For example: @@ -113,8 +119,7 @@ If both parameters are omitted the Get-CsUserDatabaseState cmdlet returns inform ```yaml Type: Fqdn Parameter Sets: RegistrarPool -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,13 +133,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Get-CsUserDatabaseState cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.Xds.UserStoreState The Get-CsUserDatabaseState cmdlet returns instances of the Microsoft.Rtc.Management.Xds.UserStoreState object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsUserDelegates.md b/skype/skype-ps/SkypeForBusiness/Get-CsUserDelegates.md similarity index 96% rename from skype/skype-ps/skype/Get-CsUserDelegates.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUserDelegates.md index 414d0cf5f2..861f3ac3b8 100644 --- a/skype/skype-ps/skype/Get-CsUserDelegates.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUserDelegates.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csuserdelegates applicable: Skype for Business Server 2019 -title: Get-CsUserDelegates -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csuserdelegates +schema: 2.0.0 +title: Get-CsUserDelegates --- # Get-CsUserDelegates @@ -44,6 +45,9 @@ This example returns the list of delegates for the specified user ## PARAMETERS ### -User + +> Applicable: Skype for Business Server 2019CU1 + Specifies the identity of the target user. Acceptable values include: Example: jphillips@contoso.com @@ -53,7 +57,6 @@ Example: sip:jphillips@contoso.com Type: String Parameter Sets: (All) Aliases: DisplayName, SipAddress, Identity -Applicable: Skype for Business Server 2019CU1 Required: True Position: 0 diff --git a/skype/skype-ps/skype/Get-CsUserLocationStatus.md b/skype/skype-ps/SkypeForBusiness/Get-CsUserLocationStatus.md similarity index 93% rename from skype/skype-ps/skype/Get-CsUserLocationStatus.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUserLocationStatus.md index 88057a3b23..9d6f639d56 100644 --- a/skype/skype-ps/skype/Get-CsUserLocationStatus.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUserLocationStatus.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csuserlocationstatus applicable: Skype for Business Online -title: Get-CsUserLocationStatus -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/get-csuserlocationstatus +schema: 2.0.0 +title: Get-CsUserLocationStatus --- # Get-CsUserLocationStatus @@ -29,7 +31,7 @@ The `Get-CsUserLocationStatus` tracks the progress of the cross region move and ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` PS C:\> Get-CsUserLocationStatus -Identity PilarA@contoso.com ``` @@ -38,23 +40,10 @@ This example tracks the progress of the cross region move for PilarA@contoso.com ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +### -Identity -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Online -### -Identity Indicates the Identity of the user account to be verified. User Identities can be specified using one of four formats: 1) the user's SIP address; @@ -66,8 +55,7 @@ You can use the asterisk (\*) wildcard character when using the display name as ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 1 @@ -77,13 +65,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 0 @@ -92,7 +82,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Skype for Business Online + +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 +``` + ### -WhatIf + +> Applicable: Skype for Business Online + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -100,7 +111,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/Get-CsUserPoolInfo.md b/skype/skype-ps/SkypeForBusiness/Get-CsUserPoolInfo.md similarity index 90% rename from skype/skype-ps/skype/Get-CsUserPoolInfo.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUserPoolInfo.md index dc820faa56..e8dceda300 100644 --- a/skype/skype-ps/skype/Get-CsUserPoolInfo.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUserPoolInfo.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csuserpoolinfo applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsUserPoolInfo -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csuserpoolinfo +schema: 2.0.0 +title: Get-CsUserPoolInfo --- # Get-CsUserPoolInfo @@ -48,13 +49,13 @@ Note that replica information will be shown only if the user's primary pool has ## EXAMPLES -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 1 ``` Get-CsUserPoolInfo "sip:kenmyer@litwareinc.com" ``` This command returns user pool information for a single user: the user with the SIP address sip:kenmyer@litwareinc.com. -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 2 ``` Get-CsUser | Get-CsUserPoolInfo ``` @@ -63,7 +64,7 @@ In Example 2, user pool information is returned for all the users who have been To carry out this task, the command first calls the Get-CsUser cmdlet without any parameters in order to return a collection of all the users enabled for Skype for Business Server. This collection is then piped to the Get-CsUserPoolInfo cmdlet, which displays pool information for each user in the collection. -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 3 ``` Get-CsUser | Where-Object {$_.RegistrarPool -ne $Null} | Get-CsUserPoolInfo ``` @@ -77,7 +78,7 @@ To suppress the error message, Example 3 again uses the Get-CsUser cmdlet to ret This time, however, the collection is piped to the Where-Object cmdlet, which picks out only users where the RegistrarPool property is not equal to a null value. (In other words, users who have been assigned a Registrar pool.) That filtered collection is then piped to the Get-CsUserPoolInfo cmdlet, which displays pool information for each user in the filtered collection. -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 4 ``` Get-CsUser -Filter {RegistrarPool -eq "redmond-cs-001.litwareinc.com"} | Get-CsUserPoolInfo ``` @@ -87,7 +88,7 @@ To do this, the Get-CsUser cmdlet is called along with the Filter parameter; the That collection is then piped to the Get-CsUserPoolInfo cmdlet, which retrieves pool information for each user in the collection. -### -------------------------- EXAMPLE -------------------------- +### EXAMPLE 5 ``` Get-CsUser | Get-CsUserPoolInfo | Where-Object {$_.BackupPoolFqdn -eq $Null} ``` @@ -97,7 +98,7 @@ To carry out this task, the command first calls the Get-CsUser cmdlet to return That information is then piped to the Get-CsUserPoolInfo cmdlet, which retrieves pool information for each user in the collection. Finally, that pool information is piped to the Where-Object cmdlet, which displays data only for those users where the BackupPoolFqdn property is equal to a null value. -### -------------------------- Example ------------------------ +### Example 6 ``` Get-CsUserPoolInfo "Ken Myer" | Select-Object -Expand PrimaryPoolMachinesInPreferredOrder ``` @@ -111,6 +112,9 @@ Expanding a property means that all of the values stored in that property are di ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user whose user pool information is to be retrieved. Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory Domain Services display name (for example, Ken Myer). You can also reference a user account by using the user's Active Directory distinguished name. @@ -123,8 +127,7 @@ For example, the Identity "\* Smith" returns information for users who have a la ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -134,6 +137,9 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the user pool information from the local replica of the Central Management store rather than from the Central Management store itself. @@ -141,8 +147,7 @@ Retrieves the user pool information from the local replica of the Central Manage ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -156,14 +161,16 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -String or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. -The Get-CsUserPoolInfo cmdlet accepts a pipelined string value representing the SamAccountName of a user account that has been enabled for Skype for Business Server. +### System.String +The Get-CsUserPoolInfo cmdlet accepts a pipelined string value representing the SamAccountName of a +user account that has been enabled for Skype for Business Server. + +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The cmdlet also accepts pipelined instances of the Active Directory user object. ## OUTPUTS -### +### Microsoft.Rtc.Management.Xds.GetOCsUserPoolInfoCmdlet+UserInformation The Get-CsUserPoolInfo cmdlet returns instances of the Microsoft.Rtc.Management.Xds.GetOCsUserPoolInfoCmdlet+UserInformation object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsUserPstnSettings.md b/skype/skype-ps/SkypeForBusiness/Get-CsUserPstnSettings.md similarity index 93% rename from skype/skype-ps/skype/Get-CsUserPstnSettings.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUserPstnSettings.md index 0db2a2b553..e3634500ef 100644 --- a/skype/skype-ps/skype/Get-CsUserPstnSettings.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUserPstnSettings.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csuserpstnsettings applicable: Skype for Business Online -title: Get-CsUserPstnSettings -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/get-csuserpstnsettings +schema: 2.0.0 +title: Get-CsUserPstnSettings --- # Get-CsUserPstnSettings @@ -34,7 +36,7 @@ Get-CsAdminRole | Where-Object {$_.Cmdlets -Match "\"} ## EXAMPLES -### -------------------------- Example -------------------------- +### Example ``` Get-CsUserPstnSettings -Identity jphillips@contoso.com -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" ``` @@ -45,6 +47,9 @@ This example returns the PSTN settings for the specified user and tenant. ## PARAMETERS ### -Identity + +> Applicable: Skype for Business Online + Specifies the identity of the target user. Acceptable values include: @@ -57,8 +62,7 @@ Example: 98403f08-577c-46dd-851a-f0460a13b03d ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 1 @@ -67,14 +71,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. +### -Tenant + +> Applicable: Skype for Business Online + +Specifies the global unique identifier (GUID) of the Skype for Business Online tenant account on which the cmdlet will operate. +For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308". + +You can find the tenant ID for your Skype for Business Online tenants by running this command: Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will be determined by your connection and credentials. +The Tenant parameter is primarily for use in a hybrid deployment. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -83,21 +96,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Specifies the global unique identifier (GUID) of the Skype for Business Online tenant account on which the cmdlet will operate. -For example: -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308". +### -Confirm -You can find the tenant ID for your Skype for Business Online tenants by running this command: Get-CsTenant | Select-Object DisplayName, TenantID +> Applicable: Skype for Business Online -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. -Instead, the tenant ID will be determined by your connection and credentials. -The Tenant parameter is primarily for use in a hybrid deployment. +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -107,6 +115,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -114,7 +125,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named @@ -128,12 +138,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### UserPstnSettings The Get-CsUserPstnSettings cmdlet returns instances of the UserPstnSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsUserReplicatorConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsUserReplicatorConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsUserReplicatorConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUserReplicatorConfiguration.md index 479833bdf5..e8b7ba9bca 100644 --- a/skype/skype-ps/skype/Get-CsUserReplicatorConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUserReplicatorConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csuserreplicatorconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsUserReplicatorConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csuserreplicatorconfiguration +schema: 2.0.0 +title: Get-CsUserReplicatorConfiguration --- # Get-CsUserReplicatorConfiguration @@ -59,7 +60,7 @@ The Get-CsUserReplicatorConfiguration cmdlet enables administrators to return in ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsUserReplicatorConfiguration ``` @@ -70,8 +71,33 @@ The command shown in Example 1 returns information about all the User Replicator ## PARAMETERS +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards when specifying the collection (or collections) of User Replicator configuration settings to be returned. +For example, this command returns all the settings configured at the service scope: + +-Filter "service:*" + + + +```yaml +Type: String +Parameter Sets: Filter +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the User Replicator configuration settings to be returned. To return settings at the service scope, use syntax similar to this: @@ -89,8 +115,7 @@ If this parameter is not specified then all the User Replicator configurations s ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -99,35 +124,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards when specifying the collection (or collections) of User Replicator configuration settings to be returned. -For example, this command returns all the settings configured at the service scope: - --Filter "service:*" - - - -```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LocalStore -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LocalStore Retrieves the User Replicator configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,13 +147,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Get-CsUserReplicatorConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.UserReplicator.UserReplicatorConfiguration The Get-CsUserReplicatorConfiguration cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserReplicator.UserReplicatorConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsUserServicesConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsUserServicesConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Get-CsUserServicesConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUserServicesConfiguration.md index 110e94585e..562c46cb90 100644 --- a/skype/skype-ps/skype/Get-CsUserServicesConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUserServicesConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csuserservicesconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsUserServicesConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csuserservicesconfiguration +schema: 2.0.0 +title: Get-CsUserServicesConfiguration --- # Get-CsUserServicesConfiguration @@ -43,7 +44,7 @@ The Get-CsUserServicesConfiguration cmdlet provides a way for administrators to ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsUserServicesConfiguration ``` @@ -52,7 +53,7 @@ The command shown in Example 1 returns a collection of all the User Services con This is achieved by calling the Get-CsUserServicesConfiguration cmdlet without any additional parameters. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUserServicesConfiguration -Identity site:Redmond ``` @@ -60,7 +61,7 @@ Get-CsUserServicesConfiguration -Identity site:Redmond In Example 2, only one collection of User Services configuration settings is returned: the collection with the Identity site:Redmond. Because identities must be unique, this command can never return more than one item. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsUserServicesConfiguration -Filter "service:*" ``` @@ -70,7 +71,7 @@ This is done by calling the Get-CsUserServicesConfiguration cmdlet along with th By definition, those are settings configured at the service scope. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsUserServicesConfiguration | Where-Object {$_.MaxContacts -gt 250} ``` @@ -80,7 +81,7 @@ To do this, the command first calls the Get-CsUserServicesConfiguration cmdlet w That collection is then piped to the Where-Object cmdlet, which picks out only those settings where the MaxContacts property is greater than 250. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsUserServicesConfiguration | Where-Object {$_.AnonymousUserGracePeriod -gt "00:10:00"} ``` @@ -92,59 +93,61 @@ The returned collection is then piped to the Where-Object cmdlet, which selects ## PARAMETERS -### -Identity - -Unique identifier for the User Services configuration settings to be returned. -To return the global settings, use this syntax:. - -`-Identity global` +### -Filter -To return settings configured at the site scope, use syntax similar to this: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-Identity site:Redmond` +Enables you to use wildcards when retrieving one or more collections of User Services configuration settings. +For example, to return all the settings configured at the site scope, use this syntax: -To return settings at the service level, use syntax like this: +`-Filter "site:*"` -`-Identity service:UserServer:atl-cs-001.litwareinc.com` +To return all the settings configured at the service scope, use this syntax: -If this parameter is omitted then the Get-CsUserServicesConfiguration cmdlet returns all the User Services configuration settings currently in use in your organization. +`-Filter "service:*"` ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter +### -Identity -Enables you to use wildcards when retrieving one or more collections of User Services configuration settings. -For example, to return all the settings configured at the site scope, use this syntax: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-Filter "site:*"` +Unique identifier for the User Services configuration settings to be returned. +To return the global settings, use this syntax:. -To return all the settings configured at the service scope, use this syntax: +`-Identity global` -`-Filter "service:*"` +To return settings configured at the site scope, use syntax similar to this: + +`-Identity site:Redmond` + +To return settings at the service level, use syntax like this: + +`-Identity service:UserServer:atl-cs-001.litwareinc.com` + +If this parameter is omitted then the Get-CsUserServicesConfiguration cmdlet returns all the User Services configuration settings currently in use in your organization. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -152,6 +155,8 @@ Accept wildcard characters: False ### -LocalStore +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the User Services configuration data from the local replica of the Central Management store rather than from the Central Management store itself. @@ -159,8 +164,7 @@ Retrieves the User Services configuration data from the local replica of the Cen ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,13 +179,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Get-CsUserServicesConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.UserServicesSettings The Get-CsUserServicesConfiguration cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.UserServicesSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsUserServicesPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsUserServicesPolicy.md similarity index 89% rename from skype/skype-ps/skype/Get-CsUserServicesPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUserServicesPolicy.md index 2feb41556d..186e70662c 100644 --- a/skype/skype-ps/skype/Get-CsUserServicesPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUserServicesPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csuserservicespolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsUserServicesPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-csuserservicespolicy +schema: 2.0.0 +title: Get-CsUserServicesPolicy --- # Get-CsUserServicesPolicy @@ -52,14 +54,14 @@ Skype for Business Server Control Panel: The functions carried out by the Get-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsUserServicesPolicy ``` The command shown in Example 1 returns information about all the User Services policies currently in use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUserServicesPolicy -Identity "site:Redmond" @@ -68,7 +70,7 @@ Get-CsUserServicesPolicy -Identity "site:Redmond" In Example 2, information is returned for a single User Services policy: the policy configured for the Redmond site. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsUserServicesPolicy -Filter "site:*" ``` @@ -77,7 +79,7 @@ Example 3 returns information for all the User Services policies configured at t This is done by including the Filter parameter and the filter value "site:*". -### -------------------------- Example 4 -------------------------- (Skype for Business Server 2015) +### Example 4 (Skype for Business Server 2015) ``` Get-CsUserServicesPolicy | Where-Object {$_.UcsAllowed -eq $False} ``` @@ -89,6 +91,9 @@ That collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcards when specifying the policy (or policies) to be retrieved. For example, this syntax returns all the policies that have been configured at the site scope: @@ -103,8 +108,7 @@ You cannot use both the Filter and the Identity parameters in the same command. ```yaml Type: String Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -114,6 +118,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the policy to be returned. To return the global policy, use this syntax: @@ -139,8 +146,7 @@ If this parameter is not included then all of the user services policies configu ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -150,13 +156,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the user services policy data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -166,6 +174,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When used, retrieves the user services policy for the specified Skype for Business Online tenant. For example: @@ -176,8 +187,7 @@ You should not use the Tenant parameter and the Identity parameter in the same c ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -193,15 +203,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ### None -### -None. +### None The Get-CsUserServicesPolicy cmdlet does not accept pipelined input. ## OUTPUTS -### System.Object - -### +### Microsoft.Rtc.Management.WritableConfig.Policy.UsersServices.UserServicesPolicy The Get-CsUserServicesPolicy cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Policy.UsersServices.UserServicesPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsUserSession.md b/skype/skype-ps/SkypeForBusiness/Get-CsUserSession.md similarity index 91% rename from skype/skype-ps/skype/Get-CsUserSession.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUserSession.md index 8871e70049..0448e84451 100644 --- a/skype/skype-ps/skype/Get-CsUserSession.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUserSession.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csusersession applicable: Skype for Business Online -title: Get-CsUserSession -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/get-csusersession +schema: 2.0.0 +title: Get-CsUserSession --- # Get-CsUserSession @@ -30,7 +32,7 @@ You have to be assigned Skype For Business admin role to run this cmdlet. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsUserSession -User "Ken.Myer@Contoso.com" -StartTime "02/22/2016 07:30:15 PM" ``` @@ -39,32 +41,34 @@ This example returns user session information for Ken Myer from "02/22/2016 07:3 ## PARAMETERS -### -StartTime -Specifies the start date, time and offset of the date range. +### -EndTime + +> Applicable: Skype for Business Online + +Specifies the end date, time and offset of the date range. ```yaml Type: DateTimeOffset Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -User -Specifies the user whose session data will be retrieved. -The input format is any form of user URI defined in Skype for Business Online. -For instance: `-User "Ken.Myer@Contoso.com"`. +### -StartTime + +> Applicable: Skype for Business Online + +Specifies the start date, time and offset of the date range. ```yaml -Type: String +Type: DateTimeOffset Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: True Position: Named @@ -73,16 +77,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EndTime -Specifies the end date, time and offset of the date range. +### -User + +> Applicable: Skype for Business Online + +Specifies the user whose session data will be retrieved. +The input format is any form of user URI defined in Skype for Business Online. +For instance: `-User "Ken.Myer@Contoso.com"`. ```yaml -Type: DateTimeOffset +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -94,12 +102,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.Hosted.Data.UserSession The Get-CsUserSession cmdlet returns an instance of the Microsoft.Rtc.Management.Hosted.Data.UserSession object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsUserSettingsPageConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsUserSettingsPageConfiguration.md similarity index 98% rename from skype/skype-ps/skype/Get-CsUserSettingsPageConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUserSettingsPageConfiguration.md index f92d47dd5f..ff2e2addb1 100644 --- a/skype/skype-ps/skype/Get-CsUserSettingsPageConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUserSettingsPageConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csusersettingspageconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsUserSettingsPageConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-csusersettingspageconfiguration +schema: 2.0.0 +title: Get-CsUserSettingsPageConfiguration --- # Get-CsUserSettingsPageConfiguration diff --git a/skype/skype-ps/skype/Get-CsUserTeamMembers.md b/skype/skype-ps/SkypeForBusiness/Get-CsUserTeamMembers.md similarity index 96% rename from skype/skype-ps/skype/Get-CsUserTeamMembers.md rename to skype/skype-ps/SkypeForBusiness/Get-CsUserTeamMembers.md index a5584e71ca..b9ae44f5cb 100644 --- a/skype/skype-ps/skype/Get-CsUserTeamMembers.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsUserTeamMembers.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csuserteammembers applicable: Skype for Business Server 2019 -title: Get-CsUserTeamMembers -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csuserteammembers +schema: 2.0.0 +title: Get-CsUserTeamMembers --- # Get-CsUserTeamMembers @@ -45,6 +46,9 @@ This example returns the list of team members for the specified user and display ## PARAMETERS ### -User + +> Applicable: Skype for Business Server 2019CU1 + Specifies the identity of the target user. Acceptable values include: Example: jphillips@contoso.com @@ -54,7 +58,6 @@ Example: sip:jphillips@contoso.com Type: String Parameter Sets: (All) Aliases: DisplayName, SipAddress, Identity -Applicable: Skype for Business Server 2019CU1 Required: True Position: 0 diff --git a/skype/skype-ps/skype/Get-CsVideoInteropServerConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsVideoInteropServerConfiguration.md similarity index 92% rename from skype/skype-ps/skype/Get-CsVideoInteropServerConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsVideoInteropServerConfiguration.md index 66425ce2e9..4005c42487 100644 --- a/skype/skype-ps/skype/Get-CsVideoInteropServerConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsVideoInteropServerConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csvideointeropserverconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsVideoInteropServerConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csvideointeropserverconfiguration +schema: 2.0.0 +title: Get-CsVideoInteropServerConfiguration --- # Get-CsVideoInteropServerConfiguration @@ -51,14 +52,14 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVideoInteropServerConfiguration ``` This example returns information about all the VIS configuration settings in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVideoInteropServerConfiguration -Identity "site:Redmond" ``` @@ -66,7 +67,7 @@ Get-CsVideoInteropServerConfiguration -Identity "site:Redmond" This example returns information for the collection of VIS configurations that are scoped to the Redmond site. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVideoInteropServerConfiguration -Filter "site:*" ``` @@ -74,7 +75,7 @@ Get-CsVideoInteropServerConfiguration -Filter "site:*" This example returns all the VIS collections configured at the site scope by including the Filter value "site:*". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsVideoInteropServerConfiguration | Where-Object {$_.EnableEnhancedVideoExperience -eq $True} ``` @@ -87,6 +88,9 @@ That collection is then piped to the Where-Object cmdlet, which picks out only t ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return one or more collections of VIS configuration settings. For example, to return all the settings that have been configured at the site scope use the following syntax: @@ -97,8 +101,7 @@ The Filter and the Identity parameters are mutually exclusive. ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -108,6 +111,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identity assigned to the VIS configuration when it was created. VIS settings can be configured at the global, site, or service scope (for the VideoInteropServer service only). To refer to the global instance, use this syntax: @@ -126,8 +132,7 @@ If neither the Identity nor the Filter parameter is specified, then the Get-CsVi ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -137,13 +142,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the VIS configuration from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -157,13 +164,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Get-CsVideoInteropServerConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.VideoInteropServer.VideoInteropServerConfiguration The Get-CsVideoInteropServerConfiguration cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.VideoInteropServer.VideoInteropServerConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsVideoInteropServerSyntheticTransactionConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsVideoInteropServerSyntheticTransactionConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Get-CsVideoInteropServerSyntheticTransactionConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsVideoInteropServerSyntheticTransactionConfiguration.md index 007084aa59..2acd9ec1ce 100644 --- a/skype/skype-ps/skype/Get-CsVideoInteropServerSyntheticTransactionConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsVideoInteropServerSyntheticTransactionConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csvideointeropserversynthetictransactionconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsVideoInteropServerSyntheticTransactionConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csvideointeropserversynthetictransactionconfiguration +schema: 2.0.0 +title: Get-CsVideoInteropServerSyntheticTransactionConfiguration --- # Get-CsVideoInteropServerSyntheticTransactionConfiguration @@ -35,7 +36,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVideoInteropServerSyntheticTransactionConfiguration -Identity "site:Redmond" ``` @@ -45,6 +46,9 @@ This example returns the Video Interop Server synthetic transaction configuratio ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return one or more collections of VIS configuration settings. For example, to return all the settings that have been configured at the site scope use the following syntax: @@ -55,8 +59,7 @@ The Filter and the Identity parameters are mutually exclusive. ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The Video Interop Server (VIS) synthetic transaction configuration to be retrieved. Wildcard characters such as the asterisk (*) cannot be used with the Identity parameter. @@ -76,8 +82,7 @@ If neither the Identity nor the Filter parameter is specified, then the Get-CsVi ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -87,13 +92,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the VIS configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -107,12 +114,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None +### None ## OUTPUTS -### +### VideoInteropServerSyntheticTransactionConfiguration Returns an object array, or single instance (if used with the Identity parameter) of the VideoInteropServerSyntheticTransactionConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsVideoTrunk.md b/skype/skype-ps/SkypeForBusiness/Get-CsVideoTrunk.md similarity index 89% rename from skype/skype-ps/skype/Get-CsVideoTrunk.md rename to skype/skype-ps/SkypeForBusiness/Get-CsVideoTrunk.md index b6024c0dac..981536af1b 100644 --- a/skype/skype-ps/skype/Get-CsVideoTrunk.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsVideoTrunk.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csvideotrunk applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsVideoTrunk -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csvideotrunk +schema: 2.0.0 +title: Get-CsVideoTrunk --- # Get-CsVideoTrunk @@ -41,21 +42,21 @@ To return a list of all the role-based access control (RBAC) roles that can run ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVideoTrunk ``` This example returns information about all the video trunks configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVideoTrunk -Identity "VideoTrunk:192.168.0.240" ``` This example returns information for a single video trunk with the identity "VideoTrunk:192.168.0.240". -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVideoTrunk -Filter "VideoTrunk:192.168*" ``` @@ -67,13 +68,15 @@ The filter value "VideoTrunk:192.168*" limits the returned data to video trunks ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return a video trunk (or a collection of video trunks). ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -83,6 +86,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the video trunk to be returned. For example: @@ -96,8 +102,7 @@ If this parameter is not specified, then all the video trunks in the organizatio ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -PoolFqdn + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the trunk as defined in the topology. For example: @@ -115,8 +123,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -130,13 +137,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Get-CsVideoTrunk cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.Xds.DisplayVideoGateway#Decorated The Get-CsVideoTrunk cmdlet returns instances of the Microsoft.Rtc.Management.Xds.DisplayVideoGateway#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsVideoTrunkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsVideoTrunkConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Get-CsVideoTrunkConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsVideoTrunkConfiguration.md index fc9b683da3..7574ebc8da 100644 --- a/skype/skype-ps/skype/Get-CsVideoTrunkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsVideoTrunkConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csvideotrunkconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsVideoTrunkConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csvideotrunkconfiguration +schema: 2.0.0 +title: Get-CsVideoTrunkConfiguration --- # Get-CsVideoTrunkConfiguration @@ -54,7 +55,7 @@ However, administrators can use the New-CsVideoTrunkConfiguration cmdlet to crea ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVideoTrunkConfiguration ``` @@ -62,7 +63,7 @@ Get-CsVideoTrunkConfiguration This example returns information about all the Video Trunk configurations in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVideoTrunkConfiguration -Identity "site:Seattle" ``` @@ -70,7 +71,7 @@ Get-CsVideoTrunkConfiguration -Identity "site:Seattle" This example returns information for a collection of Video Trunk configuration settings scoped to the Seattle site. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVideoTrunkConfiguration -Filter "site:*" ``` @@ -78,7 +79,7 @@ Get-CsVideoTrunkConfiguration -Filter "site:*" This example returns all the Video Trunk configurations configured at the site scope. This is done by including the Filter parameter and the filter value "site:*". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsVideoTrunkConfiguration | Where-Object {$_.EnableSessionTimer -eq $True} ``` @@ -91,14 +92,16 @@ That collection is then piped to the Where-Object cmdlet, which filters the outp ## PARAMETERS ### -Filter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The Filter parameter enables you to use wildcard characters in order to return one or more collections of Video Interop Server configuration settings. For example, to return all the settings that have been configured at the site scope use the following syntax: -Filter "site:*" ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -108,6 +111,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The Identity parameter specifies the Video Trunk configuration to retrieve. Video Trunk configuration settings can be configured at the global, site, or service scope (for the VideoGateway service only). To refer to the global instance, use this syntax: -Identity "global" @@ -122,8 +128,7 @@ If neither the Identity nor the Filter parameter is specified then the Get-CsVid ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -133,13 +138,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the Video Trunk configuration data from the local copy of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -153,13 +160,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Get-CsVideoTrunkConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.VideoTrunkConfiguration The Get-CsVideoTrunkConfiguration cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.VideoTrunkConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsVoiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsVoiceConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Get-CsVoiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsVoiceConfiguration.md index 862ecb0444..d80b031855 100644 --- a/skype/skype-ps/skype/Get-CsVoiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsVoiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csvoiceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsVoiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csvoiceconfiguration +schema: 2.0.0 +title: Get-CsVoiceConfiguration --- # Get-CsVoiceConfiguration @@ -39,7 +40,7 @@ To retrieve individual voice test configurations or to retrieve them as individu ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVoiceConfiguration ``` @@ -49,47 +50,53 @@ To retrieve the voice test configurations, use the Get-CsVoiceTestConfiguration ## PARAMETERS -### -Identity -The scope of the voice configuration to retrieve. -The only possible value is Global. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +There can only be one instance of this object, so this parameter does nothing. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -There can only be one instance of this object, so this parameter does nothing. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The scope of the voice configuration to retrieve. +The only possible value is Global. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the voice configuration from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -103,12 +110,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration This cmdlet returns an instance of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsVoiceNormalizationRule.md b/skype/skype-ps/SkypeForBusiness/Get-CsVoiceNormalizationRule.md similarity index 86% rename from skype/skype-ps/skype/Get-CsVoiceNormalizationRule.md rename to skype/skype-ps/SkypeForBusiness/Get-CsVoiceNormalizationRule.md index 9747b6b836..5fe90f5391 100644 --- a/skype/skype-ps/skype/Get-CsVoiceNormalizationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsVoiceNormalizationRule.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csvoicenormalizationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsVoiceNormalizationRule -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-csvoicenormalizationrule +schema: 2.0.0 +title: Get-CsVoiceNormalizationRule --- # Get-CsVoiceNormalizationRule @@ -41,7 +43,7 @@ The same rules accessed by this cmdlet can also be accessed through the Normaliz ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVoiceNormalizationRule ``` @@ -49,14 +51,14 @@ Get-CsVoiceNormalizationRule This example retrieves all voice normalization rules defined for the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVoiceNormalizationRule -Filter site* ``` Example 2 retrieves all voice normalization rules specified for all sites. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVoiceNormalizationRule -Filter *s* ``` @@ -65,7 +67,7 @@ Example 3 retrieves all voice normalization rules with the letter s anywhere in For example, this will return all site- and service-level rules, as well as per-user rules with an s in the scope name, such as RedmondEastUsers. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsVoiceNormalizationRule | Where-Object {$_.Name -match "seattle"} ``` @@ -77,49 +79,55 @@ We then pipe this collection to the Where-Object cmdlet to find all the items in ## PARAMETERS -### -Identity -A unique identifier for the rule. -If a value is specified for this parameter, it must be in the format scope/name; for example, site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Uses wildcard strings to return a collection of normalization rules based on Identity. +Note that Filter works only on the scope portion of the Identity, not on the name. +For example, the filter value *lob* will return all rules at the global scope (scopes that contain the letters lob), but not a rule with the identity site:Redmond/lobby, where lob is only in the name portion of the identity, not the scope. ```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter, (All) +Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Uses wildcard strings to return a collection of normalization rules based on Identity. -Note that Filter works only on the scope portion of the Identity, not on the name. -For example, the filter value *lob* will return all rules at the global scope (scopes that contain the letters lob), but not a rule with the identity site:Redmond/lobby, where lob is only in the name portion of the identity, not the scope. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier for the rule. +If a value is specified for this parameter, it must be in the format scope/name; for example, site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name. ```yaml -Type: String -Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: (All) +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the voice normalization rule from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -129,13 +137,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + For internal Microsoft usage. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -149,14 +159,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### System.Object - -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule The Get-CsVoiceNormalizationRule cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsVoicePolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsVoicePolicy.md similarity index 85% rename from skype/skype-ps/skype/Get-CsVoicePolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsVoicePolicy.md index ee4a8eb0cb..a066cfa8f3 100644 --- a/skype/skype-ps/skype/Get-CsVoicePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsVoicePolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csvoicepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsVoicePolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-csvoicepolicy +schema: 2.0.0 +title: Get-CsVoicePolicy --- # Get-CsVoicePolicy @@ -40,7 +42,7 @@ Use this cmdlet to retrieve the settings that enable and disable many of these f ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVoicePolicy ``` @@ -49,7 +51,7 @@ This example displays all the voice policies that have been defined for an organ -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVoicePolicy -Identity UserPolicy1 ``` @@ -57,7 +59,7 @@ Get-CsVoicePolicy -Identity UserPolicy1 This example uses the Identity parameter to retrieve the voice policy settings for the per-user policy named UserPolicy1. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVoicePolicy -Filter tag* ``` @@ -69,41 +71,43 @@ All per-user voice policies have an Identity in the format tag:\ Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter accepts a wildcard string and returns all voice policies with identities matching that string. +For example, a Filter value of tag:* will return all voice policies defined at the per-user level. ```yaml -Type: XdsIdentity -Parameter Sets: Identity, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter, (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter +### -Identity -This parameter accepts a wildcard string and returns all voice policies with identities matching that string. -For example, a Filter value of tag:* will return all voice policies defined at the per-user level. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier specifying the scope and, in some cases the name, of the policy. +If this parameter is omitted, all voice policies for the organization are returned. ```yaml -Type: String -Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity, (All) +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -111,14 +115,15 @@ Accept wildcard characters: False ### -LocalStore +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the voice policy from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -129,6 +134,8 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Office 365 tenant account whose voice policy is to be retrieved. For example: @@ -142,8 +149,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -157,12 +163,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoicePolicy This cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoicePolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsVoiceRoute.md b/skype/skype-ps/SkypeForBusiness/Get-CsVoiceRoute.md similarity index 86% rename from skype/skype-ps/skype/Get-CsVoiceRoute.md rename to skype/skype-ps/SkypeForBusiness/Get-CsVoiceRoute.md index f66706f65e..89106ee099 100644 --- a/skype/skype-ps/skype/Get-CsVoiceRoute.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsVoiceRoute.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csvoiceroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsVoiceRoute -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csvoiceroute +schema: 2.0.0 +title: Get-CsVoiceRoute --- # Get-CsVoiceRoute @@ -41,7 +42,7 @@ The PSTN usage associates the voice route to a voice policy. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVoiceRoute ``` @@ -49,7 +50,7 @@ Get-CsVoiceRoute Retrieves the properties for all voice routes defined within the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVoiceRoute -Identity Route1 ``` @@ -57,7 +58,7 @@ Get-CsVoiceRoute -Identity Route1 Retrieves the properties for the Route1 voice route. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVoiceRoute -Filter *test* ``` @@ -66,7 +67,7 @@ This command displays voice route settings where the Identity contains the strin To find the string test only at the end of the Identity, use the value \*test. Similarly, to find the string test only if it occurs at the beginning of the Identity, specify the value test\*. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsVoiceRoute | Where-Object {$_.PstnGatewayList.Count -eq 0} ``` @@ -81,47 +82,53 @@ If the count of PSTN gateways is 0, the list is empty and no gateways have been ## PARAMETERS -### -Identity -A string that uniquely identifies the voice route. -If no identity is provided, all voice routes for the organization are returned. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter filters the results of the Get operation based on the wildcard value passed to this parameter. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -This parameter filters the results of the Get operation based on the wildcard value passed to this parameter. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A string that uniquely identifies the voice route. +If no identity is provided, all voice routes for the organization are returned. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the voice route from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,12 +142,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route This cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsVoiceRoutingPolicy.md b/skype/skype-ps/SkypeForBusiness/Get-CsVoiceRoutingPolicy.md similarity index 88% rename from skype/skype-ps/skype/Get-CsVoiceRoutingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Get-CsVoiceRoutingPolicy.md index 05f3448032..65475d83ec 100644 --- a/skype/skype-ps/skype/Get-CsVoiceRoutingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsVoiceRoutingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csvoiceroutingpolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsVoiceRoutingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/get-csvoiceroutingpolicy +schema: 2.0.0 +title: Get-CsVoiceRoutingPolicy --- # Get-CsVoiceRoutingPolicy @@ -41,21 +43,21 @@ The functions carried out by the Get-CsVoiceRoutingPolicy cmdlet are not availab ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVoiceRoutingPolicy ``` The command shown in Example 1 returns information for all the voice routing policies configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVoiceRoutingPolicy -Identity "RedmondVoiceRoutingPolicy" ``` In Example 2, information is returned for a single voice routing policy: the policy with the Identity RedmondVoiceRoutingPolicy. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVoiceRoutingPolicy -Filter "tag:*" ``` @@ -63,7 +65,7 @@ Get-CsVoiceRoutingPolicy -Filter "tag:*" The command shown in Example 3 returns information about all the voice routing policies configured at the per-user scope. To do this, the command uses the Filter parameter and the filter value "tag:*"; that filter value limits the returned data to policies that have an Identity that begins with the string value "tag:". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsVoiceRoutingPolicy | Where-Object {$_.PstnUsages -contains "Long Distance"} ``` @@ -72,7 +74,7 @@ In Example 4, information is returned only for those voice routing policies that To carry out this task, the command first calls Get-CsVoiceRoutingPolicy without any parameters; that returns a collection of all the voice routing policies configured for use in the organization. This collection is then piped to the Where-Object cmdlet, which picks out only those policies where the PstnUsages property includes (-contains) the usage "Long Distance". -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsVoiceRoutingPolicy | Where-Object {$_.PstnUsages -notcontains "Long Distance"} ``` @@ -83,6 +85,9 @@ In order to do that, the Where-Object cmdlet uses the -notcontains operator, whi ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcards when retrieving one or more voice routing policies. For example, to return all the policies configured at the per-user scope, use this syntax: @@ -91,8 +96,7 @@ For example, to return all the policies configured at the per-user scope, use th ```yaml Type: String Parameter Sets: Filter, (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -102,6 +106,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the voice routing policy to be retrieved. To return the global policy, use this syntax: @@ -118,8 +125,7 @@ If neither the Identity nor the Filter parameters are specified, then Get-CsVoic ```yaml Type: XdsIdentity Parameter Sets: Identity, (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -129,13 +135,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the voice policy data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -149,13 +157,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Get-CsVoiceRoutingPolicy cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceRoutingPolicy The Get-CsVoiceRoutingPolicy cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceRoutingPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsVoiceTestConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsVoiceTestConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Get-CsVoiceTestConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsVoiceTestConfiguration.md index 3ebb3b103b..733b0ff498 100644 --- a/skype/skype-ps/skype/Get-CsVoiceTestConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsVoiceTestConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csvoicetestconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsVoiceTestConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csvoicetestconfiguration +schema: 2.0.0 +title: Get-CsVoiceTestConfiguration --- # Get-CsVoiceTestConfiguration @@ -39,7 +40,7 @@ You can do this testing by retrieving a test configuration with this cmdlet, and ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVoiceTestConfiguration ``` @@ -47,7 +48,7 @@ Get-CsVoiceTestConfiguration Retrieves all the voice test configuration settings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVoiceTestConfiguration | Select-Object Identity, DialedNumber, ExpectedTranslatedNumber ``` @@ -56,7 +57,7 @@ This example retrieves all the voice test configuration settings, displaying onl The settings returned by the Get-CsVoiceTestConfiguration cmdlet are piped to the Select-Object cmdlet, where the output is narrowed down to the Identity, DialedNumber, and ExpectedTranslatedNumber properties. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVoiceTestConfiguration -Filter *test* ``` @@ -69,47 +70,53 @@ For example, this command would return voice test configurations with names such ## PARAMETERS -### -Identity -A string uniquely identifying the test configuration you want to retrieve. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter provides a way to do a wildcard search of the defined voice test configurations. +(For details, see the examples in this topic.) ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -This parameter provides a way to do a wildcard search of the defined voice test configurations. -(For details, see the examples in this topic.) +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A string uniquely identifying the test configuration you want to retrieve. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the voice test configuration from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -123,12 +130,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration Returns one of more objects of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsVoicemailReroutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsVoicemailReroutingConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Get-CsVoicemailReroutingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsVoicemailReroutingConfiguration.md index 18b12a31a4..026f914224 100644 --- a/skype/skype-ps/skype/Get-CsVoicemailReroutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsVoicemailReroutingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csvoicemailreroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsVoicemailReroutingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csvoicemailreroutingconfiguration +schema: 2.0.0 +title: Get-CsVoicemailReroutingConfiguration --- # Get-CsVoicemailReroutingConfiguration @@ -44,7 +45,7 @@ Calling this cmdlet with no parameters will return all voice mail rerouting conf ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVoicemailReroutingConfiguration ``` @@ -52,7 +53,7 @@ Get-CsVoicemailReroutingConfiguration This example retrieves all of the voice mail rerouting configuration settings defined in this deployment of Skype for Business Server 2015. For example, if there are three branch offices where a Survivable Branch Appliance is deployed, this command will return three voice mail rerouting configuration sets. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVoicemailReroutingConfiguration -Identity site:BranchOffice_Portland ``` @@ -60,7 +61,7 @@ Get-CsVoicemailReroutingConfiguration -Identity site:BranchOffice_Portland This example retrieves the voice mail rerouting configuration settings for the site BranchOffice_Portland. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVoicemailReroutingConfiguration -Filter *:BranchOffice* ``` @@ -68,7 +69,7 @@ Get-CsVoicemailReroutingConfiguration -Filter *:BranchOffice* This example retrieves all the voice mail rerouting settings for all sites with site names beginning with the string BranchOffice (for example, BranchOffice_Portland, BranchOffice_Sacramento). -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsVoicemailReroutingConfiguration | Where-Object {$_.Enabled -eq $False} ``` @@ -81,47 +82,53 @@ The Where-Object cmdlet narrows that collection down to include only the configu ## PARAMETERS -### -Identity -The unique identifier of the configuration you want to retrieve. -For this cmdlet the Identity will be either Global or Site:\, where \ is the name of the site to which the settings are applied. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Filter parameter allows you to retrieve configuration settings for a particular set of sites based on wildcard matching. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -The Filter parameter allows you to retrieve configuration settings for a particular set of sites based on wildcard matching. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the configuration you want to retrieve. +For this cmdlet the Identity will be either Global or Site:\, where \ is the name of the site to which the settings are applied. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the voice mail rerouting configuration from the local replica of the Central Management store, rather than the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,12 +142,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.ExumRouting.VoicemailReroutingConfiguration Retrieves one or more objects of type Microsoft.Rtc.Management.WritableConfig.Settings.ExumRouting.VoicemailReroutingConfiguration. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsWatcherNodeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsWatcherNodeConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Get-CsWatcherNodeConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsWatcherNodeConfiguration.md index f8c31c4d96..bddd50e29c 100644 --- a/skype/skype-ps/skype/Get-CsWatcherNodeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsWatcherNodeConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cswatchernodeconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsWatcherNodeConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cswatchernodeconfiguration +schema: 2.0.0 +title: Get-CsWatcherNodeConfiguration --- # Get-CsWatcherNodeConfiguration @@ -48,7 +49,7 @@ Skype for Business Server Control Panel: The functions carried out by the Get-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsWatcherNodeConfiguration ``` @@ -56,7 +57,7 @@ Get-CsWatcherNodeConfiguration The command shown in Example 1 returns information about all the watcher nodes currently configured for use in the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsWatcherNodeConfiguration -Identity "atl-cs-001.litwareinc.com" ``` @@ -64,7 +65,7 @@ Get-CsWatcherNodeConfiguration -Identity "atl-cs-001.litwareinc.com" In Example 2, information is returned for the watcher node associated with the pool. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsWatcherNodeConfiguration | Where-Object {$_.TestUsers -contains "sip:kenmyer@litwareinc.com"} ``` @@ -74,7 +75,7 @@ To do this, the command first uses the Get-CsWatcherNodeConfiguration cmdlet to That collection is then piped to the Where-Object cmdlet, which picks out only those nodes where the TestUsers property contains the SIP address sip:kenmyer@litwareinc.com. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsWatcherNodeConfiguration | Where-Object {$_.ExtendedTests -match "TestType=PSTN"} ``` @@ -88,6 +89,9 @@ That collection is then piped to the Where-Object cmdlet, which selects only tho ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use wildcard characters in order to return one or more watcher nodes. For example, to return all of the watcher nodes for the domain litwareinc.com use this syntax: @@ -96,8 +100,7 @@ For example, to return all of the watcher nodes for the domain litwareinc.com us ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -108,6 +111,8 @@ Accept wildcard characters: False ### -Identity +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the pool that the watcher node has been assigned to. For example: @@ -120,8 +125,7 @@ If this parameter is not specified then the Get-CsWatcherNodeConfiguration cmdle ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -131,13 +135,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the watcher node configuration data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -151,13 +157,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Get-CsWatcherNodeConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.TargetPool#Decorated The Get-CsWatcherNodeConfiguration cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.TargetPool#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsWebServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsWebServiceConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Get-CsWebServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsWebServiceConfiguration.md index 0955ecea76..f60b6c4506 100644 --- a/skype/skype-ps/skype/Get-CsWebServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsWebServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cswebserviceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsWebServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cswebserviceconfiguration +schema: 2.0.0 +title: Get-CsWebServiceConfiguration --- # Get-CsWebServiceConfiguration @@ -43,7 +44,7 @@ The Get-CsWebServiceConfiguration cmdlet enables you to return detailed informat ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Get-CsWebServiceConfiguration ``` @@ -51,7 +52,7 @@ Get-CsWebServiceConfiguration Example 1 returns information about all the Web Services configuration settings currently in use in the organization. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsWebServiceConfiguration -Identity site:Redmond ``` @@ -59,7 +60,7 @@ Get-CsWebServiceConfiguration -Identity site:Redmond The command shown in Example 2 returns information about the Web Services configuration settings that have the Identity site:Redmond. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsWebServiceConfiguration -Filter "site:*" ``` @@ -68,7 +69,7 @@ Example 3 returns all the Web Services configuration settings that have been ass To do this, the Filter parameter is included when calling the Get-CsWebServiceConfiguration cmdlet; the filter value "site:*" ensures that only those settings that have an Identity that begins with the string value "site:" are returned. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsWebServiceConfiguration | Where-Object {$_.UsePinAuth -eq $False} ``` @@ -78,7 +79,7 @@ This is done by first calling the Get-CsWebServiceConfiguration cmdlet to return This collection is then piped to the Where-Object cmdlet, which picks out only those settings where the UsePinAuth property is equal to False. -### -------------------------- Example 5 ------------------------ +### Example 5 ``` Get-CsWebServiceConfiguration | Where-Object {$_.MaxGroupSizeToExpand -gt 100} ``` @@ -91,58 +92,60 @@ This information is then piped to the Where-Object cmdlet, which selects only th ## PARAMETERS -### -Identity - -Unique identifier for the Web Services configuration settings to be returned. -To return the global settings, use this syntax: - --Identity global +### -Filter -To return settings configured at the site scope, use syntax similar to this: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 --Identity "site:Redmond" - -Service-scope settings can be returned using syntax like this: +Enables you to use wildcards when specifying the Web Services configuration settings collection (or collections) to be returned. +For example, this syntax returns all the settings configured at the site scope: --Identity "service:WebServer:atl-cs-001.litwareinc.com" +-Filter "site:*" You cannot use both the Filter and the Identity parameters in the same command. -If you do not specify either parameter, the Get-CsWebServiceConfiguration cmdlet will return all the Web Services settings collections currently in use in your organization. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filter +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter +### -Identity -Enables you to use wildcards when specifying the Web Services configuration settings collection (or collections) to be returned. -For example, this syntax returns all the settings configured at the site scope: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 --Filter "site:*" +Unique identifier for the Web Services configuration settings to be returned. +To return the global settings, use this syntax: + +-Identity global + +To return settings configured at the site scope, use syntax similar to this: + +-Identity "site:Redmond" + +Service-scope settings can be returned using syntax like this: + +-Identity "service:WebServer:atl-cs-001.litwareinc.com" You cannot use both the Filter and the Identity parameters in the same command. +If you do not specify either parameter, the Get-CsWebServiceConfiguration cmdlet will return all the Web Services settings collections currently in use in your organization. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -150,6 +153,8 @@ Accept wildcard characters: False ### -LocalStore +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Retrieves the Web Services configuration data from the local replica of the Central Management store rather than from the Central Management store itself. @@ -157,8 +162,7 @@ Retrieves the Web Services configuration data from the local replica of the Cent ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -172,13 +176,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Get-CsWebServiceConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Web.WebServiceSettings The Get-CsWebServiceConfiguration cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Web.WebServiceSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsWindowsService.md b/skype/skype-ps/SkypeForBusiness/Get-CsWindowsService.md similarity index 89% rename from skype/skype-ps/skype/Get-CsWindowsService.md rename to skype/skype-ps/SkypeForBusiness/Get-CsWindowsService.md index 1141e80426..ea36b653aa 100644 --- a/skype/skype-ps/skype/Get-CsWindowsService.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsWindowsService.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-cswindowsservice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsWindowsService -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-cswindowsservice +schema: 2.0.0 +title: Get-CsWindowsService --- # Get-CsWindowsService @@ -41,7 +42,7 @@ However, by including the ComputerName parameter you can return information abou ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Get-CsWindowsService ``` @@ -51,7 +52,7 @@ This is done by calling the Get-CsWindowsService cmdlet without any parameters. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsWindowsService | Format-List ``` @@ -62,7 +63,7 @@ In the default, tabular view, only a subset of property values is displayed.) To -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsWindowsService -Name "RTCSrv" ``` @@ -71,7 +72,7 @@ Example 3 returns information for a single Skype for Business Server service: th -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsWindowsService -Name "RTCSrv" | Select-Object -ExpandProperty RoleName @@ -83,7 +84,7 @@ This information is then piped to the Select-Object cmdlet, which uses the Expan Note that this command will return an error message if a service does not have a role name. -### -------------------------- Example 5 ------------------------ +### Example 5 ``` Get-CsWindowsService -Computer atl-cs-001.litwareinc.com ``` @@ -93,7 +94,7 @@ This is done by including the ComputerName parameter followed by the FQDN of the -### -------------------------- Example 6 ------------------------ +### Example 6 ``` Get-CsWindowsService -Report C:\Logs\Services.html ``` @@ -104,7 +105,7 @@ If the Get-CsWindowsService cmdlet encounters any problems in retrieving service -### -------------------------- Example 7 ------------------------ +### Example 7 ``` Get-CsWindowsService | Where-Object {$_.Status -eq "Running"} ``` @@ -115,7 +116,7 @@ This collection is then piped to the Where-Object cmdlet, which picks out only t -### -------------------------- Example 8 ------------------------ +### Example 8 ``` Get-CsWindowsService | Where-Object {$_.DisplayName -like "*Application Sharing*"} ``` @@ -126,7 +127,7 @@ This collection is then piped to the Where-Object cmdlet, which selects the one The end result: information is displayed for the Skype for Business Server Application Sharing Conferencing service. -### -------------------------- Example 9 ------------------------ +### Example 9 ``` Get-CsWindowsService | Where-Object {$_.RoleName -contains "ApplicationServer"} ``` @@ -138,44 +139,39 @@ This collection is then piped to the Where-Object cmdlet, which selects those se ## PARAMETERS -### -Name - -Name of the service you want to return information for. -Note that you must use the service name (for example, RTCCAA) and not the service display name. -You can only pass a single service name to the Name parameter; in addition you cannot use wildcards in the service name. +### -ComputerName -Note, too that the Get-CsWindowsService cmdlet can only return information for Skype for Business Server services; you cannot use this cmdlet to return information for other Windows services. -For those services, you might be able to use the Windows PowerShell Get-Service cmdlet. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -If you do not include this parameter, the Get-CsWindowsService cmdlet will return information about all your Skype for Business Server services. +Name of the remote computer from which service information is to be retrieved; if this parameter is not included, the Get-CsWindowsService cmdlet will return information about the Skype for Business Server services running on the local computer. +The remote computer should be referenced by using its fully qualified domain name (FQDN); for example, atl-mcs-001.litwareinc.com. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ComputerName +### -ExcludeActivityLevel -Name of the remote computer from which service information is to be retrieved; if this parameter is not included, the Get-CsWindowsService cmdlet will return information about the Skype for Business Server services running on the local computer. -The remote computer should be referenced by using its fully qualified domain name (FQDN); for example, atl-mcs-001.litwareinc.com. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If included, this parameter causes the Get-CsWindowsService cmdlet to return only the service status and not the service activity level. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,34 +180,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeActivityLevel +### -Name -If included, this parameter causes the Get-CsWindowsService cmdlet to return only the service status and not the service activity level. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the service you want to return information for. +Note that you must use the service name (for example, RTCCAA) and not the service display name. +You can only pass a single service name to the Name parameter; in addition you cannot use wildcards in the service name. + +Note, too that the Get-CsWindowsService cmdlet can only return information for Skype for Business Server services; you cannot use this cmdlet to return information for other Windows services. +For those services, you might be able to use the Windows PowerShell Get-Service cmdlet. + +If you do not include this parameter, the Get-CsWindowsService cmdlet will return information about all your Skype for Business Server services. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Path to an HTML file where error information can be stored. If this parameter is included, any errors that occur during the running of this cmdlet will be logged to the specified file (for example, C:\Logs\Service_report.html). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,13 +231,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Get-CsWindowsService cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.Deployment.Core.NTService The Get-CsWindowsService cmdlet returns instances of the Microsoft.Rtc.Management.Deployment.Core.NTService object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsXmppAllowedPartner.md b/skype/skype-ps/SkypeForBusiness/Get-CsXmppAllowedPartner.md similarity index 91% rename from skype/skype-ps/skype/Get-CsXmppAllowedPartner.md rename to skype/skype-ps/SkypeForBusiness/Get-CsXmppAllowedPartner.md index d842572c39..63836241f5 100644 --- a/skype/skype-ps/skype/Get-CsXmppAllowedPartner.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsXmppAllowedPartner.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csxmppallowedpartner applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsXmppAllowedPartner -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csxmppallowedpartner +schema: 2.0.0 +title: Get-CsXmppAllowedPartner --- # Get-CsXmppAllowedPartner @@ -46,7 +47,7 @@ To view information about your XMPP allowed partners in the Skype for Business S ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsXmppAllowedPartner ``` @@ -55,7 +56,7 @@ The command shown in Example 1 returns information about all the XMPP allowed pa -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsXmppAllowedPartner -Identity "xmpp.contoso.com" ``` @@ -64,7 +65,7 @@ In Example 2, information is returned for a single XMPP allowed partner: the par -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsXmppAllowedPartner - Filter "*.org" ``` @@ -73,7 +74,7 @@ Example 3 returns information for all the XMPP allowed partners that have an Ide -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsXmppAllowedPartner | Where-Object {$_.SaslNegotiation -eq "Required"} ``` @@ -86,14 +87,16 @@ The returned partners are then piped to the Where-Object cmdlet, which selects o ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to use wildcards when specifying the Identities of the XMPP allowed partner (or partners) to be returned. For example the filter value "*.org" returns a collection of all the XMPP allowed partners that have an Identity that ends with the string value ".org". ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -103,14 +106,16 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Fully qualified domain name (FQDN) of the XMPP allowed partner to be returned (for example, fabrikam.com). If neither this parameter nor the Filter parameter is specified, then all the XMPP partners configured for use in your organization are returned. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 2 @@ -120,13 +125,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Retrieves the XMPP allowed partner data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -140,13 +147,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Get-CsXmppAllowedPartner cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppAllowedPartner#Decorated The Get-CsXmppAllowedPartner cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppAllowedPartner#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Get-CsXmppGatewayConfiguration.md b/skype/skype-ps/SkypeForBusiness/Get-CsXmppGatewayConfiguration.md similarity index 93% rename from skype/skype-ps/skype/Get-CsXmppGatewayConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Get-CsXmppGatewayConfiguration.md index 42d1978491..3a04d2403c 100644 --- a/skype/skype-ps/skype/Get-CsXmppGatewayConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Get-CsXmppGatewayConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/get-csxmppgatewayconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Get-CsXmppGatewayConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/get-csxmppgatewayconfiguration +schema: 2.0.0 +title: Get-CsXmppGatewayConfiguration --- # Get-CsXmppGatewayConfiguration @@ -56,7 +57,7 @@ Skype for Business Server Control Panel: The functions carried out by the Get-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsXmppGatewayConfiguration ``` @@ -69,6 +70,9 @@ Because Skype for Business Server 2015 only allows for a single, global collecti ## PARAMETERS ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to use wildcard values when referencing a collection of XMPP gateway configuration settings. Because you can only have a single, global instance of these settings there is no reason to use the Filter parameter. However, if you prefer you can use the following syntax to reference the global settings: @@ -80,8 +84,7 @@ That syntax brings back all the XMPP gateway configuration settings that have an ```yaml Type: String Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -92,6 +95,8 @@ Accept wildcard characters: False ### -Identity +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the XMPP gateway configuration settings. Because you can only have a single, global instance of these settings, you do not need to specify an Identity when calling the Get-CsXmppGatewayConfiguration cmdlet. If you prefer, however, you can use the following syntax to reference the global settings: @@ -103,8 +108,7 @@ If you prefer, however, you can use the following syntax to reference the global ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 2 @@ -114,13 +118,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Retrieves the XMPP gateway data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -134,13 +140,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Get-CsXmppGatewayConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppGatewaySettings The Get-CsXmppGatewayConfiguration cmdlet returns instances of the Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppGatewaySettings object. ## NOTES diff --git a/skype/skype-ps/skype/Grant-CsArchivingPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsArchivingPolicy.md similarity index 89% rename from skype/skype-ps/skype/Grant-CsArchivingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsArchivingPolicy.md index 195e225d06..8d81f5281b 100644 --- a/skype/skype-ps/skype/Grant-CsArchivingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsArchivingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csarchivingpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsArchivingPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/grant-csarchivingpolicy +schema: 2.0.0 +title: Grant-CsArchivingPolicy --- # Grant-CsArchivingPolicy @@ -53,7 +54,7 @@ The Grant-CsArchivingPolicy cmdlet is used to assign per-user archiving policies ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsArchivingPolicy -Identity "Ken Myer" -PolicyName RedmondArchivingPolicy @@ -64,7 +65,7 @@ Note that, with the Grant-CsArchivingPolicy cmdlet, the Identity property refers Instead, the policy to be assigned is specified by using the PolicyName parameter; the parameter value is the policy Identity (minus the "tag:" prefix). -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsUser -OU "OU=Redmond,dc=litwareinc,dc=com" | Grant-CsArchivingPolicy -PolicyName RedmondArchivingPolicy @@ -75,7 +76,7 @@ To do this, the Get-CsUser cmdlet and the OU parameter are used to return a coll This collection is then piped to the Grant-CsArchivingPolicy cmdlet, which assigns the policy RedmondArchivingPolicy to each user in the collection. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsUser -LdapFilter "l=Redmond" | Grant-CsArchivingPolicy -PolicyName RedmondArchivingPolicy @@ -86,7 +87,7 @@ To carry out this task, the Get-CsUser cmdlet is called along with the LdapFilte (In the LDAP query language, l, a lowercase L, is short for "locality", or city.) This collection is then piped to the Grant-CsArchivingPolicy cmdlet, which assigns the RedmondArchivingPolicy policy to each user in the collection. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` Get-CsUser -Filter {RegistrarPool -eq "atl-cs-001.litwareinc.com"} | Grant-CsArchivingPolicy -PolicyName RedmondArchivingPolicy @@ -97,7 +98,7 @@ To do this, the Get-CsUser cmdlet is first used to return all the users who have This collection is then piped to the Where-Object cmdlet, which selects only those users who have a RegistrarPool that is equal to atl-cs-001-litwareinc.com. This filtered collection is then piped to the Grant-CsArchivingPolicy cmdlet, which assigns the policy RedmondArchivingPolicy to each user in the collection. -### -------------------------- EXAMPLE 5 -------------------------- +### EXAMPLE 5 ``` Get-CsUser -Filter {ArchivingPolicy -eq "RedmondArchivingPolicy"} | Grant-CsArchivingPolicy -PolicyName "NorthAmericaArchivingPolicy" @@ -108,7 +109,7 @@ To perform this task, the Get-CsUser cmdlet is used to return a collection of al The filtered collection is then piped to the Grant-CsArchivingPolicy cmdlet, which assigns the policy NorthAmericaArchivingPolicy to each user in the collection. -### -------------------------- EXAMPLE 6 -------------------------- +### EXAMPLE 6 ``` Get-CsUser -Filter {ArchivingPolicy -eq "RedmondArchivingPolicy"} | Grant-CsArchivingPolicy -PolicyName $Null @@ -120,7 +121,29 @@ This time, however, the policy RedmondArchivingPolicy is unassigned from all the ## PARAMETERS +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a domain controller to connect to when assigning the policy. +If this parameter is not included then the cmdlet will use the first available domain controller. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account the policy should be assigned to. User Identities can be specified by using one of four formats: 1) The user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. @@ -131,8 +154,7 @@ For example, the Identity "* Smith" returns all the users who have a display nam ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -141,37 +163,19 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -PolicyName -"Name" of the policy to be assigned. -The PolicyName is simply the policy Identity minus the scope designator "tag:". -For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondArchivingPolicy has a PolicyName equal to RedmondArchivingPolicy. +### -PassThru -To remove a per-user policy that has been assigned to a user, set PolicyName to a null value: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-PolicyName $Null` +If present, causes the cmdlet to pass the user object (or objects) through the Windows PowerShell pipeline. +By default, the Grant-CsArchivingPolicy cmdlet does not pass objects through the pipeline. -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DomainController -Enables you to specify a domain controller to connect to when assigning the policy. -If this parameter is not included then the cmdlet will use the first available domain controller. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -180,34 +184,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru +### -PolicyName -If present, causes the cmdlet to pass the user object (or objects) through the Windows PowerShell pipeline. -By default, the Grant-CsArchivingPolicy cmdlet does not pass objects through the pipeline. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +"Name" of the policy to be assigned. +The PolicyName is simply the policy Identity minus the scope designator "tag:". +For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondArchivingPolicy has a PolicyName equal to RedmondArchivingPolicy. +To remove a per-user policy that has been assigned to a user, set PolicyName to a null value: +`-PolicyName $Null` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -216,14 +226,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -237,16 +249,19 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### String The Grant-CsArchivingPolicy cmdlet accepts pipelined input of string values representing the Identity of a user account. + +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.IM.ImArchivingPolicy The Grant-CsArchivingPolicy cmdlet does not return a value or object. Instead, the cmdlet assigns instances of the Microsoft.Rtc.Management.WritableConfig.Policy.IM.ImArchivingPolicy object to users or groups of users. + +### Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact. ## NOTES diff --git a/skype/skype-ps/skype/Grant-CsCallViaWorkPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsCallViaWorkPolicy.md similarity index 88% rename from skype/skype-ps/skype/Grant-CsCallViaWorkPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsCallViaWorkPolicy.md index 5b5a65c2cf..0f19251ef6 100644 --- a/skype/skype-ps/skype/Grant-CsCallViaWorkPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsCallViaWorkPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-cscallviaworkpolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsCallViaWorkPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/grant-cscallviaworkpolicy +schema: 2.0.0 +title: Grant-CsCallViaWorkPolicy --- # Grant-CsCallViaWorkPolicy @@ -29,7 +30,7 @@ This cmdlet assigns an existing per-user call via work policy to a user. Call vi ## EXAMPLES -### -------------------------- Example 1 -------------------------- (Skype for Business Server 2015) +### Example 1 (Skype for Business Server 2015) ``` Grant-CsCallViaWorkPolicy -Identity "Ken Myer" -PolicyName StandardUserCvW @@ -40,7 +41,29 @@ This example assigns the policy named "StandardUserCvW" to "Ken Myer". ## PARAMETERS +### -DomainController + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify the fully qualified domain name (FQDN) of a domain controller to be contacted when assigning the new policy. +If this parameter is not specified, then the Grant-CsCallViaWorkPolicy cmdlet will contact the first available domain controller. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies a unique identifier of the user account the policy should be assigned to. User identities can be specified by using one of four formats. @@ -58,8 +81,7 @@ For example, the Identity "\* Smith" grants the policy all users who have a disp ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -68,35 +90,17 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -PolicyName -Specifies the name of the policy to be assigned. -The PolicyName is the policy identity minus the policy scope ("tag:"). -A policy that has an identity of "Tag:Redmond" has a PolicyName of "Redmond". -A policy with the identity "Tag:RedmondCalloutPolicy" has a PolicyName of "RedmondCalloutPolicy". -If you set PolicyName to a null value, then the command will unassign any individual policy assigned to the user. -For example: `Grant-CsCallViaWorkPolicy -Identity "Ken Myer" -PolicyName $Null` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -PassThru -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. +By default, the Grant-CsCallViaWorkPolicy cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -105,32 +109,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to specify the fully qualified domain name (FQDN) of a domain controller to be contacted when assigning the new policy. -If this parameter is not specified, then the Grant-CsCallViaWorkPolicy cmdlet will contact the first available domain controller. +### -PolicyName + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the name of the policy to be assigned. +The PolicyName is the policy identity minus the policy scope ("tag:"). +A policy that has an identity of "Tag:Redmond" has a PolicyName of "Redmond". +A policy with the identity "Tag:RedmondCalloutPolicy" has a PolicyName of "RedmondCalloutPolicy". +If you set PolicyName to a null value, then the command will unassign any individual policy assigned to the user. +For example: `Grant-CsCallViaWorkPolicy -Identity "Ken Myer" -PolicyName $Null` ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the user being assigned the policy. -By default, the Grant-CsCallViaWorkPolicy cmdlet does not pass objects through the pipeline. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -140,13 +151,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -160,13 +173,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Grant-CsClientPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsClientPolicy.md similarity index 87% rename from skype/skype-ps/skype/Grant-CsClientPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsClientPolicy.md index 5b614c56ca..e438fd472b 100644 --- a/skype/skype-ps/skype/Grant-CsClientPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsClientPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csclientpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsClientPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/grant-csclientpolicy +schema: 2.0.0 +title: Grant-CsClientPolicy --- # Grant-CsClientPolicy @@ -45,14 +47,14 @@ In order to assign per-user policies to users, you must use the Grant-CsClientPo ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsClientPolicy -Identity "Ken Myer" -PolicyName SalesPolicy ``` In Example 1, the client policy SalesPolicy is assigned to the user with the Identity Ken Myer. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsUser -LDAPFilter "Department=Sales" | Grant-CsClientPolicy -PolicyName SalesPolicy ``` @@ -61,7 +63,7 @@ In Example 2, all the users who belong to the Sales department are assigned the The command first uses the Get-CsUser cmdlet and the LdapFilter parameter to return a collection of all the users who are members of the Sales department. This collection of users is then piped to the Grant-CsClientPolicy cmdlet, which assigns the policy SalesPolicy to each user in the collection. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsUser -LDAPFilter "(&(Title=Accountant)(l=Redmond))" | Grant-CsClientPolicy -PolicyName RedmondAccountingPolicy ``` @@ -73,7 +75,7 @@ The filter value "(&(Title=Accountant)(l=Redmond))" limits the returned data to The resulting collection is then piped to the Grant-CsClientPolicy cmdlet, which assigns the policy RedmondAccountingPolicy to each user in the collection. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` Get-CsUser -LdapFilter "(|(Title=Accountant)(Title=Senior Accountant))" | Grant-CsClientPolicy -PolicyName AccountingPolicy ``` @@ -83,7 +85,7 @@ To carry out this task, the Get-CsUser cmdlet and the LdapFilter parameter are u The filter value "(|(Title=Accountant)(Title=Senior Accountant))" limits the returned data to users with the job title Accountant (Title=Accountant) or (|) users with the job title Senior Accountant (Title=Senior Accountant). This filtered collection is then piped to the Grant-CsClientPolicy cmdlet, which assigns the client policy AccountingPolicy to each user in the collection. -### -------------------------- EXAMPLE 5 -------------------------- +### EXAMPLE 5 ``` Get-CsUser -Filter {RegistrarPool -eq "atl-cs-001.litwareinc.com"} | Grant-CsClientPolicy -PolicyName AtlantaBranchPolicy ``` @@ -94,7 +96,29 @@ This collection is then piped to the Grant-CsClientPolicy cmdlet, which assigns ## PARAMETERS +### -DomainController + +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a domain controller to connect to when assigning the policy. +If this parameter is not included then the cmdlet will use the first available domain controller. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account the policy should be assigned to. User Identities can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. @@ -105,8 +129,7 @@ For example, the Identity "* Smith" returns all the users who have a display nam ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -115,71 +138,68 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -PolicyName -"Name" of the policy to be assigned. -The PolicyName is simply the policy Identity minus the policy scope ("tag:"). -For example, a policy that has the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondConferencingPolicy has a PolicyName equal to RedmondConferencingPolicy. +### -PassThru -If you set PolicyName to a null value, then the command will unassign any per-user policy assigned to the user. -For example: +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -`Grant-CsClientPolicy -Identity "Ken Myer" -PolicyName $Null` +If present, causes the cmdlet to pass the user object (or objects) through the Windows PowerShell pipeline. +By default, the Grant-CsClientPolicy cmdlet does not pass objects through the pipeline. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to specify a domain controller to connect to when assigning the policy. -If this parameter is not included then the cmdlet will use the first available domain controller. +### -PolicyName -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +"Name" of the policy to be assigned. +The PolicyName is simply the policy Identity minus the policy scope ("tag:"). +For example, a policy that has the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondConferencingPolicy has a PolicyName equal to RedmondConferencingPolicy. -### -PassThru -If present, causes the cmdlet to pass the user object (or objects) through the Windows PowerShell pipeline. -By default, the Grant-CsClientPolicy cmdlet does not pass objects through the pipeline. +If you set PolicyName to a null value, then the command will unassign any per-user policy assigned to the user. +For example: + +`Grant-CsClientPolicy -Identity "Ken Myer" -PolicyName $Null` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Tenant +Globally unique identifier (GUID) of the tenant account whose hybrid configuration settings are being returned. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return your tenant ID by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -189,13 +209,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -204,24 +226,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose hybrid configuration settings are being returned. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return your tenant ID by running this command: +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` - -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. -Instead, the tenant ID will automatically be filled in for you based on your connection information. -The Tenant parameter is primarily for use in a hybrid deployment. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named @@ -235,14 +249,15 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String The Grant-CsClientPolicy cmdlet accepts pipelined input of string values representing the Identity of a user account. + +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact By default, the Grant-CsClientPolicy cmdlet returns no objects or values. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact object. diff --git a/skype/skype-ps/skype/Grant-CsClientVersionPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsClientVersionPolicy.md similarity index 90% rename from skype/skype-ps/skype/Grant-CsClientVersionPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsClientVersionPolicy.md index f3c7b5346a..fe7fff1327 100644 --- a/skype/skype-ps/skype/Grant-CsClientVersionPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsClientVersionPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csclientversionpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsClientVersionPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/grant-csclientversionpolicy +schema: 2.0.0 +title: Grant-CsClientVersionPolicy --- # Grant-CsClientVersionPolicy @@ -53,7 +54,7 @@ Client version policies enforced in your organization do not override the client ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsClientVersionPolicy -Identity "Ken Myer" -PolicyName "RedmondClientVersionPolicy" @@ -62,7 +63,7 @@ Grant-CsClientVersionPolicy -Identity "Ken Myer" -PolicyName "RedmondClientVersi In Example 1, the client version policy RedmondClientVersionPolicy is assigned to user Ken Myer. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsUser -LdapFilter "l=Redmond" | Grant-CsClientVersionPolicy -PolicyName "RedmondClientVersionPolicy" @@ -73,7 +74,7 @@ To do this, the command first uses the Get-CsUser cmdlet and the LdapFilter para This collection is then piped to the Grant-CsClientVersionPolicy cmdlet, which assigns the specified policy to each user in the collection. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsUser -OU "ou=Redmond,ou=North America,dc=litwareinc,dc=com" | Grant-CsClientVersionPolicy -PolicyName "RedmondClientVersionPolicy" @@ -84,7 +85,7 @@ To accomplish this task, the command first calls the Get-CsUser cmdlet and the O After the user accounts have been retrieved, the collection is piped to the Grant-CsClientVersionPolicy cmdlet, which assigns RedmondClientVersionPolicy to each of those users. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` Get-CsUser -Filter {VoicePolicy -eq "RedmondVoicePolicy"} | Grant-CsClientVersionPolicy -PolicyName "RedmondClientVersionPolicy" @@ -95,7 +96,7 @@ To do this, the command first calls the Get-CsUser cmdlet along with the Filter The resulting user accounts are then piped to the Grant-CsClientVersionPolicy cmdlet and assigned the client version policy RedmondClientVersionPolicy. -### -------------------------- EXAMPLE 5 -------------------------- +### EXAMPLE 5 ``` Get-CsUser | Grant-CsClientVersionPolicy -PolicyName $Null @@ -109,7 +110,31 @@ This is done by setting the parameter value of PolicyName to $null. ## PARAMETERS +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a domain controller to connect to when assigning the policy. +If this parameter is not included, then the cmdlet will use the first available domain controller. + + + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account the policy should be assigned to. User Identities can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. @@ -120,8 +145,7 @@ For example, the Identity "* Smith" returns all the users who have a display nam ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -130,27 +154,10 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -PolicyName -"Name" of the policy to be assigned. -The PolicyName is simply the policy Identity minus the policy scope ("tag:"). -For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondClientVersionPolicy has a PolicyName equal to RedmondClientVersionPolicy. -To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($null). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -PassThru +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If present, causes the cmdlet to pass the user object (or objects) through the Windows PowerShell pipeline. By default, the Grant-CsClientVersionPolicy cmdlet does not pass objects through the pipeline. @@ -159,8 +166,7 @@ By default, the Grant-CsClientVersionPolicy cmdlet does not pass objects through ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -169,30 +175,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -PolicyName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +"Name" of the policy to be assigned. +The PolicyName is simply the policy Identity minus the policy scope ("tag:"). +For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondClientVersionPolicy has a PolicyName equal to RedmondClientVersionPolicy. +To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($null). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -201,18 +214,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController - -Enables you to specify a domain controller to connect to when assigning the policy. -If this parameter is not included, then the cmdlet will use the first available domain controller. +### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -226,14 +237,15 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String The Grant-CsClientVersionPolicy cmdlet accepts pipelined input of string values representing the Identity of a user account. + +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact By default, the Grant-CsClientVersionPolicy cmdlet does not return objects or values. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact object. diff --git a/skype/skype-ps/skype/Grant-CsConferencingPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsConferencingPolicy.md similarity index 84% rename from skype/skype-ps/skype/Grant-CsConferencingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsConferencingPolicy.md index 079b1f8b84..1085945408 100644 --- a/skype/skype-ps/skype/Grant-CsConferencingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsConferencingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csconferencingpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsConferencingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/grant-csconferencingpolicy +schema: 2.0.0 +title: Grant-CsConferencingPolicy --- # Grant-CsConferencingPolicy @@ -51,7 +53,7 @@ Instead, you must use the Grant-CsConferencingPolicy cmdlet to explicitly assign ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsConferencingPolicy -identity "Ken Myer" -PolicyName SalesConferencingPolicy ``` @@ -59,7 +61,7 @@ Grant-CsConferencingPolicy -identity "Ken Myer" -PolicyName SalesConferencingPol In Example 1, the Grant-CsConferencingPolicy cmdlet is used to assign the policy SalesConferencingPolicy to the user with the Identity "Ken Myer". -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsUser -OU "ou=Finance,dc=litwareinc,dc=com" | Grant-CsConferencingPolicy -PolicyName FinanceConferencingPolicy ``` @@ -69,7 +71,7 @@ To assign the same policy to all the users in a given organizational unit (OU), After the user accounts have been retrieved, that information is then piped to the Grant-CsConferencingPolicy cmdlet, which assigns the FinanceConferencingPolicy policy to each user in the collection. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsUser -OU "ou=Finance,dc=litwareinc,dc=com" | Grant-CsConferencingPolicy -PolicyName $Null ``` @@ -78,7 +80,7 @@ Example 3 represents a variation of Example 2: in this case, however, any per-us To do this, the command calls the Grant-CsConferencingPolicy cmdlet and specifies a null value ($Null) as the parameter value for the parameter PolicyName. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` Get-CsUser -LdapFilter "Department=Human Resources" | Grant-CsConferencingPolicy -PolicyName HRConferencingPolicy ``` @@ -90,7 +92,29 @@ After the user accounts have been retrieved, that collection is piped to the Gra ## PARAMETERS +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify the fully qualified domain name (FQDN) of a domain controller to be contacted when assigning the new policy. +If this parameter is not specified then the Grant-CsConferencingPolicy cmdlet will contact the first available domain controller. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account the policy should be assigned to. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. @@ -101,8 +125,7 @@ For example, the Identity "* Smith" returns all the users with a display name th ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -111,68 +134,57 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -PolicyName -"Name" of the policy to be assigned. -The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). -For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondConferencingPolicy has a PolicyName equal to RedmondConferencingPolicy. +### -PassThru -To unassign a per-user policy previously assigned to a user, set the PolicyName parameter to $Null. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. +By default, the Grant-CsConferencingPolicy cmdlet does not pass objects through the pipeline. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to specify the fully qualified domain name (FQDN) of a domain controller to be contacted when assigning the new policy. -If this parameter is not specified then the Grant-CsConferencingPolicy cmdlet will contact the first available domain controller. +### -PolicyName -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +"Name" of the policy to be assigned. +The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). +For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondConferencingPolicy has a PolicyName equal to RedmondConferencingPolicy. -### -PassThru -Enables you to pass a user object through the pipeline that represents the user being assigned the policy. -By default, the Grant-CsConferencingPolicy cmdlet does not pass objects through the pipeline. +To unassign a per-user policy previously assigned to a user, set the PolicyName parameter to $Null. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Tenant + +> Applicable: Skype for Business Online + +{{Fill Tenant Description}} ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,13 +194,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -197,14 +211,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -{{Fill Tenant Description}} +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: wi Required: False Position: Named @@ -218,30 +234,20 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String Grant-CsConferencingPolicy accepts pipelined input of string values representing the Identity of a user account. + +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The cmdlet also accepts pipelined input of user objects. ### Microsoft.Rtc.Management.AD.UserIdParameter -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. -The Grant-CsConferencingPolicy cmdlet accepts pipelined input of string values representing the Identity of a user account. -The cmdlet also accepts pipelined input of user objects. - ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact By default, Grant-CsConferencingPolicy returns no objects or values. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact object. -### System.Object - -### -By default, the Grant-CsConferencingPolicy cmdlet returns no objects or values. -However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact object. - ## NOTES ## RELATED LINKS diff --git a/skype/skype-ps/skype/Grant-CsDialPlan.md b/skype/skype-ps/SkypeForBusiness/Grant-CsDialPlan.md similarity index 86% rename from skype/skype-ps/skype/Grant-CsDialPlan.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsDialPlan.md index 17aa244dd3..51790c121e 100644 --- a/skype/skype-ps/skype/Grant-CsDialPlan.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsDialPlan.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csdialplan applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsDialPlan -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/grant-csdialplan +schema: 2.0.0 +title: Grant-CsDialPlan --- # Grant-CsDialPlan @@ -43,7 +44,7 @@ For example: ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsDialPlan -Identity "Ken Myer" -PolicyName RedmondDialPlan @@ -52,7 +53,7 @@ Grant-CsDialPlan -Identity "Ken Myer" -PolicyName RedmondDialPlan In the example, the Grant-CsDialPlan cmdlet is used to assign the dial plan RedmondDialPlan to the user with the Identity (in this case the display name) Ken Myer. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsUser -LDAPFilter "l=Redmond" | Grant-CsDialPlan -PolicyName RedmondDialPlan @@ -65,7 +66,29 @@ To do this, the Get-CsUser cmdlet is invoked in order to retrieve a collection o ## PARAMETERS +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to specify a domain controller. +If no domain controller is specified, the first available will be used. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Identity (unique identifier) of the user to whom the dial plan is being assigned. User identities can be specified using one of four formats: 1) The user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). @@ -78,8 +101,7 @@ Full data type: Microsoft.Rtc.Management.AD.UserIdParameter ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -88,53 +110,55 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -PolicyName +### -PassThru -The Identity value of the dial plan to be assigned to the user. -(Note that this includes only the name portion of the Identity. -Per-user dial plan identities include a prefix of tag: that should not be included with the PolicyName.) +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns the results of the command. +By default, this cmdlet does not generate any output. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController +### -PolicyName -Allows you to specify a domain controller. -If no domain controller is specified, the first available will be used. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity value of the dial plan to be assigned to the user. +(Note that this includes only the name portion of the Identity. +Per-user dial plan identities include a prefix of tag: that should not be included with the PolicyName.) ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru +### -Confirm -Returns the results of the command. -By default, this cmdlet does not generate any output. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -145,30 +169,14 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm - -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -182,15 +190,14 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String. +### System.String Accepts a pipelined string value representing the Identity of a user account to which the dial plan is being granted. ### Microsoft.Rtc.Management.AD.UserIdParameter ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADUserOrAppContact When used with the PassThru parameter, returns an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADUserOrAppContact. ### System.Object diff --git a/skype/skype-ps/skype/Grant-CsExternalAccessPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsExternalAccessPolicy.md similarity index 87% rename from skype/skype-ps/skype/Grant-CsExternalAccessPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsExternalAccessPolicy.md index cee8b30442..dd7307425b 100644 --- a/skype/skype-ps/skype/Grant-CsExternalAccessPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsExternalAccessPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csexternalaccesspolicy applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsExternalAccessPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/grant-csexternalaccesspolicy +schema: 2.0.0 +title: Grant-CsExternalAccessPolicy --- # Grant-CsExternalAccessPolicy @@ -77,14 +79,14 @@ That's because the settings in the per-user policy take precedence. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsExternalAccessPolicy -Identity "Ken Myer" -PolicyName RedmondAccessPolicy ``` Example 1 assigns the external access policy RedmondAccessPolicy to the user with the Active Directory display name Ken Myer. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsUser -LdapFilter "l=Redmond" | Grant-CsExternalAccessPolicy -PolicyName RedmondAccessPolicy ``` @@ -93,7 +95,7 @@ The command shown in Example 2 assigns the external access policy RedmondAccessP To do this, the command first uses the Get-CsUser cmdlet and the LdapFilter parameter to return a collection of all the users who work in Redmond; the filter value "l=Redmond" limits returned data to those users who work in the city of Redmond (the l in the filter, a lowercase L, represents the locality). That collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which assigns the policy RedmondAccessPolicy to each user in the collection. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsUser -LdapFilter "Title=Sales Representative" | Grant-CsExternalAccessPolicy -PolicyName SalesAccessPolicy ``` @@ -102,7 +104,7 @@ In Example 3, all the users who have the job title "Sales Representative" are as To perform this task, the command first uses the Get-CsUser cmdlet and the LdapFilter parameter to return a collection of all the Sales Representatives; the filter value "Title=Sales Representative" restricts the returned collection to users who have the job title "Sales Representative". This filtered collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which assigns the policy SalesAccessPolicy to each user in the collection. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` Get-CsUser -Filter {ExternalAccessPolicy -eq $Null} | Grant-CsExternalAccessPolicy -PolicyName BasicAccessPolicy ``` @@ -111,7 +113,7 @@ The command shown in Example 4 assigns the external access policy BasicAccessPol (That is, users currently being governed by a site policy or by the global policy.) To do this, the Get-CsUser cmdlet and the Filter parameter are used to return the appropriate set of users; the filter value {ExternalAccessPolicy -eq $Null} limits the returned data to user accounts where the ExternalAccessPolicy property is equal to (-eq) a null value ($Null). By definition, ExternalAccessPolicy will be null only if users have not been assigned a per-user policy. -### -------------------------- EXAMPLE 5 -------------------------- +### EXAMPLE 5 ``` Get-CsUser -OU "ou=US,dc=litwareinc,dc=com" | Grant-CsExternalAccessPolicy -PolicyName USAccessPolicy ``` @@ -120,7 +122,7 @@ Example 5 assigns the external access policy USAccessPolicy to all the users who The command starts off by calling the Get-CsUser cmdlet and the OU parameter; the parameter value "ou=US,dc=litwareinc,dc=com" limits the returned data to user accounts found in the US OU. The returned collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which assigns the policy USAccessPolicy to each user in the collection. -### -------------------------- EXAMPLE 6 -------------------------- +### EXAMPLE 6 ``` Get-CsUser | Grant-CsExternalAccessPolicy -PolicyName $Null ``` @@ -131,73 +133,89 @@ That collection is then piped to the Grant-CsExternalAccessPolicy cmdlet, which ## PARAMETERS -### -Identity -Identity of the user account the policy should be assigned to. -User Identities can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). -User Identities can also be referenced by using the user's Active Directory distinguished name. +### -DomainController -In addition, you can use the asterisk (*) wildcard character when specifying the user Identity. -For example, the Identity "* Smith" returns all the users with a display name that ends with the string value " Smith." +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify the fully qualified domain name (FQDN) of a domain controller to be contacted when assigning the new policy. +If this parameter is not specified, then the Grant-CsExternalAccessPolicy cmdlet will contact the first available domain controller. ```yaml -Type: UserIdParameter -Parameter Sets: GrantToUser -Aliases: -Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Fqdn +Parameter Sets: (All) +Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -"Name" of the policy to be assigned. -The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). -For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondAccessPolicy has a PolicyName equal to RedmondAccessPolicy. +### -Global +When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". -To unassign a per-user policy previously assigned to a user, set the PolicyName parameter to $Null. +```yaml +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: + +Required: True +Position: 0 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Group +Specifies the group used for the group policy assignment. ```yaml Type: String -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: GrantToGroup +Aliases: -Required: False -Position: 2 +Required: True +Position: 0 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to specify the fully qualified domain name (FQDN) of a domain controller to be contacted when assigning the new policy. -If this parameter is not specified, then the Grant-CsExternalAccessPolicy cmdlet will contact the first available domain controller. +### -Identity + +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Identity of the user account the policy should be assigned to. +User Identities can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). +User Identities can also be referenced by using the user's Active Directory distinguished name. + +In addition, you can use the asterisk (*) wildcard character when specifying the user Identity. +For example, the Identity "* Smith" returns all the users with a display name that ends with the string value " Smith." ```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: UserIdParameter +Parameter Sets: GrantToUser +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsExternalAccessPolicy cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -206,32 +224,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -PolicyName + +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +"Name" of the policy to be assigned. +The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). +For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondAccessPolicy has a PolicyName equal to RedmondAccessPolicy. + +To unassign a per-user policy previously assigned to a user, set the PolicyName parameter to $Null. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Int32 +Parameter Sets: GrantToGroup +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -239,13 +262,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -254,46 +279,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -Confirm + +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. - -```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: +### -WhatIf -Required: True -Position: 0 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Microsoft Teams, Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -Global -When you use this cmdlet without specifying a user identity, the policy applies to all users in your tenant. To skip a warning when you do this operation, specify "-Global". +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter -Parameter Sets: GrantToTenant -Aliases: +Parameter Sets: (All) +Aliases: wi -Required: True -Position: 0 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -304,30 +320,21 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String Grant-CsExternalAccessPolicy accepts pipelined input of string values representing the Identity of a user account. -The cmdlet also accepts pipelined input of user objects. ### Microsoft.Rtc.Management.AD.UserIdParameter +The cmdlet also accepts pipelined input of user objects. -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. -The Grant-CsExternalAccessPolicy cmdlet accepts pipelined input of string values representing the Identity of a user account. +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact By default, Grant-CsExternalAccessPolicy does not return a value or object. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact object. -### System.Object - -### -By default, the Grant-CsExternalAccessPolicy cmdlet does not return a value or object. -However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact object. - ## NOTES ## RELATED LINKS diff --git a/skype/skype-ps/skype/Grant-CsGraphPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsGraphPolicy.md similarity index 96% rename from skype/skype-ps/skype/Grant-CsGraphPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsGraphPolicy.md index d1c384d7e3..96c319fcbd 100644 --- a/skype/skype-ps/skype/Grant-CsGraphPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsGraphPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csgraphpolicy applicable: Lync Server 2010 -title: Grant-CsGraphPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/grant-csgraphpolicy +schema: 2.0.0 +title: Grant-CsGraphPolicy --- # Grant-CsGraphPolicy @@ -41,7 +43,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Grant-CsGraphPolicy -PolicyName "GraphDisabled" -Identity Ken.Myer ``` @@ -51,53 +53,46 @@ This example grants the "GraphDisabled" policy to Ken Myer. ## PARAMETERS -### -PolicyName -Specifies the name of the graph policy to grant to the tenant or user. -The two options are: - -Graph Enabled: Granting this policy will enable the pre-loading content or files that are attached to an Outlook meeting invitation into a Microsoft Teams or Skype for Business Online meeting. -For example, `Grant-CsGraphPolicy -PolicyName "Graph Enabled"`. - -Graph Disabled: Granting this policy will disable the pre-loading of content, files or attachments attached to an Outlook meeting invitation into a Microsoft Teams or Skype for Business Online meeting. -For example, `Grant-CsGraphPolicy -PolicyName "Graph Disabled"`. +### -DomainController +Specifies the domain controller that's used by the cmdlet to read or write the specified data. +Valid inputs for this parameter are either the fully qualified domain name (FQDN) or the computer name. ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: +Aliases: applicable: Microsoft Teams Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. +### -Identity +Specifies the identity of the user who will be granted the graph policy. ```yaml -Type: SwitchParameter +Type: UserIdParameter Parameter Sets: (All) -Aliases: cf +Aliases: applicable: Microsoft Teams Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Specifies the domain controller that's used by the cmdlet to read or write the specified data. -Valid inputs for this parameter are either the fully qualified domain name (FQDN) or the computer name. +### -PassThru +Enables you to pass a user object through the pipeline that represents the user account being assigned the policy. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: applicable: Microsoft Teams Required: False @@ -107,29 +102,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specifies the identity of the user who will be granted the graph policy. +### -PolicyName +Specifies the name of the graph policy to grant to the tenant or user. +The two options are: + +Graph Enabled: Granting this policy will enable the pre-loading content or files that are attached to an Outlook meeting invitation into a Microsoft Teams or Skype for Business Online meeting. +For example, `Grant-CsGraphPolicy -PolicyName "Graph Enabled"`. + +Graph Disabled: Granting this policy will disable the pre-loading of content, files or attachments attached to an Outlook meeting invitation into a Microsoft Teams or Skype for Business Online meeting. +For example, `Grant-CsGraphPolicy -PolicyName "Graph Disabled"`. ```yaml -Type: UserIdParameter +Type: String Parameter Sets: (All) -Aliases: +Aliases: applicable: Microsoft Teams Required: False -Position: 1 +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the user account being assigned the policy. +### -Tenant +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: +Aliases: applicable: Microsoft Teams Required: False @@ -139,13 +141,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -This parameter is reserved for internal Microsoft use. +### -Confirm +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf applicable: Microsoft Teams Required: False @@ -177,12 +179,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### +### System.String The Grant-CsGraphPolicy cmdlet accepts a pipelined string value representing the Identity of a user account to which the graph policy is being granted. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADUserOrAppContact The Grant-CsGraphPolicy cmdlet returns an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADUserOrAppContact when used with the PassThru parameter. ## NOTES diff --git a/skype/skype-ps/skype/Grant-CsHostedVoicemailPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsHostedVoicemailPolicy.md similarity index 86% rename from skype/skype-ps/skype/Grant-CsHostedVoicemailPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsHostedVoicemailPolicy.md index 9fe8d50ae6..c9d1065561 100644 --- a/skype/skype-ps/skype/Grant-CsHostedVoicemailPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsHostedVoicemailPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-cshostedvoicemailpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsHostedVoicemailPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/grant-cshostedvoicemailpolicy +schema: 2.0.0 +title: Grant-CsHostedVoicemailPolicy --- # Grant-CsHostedVoicemailPolicy @@ -40,7 +42,7 @@ If you assign to a user a hosted voice mail policy that does not include a desti ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsHostedVoicemailPolicy -Identity "Ken Myer" -PolicyName ExRedmond ``` @@ -48,7 +50,7 @@ Grant-CsHostedVoicemailPolicy -Identity "Ken Myer" -PolicyName ExRedmond This example assigns the hosted voice mail policy with the Identity ExRedmond to the user with the display name Ken Myer. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsUser -OU "ou=Finance,ou=North America,dc=litwareinc,dc=com" | Grant-CsHostedVoicemailPolicy -PolicyName ExRedmond ``` @@ -60,7 +62,29 @@ This collection of users is then piped to the Grant-CsHostedVoicemailPolicy cmdl ## PARAMETERS +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to specify a domain controller. +If no domain controller is specified, the first available will be used. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Identity (unique identifier) of the user to whom the hosted voice mail policy is being assigned. User identities can be specified using one of four formats: 1) The user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). @@ -73,8 +97,7 @@ Full data type: Microsoft.Rtc.Management.AD.UserIdParameter ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -83,33 +106,17 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -PolicyName -The name (Identity) of the hosted voice mail policy to be assigned to the user. -(Note that this includes only the name portion of the Identity. -Per-user hosted voice mail policy identities include a prefix of tag: that should not be included with the PolicyName.) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PassThru -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -DomainController -Allows you to specify a domain controller. -If no domain controller is specified, the first available will be used. +Returns the results of the command. +By default, this cmdlet does not generate any output. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -118,31 +125,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Returns the results of the command. -By default, this cmdlet does not generate any output. +### -PolicyName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The name (Identity) of the hosted voice mail policy to be assigned to the user. +(Note that this includes only the name portion of the Identity. +Per-user hosted voice mail policy identities include a prefix of tag: that should not be included with the PolicyName.) ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -151,14 +163,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -172,15 +186,14 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String. +### System.String Accepts a pipelined string value representing the Identity of a user account to which the hosted voice mail policy is being granted. ### Microsoft.Rtc.Management.AD.UserIdParameter ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADUserOrAppContact When used with the PassThru parameter, returns an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADUserOrAppContact. ### System.Object diff --git a/skype/skype-ps/skype/Grant-CsIPPhonePolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsIPPhonePolicy.md similarity index 96% rename from skype/skype-ps/skype/Grant-CsIPPhonePolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsIPPhonePolicy.md index 0bc1ea6d26..aa3d9bd679 100644 --- a/skype/skype-ps/skype/Grant-CsIPPhonePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsIPPhonePolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csipphonepolicy applicable: Skype for Business Server 2019 -title: Grant-CsIPPhonePolicy, Skype for Business Server 2019 -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/grant-csipphonepolicy +schema: 2.0.0 +title: Grant-CsIPPhonePolicy, Skype for Business Server 2019 --- # Grant-CsIPPhonePolicy @@ -37,7 +39,7 @@ IP phone policies are applied each time a user accesses the system, regardless o ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Grant-CsIPPhonePolicy -Identity "Ken Myer" -PolicyName SkypePolicy ``` @@ -45,7 +47,7 @@ Grant-CsIPPhonePolicy -Identity "Ken Myer" -PolicyName SkypePolicy This example assigns the IP phone policy "SkypePolicy" to the user with the identity "Ken Myer". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUser -LDAPFilter "Department=Sales" | Grant-CsIPPhonePolicy -PolicyName SalesPolicy ``` @@ -57,49 +59,53 @@ This collection of users is piped to the Grant-CsIPPhonePolicy cmdlet, which ass ## PARAMETERS -### -PolicyName -Specifies the name of the policy to be assigned. -The PolicyName is the policy Identity minus the policy scope ("tag:"). -For example, a policy that has the identity "tag:Redmond" has a PolicyName equal to "Redmond". -If you set PolicyName to a null value, then the command will unassign any per-user policy assigned to the user. -For example: `Grant-CsIPPhonePolicy -Identity "Ken Myer" -PolicyName $Null` +### -DomainController +This parameter is reserved for internal Microsoft use. ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: +Aliases: applicable: Microsoft Teams, Skype for Business Server 2019 Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. +### -Identity +Specifies the identity of the target user. +Acceptable values include: + +Example: jphillips@contoso.com + +Example: sip:jphillips@contoso.com + +Example: 98403f08-577c-46dd-851a-f0460a13b03d ```yaml -Type: SwitchParameter +Type: UserIdParameter Parameter Sets: (All) -Aliases: cf +Aliases: applicable: Microsoft Teams, Skype for Business Server 2019 Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -This parameter is reserved for internal Microsoft use. +### -PassThru +Including this switch enables you to pass a user object through the pipeline that represents the user account being assigned the voice routing policy. +By default, the Grant-CsIPPhonePolicy cmdlet does not pass objects through the pipeline. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: applicable: Microsoft Teams, Skype for Business Server 2019 Required: False @@ -109,37 +115,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specifies the identity of the target user. -Acceptable values include: - -Example: jphillips@contoso.com - -Example: sip:jphillips@contoso.com - -Example: 98403f08-577c-46dd-851a-f0460a13b03d +### -PolicyName +Specifies the name of the policy to be assigned. +The PolicyName is the policy Identity minus the policy scope ("tag:"). +For example, a policy that has the identity "tag:Redmond" has a PolicyName equal to "Redmond". +If you set PolicyName to a null value, then the command will unassign any per-user policy assigned to the user. +For example: `Grant-CsIPPhonePolicy -Identity "Ken Myer" -PolicyName $Null` ```yaml -Type: UserIdParameter +Type: String Parameter Sets: (All) -Aliases: +Aliases: applicable: Microsoft Teams, Skype for Business Server 2019 Required: False -Position: 1 +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Including this switch enables you to pass a user object through the pipeline that represents the user account being assigned the voice routing policy. -By default, the Grant-CsIPPhonePolicy cmdlet does not pass objects through the pipeline. +### -Tenant +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: +Aliases: applicable: Microsoft Teams, Skype for Business Server 2019 Required: False @@ -149,13 +151,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -This parameter is reserved for internal Microsoft use. +### -Confirm +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf applicable: Microsoft Teams, Skype for Business Server 2019 Required: False @@ -187,12 +189,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The Grant-CsIPPhonePolicy cmdlet accepts pipelined input of Microsoft.Rtc.Management.ADConnect.Schema.ADUser objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact By default, the Grant-CsIPPhonePolicy cmdlet returns no objects or values. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact object. diff --git a/skype/skype-ps/skype/Grant-CsLocationPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsLocationPolicy.md similarity index 88% rename from skype/skype-ps/skype/Grant-CsLocationPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsLocationPolicy.md index 6ea4f48cc5..2b39c52cb3 100644 --- a/skype/skype-ps/skype/Grant-CsLocationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsLocationPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-cslocationpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsLocationPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/grant-cslocationpolicy +schema: 2.0.0 +title: Grant-CsLocationPolicy --- # Grant-CsLocationPolicy @@ -47,7 +48,7 @@ If the user calls from a location that is unknown or unmapped in the organizatio ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsLocationPolicy -Identity "Ken Myer" -PolicyName Reno @@ -56,7 +57,7 @@ Grant-CsLocationPolicy -Identity "Ken Myer" -PolicyName Reno In Example 1, the Grant-CsLocationPolicy cmdlet is used to assign the Reno location policy to user Ken Myer. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsUser -LDAPFilter "Department=Accounting" | Grant-CsLocationPolicy -PolicyName AccountingArea @@ -68,7 +69,7 @@ The query value passed to LDAPFilter--"Department=Accounting"--returns all the u This collection is then passed to the Grant-CsLocationPolicy cmdlet, which proceeds to assign the AccountingArea policy to each user in the collection. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Grant-CsLocationPolicy -Identity "Ken Myer" -PolicyName Reno -PassThru | Select-Object DisplayName, LocationPolicy @@ -84,7 +85,29 @@ One thing to notice with this example is that the newly granted location policy ## PARAMETERS +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to specify a domain controller. +If no domain controller is specified, the first available will be used. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account the policy should be assigned to. User identities can be specified using one of four formats: 1) The user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). Note that the SAMAccountName cannot be used as an identity. @@ -95,8 +118,7 @@ For example, the Identity "* Smith" would grant the policy to all the users with ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -105,32 +127,17 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -DomainController -Allows you to specify a domain controller. -If no domain controller is specified, the first available will be used. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PassThru -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PassThru Including this parameter (which does not take a value) displays the user information when the cmdlet completes. Normally there is no output when this cmdlet is run. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -140,13 +147,15 @@ Accept wildcard characters: False ``` ### -PolicyName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Identity of the location policy to apply to the user. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -155,14 +164,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -171,14 +182,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -192,13 +205,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String. +### System.String Accepts a pipelined string value representing the Identity of a user account to which the location policy is being granted. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADUserOrAppContact When used with the PassThru parameter, returns an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADUserOrAppContact. ## NOTES diff --git a/skype/skype-ps/skype/Grant-CsMobilityPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsMobilityPolicy.md similarity index 86% rename from skype/skype-ps/skype/Grant-CsMobilityPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsMobilityPolicy.md index a6b4002ac5..f63feaab5e 100644 --- a/skype/skype-ps/skype/Grant-CsMobilityPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsMobilityPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csmobilitypolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsMobilityPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/grant-csmobilitypolicy +schema: 2.0.0 +title: Grant-CsMobilityPolicy --- # Grant-CsMobilityPolicy @@ -36,7 +38,7 @@ Users who have been enabled for Call via Work can achieve this either by dialing With dial-out conferencing, a user effectively asks the Mobility Service server to make a call for them. The server will set up the call, and then call the user back on their mobile phone. After the user has answered, the server will then dial the party being called. -Both of these capabilities can be managed by using mobility policies. +Both of these capabilities can be managed by using mobility policies. With Microsoft Teams or Skype for Business Server, mobile devices can make or receive phone calls by using either the standard cellular phone network. or by using Wi-Fi connections. @@ -67,7 +69,7 @@ Who can run this cmdlet: By default, members of the following groups are authori ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsMobilityPolicy -Identity "Ken Myer" -PolicyName "RedmondMobilityPolicy" ``` @@ -75,7 +77,7 @@ Grant-CsMobilityPolicy -Identity "Ken Myer" -PolicyName "RedmondMobilityPolicy" The command shown in Example 1 assigns the per-user mobility policy RedmondMobilityPolicy to a single user: Ken Myer. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsUser -Filter {MobilityPolicy -eq "NorthAmericaMobilityPolicy"} | Grant-CsMobilityPolicy -PolicyName "RedmondMobilityPolicy" ``` @@ -85,7 +87,7 @@ To do this, the command first uses the Get-CsUser cmdlet and the Filter paramete After retrieving the collection of user accounts, those accounts are then piped to the Grant-CsMobilityPolicy cmdlet, which assigns each user the policy RedmondMobilityPolicy. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsUser -LdapFilter "l=Redmond" | Grant-CsMobilityPolicy -PolicyName "RedmondMobilityPolicy" ``` @@ -95,7 +97,7 @@ To perform this task, the command first calls the Get-CsUser cmdlet along with t (The "l" represents the Active Directory attribute "locality".) After the user accounts have been retrieved, those accounts are piped to the Grant-CsMobilityPolicy cmdlet; in turn, the Grant-CsMobilityPolicy cmdlet assigns each user the policy RedmondMobilityPolicy. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` Get-CsUser -Filter {RegistrarPool -eq "atl-cs-001.litwareinc.com"} | Grant-CsMobilityPolicy -PolicyName "RedmondMobilityPolicy" ``` @@ -107,35 +109,17 @@ After retrieving the collection of user accounts, those accounts are then piped ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be assigned the per-user mobility policy. -User Identities are typically specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). -User Identities can also be specified by using the user's Active Directory distinguished name. - -In addition, you can use the asterisk (*) wildcard character when using the Display Name as the user Identity. -For example, the Identity "* Smith" will assign the policy to all the users who have a display name that ends with the string value " Smith". +### -DomainController -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Enables you to specify the fully qualified domain name (FQDN) of a domain controller to be contacted when assigning the new policy. +If this parameter is not specified then the Grant-CsMobilityPolicy cmdlet will contact the first available domain controller. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -144,32 +128,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to specify the fully qualified domain name (FQDN) of a domain controller to be contacted when assigning the new policy. -If this parameter is not specified then the Grant-CsMobilityPolicy cmdlet will contact the first available domain controller. +### -Identity + +> Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the user account to be assigned the per-user mobility policy. +User Identities are typically specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). +User Identities can also be specified by using the user's Active Directory distinguished name. + +In addition, you can use the asterisk (*) wildcard character when using the Display Name as the user Identity. +For example, the Identity "* Smith" will assign the policy to all the users who have a display name that ends with the string value " Smith". ```yaml -Type: Fqdn +Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsMobilityPolicy cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,6 +171,9 @@ Accept wildcard characters: False ``` ### -PolicyName + +> Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + "Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondUsersMobilityPolicy has a PolicyName equal to RedmondUsersMobilityPolicy. @@ -193,8 +188,7 @@ To unassign a per-user policy previously assigned to a user, set the PolicyName ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -203,14 +197,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Tenant +{{Fill Tenant Description}} + +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -219,13 +230,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -{{Fill Tenant Description}} +### -WhatIf + +> Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named @@ -239,28 +253,19 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### +### System.String Grant-CsMobilityPolicy accepts pipelined input of string values representing the Identity of a user account. The cmdlet also accepts pipelined input of user objects. ### Microsoft.Rtc.Management.AD.UserIdParameter - -### -The Grant-CsMobilityPolicy cmdlet accepts pipelined input of string values representing the Identity of a user account. The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact By default, Grant-CsMobilityPolicy does not return any objects or values. However, if you include the PassThru parameter, the cmdlet will be able to pipeline instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact object. -### System.Object - -### -By default, the Grant-CsMobilityPolicy cmdlet does not return any objects or values. -However, if you include the PassThru parameter, the cmdlet will be able to pipeline instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact object. - ## NOTES ## RELATED LINKS diff --git a/skype/skype-ps/skype/Grant-CsOUPermission.md b/skype/skype-ps/SkypeForBusiness/Grant-CsOUPermission.md similarity index 84% rename from skype/skype-ps/skype/Grant-CsOUPermission.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsOUPermission.md index 222046671f..af92b0cd07 100644 --- a/skype/skype-ps/skype/Grant-CsOUPermission.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsOUPermission.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csoupermission applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsOUPermission -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/grant-csoupermission +schema: 2.0.0 +title: Grant-CsOUPermission --- # Grant-CsOUPermission @@ -42,7 +43,7 @@ In that case, you will need to be an enterprise administrator or a domain admini ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsOUPermission -OU "ou=Redmond,dc=litwareinc,dc=com" -ObjectType "user" @@ -51,7 +52,7 @@ Grant-CsOUPermission -OU "ou=Redmond,dc=litwareinc,dc=com" -ObjectType "user" The command shown in Example 1 grants user management rights (-ObjectType "user") to the Redmond OU in the domain litwareinc.com. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Grant-CsOUPermission -OU "ou=Redmond,dc=litwareinc,dc=com" -ObjectType "user","contact","inetOrgPerson" @@ -60,7 +61,7 @@ Grant-CsOUPermission -OU "ou=Redmond,dc=litwareinc,dc=com" -ObjectType "user","c In Example 2, management rights are granted for three different objects (user, contact, inetOrgPerson) for the Redmond OU in the domain litwareinc.com. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` $x = "ou=Redmond,dc=litwareinc,dc=com", "ou=Dublin,dc=litwareinc,dc=com", "ou=Tokyo,dc=litwareinc,dc=com" @@ -76,77 +77,58 @@ In turn, that command grants user management rights for each OU in the array. ## PARAMETERS -### -ObjectType - -Type of object covered by these rights. -Valid values are: - -User - -Computer - -Contact - -AppContact - -InetOrgPerson +### -Domain -Device (required for creating common area phones) +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -To assign multiple object types in the same command, separate the object types by using commas: `-ObjectType "user","computer","contact".` -Note, however, that you can only specify a maximum of three object types per command. +Name of the domain where the OU is located. +If this parameter is not included, then the Grant-CsOUPermission cmdlet will look for the OU on the current domain. ```yaml -Type: ObjectType +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OU +### -DomainController -Distinguished name of the OU where rights are to be granted. -For example: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-OU "ou=Redmond,dc=litwareinc,dc=com"` - -Note that you can only grant rights to a single OU per command. +Enables administrators to specify the fully qualified domain name (FQDN) of the domain controller to be used when running the Grant-CsOUPermission cmdlet. +If not specified, the cmdlet will use the first available domain controller. ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Domain - -Name of the domain where the OU is located. -If this parameter is not included, then the Grant-CsOUPermission cmdlet will look for the OU on the current domain. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -155,18 +137,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController +### -GlobalCatalog -Enables administrators to specify the fully qualified domain name (FQDN) of the domain controller to be used when running the Grant-CsOUPermission cmdlet. -If not specified, the cmdlet will use the first available domain controller. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of a global catalog server in your domain. +This parameter is not required if you are running the Grant-CsOUPermission cmdlet on a computer with an account in your domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,36 +158,61 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalCatalog +### -ObjectType -FQDN of a global catalog server in your domain. -This parameter is not required if you are running the Grant-CsOUPermission cmdlet on a computer with an account in your domain. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of object covered by these rights. +Valid values are: + +User + +Computer + +Contact + +AppContact + +InetOrgPerson + +Device (required for creating common area phones) + +To assign multiple object types in the same command, separate the object types by using commas: `-ObjectType "user","computer","contact".` +Note, however, that you can only specify a maximum of three object types per command. ```yaml -Type: Fqdn +Type: ObjectType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Distinguished name of the OU where rights are to be granted. +For example: + +`-OU "ou=Redmond,dc=litwareinc,dc=com"` + +Note that you can only grant rights to a single OU per command. + + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -213,6 +221,8 @@ Accept wildcard characters: False ### -Report +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: @@ -223,8 +233,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -233,14 +242,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -249,14 +260,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -270,13 +283,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Grant-CsOUPermission cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The Grant-CsOUPermission cmdlet does not return any objects or values. ## NOTES diff --git a/skype/skype-ps/skype/Grant-CsPersistentChatPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsPersistentChatPolicy.md similarity index 91% rename from skype/skype-ps/skype/Grant-CsPersistentChatPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsPersistentChatPolicy.md index 2802ff6d76..403eeb9f36 100644 --- a/skype/skype-ps/skype/Grant-CsPersistentChatPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsPersistentChatPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-cspersistentchatpolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsPersistentChatPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/grant-cspersistentchatpolicy +schema: 2.0.0 +title: Grant-CsPersistentChatPolicy --- # Grant-CsPersistentChatPolicy @@ -45,7 +46,7 @@ In the Edit Lync Server User dialog box, select a policy from the Persistent Cha ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Grant-CsPersistentChatPolicy -Identity "Ken Myer" -PolicyName "RedmondUsersPersistentChatPolicy" @@ -54,7 +55,7 @@ Grant-CsPersistentChatPolicy -Identity "Ken Myer" -PolicyName "RedmondUsersPersi The command shown in Example 1 assigns the per-user policy RedmondUsersPersistentChatPolicy to the user with the Active Directory display name "Ken Myer". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUser -LdapFilter "Department=IT" | Grant-CsPersistentChatPolicy -PolicyName "RedmondUsersPersistentChatPolicy" @@ -65,7 +66,7 @@ To do this, the command first calls the Get-CsUser cmdlet along with the LdapFil That collection of users is then piped to the Grant-CsPersistentChatPolicy cmdlet, which assigns the policy RedmondUsersPersistentChatPolicy to each user in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsUser -Filter {PersistentChatPolicy -eq $Null} | Grant-CsPersistentChatPolicy -PolicyName "RedmondUsersPersistentChatPolicy" @@ -76,7 +77,7 @@ To carry out this task, the command first employs the Get-CsUser cmdlet and the That collection of users is then piped to the Grant-CsPersistentChatPolicy cmdlet, which assigns each user in the collection the policy RedmondUsersPersistentChatPolicy. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsUser -Filter {PersistentChatPolicy -eq "RedmondUsersPersistentChatPolicy"} | Grant-CsPersistentChatPolicy -PolicyName $Null @@ -91,35 +92,19 @@ After the per-user policy has been unassigned, users will have their Persistent ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be assigned the per-user Persistent Chat policy. -User Identities are typically specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (four example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). -User Identities can also be specified by using the user's Active Directory distinguished name. +### -DomainController -In addition, you can use the asterisk (*) wildcard character when using the Display Name as the user Identity. -For example, the Identity "* Smith" returns all the users who have a display name that ends with the string value " Smith". +> Applicable: Lync Server 2013, Skype for Business Server 2015 -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Enables you to specify the fully qualified domain name of a domain controller to be contacted when assigning the new policy. +If this parameter is not specified then the Grant-CsPersistentChatPolicy cmdlet will contact the first available domain controller. -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` -### -Confirm -Prompts you for confirmation before executing the command. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -128,35 +113,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController +### -Identity -Enables you to specify the fully qualified domain name of a domain controller to be contacted when assigning the new policy. -If this parameter is not specified then the Grant-CsPersistentChatPolicy cmdlet will contact the first available domain controller. +> Applicable: Lync Server 2013, Skype for Business Server 2015 +Indicates the Identity of the user account to be assigned the per-user Persistent Chat policy. +User Identities are typically specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (four example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). +User Identities can also be specified by using the user's Active Directory distinguished name. +In addition, you can use the asterisk (*) wildcard character when using the Display Name as the user Identity. +For example, the Identity "* Smith" returns all the users who have a display name that ends with the string value " Smith". ```yaml -Type: Fqdn +Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to pass a user object through the pipeline that represents the user being assigned the policy. By default, the Grant-CsPersistentChatPolicy cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -166,6 +156,9 @@ Accept wildcard characters: False ``` ### -PolicyName + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + "Name" of the policy to be assigned. The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondUsersPersistentChatPolicy has a PolicyName equal to RedmondUsersPersistentChatPolicy. @@ -174,8 +167,7 @@ To unassign a per-user policy previously assigned to a user, set the PolicyName ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 2 @@ -184,14 +176,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -205,14 +217,15 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String value or Microsoft.Rtc.Management.WritableConfig.Policy.PersistentChat.PersistentChatPolicy object. +### System.String The Grant-CsPersistentChatPolicy cmdlet accepts pipelined input of string values representing the Identity of a user account. + +### Microsoft.Rtc.Management.WritableConfig.Policy.PersistentChat.PersistentChatPolicy The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact By default, the Grant-CsPersistentChatPolicy cmdlet does not return an objects or values. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact. diff --git a/skype/skype-ps/skype/Grant-CsPinPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsPinPolicy.md similarity index 86% rename from skype/skype-ps/skype/Grant-CsPinPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsPinPolicy.md index 7abc34da1c..5be543f393 100644 --- a/skype/skype-ps/skype/Grant-CsPinPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsPinPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-cspinpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsPinPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/grant-cspinpolicy +schema: 2.0.0 +title: Grant-CsPinPolicy --- # Grant-CsPinPolicy @@ -41,7 +42,7 @@ In order to assign a per-user policy you must use the Grant-CsPinPolicy cmdlet. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsPinPolicy -Identity "kenmyer@litwareinc.com" -PolicyName RedmondUsersPinPolicy @@ -50,7 +51,7 @@ Grant-CsPinPolicy -Identity "kenmyer@litwareinc.com" -PolicyName RedmondUsersPin The command shown in Example 1 assigns the policy RedmondUsersPinPolicy to the user kenmyer@litwareinc.com. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Grant-CsPinPolicy -Identity kenmyer@litwareinc.com -PolicyName $Null @@ -60,7 +61,7 @@ Example 2 unassigns any per-user PIN policy previously assigned to the user kenm Calling the Grant-CsPinPolicy cmdlet and setting the policy name to a null value ($Null) removes any per-user policy assigned to the user. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsUser -LdapFilter "l=Redmond" | Grant-CsPinPolicy -PolicyName RedmondUsersPinPolicy @@ -71,7 +72,7 @@ In Example 3, the policy RedmondUsersPinPolicy is assigned to all the users who To do this, the Get-CsUser cmdlet first retrieves a collection of all the users who work in Redmond; this is done by including the LdapFilter parameter and using the filter value "l=Redmond". (With LDAP filters, l, a lowercase L, represents the user's locality.) That collection of users is then piped to the Grant-CsPinPolicy cmdlet, which assigns each user the policy RedmondUsersPinPolicy. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` Get-CsUser -Filter {PinPolicy -eq $Null} | Grant-CsPinPolicy -PolicyName RedmondUsersPinPolicy @@ -84,7 +85,31 @@ That collection of users is then piped to the Grant-CsPinPolicy cmdlet, which as ## PARAMETERS +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify the fully qualified domain name of a domain (FQDN) controller to be contacted when assigning the new policy. +If this parameter is not specified then the Grant-CsPinPolicy cmdlet will contact the first available domain controller. + + + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account to be assigned the per-user PIN policy. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (four example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be specified by using the user's Active Directory distinguished name. @@ -95,8 +120,7 @@ For example, the Identity "* Smith" returns all the users who have a display nam ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -105,57 +129,58 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -PolicyName - -"Name" of the policy to be assigned. -The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). -For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondUsersPinPolicy has a PolicyName equal to RedmondUsersPinPolicy. -To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). +### -PassThru +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. +By default, the Grant-CsPinPolicy cmdlet does not pass objects through the pipeline. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController +### -PolicyName -Enables you to specify the fully qualified domain name of a domain (FQDN) controller to be contacted when assigning the new policy. -If this parameter is not specified then the Grant-CsPinPolicy cmdlet will contact the first available domain controller. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +"Name" of the policy to be assigned. +The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). +For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondUsersPinPolicy has a PolicyName equal to RedmondUsersPinPolicy. +To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the user being assigned the policy. -By default, the Grant-CsPinPolicy cmdlet does not pass objects through the pipeline. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -165,29 +190,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -201,15 +212,15 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String value or Microsoft.Rtc.Management.UserPinService.PinInfoDetails object. +### System.String The Grant-CsPinPolicy cmdlet accepts pipelined input of string values representing the Identity of a user account. + +### Microsoft.Rtc.Management.UserPinService.PinInfoDetails The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### -By default, the Grant-CsPinPolicy cmdlet does not return a value or object. +### Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact. ## NOTES diff --git a/skype/skype-ps/skype/Grant-CsPresencePolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsPresencePolicy.md similarity index 88% rename from skype/skype-ps/skype/Grant-CsPresencePolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsPresencePolicy.md index 0b4f666350..ac8a3f704b 100644 --- a/skype/skype-ps/skype/Grant-CsPresencePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsPresencePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-cspresencepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsPresencePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/grant-cspresencepolicy +schema: 2.0.0 +title: Grant-CsPresencePolicy --- # Grant-CsPresencePolicy @@ -52,7 +53,7 @@ Instead, per-user presence policies must be explicitly assigned to users (or gro ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsPresencePolicy -Identity "Ken Myer" -PolicyName "RedmondPresencePolicy" @@ -61,7 +62,7 @@ Grant-CsPresencePolicy -Identity "Ken Myer" -PolicyName "RedmondPresencePolicy" The command shown in Example 1 assigns the per-user presence policy RedmondPresencePolicy to a single user: the user with the Identity Ken Myer. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsUser -OU "OU=Redmond,dc=litwareinc,dc=com" | Grant-CsPresencePolicy -PolicyName "RedmondPresencePolicy" @@ -72,7 +73,7 @@ To do this, the command first uses the Get-CsUser cmdlet and the OU parameter to This collection is then piped to the Grant-CsPresencePolicy cmdlet, which assigns the policy RedmondPresencePolicy to each user in the collection. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsUser -LdapFilter "l=Redmond" | Grant-CsPresencePolicy -PolicyName "RedmondPresencePolicy" @@ -83,7 +84,7 @@ To carry out this task, the command first uses the Get-CsUser cmdlet and the Lda (In the LDAP query language, l, the lowercase L, is short for "locality.") The retrieved collection is then piped to the Grant-CsPresencePolicy cmdlet, which assigns the policy RedmondPresencePolicy to each user in the collection. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` Get-CsUser -LdapFilter "l=Redmond" | Grant-CsPresencePolicy -PolicyName $Null @@ -95,7 +96,35 @@ Calling the Grant-CsPresencePolicy cmdlet while setting the PolicyName parameter ## PARAMETERS +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified name of the domain (FQDN) controller to be contacted when assigning the policy. +For example: + +`-DomainController atl-dc-001.litwareinc.com` + +If not specified, the Grant-CsPresencePolicy cmdlet will contact the nearest available domain controller when assigning the policy. + + + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account to be assigned the presence policy. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be specified by using the user's Active Directory distinguished name. @@ -106,8 +135,7 @@ For example, the Identity "* Smith" returns all the users with display name that ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -116,63 +144,60 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -PolicyName - -Identity of the per-user policy to be assigned; for example: - -`-PolicyName "RedmondPresencePolicy"` - -The PolicyName is the Identity of the policy minus the "tag:" prefix. -For example, a policy with the Identity "tag:NorthAmericaPresencePolicy" has a PolicyName equal to "NorthAmericaPresencePolicy". +### -PassThru +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. +By default, the Grant-CsPresencePolicy cmdlet does not pass objects through the pipeline. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController +### -PolicyName -Fully qualified name of the domain (FQDN) controller to be contacted when assigning the policy. -For example: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-DomainController atl-dc-001.litwareinc.com` +Identity of the per-user policy to be assigned; for example: -If not specified, the Grant-CsPresencePolicy cmdlet will contact the nearest available domain controller when assigning the policy. +`-PolicyName "RedmondPresencePolicy"` + +The PolicyName is the Identity of the policy minus the "tag:" prefix. +For example, a policy with the Identity "tag:NorthAmericaPresencePolicy" has a PolicyName equal to "NorthAmericaPresencePolicy". ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the user being assigned the policy. -By default, the Grant-CsPresencePolicy cmdlet does not pass objects through the pipeline. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -182,29 +207,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -218,14 +229,15 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String value or Microsoft.Rtc.Management.WritebleConfig.Policy.Presence.PresencePolicy object. +### System.String The Grant-CsPresencePolicy cmdlet accepts pipelined input of string values representing the Identity of a user account. + +### Microsoft.Rtc.Management.WritebleConfig.Policy.Presence.PresencePolicy The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact By default, the Grant-CsPresencePolicy cmdlet does not return an objects or values. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact. diff --git a/skype/skype-ps/skype/Grant-CsSetupPermission.md b/skype/skype-ps/SkypeForBusiness/Grant-CsSetupPermission.md similarity index 83% rename from skype/skype-ps/skype/Grant-CsSetupPermission.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsSetupPermission.md index 7884f28095..3d8397be39 100644 --- a/skype/skype-ps/skype/Grant-CsSetupPermission.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsSetupPermission.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-cssetuppermission applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsSetupPermission -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/grant-cssetuppermission +schema: 2.0.0 +title: Grant-CsSetupPermission --- # Grant-CsSetupPermission @@ -39,7 +40,7 @@ Keep in mind that this cmdlet only grants permissions to the RTCUniversalServerA ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsSetupPermission -ComputerOU "ou=CsServers,dc=litwareinc,dc=com" @@ -52,6 +53,8 @@ The command shown in Example 1 grants setup permissions for the CsServers OU in ### -ComputerOU +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Distinguished name of the OU containing the accounts for the computers where Skype for Business Server will be (or has been) installed. For example: "ou=CsServers,dc=litwareinc,dc=com". @@ -65,8 +68,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -77,6 +79,8 @@ Accept wildcard characters: False ### -Domain +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the domain where the OU is located. If this parameter is not included, then the Grant-CsSetupPermission cmdlet will look for the OU in the current domain. @@ -85,8 +89,7 @@ If this parameter is not included, then the Grant-CsSetupPermission cmdlet will ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -97,6 +100,8 @@ Accept wildcard characters: False ### -DomainController +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified name of the domain controller to be contacted when assigning the policy. For example: @@ -109,8 +114,7 @@ If not specified, the Grant-CsSetupPermission cmdlet will contact the nearest av ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,22 +123,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalCatalog - -Fully qualified name of the global catalog server to be contacted when assigning the policy. -For example: - -`-GlobalCatalog atl-dc-001.litwareinc.com` - -If not specified, the Grant-CsSetupPermission cmdlet will contact the nearest available global catalog server when assigning the policy. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -143,14 +141,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified name of the global catalog server to be contacted when assigning the policy. +For example: + +`-GlobalCatalog atl-dc-001.litwareinc.com` + +If not specified, the Grant-CsSetupPermission cmdlet will contact the nearest available global catalog server when assigning the policy. + + ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -161,6 +168,8 @@ Accept wildcard characters: False ### -Report +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: @@ -171,8 +180,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -181,14 +189,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -197,14 +207,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -218,15 +230,13 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Grant-CsSetupPermission cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None The Grant-CsSetupPermission cmdlet does not return any objects or values. ## NOTES diff --git a/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsTeamsUpgradePolicy.md similarity index 97% rename from skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsTeamsUpgradePolicy.md index 49be661490..228b9e229b 100644 --- a/skype/skype-ps/skype/Grant-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsTeamsUpgradePolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csteamsupgradepolicy applicable: Skype for Business Server 2019, Skype for Business Server 2015 -title: Grant-CsTeamsUpgradePolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/grant-csteamsupgradepolicy +schema: 2.0.0 +title: Grant-CsTeamsUpgradePolicy --- # Grant-CsTeamsUpgradePolicy @@ -165,32 +167,33 @@ After running these lines will create an HTML file on the Desktop of the curre ## PARAMETERS -### -Identity - -The user you want to grant policy to. This can be specified as SIP address, UserPrincipalName, or ObjectId. +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml -Type: UserIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 +Type: SwitchParameter +Parameter Sets: GrantToTenant +Aliases: Required: False -Position: 0 +Position: Named Default value: None -Accept pipeline input: True +Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName +### -Global -The name of the policy instance. +> Applicable: Skype for Business Online + +Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. ```yaml -Type: Object +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 Required: False Position: 1 @@ -199,49 +202,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Global - -Use this switch if you want to grant the specified policy to be the default policy for all users in the tenant. +### -Group +Specifies the group used for the group policy assignment. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Type: String +Parameter Sets: GrantToGroup +Aliases: -Required: False -Position: 1 +Required: True +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -Identity -Prompts you for confirmation before running the cmdlet. +> Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 + +The user you want to grant policy to. This can be specified as SIP address, UserPrincipalName, or ObjectId. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 +Type: UserIdParameter +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 0 Default value: None -Accept pipeline input: False +Accept pipeline input: True Accept wildcard characters: False ``` -### -Tenant - -Do not use. +### -MigrateMeetingsToTeams +Not supported anymore, see the Description section. ```yaml -Type: Object +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -250,14 +250,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -PassThru +Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams call hold policy. + +By default, the cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter -Parameter Sets: GrantToTenant +Parameter Sets: (All) Aliases: Required: False @@ -267,27 +267,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Group -Specifies the group used for the group policy assignment. +### -PolicyName + +> Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 + +The name of the policy instance. ```yaml -Type: String -Parameter Sets: GrantToGroup -Aliases: +Type: Object +Parameter Sets: (All) +Aliases: -Required: True -Position: Named +Required: False +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MigrateMeetingsToTeams -Not supported anymore, see the Description section. +### -Rank +The rank of the policy assignment, relative to other group policy assignments for the same policy type. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: Int32 +Parameter Sets: GrantToGroup Aliases: Required: False @@ -297,15 +300,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the user account being assigned the Teams call hold policy. +### -Tenant -By default, the cmdlet does not pass objects through the pipeline. +> Applicable: Skype for Business Online + +Do not use. ```yaml -Type: SwitchParameter +Type: Object Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -314,13 +318,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Rank -The rank of the policy assignment, relative to other group policy assignments for the same policy type. +### -Confirm + +> Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015 + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Int32 -Parameter Sets: GrantToGroup -Aliases: +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named diff --git a/skype/skype-ps/skype/Grant-CsThirdPartyVideoSystemPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsThirdPartyVideoSystemPolicy.md similarity index 91% rename from skype/skype-ps/skype/Grant-CsThirdPartyVideoSystemPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsThirdPartyVideoSystemPolicy.md index c5066205d9..3a8c775ff4 100644 --- a/skype/skype-ps/skype/Grant-CsThirdPartyVideoSystemPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsThirdPartyVideoSystemPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csthirdpartyvideosystempolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsThirdPartyVideoSystemPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/grant-csthirdpartyvideosystempolicy +schema: 2.0.0 +title: Grant-CsThirdPartyVideoSystemPolicy --- # Grant-CsThirdPartyVideoSystemPolicy @@ -39,7 +40,7 @@ If you want a VTC device to be managed by the global policy or (if available) th ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsThirdPartyVideoSystem -Filter {DisplayName -eq "Redmond Video Device"} | Grant-CsThirdPartyVideoSystemPolicy -PolicyName "RedmondVideoSystemPolicy" @@ -50,7 +51,7 @@ To do this, the command first uses the Get-CsThirdPartyVideoSystem cmdlet and th This device is then piped to the Grant-CsThirdPartyVideoSystemPolicy cmdlet, which assigns the device the policy RedmondVideoSystemPolicy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsThirdPartyVideoSystem -Filter {DisplayName -eq "Redmond Video Device"} | Grant-CsThirdPartyVideoSystemPolicy -PolicyName $Null @@ -61,7 +62,7 @@ The command shown in Example 2 is effectively the inverse of the command shown i If no site policy exists then Redmond Video Device will be managed by using the global policy. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsThirdPartyVideoSystem -Filter {ThirdPartyVideoSystemPolicy -eq $Null} | Grant-CsThirdPartyVideoSystemPolicy -PolicyName "RedmondVideoSystemPolicy" @@ -74,7 +75,29 @@ To do this, the command first uses the Get-CsUser cmdlet and the Filter paramete ## PARAMETERS +### -DomainController + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify the fully qualified domain name (FQDN) of a domain controller to be contacted when assigning the new policy. +If this parameter is not specified then the Grant-CsThirdPartyVideoSystemPolicy cmdlet will contact the first available domain controller. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the video system being assigned the per-user policy. Video systems are identified by using the Active Directory distinguished name (DN) of the associated contact object. By default, video systems use a GUID (globally unique identifier) as their common name, which means systems will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. @@ -83,8 +106,7 @@ This means you might find it easier to modify third-party video systems by using ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -93,33 +115,17 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -PolicyName -"Name" of the policy to be assigned. -The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). -For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondUsersVideoPolicy has a PolicyName equal to RedmondUsersVideoPolicy. -To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). +### -PassThru -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Enables you to pass a contact object through the pipeline that represents the user being assigned the policy. +By default, the Grant-CsThirdPartyVideoSystemPolicy cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,32 +134,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to specify the fully qualified domain name (FQDN) of a domain controller to be contacted when assigning the new policy. -If this parameter is not specified then the Grant-CsThirdPartyVideoSystemPolicy cmdlet will contact the first available domain controller. +### -PolicyName + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +"Name" of the policy to be assigned. +The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). +For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; a policy with the Identity tag:RedmondUsersVideoPolicy has a PolicyName equal to RedmondUsersVideoPolicy. +To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a contact object through the pipeline that represents the user being assigned the policy. -By default, the Grant-CsThirdPartyVideoSystemPolicy cmdlet does not pass objects through the pipeline. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -163,13 +174,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -183,14 +196,15 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String The Grant-CsThirdPartyVideoSystemPolicy cmdlet accepts pipelined input of string values representing the Identity of a user account. + +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.ThirdPartyVideoSystem.ThirdPartyVideoSystemPolicy By default, the Grant-CsThirdPartyVideoSystemPolicy cmdlet does not return a value or object. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ThirdPartyVideoSystem.ThirdPartyVideoSystemPolicy object. diff --git a/skype/skype-ps/skype/Grant-CsUserServicesPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsUserServicesPolicy.md similarity index 90% rename from skype/skype-ps/skype/Grant-CsUserServicesPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsUserServicesPolicy.md index cbb4c917da..3a5e074823 100644 --- a/skype/skype-ps/skype/Grant-CsUserServicesPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsUserServicesPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csuserservicespolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsUserServicesPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/grant-csuserservicespolicy +schema: 2.0.0 +title: Grant-CsUserServicesPolicy --- # Grant-CsUserServicesPolicy @@ -49,7 +50,7 @@ Skype for Business Server Control Panel: The functions carried out by the Grant- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Grant-CsUserServicesPolicy -Identity "Ken Myer" -PolicyName "RedmondUserServicesPolicy" @@ -58,7 +59,7 @@ Grant-CsUserServicesPolicy -Identity "Ken Myer" -PolicyName "RedmondUserServices The command shown in Example 1 assigns the per-user User Services policy RedmondUserServicesPolicy to the user with the Identity (in this example, the Active Directory display name) Ken Myer. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Grant-CsUserServicesPolicy -Identity "Ken Myer" -PolicyName $Null @@ -68,7 +69,7 @@ Example 2 unassigns any per-user Users Services policy previously assigned to Ke Per-user policies are unassigned by setting the PolicyName parameter to a Null value ($Null). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsUser -Filter {RegistrarPool -eq "atl-cs-001.litwareinc.com"} | Grant-CsUserServicesPolicy -PolicyName "RedmondUserServicesPolicy" @@ -81,7 +82,29 @@ This collection of users is then piped to the Grant-CsUserServicesPolicy cmdlet, ## PARAMETERS +### -DomainController + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to connect to the specified domain controller in order to retrieve user information. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account to be assigned the per-user user experience policy. User Identities are typically specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (four example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). @@ -93,8 +116,7 @@ For example, the Identity "* Smith" returns all the users who have a display nam ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -103,14 +125,17 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -PassThru + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to pass a user object through the pipeline that represents the user account being assigned the policy. +By default, the Grant-CsUserServicesPolicy cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,68 +144,56 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to connect to the specified domain controller in order to retrieve user information. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). +### -PolicyName -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +"Name" of the policy to be assigned. +The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). +For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:RedmondUserExperiencePolicy has a PolicyName equal to RedmondUserExperiencePolicy. -### -PassThru -Enables you to pass a user object through the pipeline that represents the user account being assigned the policy. -By default, the Grant-CsUserServicesPolicy cmdlet does not pass objects through the pipeline. +To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -"Name" of the policy to be assigned. -The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). -For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:RedmondUserExperiencePolicy has a PolicyName equal to RedmondUserExperiencePolicy. +### -Confirm -To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -194,14 +207,15 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String The Grant-CsUserServicesPolicy cmdlet accepts pipelined input of string values representing the Identity of a user account. + +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact By default, the Grant-CsUserServicesPolicy cmdlet does not return a value or object. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact. diff --git a/skype/skype-ps/skype/Grant-CsVoicePolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsVoicePolicy.md similarity index 87% rename from skype/skype-ps/skype/Grant-CsVoicePolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsVoicePolicy.md index f553602f84..1b0d990881 100644 --- a/skype/skype-ps/skype/Grant-CsVoicePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsVoicePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csvoicepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsVoicePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/grant-csvoicepolicy +schema: 2.0.0 +title: Grant-CsVoicePolicy --- # Grant-CsVoicePolicy @@ -50,7 +51,7 @@ For example: ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Grant-CsVoicePolicy -Identity "Ken Myer" -PolicyName VoicePolicyRedmond ``` @@ -58,7 +59,7 @@ Grant-CsVoicePolicy -Identity "Ken Myer" -PolicyName VoicePolicyRedmond This example assigns the voice policy with the Identity VoicePolicyRedmond to the user with the display name Ken Myer. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsUser -OU "ou=Finance,ou=North America,dc=litwareinc,dc=com" | Grant-CsVoicePolicy -PolicyName VoicePolicyRedmond ``` @@ -70,7 +71,29 @@ This collection of users is then piped to the Grant-CsVoicePolicy cmdlet, which ## PARAMETERS +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to specify a domain controller. +If no domain controller is specified, the first available will be used. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Identity (unique identifier) of the user to whom the policy is being assigned. User identities can be specified by using one of four formats: 1) The user's SIP address; 2) the user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). @@ -83,8 +106,7 @@ Full Data Type: Microsoft.Rtc.Management.AD.UserIdParameter ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -93,33 +115,17 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -PolicyName -The name (Identity) of the voice policy to be assigned to the user. -(Note that this includes only the name portion of the Identity. -Per-user policy identities include a prefix of tag: that should not be included with the PolicyName.) - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PassThru -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -DomainController -Allows you to specify a domain controller. -If no domain controller is specified, the first available will be used. +Returns the results of the command. +By default, this cmdlet does not generate any output. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,31 +134,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Returns the results of the command. -By default, this cmdlet does not generate any output. +### -PolicyName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The name (Identity) of the voice policy to be assigned to the user. +(Note that this includes only the name portion of the Identity. +Per-user policy identities include a prefix of tag: that should not be included with the PolicyName.) ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Tenant + +> Applicable: Skype for Business Online + +Globally unique identifier (GUID) of the tenant account whose federation settings are being returned. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return your tenant ID by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,13 +180,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -177,21 +197,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the tenant account whose federation settings are being returned. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return your tenant ID by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: wi Required: False Position: Named @@ -205,13 +220,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String. +### System.String Accepts a pipelined string value representing the Identity of a user account to which the voice policy is being granted. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADUserOrAppContact When used with the PassThru parameter, returns an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADUserOrAppContact. ## NOTES diff --git a/skype/skype-ps/skype/Grant-CsVoiceRoutingPolicy.md b/skype/skype-ps/SkypeForBusiness/Grant-CsVoiceRoutingPolicy.md similarity index 86% rename from skype/skype-ps/skype/Grant-CsVoiceRoutingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Grant-CsVoiceRoutingPolicy.md index 741af07a2c..71867779da 100644 --- a/skype/skype-ps/skype/Grant-CsVoiceRoutingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Grant-CsVoiceRoutingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/grant-csvoiceroutingpolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Grant-CsVoiceRoutingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/grant-csvoiceroutingpolicy +schema: 2.0.0 +title: Grant-CsVoiceRoutingPolicy --- # Grant-CsVoiceRoutingPolicy @@ -41,7 +43,7 @@ Skype for Business Server Control Panel: The functions carried out by the Grant- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Grant-CsVoiceRoutingPolicy -Identity "Ken Myer" -PolicyName "RedmondVoiceRoutingPolicy" ``` @@ -49,7 +51,7 @@ Grant-CsVoiceRoutingPolicy -Identity "Ken Myer" -PolicyName "RedmondVoiceRouting The command shown in Example 1 assigns the per-user voice routing policy RedmondVoiceRoutingPolicy to the user with the Active Directory display name "Ken Myer". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Grant-CsVoiceRoutingPolicy -Identity "Ken Myer" -PolicyName $Null ``` @@ -58,7 +60,7 @@ In Example 2, any per-user voice routing policy previously assigned to the user To unassign a per-user policy, set the PolicyName to a null value ($Null). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsUser -OU "OU=Redmond,dc=litwareinc,dc=com" | Grant-CsVoiceRoutingPolicy -PolicyName "RedmondVoiceRoutingPolicy" ``` @@ -70,7 +72,29 @@ Those user accounts are then piped to the Grant-CsVoiceRoutingPolicy cmdlet, whi ## PARAMETERS +### -DomainController + +> Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to connect to the specified domain controller in order to retrieve user information. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account to be assigned the per-user voice routing policy. User Identities are typically specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). @@ -82,8 +106,7 @@ For example, the Identity "\* Smith" returns all the users who have a display na ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -92,14 +115,17 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -PassThru + +> Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to pass a user object through the pipeline that represents the user account being assigned the voice routing policy. +By default, the Grant-CsVoiceRoutingPolicy cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -108,32 +134,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to connect to the specified domain controller in order to retrieve user information. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). +### -PolicyName + +> Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +"Name" of the policy to be assigned. +The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). +For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:RedmondVoiceRoutingPolicy has a PolicyName equal to RedmondVoiceRoutingPolicy. + +To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the user account being assigned the voice routing policy. -By default, the Grant-CsVoiceRoutingPolicy cmdlet does not pass objects through the pipeline. +### -Tenant +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -142,49 +171,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyName -"Name" of the policy to be assigned. -The PolicyName is simply the policy Identity minus the policy scope (the "tag:" prefix). -For example, a policy with the Identity tag:Redmond has a PolicyName equal to Redmond; likewise, a policy with the Identity tag:RedmondVoiceRoutingPolicy has a PolicyName equal to RedmondVoiceRoutingPolicy. +### -Confirm -To unassign a per-user policy previously assigned to a user, set the PolicyName to a null value ($Null). +> Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Microsoft Teams, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Guid -Parameter Sets: (All) -Aliases: Required: False Position: Named @@ -198,14 +212,15 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String The Grant-CsVoiceRoutingPolicy cmdlet accepts pipelined input of string values representing the Identity of a user account. + +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact By default, the Grant-CsVoiceRoutingPolicy cmdlet does not return a value or object. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact. diff --git a/skype/skype-ps/skype/Import-CSAnnouncementFile.md b/skype/skype-ps/SkypeForBusiness/Import-CSAnnouncementFile.md similarity index 84% rename from skype/skype-ps/skype/Import-CSAnnouncementFile.md rename to skype/skype-ps/SkypeForBusiness/Import-CSAnnouncementFile.md index 37882297f1..1862ba5836 100644 --- a/skype/skype-ps/skype/Import-CSAnnouncementFile.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CSAnnouncementFile.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/import-csannouncementfile applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Import-CSAnnouncementFile -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/import-csannouncementfile +schema: 2.0.0 +title: Import-CSAnnouncementFile --- # Import-CSAnnouncementFile @@ -37,7 +38,7 @@ Imported files must be WAV or WMA files. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $a = [System.IO.File]::ReadAllBytes('.\GreetingFile.wav') @@ -53,7 +54,7 @@ We pass the service Identity ApplicationServer:redmond.litwareinc.com to the Par This can be any valid Windows operating system file name, but it should end with a .wav or .wma extension. Finally, we pass the variable $a as the value to the Content parameter to read in our byte array. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Import-CsAnnouncementFile -Parent ApplicationServer:redmond.litwareinc.com -FileName "WelcomeMessage.wav" -Content ([System.IO.File]::ReadAllBytes('.\GreetingFile.wav')) @@ -61,7 +62,7 @@ Import-CsAnnouncementFile -Parent ApplicationServer:redmond.litwareinc.com -File Example 2 is identical to Example 1 except that we included the command inside parentheses as a value to the Content parameter rather than calling that command on its own and assigning it to a variable. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` [System.IO.File]::ReadAllBytes('.\GreetingFile.wav') | Import-CsAnnouncementFile -Parent ApplicationServer:redmond.litwareinc.com -FileName "WelcomeMessage.wav" @@ -73,31 +74,37 @@ This is the most reliable way of importing an announcement file from a remote se ## PARAMETERS -### -Parent -The service ID of the Application Server on which the associated Announcement service is running. +### -Content + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The contents of the audio file as a byte array. + +A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). ```yaml -Type: String +Type: Byte[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True -Position: 2 +Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### -FileName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name that you want the file to have in the File Store. You will use this name in the AudioFilePrompt parameter in the call to the New-CsAnnouncement or Set-CsAnnouncement cmdlet to assign the file to an announcement. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -106,48 +113,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Content -The contents of the audio file as a byte array. +### -Force -A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: Byte[] +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Parent + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The service ID of the Application Server on which the associated Announcement service is running. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -156,14 +167,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -177,15 +190,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -Byte\[\]. -Accepts a byte array from an audio file. -Byte array must be piped as a single record. -See Example 3. +### System.Byte[] +Accepts a byte array from an audio file. Byte array must be piped as a single record. See Example 3. ## OUTPUTS -### +### None This cmdlet does not return a value. ## NOTES diff --git a/skype/skype-ps/skype/Import-CsCertificate.md b/skype/skype-ps/SkypeForBusiness/Import-CsCertificate.md similarity index 84% rename from skype/skype-ps/skype/Import-CsCertificate.md rename to skype/skype-ps/SkypeForBusiness/Import-CsCertificate.md index ba39973617..b9634dd6a6 100644 --- a/skype/skype-ps/skype/Import-CsCertificate.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsCertificate.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/import-cscertificate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Import-CsCertificate -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/import-cscertificate +schema: 2.0.0 +title: Import-CsCertificate --- # Import-CsCertificate @@ -56,7 +57,7 @@ At that point, you can use the Import-CsCertificate cmdlet to import the certifi ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Import-CsCertificate -Path "C:\Certificates\WebServer.pfx" -PrivateKeyExportable $True @@ -68,31 +69,37 @@ After the command completes, the certificate will be available to be assigned to ## PARAMETERS -### -Path -Full path to the certificate file to be imported. -For example: `-Path "C:\Certificates\WebServer.cer".` +### -EffectiveDate + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Date and time when the certificate can first be used. +For example, to configure a certificate for first use at 8:00 AM on July 31, 2012 use this syntax on a server running under the US English Region and Language settings: + +`-EffectiveTime "7/31/2012 8:00 AM"` ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: DateTime +Parameter Sets: CMS, Local +Aliases: EffectiveTime -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Password -Password associated with the certificate file. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -101,30 +108,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PrivateKeyExportable -When set to True, ensures that the private key portion of the certificate can be read by the Network Service account. +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to Global, enables the certificate to function at the global scope. +Global certificates will automatically be copied and distributed to the appropriate computers. ```yaml -Type: Boolean -Parameter Sets: (All), Local -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: CMS +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Password + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Password associated with the certificate file. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -133,31 +145,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: `-Report "C:\Logs\Certificates.html"` +### -Path + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Full path to the certificate file to be imported. +For example: `-Path "C:\Certificates\WebServer.cer".` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -PrivateKeyExportable + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, ensures that the private key portion of the certificate can be read by the Network Service account. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All), Local +Aliases: Required: False Position: Named @@ -166,14 +182,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: `-Report "C:\Logs\Certificates.html"` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,18 +201,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -When set to Global, enables the certificate to function at the global scope. -Global certificates will automatically be copied and distributed to the appropriate computers. +### -Roll + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to update the specified certificate at the date and time specified by the EffectiveDate parameter; this enables you to specify a date and time when the new certificate will become the primary certificate. +Note that your command will fail if you specify the Roll parameter without including the EffectiveDate parameter. ```yaml -Type: XdsIdentity -Parameter Sets: CMS -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: CMS, Local +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -201,6 +222,8 @@ Accept wildcard characters: False ### -Type +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Type of certificate being requested. Certificate types include, but are not limited to, the following: @@ -249,8 +272,7 @@ XMPPServer ```yaml Type: CertType[] Parameter Sets: CMS -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -259,17 +281,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EffectiveDate -Date and time when the certificate can first be used. -For example, to configure a certificate for first use at 8:00 AM on July 31, 2012 use this syntax on a server running under the US English Region and Language settings: +### -Confirm -`-EffectiveTime "7/31/2012 8:00 AM"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: DateTime -Parameter Sets: CMS, Local -Aliases: EffectiveTime -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -278,15 +299,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Roll -Enables you to update the specified certificate at the date and time specified by the EffectiveDate parameter; this enables you to specify a date and time when the new certificate will become the primary certificate. -Note that your command will fail if you specify the Roll parameter without including the EffectiveDate parameter. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter -Parameter Sets: CMS, Local -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -300,18 +322,15 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None Import-CsCertificate does not accept pipelined input. -### -None. +### None The Import-CsCertificate cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Import-CsCompanyPhoneNormalizationRules.md b/skype/skype-ps/SkypeForBusiness/Import-CsCompanyPhoneNormalizationRules.md similarity index 90% rename from skype/skype-ps/skype/Import-CsCompanyPhoneNormalizationRules.md rename to skype/skype-ps/SkypeForBusiness/Import-CsCompanyPhoneNormalizationRules.md index 68beb13982..396297431c 100644 --- a/skype/skype-ps/skype/Import-CsCompanyPhoneNormalizationRules.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsCompanyPhoneNormalizationRules.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/import-cscompanyphonenormalizationrules applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Import-CsCompanyPhoneNormalizationRules -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/import-cscompanyphonenormalizationrules +schema: 2.0.0 +title: Import-CsCompanyPhoneNormalizationRules --- # Import-CsCompanyPhoneNormalizationRules @@ -42,7 +43,7 @@ Alternatively, the New-CsAddressBookNormalizationConfiguration and Set-CsAddress ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Import-CsCompanyPhoneNormalizationRules -Filename "C:\Data\Company_Phone_Number_Normalization_Rules.txt" -Identity Global @@ -54,6 +55,9 @@ This example reads the phone normalization rules at the specified path and appli ## PARAMETERS ### -FileName + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the full path to the input Company_Phone_Number_Normalization_Rules.txt file. For example: @@ -62,8 +66,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -72,30 +75,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Force Suppresses the display of any non-fatal error messages and completes the cmdlet operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -105,6 +94,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the address book normalization configuration settings to be updated. To modify the global settings, use this syntax: @@ -124,8 +116,7 @@ An error will occur if you try to apply these settings to any other service. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -135,13 +126,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,14 +143,34 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -171,13 +184,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None +### None ## OUTPUTS -### -None +### None ## NOTES diff --git a/skype/skype-ps/skype/Import-CsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Import-CsConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Import-CsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Import-CsConfiguration.md index 6f8f568b9c..6fe53880c2 100644 --- a/skype/skype-ps/skype/Import-CsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/import-csconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Import-CsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/import-csconfiguration +schema: 2.0.0 +title: Import-CsConfiguration --- # Import-CsConfiguration @@ -49,7 +50,7 @@ You only need to do this once; after that, replication will take place automatic ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` @@ -59,7 +60,7 @@ Import-CsConfiguration -FileName "C:\Config.zip" The command shown in Example 1 imports the current topology, configuration settings, and policies from a file named C:\Config.zip to the Central Management store. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Import-CsConfiguration -FileName "C:\Config.zip" -LocalStore @@ -70,7 +71,7 @@ In this example, configuration data has been exported to a file named Config.zip Import-CsConfiguration is then used to import that data, with the LocalStore parameter causing that data to be imported to the local computer instead of the Central Management store. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` $x = Export-CsConfiguration -AsBytes @@ -89,6 +90,8 @@ The net effect is that data is copied from the Central Management store to the l ### -ByteInput +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Reads topology information from a byte array stored in a variable. This byte array is created by using the ByteInput parameter when calling the Export-CsConfiguration cmdlet. @@ -99,8 +102,7 @@ You cannot use both the ByteInput parameter and the FileName parameter in the sa ```yaml Type: Byte[] Parameter Sets: ByteInput -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -111,6 +113,8 @@ Accept wildcard characters: False ### -FileName +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Path to the .ZIP file created by Export-CsConfiguration. For example: `-FileName "C:\Config.zip".` Note that you must include either the FileName or the ByteInput parameter, but not both, when calling the Import-CsConfiguration cmdlet. @@ -120,8 +124,7 @@ Note that you must include either the FileName or the ByteInput parameter, but n ```yaml Type: String Parameter Sets: FileName -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -131,6 +134,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Bypasses any prompts that would otherwise appear should a non-fatal error occur when running the command. To set the Force parameter to True, use this syntax: @@ -139,8 +145,7 @@ To set the Force parameter to True, use this syntax: ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,13 +155,15 @@ Accept wildcard characters: False ``` ### -LocalStore + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Copies the configuration data to the local computer rather than the Central Management store. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -170,14 +177,13 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Import-CsConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The Import-CsConfiguration cmdlet does not return any values or objects. ## NOTES diff --git a/skype/skype-ps/skype/Import-CsDeviceUpdate.md b/skype/skype-ps/SkypeForBusiness/Import-CsDeviceUpdate.md similarity index 88% rename from skype/skype-ps/skype/Import-CsDeviceUpdate.md rename to skype/skype-ps/SkypeForBusiness/Import-CsDeviceUpdate.md index a5c01e0bfd..b1d5e62a98 100644 --- a/skype/skype-ps/skype/Import-CsDeviceUpdate.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsDeviceUpdate.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/import-csdeviceupdate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Import-CsDeviceUpdate -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/import-csdeviceupdate +schema: 2.0.0 +title: Import-CsDeviceUpdate --- # Import-CsDeviceUpdate @@ -53,7 +54,7 @@ Alternatively, you can use a command like the one shown in Example 3; this one c ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Import-CsDeviceUpdate -Identity "service:WebServer:atl-cs-001.litwareinc.com" -FileName C:\Updates\UCUpdates.cab @@ -61,7 +62,7 @@ Import-CsDeviceUpdate -Identity "service:WebServer:atl-cs-001.litwareinc.com" -F The command shown in Example 1 imports device update rules from the file C:\Updates\UCUpdates.cab. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Import-CsDeviceUpdate -Identity "service:WebServer:atl-cs-001.litwareinc.com" -FileName \\\\atl-fs-001\Updates\UCUpdates.cab @@ -70,7 +71,7 @@ Import-CsDeviceUpdate -Identity "service:WebServer:atl-cs-001.litwareinc.com" -F The command shown in Example 2 imports device update rules from the UNC path \\\\atl-fs-001\Updates\UCUpdates.cab. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsService -WebServer | ForEach-Object {Import-CsDeviceUpdate -Identity $_.Identity -FileName C:\Updates\UCUpdates.cab} @@ -84,68 +85,75 @@ Note that this command will work only if you have copied UCUpdates.cab to the sa ## PARAMETERS -### -Identity - -Indicates the service instance where the new update rules will be applied. -For example: `-Identity "service:WebServer:atl-cs-001.litwareinc.com".` - -The Identity should be the fully qualified domain name of the Front End pool where the Web server is installed. +### -FileName +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Path to the update file (for example, C:\Updates\UCUpdates.cab). ```yaml -Type: XdsIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -FileName -Path to the update file (for example, C:\Updates\UCUpdates.cab). +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the service instance where the new update rules will be applied. +For example: `-Identity "service:WebServer:atl-cs-001.litwareinc.com".` + +The Identity should be the fully qualified domain name of the Front End pool where the Web server is installed. + + ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -154,14 +162,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -175,13 +185,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Import-CsDeviceUpdate cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.Rule The Import-CsDeviceUpdate cmdlet imports instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.Rule class. ## NOTES diff --git a/skype/skype-ps/skype/Import-CsLegacyConferenceDirectory.md b/skype/skype-ps/SkypeForBusiness/Import-CsLegacyConferenceDirectory.md similarity index 89% rename from skype/skype-ps/skype/Import-CsLegacyConferenceDirectory.md rename to skype/skype-ps/SkypeForBusiness/Import-CsLegacyConferenceDirectory.md index aa6269159b..0bcaa26f6b 100644 --- a/skype/skype-ps/skype/Import-CsLegacyConferenceDirectory.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsLegacyConferenceDirectory.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/import-cslegacyconferencedirectory applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Import-CsLegacyConferenceDirectory -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/import-cslegacyconferencedirectory +schema: 2.0.0 +title: Import-CsLegacyConferenceDirectory --- # Import-CsLegacyConferenceDirectory @@ -44,7 +45,7 @@ The Import-CsLegacyConferenceDirectory cmdlet should also be run anytime the Mer ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Import-CsLegacyConferenceDirectory @@ -55,15 +56,16 @@ The command shown in Example 1 imports conferencing directories from Communicati ## PARAMETERS -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: `-Report "C:\Logs\ImportDirectories.html"` +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -72,14 +74,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: `-Report "C:\Logs\ImportDirectories.html"` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -88,14 +93,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -104,14 +111,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -125,13 +134,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Import-CsLegacyConferenceDirectory cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The Import-CsLegacyConferenceDirectory cmdlet does not return any objects or values. ## NOTES diff --git a/skype/skype-ps/skype/Import-CsLegacyConfiguration.md b/skype/skype-ps/SkypeForBusiness/Import-CsLegacyConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Import-CsLegacyConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Import-CsLegacyConfiguration.md index 51ac1f67d2..00b74e153a 100644 --- a/skype/skype-ps/skype/Import-CsLegacyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsLegacyConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/import-cslegacyconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Import-CsLegacyConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/import-cslegacyconfiguration +schema: 2.0.0 +title: Import-CsLegacyConfiguration --- # Import-CsLegacyConfiguration @@ -56,7 +57,7 @@ If that happens you must re-run the Import-CsLegacyConfiguration cmdlet before y ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Import-CsLegacyConfiguration @@ -65,7 +66,7 @@ Import-CsLegacyConfiguration The command shown in Example 1 merges voice policies and other settings from Communications Server 2007 or Communications Server 2007 R2 with an installation of Skype for Business Server. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Import-CsLegacyConfiguration -ReplaceExisting @@ -80,17 +81,16 @@ Because you included the ReplaceExisting parameter, the Skype for Business Serve ## PARAMETERS -### -ReplaceExisting - -If present, this parameter instructs the Import-CsLegacyConfiguration cmdlet to overwrite any previously imported policies or settings that have changed since the last time the cmdlet was run. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -99,14 +99,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -ReplaceExisting + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If present, this parameter instructs the Import-CsLegacyConfiguration cmdlet to overwrite any previously imported policies or settings that have changed since the last time the cmdlet was run. + + ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,14 +120,16 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: `-Report "C:\Logs\ImportConfiguration.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,14 +138,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -148,14 +156,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -169,13 +179,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Import-CsLegacyConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The Import-CsLegacyConfiguration cmdlet does not return any objects or values. ## NOTES diff --git a/skype/skype-ps/skype/Import-CsLisConfiguration.md b/skype/skype-ps/SkypeForBusiness/Import-CsLisConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Import-CsLisConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Import-CsLisConfiguration.md index 20298f3573..cbcfbea3a4 100644 --- a/skype/skype-ps/skype/Import-CsLisConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsLisConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/import-cslisconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Import-CsLisConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/import-cslisconfiguration +schema: 2.0.0 +title: Import-CsLisConfiguration --- # Import-CsLisConfiguration @@ -48,7 +49,7 @@ If you then call the Import-CsLisConfiguration cmdlet to restore the backed-up c ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Import-CsLisConfiguration -FileName C:\E911Config.bak @@ -56,7 +57,7 @@ Import-CsLisConfiguration -FileName C:\E911Config.bak This example imports the E9-1-1 configuration from the backup file named E911Config.back to the location configuration database. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $lisconfig = Export-CsLisConfiguration -AsBytes @@ -72,7 +73,7 @@ In line 2 the Import-CsLisConfiguration cmdlet is called. The ByteInput parameter receives a value of $lisconfig, which is the variable containing the byte array we exported. This will import that byte array back into the location configuration database. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` $lisconfig = Export-CsLisConfiguration -AsBytes @@ -95,13 +96,15 @@ The contents of the file are then piped to the Import-CsLisConfiguration cmdlet, ## PARAMETERS ### -ByteInput + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The value passed to this parameter is a variable containing a byte array of the LIS configuration that was created by the Export-CsLisConfiguration cmdlet with the AsBytes parameter. ```yaml Type: Byte[] Parameter Sets: ByteInput -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -111,6 +114,9 @@ Accept wildcard characters: False ``` ### -FileName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name of the backup file from which to import the configuration. You cannot specify a FileName and a ByteInput. Only one of these two parameters can be used with each call to this cmdlet. @@ -118,8 +124,7 @@ Only one of these two parameters can be used with each call to this cmdlet. ```yaml Type: String Parameter Sets: FileName -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -133,15 +138,13 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -Byte\[\]. -Accepts a byte array from an exported LIS configuration. -The byte array must be piped as a single record. -See Example 3. +### Sysetm.Byte[] +Accepts a byte array from an exported LIS configuration. The byte array must be piped as a single +record. See Example 3. ## OUTPUTS -### +### None This cmdlet does not return a value. ## NOTES diff --git a/skype/skype-ps/skype/Import-CsPersistentChatData.md b/skype/skype-ps/SkypeForBusiness/Import-CsPersistentChatData.md similarity index 91% rename from skype/skype-ps/skype/Import-CsPersistentChatData.md rename to skype/skype-ps/SkypeForBusiness/Import-CsPersistentChatData.md index a6407326d2..c1f070b50d 100644 --- a/skype/skype-ps/skype/Import-CsPersistentChatData.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsPersistentChatData.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/import-cspersistentchatdata applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Import-CsPersistentChatData -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/import-cspersistentchatdata +schema: 2.0.0 +title: Import-CsPersistentChatData --- # Import-CsPersistentChatData @@ -51,7 +52,7 @@ Skype for Business Server Control Panel: The functions carried out by the Import ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Import-CsPersistentChatData -DBInstance "atl-sql-001.litwareinc.com\rtc" -FileName "C:\Logs\PersistentChatExport.zip" @@ -63,13 +64,15 @@ The command shown on Example 1 reads exported Persistent Chat data from the file ## PARAMETERS ### -ByteInput + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When specified, data is imported as a byte array rather than an XML file. ```yaml Type: Byte[] Parameter Sets: ByteInput -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: Named @@ -80,6 +83,8 @@ Accept wildcard characters: False ### -DBInstance +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Fully qualified domain name and name of the SQL Server instance where the Skype for Business Server Persistent Chat database is located. For example, this syntax specifies the database found in the RTC database instance on the server atl-sql-001.litwareinc.com: @@ -90,8 +95,7 @@ For example, this syntax specifies the database found in the RTC database instan ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: Named @@ -101,6 +105,9 @@ Accept wildcard characters: False ``` ### -FileName + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Full path to the XML file being imported. For example: @@ -109,8 +116,7 @@ For example: ```yaml Type: String Parameter Sets: FileName -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: Named @@ -119,14 +125,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Report + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: + +`-Report "C:\Logs\PersistentChatExport.html"` + +If this file already exists, it will be overwritten when you run the cmdlet. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -135,19 +148,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +### -Confirm -`-Report "C:\Logs\PersistentChatExport.html"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -If this file already exists, it will be overwritten when you run the cmdlet. +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: cf Required: False Position: Named @@ -157,13 +167,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -177,14 +189,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Import-CsPersistentChatData cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Import-CsRgsAudioFile.md b/skype/skype-ps/SkypeForBusiness/Import-CsRgsAudioFile.md similarity index 88% rename from skype/skype-ps/skype/Import-CsRgsAudioFile.md rename to skype/skype-ps/SkypeForBusiness/Import-CsRgsAudioFile.md index 2e14bd423a..fdab9b58e3 100644 --- a/skype/skype-ps/skype/Import-CsRgsAudioFile.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsRgsAudioFile.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/import-csrgsaudiofile applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Import-CsRgsAudioFile -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/import-csrgsaudiofile +schema: 2.0.0 +title: Import-CsRgsAudioFile --- # Import-CsRgsAudioFile @@ -37,7 +38,7 @@ Even though the audio file is already used by the Response Group application you ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $x = Import-CsRgsAudioFile -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -FileName "WhileYouWait.wav" -Content ([System.IO.File]::ReadAllBytes('C:\Media\WhileYouWait.wav')) @@ -64,24 +65,10 @@ If you do not call Set-CsRgsWorkflow, your modifications will exist only in memo ## PARAMETERS -### -Identity -Identity of the service where the audio file is to be imported. -(This must be the same service that hosts the Response Group application.) For example: `-Identity "service:ApplicationServer:atl-cs-001.litwareinc.com".` - -```yaml -Type: RgsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Content -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Content Actual content of the audio file being imported. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -89,8 +76,7 @@ A valid value for this parameter requires you to read the file to a byte-encoded ```yaml Type: Byte[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -100,14 +86,16 @@ Accept wildcard characters: False ``` ### -FileName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + File name for the audio file being imported. For example, the file name for the file C:\Media\Welcome.wav is this: Welcome.wav. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -117,13 +105,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,30 +122,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Identity of the service where the audio file is to be imported. +(This must be the same service that hosts the Response Group application.) For example: `-Identity "service:ApplicationServer:atl-cs-001.litwareinc.com".` ```yaml -Type: SwitchParameter +Type: RgsIdentity Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -169,13 +182,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None Import-CsRgsAudioFile does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Rgs.Management.WritableSettings.AudioFile Creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.AudioFile object. ## NOTES diff --git a/skype/skype-ps/skype/Import-CsRgsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Import-CsRgsConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Import-CsRgsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Import-CsRgsConfiguration.md index a18372286a..6474a9db95 100644 --- a/skype/skype-ps/skype/Import-CsRgsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsRgsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/import-csrgsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Import-CsRgsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/import-csrgsconfiguration +schema: 2.0.0 +title: Import-CsRgsConfiguration --- # Import-CsRgsConfiguration @@ -41,7 +42,7 @@ Skype for Business Server Control Panel: The functions carried out by the Import ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Import-CsRgsConfiguration -FileName "C:\Export\RgsExport.zip" -Destination "ApplicationServer:atl-cs-001.litwareinc.com" @@ -54,6 +55,8 @@ The command shown in Example 1 imports a previously exported collection of Respo ### -Destination +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Identity of the Response Group instance where the configuration settings are being imported. For example: @@ -64,8 +67,7 @@ For example: ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -76,6 +78,8 @@ Accept wildcard characters: False ### -FileName +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Path to the .ZIP file created by the Export-CsRgsConfiguration cmdlet. For example: @@ -86,8 +90,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -97,13 +100,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -113,13 +118,15 @@ Accept wildcard characters: False ``` ### -OverwriteOwner + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present the current owner of the Response Group objects will be overwritten with the service identity of the new Response Group pool. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -129,14 +136,16 @@ Accept wildcard characters: False ``` ### -ReplaceExistingRgsSettings + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When specified, all the existing service settings for the destination pool are replaced with the imported settings. If not specified, then service settings will remain as-is and only Response Group object (such as workflows and agent groups) will be imported. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -146,14 +155,16 @@ Accept wildcard characters: False ``` ### -ResolveNameConflicts + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, duplicate names will be resolved by appending a unique identifying number. For example, if there are two workflows named Help Desk Workflow one of the two will be renamed Help Desk Workflow (2). ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,14 +178,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Import-CsRgsConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Import-CsUserData.md b/skype/skype-ps/SkypeForBusiness/Import-CsUserData.md similarity index 85% rename from skype/skype-ps/skype/Import-CsUserData.md rename to skype/skype-ps/SkypeForBusiness/Import-CsUserData.md index d282e09e95..1a6ebe9d5b 100644 --- a/skype/skype-ps/skype/Import-CsUserData.md +++ b/skype/skype-ps/SkypeForBusiness/Import-CsUserData.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/import-csuserdata applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Import-CsUserData -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/import-csuserdata +schema: 2.0.0 +title: Import-CsUserData --- # Import-CsUserData @@ -40,7 +41,7 @@ Import-CsUserData -FileName -PoolFqdn [-ConfDirectoryFilter Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When specified, allows you to import conference directory information for the specified conference directory. +For example, to import data from the conference directory with the ID 13 use this syntax: + +`-ConfDirectoryFilter 13` + +You can return conference directory IDs by using this command: + +`Get-CsConferenceDirectory` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Service Identity of the user database where the data should be imported. -For example: +### -DomainController + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to specify the FQDN of the domain controller to be used when running the Import-CsUserData cmdlet. +If not specified, the cmdlet will use the first available domain controller. -`-Identity "UserDatabase:atl-sql-001.litwareinc.com"` -You cannot use both the Identity and the PoolFqdn parameters in the same command. ```yaml -Type: String -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Fqdn +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -PoolFqdn -Fully qualified domain name of the Registrar pool for the user data being imported. +### -FileName + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Full path to the input file containing the exported user data. For example: -`-PoolFqdn "atl-cs-001.litwareinc.com"` +`-InputFile "C:\Data\ExportedUsers.xml"` ```yaml -Type: Fqdn -Parameter Sets: PoolFqdn -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: True Position: Named @@ -118,21 +127,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConfDirectoryFilter -When specified, allows you to import conference directory information for the specified conference directory. -For example, to import data from the conference directory with the ID 13 use this syntax: - -`-ConfDirectoryFilter 13` +### -Force -You can return conference directory IDs by using this command: +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsConferenceDirectory` +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,34 +145,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController +### -Identity -Enables administrators to specify the FQDN of the domain controller to be used when running the Import-CsUserData cmdlet. -If not specified, the cmdlet will use the first available domain controller. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Service Identity of the user database where the data should be imported. +For example: +`-Identity "UserDatabase:atl-sql-001.litwareinc.com"` + +You cannot use both the Identity and the PoolFqdn parameters in the same command. ```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Identity +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -LegacyFormat + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates that the data to be imported was exported from a previous version of Lync Server or Office Communications Server. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -177,16 +186,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LegacyFormat -Indicates that the data to be imported was exported from a previous version of Lync Server or Office Communications Server. +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the Registrar pool for the user data being imported. +For example: + +`-PoolFqdn "atl-cs-001.litwareinc.com"` ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Fqdn +Parameter Sets: PoolFqdn +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -195,6 +209,8 @@ Accept wildcard characters: False ### -RoutingGroupFilter +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to limit the imported data to users who belong to the same routing group. Routing groups are used by Skype for Business Server to determine the Front End server that users register with. @@ -203,8 +219,7 @@ Routing groups are used by Skype for Business Server to determine the Front End ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -214,6 +229,9 @@ Accept wildcard characters: False ``` ### -UserFilter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to import user data for a single user. To convert data for a specified user (and only for that user), set the UserFilter parameter to the SIP address of that user, being sure to omit the sip: prefix. For example: @@ -225,8 +243,7 @@ This parameter allows you to import data one user at a time. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -240,14 +257,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Import-CsUserData cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Install-CsAdServerSchema.md b/skype/skype-ps/SkypeForBusiness/Install-CsAdServerSchema.md similarity index 85% rename from skype/skype-ps/skype/Install-CsAdServerSchema.md rename to skype/skype-ps/SkypeForBusiness/Install-CsAdServerSchema.md index 9a20d7aaef..f3d696c34f 100644 --- a/skype/skype-ps/skype/Install-CsAdServerSchema.md +++ b/skype/skype-ps/SkypeForBusiness/Install-CsAdServerSchema.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/install-csadserverschema applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Install-CsAdServerSchema -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/install-csadserverschema +schema: 2.0.0 +title: Install-CsAdServerSchema --- # Install-CsAdServerSchema @@ -44,7 +45,7 @@ If it does not, then you must run the Install-CsAdServerSchema cmdlet on the sch ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Install-CsAdServerSchema @@ -52,7 +53,7 @@ Install-CsAdServerSchema The command shown in Example 1 determines the location of the .LDF file by reading information from the registry, then uses that file to update the Active Directory schema. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Install-CsAdServerSchema -Ldf "C:\Schemas" @@ -64,8 +65,28 @@ This folder location is specified by using the Ldf parameter. ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -GlobalCatalog +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of a global catalog server in your domain. This parameter is not required if you are running the Install-CsAdServerSchema cmdlet on a computer with an account in your domain. @@ -74,8 +95,7 @@ This parameter is not required if you are running the Install-CsAdServerSchema c ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -86,6 +106,8 @@ Accept wildcard characters: False ### -GlobalSettingsDomainController +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a domain controller in your domain. This parameter is not required if you are running the Install-CsAdServerSchema cmdlet on a computer with an account in your domain. @@ -94,8 +116,7 @@ This parameter is not required if you are running the Install-CsAdServerSchema c ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -106,6 +127,8 @@ Accept wildcard characters: False ### -Ldf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Path to the folder containing the .LDF file to be imported; the .LDF (LDAP Data Interchange Format) file contains the required updates for the Active Directory schema. If this parameter is not included, the Install-CsAdServerSchema cmdlet will look for the file in the Skype for Business Server installation path recorded in the registry. The installation path will typically be C:\Program Files\Skype for Business Server\Deployment\Setup. @@ -115,8 +138,7 @@ The installation path will typically be C:\Program Files\Skype for Business Serv ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -125,31 +147,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Report -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Report Enables you to specify a file path for the log file created when the cmdlet runs. For example: `-Report "C:\Logs\ServerSchema.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,14 +166,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SchemaMaster + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the Active Directory schema master for your domain. +This parameter is not required if you are running the Install-CsAdServerSchema cmdlet on a computer with an account in your domain. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,13 +186,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -190,15 +203,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SchemaMaster -Fully qualified domain name (FQDN) of the Active Directory schema master for your domain. -This parameter is not required if you are running the Install-CsAdServerSchema cmdlet on a computer with an account in your domain. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -212,13 +226,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Install-CsAdServerSchema cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The Install-CsAdServerSchema cmdlet does not return any values or objects. ## NOTES diff --git a/skype/skype-ps/skype/Install-CsDatabase.md b/skype/skype-ps/SkypeForBusiness/Install-CsDatabase.md similarity index 85% rename from skype/skype-ps/skype/Install-CsDatabase.md rename to skype/skype-ps/SkypeForBusiness/Install-CsDatabase.md index cfa2fa1de6..62c86dc998 100644 --- a/skype/skype-ps/skype/Install-CsDatabase.md +++ b/skype/skype-ps/SkypeForBusiness/Install-CsDatabase.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/install-csdatabase applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Install-CsDatabase -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/install-csdatabase +schema: 2.0.0 +title: Install-CsDatabase --- # Install-CsDatabase @@ -124,7 +125,7 @@ If that group is listed as the owner the group could possibly be deleted when yo ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Install-CsDatabase -ConfiguredDatabases -SqlServerFqdn atl-sql-001.litwareinc.com -DatabasePaths "E:\CSLog","F:\CSLog","G:\CSDB" @@ -133,7 +134,7 @@ Install-CsDatabase -ConfiguredDatabases -SqlServerFqdn atl-sql-001.litwareinc.co In Example 1, the Install-CsDatabase cmdlet reads in the Skype for Business Server topology, and then installs any required databases on the pool atl-sql-001.litwareinc.com. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Install-CsDatabase -CentralManagementDatabase -SqlServerFqdn atl-sql-001.litwareinc.com -SqlInstanceName rtc -DatabasePaths "G:\CSDB" @@ -145,8 +146,28 @@ The database will be installed in the rtc instance, and make use of the folder G ## PARAMETERS +### -Backup + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When used, backs up the existing Central Management server database to the specified SQL Server instance. + +```yaml +Type: SwitchParameter +Parameter Sets: ByCMS +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -CentralManagementDatabase +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If this parameter is included, the Install-CsDatabase cmdlet will use the SqlServerFqdn parameter to install the Central Management store on the specified computer. This parameter is typically used only by Topology Builder, and is generally called just once, during initial setup. @@ -155,8 +176,7 @@ This parameter is typically used only by Topology Builder, and is generally call ```yaml Type: SwitchParameter Parameter Sets: ByCMS -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -167,6 +187,8 @@ Accept wildcard characters: False ### -Clean +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If this parameter is included, the Install-CsDatabase cmdlet will delete and reinstall databases as needed. If this parameter is not included, the Install-CsDatabase cmdlet will not overwrite any existing databases. You cannot use both Clean and Update in the same command. @@ -176,8 +198,7 @@ You cannot use both Clean and Update in the same command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -187,13 +208,15 @@ Accept wildcard characters: False ``` ### -Collocated + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If present, additional database roles will be collocated with the Central Management store. ```yaml Type: SwitchParameter Parameter Sets: ByCMS, ByDatabase -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -204,6 +227,8 @@ Accept wildcard characters: False ### -ConfiguredDatabases +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Reads information from the Skype for Business Server topology, and installs the required databases on the specified SQL Server computer or SQL Server cluster. Administrators who need to call the Install-CsDatabase cmdlet will almost always use this parameter when specifying the databases to be installed. @@ -212,8 +237,7 @@ Administrators who need to call the Install-CsDatabase cmdlet will almost always ```yaml Type: SwitchParameter Parameter Sets: ByConfigured -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -222,14 +246,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DatabasePathMap + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify custom folder paths for data files and log files; multiple paths should be separated by using a semicolon (;). +For example: + +`-DatabasePathMap @{"Archiving:DbPath"="\\\\atl-sql-001.litwareinc.com\db";"Archiving:LogPath"="\\\\atl-sql-002.litwareinc.com\logs"}` + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DatabasePaths + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the drives and folders where data and log files can be stored; for example: -DatabasePaths "D:\Logs","E:\Data". ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -240,6 +287,8 @@ Accept wildcard characters: False ### -DatabaseType +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to install a specific database on a specific SQL Server computer or SQL Server cluster. As a general rule, administrators should not run the Install-CsDatabase cmdlet with the DatabaseType parameter unless instructed otherwise by Microsoft support personnel. Instead, administrators should typically use the ConfiguredDatabases parameter. @@ -278,8 +327,7 @@ User ```yaml Type: DatabaseNameType Parameter Sets: ByDatabase -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -289,13 +337,33 @@ Accept wildcard characters: False ``` ### -ExcludeCollocatedStores + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, suppresses a warning message telling you that any collocated database stores must be installed on the local computer. ```yaml Type: SwitchParameter Parameter Sets: ByConfigured -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, forces the installation of the new database even if an existing database of that type is currently in use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -306,6 +374,8 @@ Accept wildcard characters: False ### -ForDefaultInstance +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When specified, instructs the Install-CsDatabase cmdlet to only act against the default SQL Server instance. You cannot use both ForDefaultInstance and ForInstance in the same command. @@ -314,8 +384,7 @@ You cannot use both ForDefaultInstance and ForInstance in the same command. ```yaml Type: SwitchParameter Parameter Sets: ByConfigured, ByLocal -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -326,6 +395,8 @@ Accept wildcard characters: False ### -ForInstance +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When specified, instructs the Install-CsDatabase cmdlet to only act against the specified SQL Server instance. You cannot use both ForInstance and ForDefaultInstance in the same command. @@ -334,8 +405,7 @@ You cannot use both ForInstance and ForDefaultInstance in the same command. ```yaml Type: String Parameter Sets: ByConfigured, ByLocal -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -346,6 +416,8 @@ Accept wildcard characters: False ### -GlobalCatalog +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of a global catalog server in your domain. This parameter is not required if you are running the Install-CsDatabase cmdlet on a computer with an account in your domain. @@ -354,8 +426,7 @@ This parameter is not required if you are running the Install-CsDatabase cmdlet ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -366,6 +437,8 @@ Accept wildcard characters: False ### -GlobalSettingsDomainController +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of a domain controller where global settings are stored. If global settings are stored in the System container in Active Directory Domain Services, then this parameter must point to the root domain controller. If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. @@ -375,8 +448,7 @@ If global settings are stored in the Configuration container, then any domain co ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -387,6 +459,8 @@ Accept wildcard characters: False ### -LocalDatabases +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If this parameter is included, the Install-CsDatabase cmdlet will read in the Skype for Business Server topology and install databases and stores as needed on the local computer. @@ -394,8 +468,7 @@ If this parameter is included, the Install-CsDatabase cmdlet will read in the Sk ```yaml Type: SwitchParameter Parameter Sets: ByLocal -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -404,8 +477,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -NoReindex + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prevents the index files from being rebuilt when a database is being updated. +This parameter can only be used along with the Update parameter. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: `-Report "C:\Logs\InstallDatabases.html"` + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SkipPrepareCheck +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, causes the Install-CsDatabase cmdlet to forego its initial preparation checks. @@ -413,8 +526,7 @@ When present, causes the Install-CsDatabase cmdlet to forego its initial prepara ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -425,6 +537,8 @@ Accept wildcard characters: False ### -SqlInstanceName +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the database instance where the database is to be installed. A database instance is simply a set of running processes that provides access to database files. If this parameter is omitted, the Install-CsDatabase cmdlet will use the default SQL Server instance. @@ -434,8 +548,7 @@ If this parameter is omitted, the Install-CsDatabase cmdlet will use the default ```yaml Type: String Parameter Sets: ByCMS, ByDatabase -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -445,14 +558,16 @@ Accept wildcard characters: False ``` ### -SqlServerFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the computer where the database is to be installed. For example: `-SqlServerFqdn atl-sql-001.litwareinc.com.` ```yaml Type: Fqdn Parameter Sets: ByCMS, ByDatabase, ByConfigured -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -463,6 +578,8 @@ Accept wildcard characters: False ### -Update +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, updates the existing database. You cannot use Update and Clean in the same command. @@ -475,8 +592,7 @@ At that point you can then run Install-CsDatabase and the Update parameter. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -486,46 +602,15 @@ Accept wildcard characters: False ``` ### -UseDefaultSqlPaths -When specified, instructs SQL Server to select the drive where data and log files will be stored. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -When present, forces the installation of the new database even if an existing database of that type is currently in use. +When specified, instructs SQL Server to select the drive where data and log files will be stored. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: `-Report "C:\Logs\InstallDatabases.html"` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -534,46 +619,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Backup -When used, backs up the existing Central Management server database to the specified SQL Server instance. - -```yaml -Type: SwitchParameter -Parameter Sets: ByCMS -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -582,34 +637,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DatabasePathMap -Enables you to specify custom folder paths for data files and log files; multiple paths should be separated by using a semicolon (;). -For example: - -`-DatabasePathMap @{"Archiving:DbPath"="\\\\atl-sql-001.litwareinc.com\db";"Archiving:LogPath"="\\\\atl-sql-002.litwareinc.com\logs"}` - -```yaml -Type: Hashtable -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -NoReindex -Prevents the index files from being rebuilt when a database is being updated. -This parameter can only be used along with the Update parameter. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -623,13 +660,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Install-CsDatabase cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The Install-CsDatabase cmdlet does not return any values or objects. ## NOTES diff --git a/skype/skype-ps/skype/Install-CsMirrorDatabase.md b/skype/skype-ps/SkypeForBusiness/Install-CsMirrorDatabase.md similarity index 85% rename from skype/skype-ps/skype/Install-CsMirrorDatabase.md rename to skype/skype-ps/SkypeForBusiness/Install-CsMirrorDatabase.md index feb4acc5d3..d6ad4951a4 100644 --- a/skype/skype-ps/skype/Install-CsMirrorDatabase.md +++ b/skype/skype-ps/SkypeForBusiness/Install-CsMirrorDatabase.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/install-csmirrordatabase applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Install-CsMirrorDatabase -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/install-csmirrordatabase +schema: 2.0.0 +title: Install-CsMirrorDatabase --- # Install-CsMirrorDatabase @@ -52,7 +53,7 @@ Skype for Business Server Control Panel: The functions carried out by the Instal ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Install-CsMirrorDatabase -ConfiguredDatabases -FileShare "\\atl-fs-001.litware.com\DbBackup" -SqlServerFqdn "atl-primary-001.litwareinc.com" -DropExisitingDatabasesOnMirror @@ -66,6 +67,8 @@ The ConfiguredDatabases parameter causes the Install-CsMirrorDatabase cmdlet to ### -ConfiguredDatabases +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Reads information from the Skype for Business Server topology, and installs the required mirror databases on the specified SQL Server computer or SQL Server cluster. @@ -73,8 +76,7 @@ Reads information from the Skype for Business Server topology, and installs the ```yaml Type: SwitchParameter Parameter Sets: ByConfigured -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -83,8 +85,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -DatabasePathMap + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify custom folder paths for data files and log files; multiple paths should be separated by using a semicolon (;). +For example: + +`-DatabasePathMap @{"Archiving:DbPath"="\\\\atl-sql-001.litwareinc.com\db";"Archiving:LogPath"="\\\\atl-sql-002.litwareinc.com\logs"}` + +```yaml +Type: Hashtable +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -DatabaseType +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Type of mirror database to be installed. Allowed values are: @@ -119,8 +144,7 @@ User ```yaml Type: DatabaseNameType Parameter Sets: ByDatabase -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -129,56 +153,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FileShare - -UNC path to the database shared folder. -The file share is used to export of databases from the primary SQL Server and import those databases onto the mirror. - -The shared folder and its contents can be deleted after mirroring is established. -The folder should also be deleted if you decide to disable mirroring. - - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SqlServerFqdn -Fully qualified domain name (FQDN) of the primary SQL Server computer. -For example: - -`-SqlServerFqdn atl-sql-001.litwareinc.com` - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -DropExistingDatabasesOnMirror -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +When present, deletes any existing copies of the mirrored databases from the server acting as the mirror before new data is copied to that server. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -187,17 +171,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DatabasePathMap -Enables you to specify custom folder paths for data files and log files; multiple paths should be separated by using a semicolon (;). +### -ExcludeDatabaseList + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +List of databases that should not be included in the mirror database; multiple databases can be specified by separating those databases using commas. For example: -`-DatabasePathMap @{"Archiving:DbPath"="\\\\atl-sql-001.litwareinc.com\db";"Archiving:LogPath"="\\\\atl-sql-002.litwareinc.com\logs"}` +`-ExcludeDatabaseList "RTCCAB","RTCPROV"` ```yaml -Type: Hashtable +Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -206,35 +192,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DropExistingDatabasesOnMirror -When present, deletes any existing copies of the mirrored databases from the server acting as the mirror before new data is copied to that server. +### -FileShare -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +UNC path to the database shared folder. +The file share is used to export of databases from the primary SQL Server and import those databases onto the mirror. + +The shared folder and its contents can be deleted after mirroring is established. +The folder should also be deleted if you decide to disable mirroring. -### -ExcludeDatabaseList -List of databases that should not be included in the mirror database; multiple databases can be specified by separating those databases using commas. -For example: -`-ExcludeDatabaseList "RTCCAB","RTCPROV"` ```yaml -Type: String[] +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -243,6 +218,8 @@ Accept wildcard characters: False ### -ForDefaultInstance +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When specified, instructs the Install-CsMirrorDatabase cmdlet to only act against the default SQL Server instance. You cannot use both ForDefaultInstance and ForInstance in the same command. @@ -251,8 +228,7 @@ You cannot use both ForDefaultInstance and ForInstance in the same command. ```yaml Type: SwitchParameter Parameter Sets: ByConfigured -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -263,6 +239,8 @@ Accept wildcard characters: False ### -ForInstance +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When specified, instructs the Install-CsMirrorDatabase cmdlet to only act against the specified SQL Server instance. You cannot use both ForInstance and ForDefaultInstance in the same command. @@ -271,8 +249,7 @@ You cannot use both ForInstance and ForDefaultInstance in the same command. ```yaml Type: String Parameter Sets: ByConfigured -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -283,6 +260,8 @@ Accept wildcard characters: False ### -Report +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: @@ -293,8 +272,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -305,6 +283,8 @@ Accept wildcard characters: False ### -SqlInstanceName +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the database instance where the database is to be installed. A database instance is simply a set of running processes that provides access to database files. If this parameter is omitted, the Install-CsMirrorDatabase cmdlet will use the default SQL Server instance. @@ -314,8 +294,46 @@ If this parameter is omitted, the Install-CsMirrorDatabase cmdlet will use the d ```yaml Type: String Parameter Sets: ByDatabase -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SqlServerFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the primary SQL Server computer. +For example: + +`-SqlServerFqdn atl-sql-001.litwareinc.com` + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -325,13 +343,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -345,14 +365,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Install-CsMirrorDatabase cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Invoke-CsArchivingDatabasePurge.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsArchivingDatabasePurge.md similarity index 89% rename from skype/skype-ps/skype/Invoke-CsArchivingDatabasePurge.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsArchivingDatabasePurge.md index dbb310849d..0ae14fe708 100644 --- a/skype/skype-ps/skype/Invoke-CsArchivingDatabasePurge.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsArchivingDatabasePurge.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-csarchivingdatabasepurge applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Invoke-CsArchivingDatabasePurge -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/invoke-csarchivingdatabasepurge +schema: 2.0.0 +title: Invoke-CsArchivingDatabasePurge --- # Invoke-CsArchivingDatabasePurge @@ -59,7 +60,7 @@ Skype for Business Server Control Panel: The functions carried out by the Invoke ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Invoke-CsArchivingDatabasePurge -Identity "service:ArchivingDatabase:atl-sql-001.litwareinc.com" -PurgeArchivingDataOlderThanHours 24 -PurgeExportedArchivesOnly $False @@ -70,7 +71,7 @@ To ensure that all the records are deleted, including records that have not been -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Invoke-CsArchivingDatabasePurge -Identity "service:ArchivingDatabase:atl-sql-001.litwareinc.com" -PurgeArchivingDataOlderThanHours 24 -PurgeExportedArchivesOnly $False -Confirm:$False @@ -83,7 +84,7 @@ The command shown in Example 2 is a variation of the command shown in Example 1; That syntax suppresses the confirmation prompts that would otherwise appear when purging archiving records. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsService -ArchivingDatabase | ForEach-Object {Invoke-CsArchivingDatabasePurge -Identity $_.Identity -PurgeArchivingDataOlderThanHours 24 -PurgeExportedArchivesOnly $False -Confirm:$False} @@ -97,7 +98,28 @@ In turn, the ForEach-Object cmdlet takes each database in the collection and the ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service Identity of the archiving database to be purged. You can retrieve the Identities for your archiving databases by running this command: @@ -108,8 +130,7 @@ Note that you cannot use the Identity parameter and the SqlServerFqdn parameter ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -118,15 +139,37 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` +### -MaxArchivingRecordsToDelete + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the maximum number of archiving records to be purged from the database; if you set this value to 99 and you have 100 records in the database that meet the PurgeArchivingDataOlderThanHours criterion, only the 99 oldest records will be deleted. + +MaxArchivingRecordsToDelete can be set to any integer value between 1 and 2147483647, inclusive. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: 4 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PurgeArchivingDataOlderThanHours + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the age (in hours) of the archiving records to be purged from the database; any records older than this value will be deleted. PurgeArchivingDataOlderThanHours can be set to any integer value between 1 and 2147483647, inclusive. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -136,14 +179,16 @@ Accept wildcard characters: False ``` ### -PurgeExportedArchivesOnly + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, records will be removed for the archiving database only if those records have been exported (and, as a result, have been marked for deletion). Records that have not been exported will remain in the database, even if those records are older than the value specified by the PurgeArchivingDataOlderThanHours property. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 3 @@ -152,35 +197,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlServerFqdn -Fully qualified domain name of the computer where the archiving database is located. -For example: +### -SqlInstanceName -`-SqlServerFqdn "atl-sql-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that you cannot use the Identity parameter and the SqlServerFqdn parameter in the same command. +SQL Server instance name for the archiving database. +For example: + +`-SqlInstanceName "archinst"` ```yaml Type: String Parameter Sets: SqlServer -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -189,51 +218,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -SqlServerFqdn -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Fully qualified domain name of the computer where the archiving database is located. +For example: -### -MaxArchivingRecordsToDelete -Specifies the maximum number of archiving records to be purged from the database; if you set this value to 99 and you have 100 records in the database that meet the PurgeArchivingDataOlderThanHours criterion, only the 99 oldest records will be deleted. +`-SqlServerFqdn "atl-sql-001.litwareinc.com"` -MaxArchivingRecordsToDelete can be set to any integer value between 1 and 2147483647, inclusive. +Note that you cannot use the Identity parameter and the SqlServerFqdn parameter in the same command. ```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: SqlServer +Aliases: -Required: False -Position: 4 +Required: True +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlInstanceName -SQL Server instance name for the archiving database. -For example: +### -Confirm -`-SqlInstanceName "archinst"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String -Parameter Sets: SqlServer -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -243,13 +260,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -263,12 +282,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### +### Microsoft.Rtc.Management.Xds.DisplayArchivingDatabase#Decorated The Invoke-CsArchivingDatabasePurge cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.Xds.DisplayArchivingDatabase#Decorated class. ## OUTPUTS -### +### Microsoft.Rtc.Management.Purge.ArchDataPurgeStatistics The Invoke-CsArchivingDatabasePurge cmdlet returns instances of the Microsoft.Rtc.Management.Purge.ArchDataPurgeStatistics class. ## NOTES diff --git a/skype/skype-ps/skype/Invoke-CsBackupServiceSync.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsBackupServiceSync.md similarity index 86% rename from skype/skype-ps/skype/Invoke-CsBackupServiceSync.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsBackupServiceSync.md index 4c9944e54e..badaf35899 100644 --- a/skype/skype-ps/skype/Invoke-CsBackupServiceSync.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsBackupServiceSync.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-csbackupservicesync applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Invoke-CsBackupServiceSync -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/invoke-csbackupservicesync +schema: 2.0.0 +title: Invoke-CsBackupServiceSync --- # Invoke-CsBackupServiceSync @@ -37,7 +38,7 @@ Skype for Business Server Control Panel: The functions carried out by the Invoke ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Invoke-CsBackupServiceSync -PoolFqdn "atl-cs-001.litwareinc.com" @@ -48,27 +49,10 @@ The command shown in Example 1 synchronizes the backup services for the pool atl ## PARAMETERS -### -PoolFqdn -Fully qualified domain name of the pool where backup service synchronization is being invoked. -For example: - -`-PoolFqdn "atl-cs-001.litwareinc.com"` - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - ### -BackupModule +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the type of data to be synchronized. Valid values are: @@ -80,13 +64,12 @@ CentralMgmt.CMSMaster ApplicationServer.RGSDataStore -ApplicationServer.RGSFileStore +ApplicationServer.RGSFileStore ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,13 +79,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -111,19 +96,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool where backup service synchronization is being invoked. +For example: + +`-PoolFqdn "atl-cs-001.litwareinc.com"` + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: True +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 (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS -### -String value. +### System.Stringvalue. The Invoke-CsBackupServiceSync cmdlet can accept a pipelined string value representing the fully qualified domain name of a Skype for Business Server pool. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Invoke-CsCdrDatabasePurge.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsCdrDatabasePurge.md similarity index 89% rename from skype/skype-ps/skype/Invoke-CsCdrDatabasePurge.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsCdrDatabasePurge.md index 1aff964a92..c30677de57 100644 --- a/skype/skype-ps/skype/Invoke-CsCdrDatabasePurge.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsCdrDatabasePurge.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-cscdrdatabasepurge applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Invoke-CsCdrDatabasePurge -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/invoke-cscdrdatabasepurge +schema: 2.0.0 +title: Invoke-CsCdrDatabasePurge --- # Invoke-CsCdrDatabasePurge @@ -59,7 +60,7 @@ Skype for Business Server Control Panel: The functions carried out by the Invoke ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Invoke-CsCdrDatabasePurge -Identity "service:MonitoringDatabase:atl-sql-001.litwareinc.com" -PurgeCallDetailDataOlderThanDays 10 -PurgeDiagnosticDataOlderThanDays 10 @@ -67,7 +68,7 @@ Invoke-CsCdrDatabasePurge -Identity "service:MonitoringDatabase:atl-sql-001.litw The command shown in Example 1 deletes all the records (both call detail and diagnostic records) from the monitoring database atl-sql-001.litwareinc.com that are more than 10 days old. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Invoke-CsCdrDatabasePurge -Identity "service:MonitoringDatabase:atl-sql-001.litwareinc.com" -PurgeCallDetailDataOlderThanDays 10 -PurgeDiagnosticDataOlderThanDays 10 -Confirm:$False @@ -80,7 +81,7 @@ The command shown in Example 2 is a variation of the command shown in Example 1; That syntax suppresses the confirmation prompts that would otherwise appear when purging CDR records. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsService -MonitoringDatabase | ForEach-Object {Invoke-CsCdrDatabasePurge -Identity $_.Identity -PurgeCallDetailDataOlderThanDays 10 -PurgeDiagnosticDataOlderThanDays 10 -Confirm:$False} @@ -94,7 +95,28 @@ In turn, the ForEach-Object cmdlet takes each database in the collection and the ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service Identity of the monitoring database to be purged. You can retrieve the Identities for your monitoring databases by running this command: @@ -105,8 +127,7 @@ Note that you cannot use the Identity parameter and the SqlServerFqdn parameter ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -117,6 +138,8 @@ Accept wildcard characters: False ### -PurgeCallDetailDataOlderThanDays +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the age (in days) of the call detail records to be purged from the database; any records older than this value will be deleted. Call detail records represent user/session reports. They differ from diagnostic data reports, which are diagnostic logs uploaded by client applications such as Skype for Business. @@ -128,8 +151,7 @@ PurgeCallDetailDataOlderThanDays can be set to any integer value between 1 and 2 ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -140,6 +162,8 @@ Accept wildcard characters: False ### -PurgeDiagnosticDataOlderThanDays +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the age (in days) of the diagnostic data records to be purged from the database; any records older than this value will be deleted. Diagnostic data reports are diagnostic logs uploaded by client applications such as Skype for Business. @@ -150,8 +174,7 @@ PurgeDiagnosticDataOlderThanHours can be set to any integer value between 1 and ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 3 @@ -160,70 +183,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlServerFqdn -Fully qualified domain name of the computer where the CDR database is located. -For example: +### -SqlInstanceName -`-SqlServerFqdn "atl-sql-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that you cannot use the Identity parameter and the SqlServerFqdn parameter in the same command. +SQL Server instance name for the CDR database. +For example: + +`-SqlInstanceName "archinst"` ```yaml Type: String Parameter Sets: SqlServer -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -SqlServerFqdn -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Fully qualified domain name of the computer where the CDR database is located. +For example: -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +`-SqlServerFqdn "atl-sql-001.litwareinc.com"` + +Note that you cannot use the Identity parameter and the SqlServerFqdn parameter in the same command. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: SqlServer +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlInstanceName -SQL Server instance name for the CDR database. -For example: +### -Confirm -`-SqlInstanceName "archinst"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String -Parameter Sets: SqlServer -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -233,13 +246,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -253,13 +268,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### +### Microsoft.Rtc.Management.Xds.DisplayMonitoringDatabase#Decorated The Invoke-CsCdrDatabasePurge cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.Xds.DisplayMonitoringDatabase#Decorated class. ## OUTPUTS - -### +### Microsoft.Rtc.Management.Purge.CdrDataPurgeStatistics The Invoke-CsCdrDatabasePurge cmdlet returns instances of the Microsoft.Rtc.Management.Purge.CdrDataPurgeStatistics class. ## NOTES diff --git a/skype/skype-ps/skype/Invoke-CsComputerFailBack.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsComputerFailBack.md similarity index 86% rename from skype/skype-ps/skype/Invoke-CsComputerFailBack.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsComputerFailBack.md index 2700d5b25c..e55abec0b1 100644 --- a/skype/skype-ps/skype/Invoke-CsComputerFailBack.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsComputerFailBack.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-cscomputerfailback applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Invoke-CsComputerFailBack -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/invoke-cscomputerfailback +schema: 2.0.0 +title: Invoke-CsComputerFailBack --- # Invoke-CsComputerFailBack @@ -32,7 +33,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- (Skype for Business Server 2015) +### Example 1 (Skype for Business Server 2015) ``` Invoke-CsComputerFailBack -ComputerName "atl-mcs-001.litwareinc.com" -NoStart @@ -44,6 +45,9 @@ This example marks the computer "atl-mcs-001.litwareinc.com" as available to the ## PARAMETERS ### -ComputerName + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the computer name to fail back. The computer should be referenced by using its fully qualified domain name (FQDN). For example, `-ComputerName "atl-mcs-001.litwareinc.com".` @@ -52,8 +56,7 @@ The computer name used during failback must be the same name used during failove ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -62,23 +65,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -NoStart -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -NoStart If the NoStart parameter is specified, the Skype for Business server is added back into the pool and marked as available, but all the Skype for Business services are not started. Only the Skype for Business service (rtcsrv) is verified by the cmdlet. This allows for follow-up scripting to start the remaining services and configure the server for your environment before users and data are assigned. @@ -86,8 +76,7 @@ This allows for follow-up scripting to start the remaining services and configur ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -97,6 +86,9 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the file path for the log file created when the cmdlet runs. For example: `-Report "C:\Logs\Server1FailbackLog.html".` If this file already exists, it will be overwritten. @@ -105,8 +97,25 @@ By default, reports are written to the AppData\Local\Temp folder in your user pr ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipFabricHealthCheck + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +{{Fill SkipFabricHealthCheck Description}} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -116,6 +125,9 @@ Accept wildcard characters: False ``` ### -WaitTime + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the amount of time in TimeSpan format that the cmdlet will wait for a confirmation of failback success. If the time is exceeded, the cmdlet will fail and Skype for Business services will not be started or enabled. The default is one hour. @@ -123,8 +135,7 @@ The default is one hour. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -133,14 +144,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -149,14 +162,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipFabricHealthCheck -{{Fill SkipFabricHealthCheck Description}} +### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -170,14 +185,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Invoke-CsComputerFailBack cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Invoke-CsComputerFailOver.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsComputerFailOver.md similarity index 85% rename from skype/skype-ps/skype/Invoke-CsComputerFailOver.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsComputerFailOver.md index 723b08653b..895195df4a 100644 --- a/skype/skype-ps/skype/Invoke-CsComputerFailOver.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsComputerFailOver.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-cscomputerfailover applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Invoke-CsComputerFailOver -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/invoke-cscomputerfailover +schema: 2.0.0 +title: Invoke-CsComputerFailOver --- # Invoke-CsComputerFailOver @@ -34,7 +35,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- (Skype for Business Server 2015) +### Example 1 (Skype for Business Server 2015) ``` Invoke-CsComputerFailOver -ComputerName "atl-mcs-001.litwareinc.com" -Report "C:\Logs\S1_FailOverLog.html" -WaitTime 1:30:00 ``` @@ -42,7 +43,7 @@ Invoke-CsComputerFailOver -ComputerName "atl-mcs-001.litwareinc.com" -Report "C: This example directs that the users assigned to server "atl-mcs-001.litwareinc.com" will be moved to other servers in the pool. The log output path is specified and the cmdlet will wait 1 hour 30 minutes before timing out. -### -------------------------- Example 2 -------------------------- (Skype for Business Server 2015) +### Example 2 (Skype for Business Server 2015) ``` $TimeSpan = New-TimeSpan -Minutes 30 Invoke-CsComputerFailOver -ComputerName "atl-mcs-001.litwareinc.com" -DrainingTimeout $TimeSpan @@ -53,6 +54,9 @@ This example force to drain all conferences and sessions after 30 minutes. If us ## PARAMETERS ### -ComputerName + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the computer name to fail over. The computer should be referenced by using its fully qualified domain name (FQDN). For example, `-ComputerName "atl-mcs-001.litwareinc.com".` @@ -60,8 +64,7 @@ For example, `-ComputerName "atl-mcs-001.litwareinc.com".` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -70,14 +73,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -DrainingTimeout + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Draining timeout in TimeSpan format to gracefully drain MCUs. ```yaml -Type: SwitchParameter +Type: TimeSpan Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -87,6 +92,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + If the Force parameter is specified, the server is failed over without verifying the pool's capacity to absorb the failed over server's workload. **Note:** If you run this parameter together with -WhatIf parameter, it will be ignored and a server failover will be started. @@ -94,8 +102,7 @@ If the Force parameter is specified, the server is failed over without verifying ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -105,14 +112,16 @@ Accept wildcard characters: False ``` ### -NoStop + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + If specified, Skype for Business Server services will not be stopped as part of the failover. This maintains the failed over server's state for additional scripting or troubleshooting. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,6 +131,9 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the file path for the log file created when the cmdlet runs. For example: `-Report "C:\Logs\S1_FailOverLog.html".` If this file already exists, it will be overwritten. @@ -130,8 +142,7 @@ By default, reports are written to the "AppData\Local\Temp" folder in your user ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -140,16 +151,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WaitTime -Specifies the amount of time in TimeSpan format that the cmdlet will wait for confirmation that users and data have been migrated, and all conferences and sessions have been drained. -If the wait time is exceeded, the cmdlet fails and no action is taken on the specified server. -The default is one hour. +### -SkipFabricHealthCheck + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is reserved for internal Microsoft use. ```yaml -Type: TimeSpan +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,14 +169,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -WaitTime + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the amount of time in TimeSpan format that the cmdlet will wait for confirmation that users and data have been migrated, and all conferences and sessions have been drained. +If the wait time is exceeded, the cmdlet fails and no action is taken on the specified server. +The default is one hour. ```yaml -Type: SwitchParameter +Type: TimeSpan Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -174,14 +189,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DrainingTimeout -Draining timeout in TimeSpan format to gracefully drain MCUs. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: TimeSpan +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -190,14 +207,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipFabricHealthCheck -This parameter is reserved for internal Microsoft use. +### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -211,14 +230,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Invoke-CsComputerFailOver cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Invoke-CsDatabaseFailover.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsDatabaseFailover.md similarity index 85% rename from skype/skype-ps/skype/Invoke-CsDatabaseFailover.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsDatabaseFailover.md index 95e2fcf516..3c8707e526 100644 --- a/skype/skype-ps/skype/Invoke-CsDatabaseFailover.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsDatabaseFailover.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-csdatabasefailover applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Invoke-CsDatabaseFailover -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/invoke-csdatabasefailover +schema: 2.0.0 +title: Invoke-CsDatabaseFailover --- # Invoke-CsDatabaseFailover @@ -43,7 +44,7 @@ Skype for Business Server Control Panel: The functions carried out by the Invoke ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Invoke-CsDatabaseFailover -PoolFqdn atl-cs-001.litwareinc.com -DatabaseType "User" -NewPrincipal "Mirror" @@ -52,7 +53,7 @@ Invoke-CsDatabaseFailover -PoolFqdn atl-cs-001.litwareinc.com -DatabaseType "Use The command shown in Example 1 invokes failover for the User database found on the pool atl-cs-001.litwareinc.com. The command causes the User database to failover to a previously-assigned mirror database. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Invoke-CsDatabaseFailover -PoolFqdn atl-cs-001.litwareinc.com -ExcludeDatabase -NewPrincipal "Mirror" -ExcludeDatabaseList "LcsCDR", "LcsLog" @@ -66,6 +67,8 @@ These databases are exempted from failover by using the ExcludeDatabaseList para ### -DatabaseType +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Type of database being failed over. Valid values are: @@ -100,8 +103,7 @@ User ```yaml Type: DatabaseNameType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -110,54 +112,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NewPrincipal +### -ExcludeDatabaseList -Specifies whether failover will be to the primary database or to the mirror database. -Valid values are: +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Mirror +List of databases that should not be failed over. +For example: -Primary +`-ExcludeDatabaseList "LcsCDR"` +To prevent multiple databases from being failed over, separate the database names using commas: +`-ExcludeDatabaseList "LcsCDR", "LcsLog"` ```yaml -Type: MirrorRole +Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PoolFqdn -Fully qualified domain name of the pool containing the database to be failed over. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. +The Force parameter is also used if the current database is not accessible. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -LocalStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Retrieves topology information from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -166,54 +174,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeDatabaseList -List of databases that should not be failed over. -For example: +### -NewPrincipal -`-ExcludeDatabaseList "LcsCDR"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies whether failover will be to the primary database or to the mirror database. +Valid values are: + +Mirror + +Primary -To prevent multiple databases from being failed over, separate the database names using commas: -`-ExcludeDatabaseList "LcsCDR", "LcsLog"` ```yaml -Type: String[] +Type: MirrorRole Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. -The Force parameter is also used if the current database is not accessible. +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool containing the database to be failed over. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -Retrieves topology information from the local replica of the Central Management store rather than from the Central Management store itself. +### -Report + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: `-Report "C:\Logs\DatabaseFailover.html"` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -222,15 +236,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: `-Report "C:\Logs\DatabaseFailover.html"` +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -240,13 +255,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -260,14 +277,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Invoke-CsDatabaseFailover cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Invoke-CsManagementServerFailover.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsManagementServerFailover.md similarity index 85% rename from skype/skype-ps/skype/Invoke-CsManagementServerFailover.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsManagementServerFailover.md index 342f852532..69d725a599 100644 --- a/skype/skype-ps/skype/Invoke-CsManagementServerFailover.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsManagementServerFailover.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-csmanagementserverfailover applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Invoke-CsManagementServerFailover -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/invoke-csmanagementserverfailover +schema: 2.0.0 +title: Invoke-CsManagementServerFailover --- # Invoke-CsManagementServerFailover @@ -53,7 +54,7 @@ Skype for Business Server Control Panel: The functions carried out by the Invoke ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Invoke-CsManagementServerFailover @@ -63,7 +64,7 @@ Invoke-CsManagementServerFailover The command shown in Example 1 fails over the Central Management store for Skype for Business Server. In this case, the existing management store will be replaced by the preassigned database specified in the topology. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Invoke-CsManagementServerFailover -BackupSqlServerFqdn "redmond-cs-001.litwareinc.com" - BackupSqlInstanceName "RTC" -Force @@ -75,57 +76,52 @@ In this case, the existing management store will be replaced by the RTC database ## PARAMETERS -### -BackupSqlServerFqdn - -Fully qualified domain name of the computer hosting the SQL Server backup database. -This parameter is required if you are running the Invoke-CsManagementServerFailover cmdlet in disaster recovery mode. +### -BackupMirrorSqlInstanceName +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +SQL Server instance for the mirror database. ```yaml -Type: Fqdn +Type: String Parameter Sets: DisasterRecovery -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force - -Suppresses the display of any non-fatal error message that might occur when running the command. -This parameter is required if you are running the Invoke-CsManagementServerFailover cmdlet in disaster recovery mode. - -You should not use the Force parameter if you are running the cmdlet for purposes other than disaster recovery, as it will not account for replication during the failover. -When the parameter is not used, the cmdlet will first make sure all replications are done, then set the source DB to read-only mode. +### -BackupMirrorSqlServerFqdn +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Fully qualified domain name of the computer hosting the SQL Server mirror database. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: DisasterRecovery -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BackupMirrorSqlInstanceName -SQL Server instance for the mirror database. +### -BackupSqlInstanceName + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SQL Server instance for the backup database. ```yaml Type: String Parameter Sets: DisasterRecovery -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,48 +130,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BackupMirrorSqlServerFqdn -Fully qualified domain name of the computer hosting the SQL Server mirror database. +### -BackupSqlServerFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the computer hosting the SQL Server backup database. +This parameter is required if you are running the Invoke-CsManagementServerFailover cmdlet in disaster recovery mode. + + ```yaml Type: Fqdn Parameter Sets: DisasterRecovery -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BackupSqlInstanceName -SQL Server instance for the backup database. +### -Force -```yaml -Type: String -Parameter Sets: DisasterRecovery -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. +This parameter is required if you are running the Invoke-CsManagementServerFailover cmdlet in disaster recovery mode. + +You should not use the Force parameter if you are running the cmdlet for purposes other than disaster recovery, as it will not account for replication during the failover. +When the parameter is not used, the cmdlet will first make sure all replications are done, then set the source DB to read-only mode. -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -Confirm -Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: DisasterRecovery +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -183,14 +176,16 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: `-Report "C:\Logs\CMSFailover.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -200,13 +195,33 @@ Accept wildcard characters: False ``` ### -Restore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When specified, restores the existing Central Management Server database. ```yaml Type: SwitchParameter Parameter Sets: Normal -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -216,13 +231,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -236,14 +253,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Invoke-CsManagementServerFailover cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Invoke-CsManagementStoreReplication.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsManagementStoreReplication.md similarity index 91% rename from skype/skype-ps/skype/Invoke-CsManagementStoreReplication.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsManagementStoreReplication.md index c002ae71c5..b30733dc33 100644 --- a/skype/skype-ps/skype/Invoke-CsManagementStoreReplication.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsManagementStoreReplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-csmanagementstorereplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Invoke-CsManagementStoreReplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/invoke-csmanagementstorereplication +schema: 2.0.0 +title: Invoke-CsManagementStoreReplication --- # Invoke-CsManagementStoreReplication @@ -47,7 +48,7 @@ Instead, there could be a two to three minute delay as changes are processed by ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Invoke-CsManagementStoreReplication @@ -56,7 +57,7 @@ Invoke-CsManagementStoreReplication In Example 1, the Invoke-CsManagementStoreReplication cmdlet is called without any parameters. This forces replication to take place on all Skype for Business Server computers. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Invoke-CsManagementStoreReplication -ReplicaFqdn atl-cs-001.litwareinc.com @@ -68,41 +69,44 @@ That causes replication to take place only on the computer atl-cs-001.litwareinc ## PARAMETERS -### -ReplicaFqdn - -Fully qualified domain name (FQDN) of the computer where replication should be initiated. -For example: `-ReplicaFqdn "atl-cs-001.litwareinc.com".` - -If this parameter is not included, then replication will be initiated on all your Skype for Business Server computers. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -ReplicaFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the computer where replication should be initiated. +For example: `-ReplicaFqdn "atl-cs-001.litwareinc.com".` + +If this parameter is not included, then replication will be initiated on all your Skype for Business Server computers. + + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` @@ -111,13 +115,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Invoke-CsManagementStoreReplication cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The Invoke-CsManagementStoreReplication cmdlet does not return any objects. ## NOTES diff --git a/skype/skype-ps/skype/Invoke-CsPoolFailBack.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsPoolFailBack.md similarity index 87% rename from skype/skype-ps/skype/Invoke-CsPoolFailBack.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsPoolFailBack.md index 99b453decd..18f91e8113 100644 --- a/skype/skype-ps/skype/Invoke-CsPoolFailBack.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsPoolFailBack.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-cspoolfailback applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Invoke-CsPoolFailBack -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/invoke-cspoolfailback +schema: 2.0.0 +title: Invoke-CsPoolFailBack --- # Invoke-CsPoolFailBack @@ -47,7 +48,7 @@ Skype for Business Server Control Panel: The functions carried out by the Invoke ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Invoke-CsPoolFailback -PoolFqdn "atl-cs-001.litwareinc.com" @@ -58,38 +59,55 @@ In Example 1, failback is invoked for the pool atl-cs-001.litwareinc.com. ## PARAMETERS -### -PoolFqdn +### -DatabaseCommandTimeoutInSeconds -Fully qualified domain name of the pool being failed back. -For example: +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -`-PoolFqdn "atl-cs-001.litwareinc.com"` +The amount of time, in seconds, to wait for database commands to time out. -The pool FQDN used during failback must be the same FQDN used during failover. +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisasterMode + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to invoke pool failback even if the backup pool is currently unavailable. +When you use this parameter, data generated by the failed-over users on the backup pool will be lost. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -98,34 +116,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisasterMode +### -PoolFqdn -Enables administrators to invoke pool failback even if the backup pool is currently unavailable. -When you use this parameter, data generated by the failed-over users on the backup pool will be lost. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool being failed back. +For example: + +`-PoolFqdn "atl-cs-001.litwareinc.com"` + +The pool FQDN used during failback must be the same FQDN used during failover. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -SkipDataVerification + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When included in a command, Invoke-CsPoolFailover will proceed with the failover operation without first verifying data integrity. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,6 +160,9 @@ Accept wildcard characters: False ``` ### -WaitTime + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the maximum amount of time the cmdlet should wait before synching data. Time values must be express using the format hours:minutes:seconds; for example, the following syntax sets the wait time to 1 minute and 30 seconds (00 hours:01:minutes:30 seconds): @@ -145,8 +173,7 @@ The default value is 15 seconds. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -155,14 +182,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -171,30 +200,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DatabaseCommandTimeoutInSeconds -The amount of time, in seconds, to wait for database commands to time out. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -SkipDataVerification -When included in a command, Invoke-CsPoolFailover will proceed with the failover operation without first verifying data integrity. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -208,14 +223,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Invoke-CsPoolFailBack cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Invoke-CsPoolFailOver.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsPoolFailOver.md similarity index 86% rename from skype/skype-ps/skype/Invoke-CsPoolFailOver.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsPoolFailOver.md index 45d8e8e11f..fd708e6be8 100644 --- a/skype/skype-ps/skype/Invoke-CsPoolFailOver.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsPoolFailOver.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-cspoolfailover applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Invoke-CsPoolFailOver -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/invoke-cspoolfailover +schema: 2.0.0 +title: Invoke-CsPoolFailOver --- # Invoke-CsPoolFailOver @@ -49,7 +50,7 @@ Skype for Business Server Control Panel: The functions carried out by the Invoke ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Invoke-CsPoolFailOver -PoolFqdn "atl-cs-001.litwareinc.com" @@ -57,7 +58,7 @@ Invoke-CsPoolFailOver -PoolFqdn "atl-cs-001.litwareinc.com" The command shown in Example 1 invokes pool failover for the pool atl-cs-001.litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Invoke-CsPoolFailOver -PoolFqdn "atl-cs-001.litwareinc.com" -DisasterMode @@ -68,36 +69,16 @@ Example 2 invokes disaster mode failover for the pool atl-cs-001.litwareinc.com. ## PARAMETERS -### -PoolFqdn - -Fully qualified domain name of the pool being failed over from. -For example: - -`-PoolFqdn "atl-cs-001.litwareinc.com"` - - - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -DatabaseCommandTimeoutInSeconds -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +The amount of time to wait, in seconds, for database commands to time out. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -108,6 +89,8 @@ Accept wildcard characters: False ### -DisasterMode +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, indicates that failover is being performed in "disaster mode." If a pool is no longer accessible the only way to restore full functionality to users in that pool is to fail over the pool by using the DisasterMode parameter. If this parameter is not present that means that the pool is still up and running and that failover occurred by administrator choice; for example, the pool might temporarily be failed over in order to do hardware or software upgrades on the server. @@ -119,8 +102,7 @@ Note: The parameters required for an Enterprise pool if the backend SQL services ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,6 +113,8 @@ Accept wildcard characters: False ### -FlushStorageService +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When specified, the Invoke-CsPoolFailOver cmdlet will both fail over all the users in the pool, and call the Invoke-CsStorageServiceFlush cmdlet to flush the storage service database on each Front End server in the pool. Flushing a database involves writing all the queued data to disk, and then clearing the database cache. @@ -139,8 +123,7 @@ Flushing a database involves writing all the queued data to disk, and then clear ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,13 +133,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -165,14 +150,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WaitTime -Specifies the amount of time (in seconds) that the cmdlet will wait before assuming that the data has been synced from the failed-over pool to the backup pool. +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool being failed over from. +For example: + +`-PoolFqdn "atl-cs-001.litwareinc.com"` + + ```yaml -Type: TimeSpan +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ServicesStopDelayMins + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies a number of minutes to wait for the services to stop. + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -181,14 +191,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SkipDataVerification + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When included in a command, Invoke-CsPoolFailback will proceed with the failback operation without first verifying data integrity. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -197,14 +209,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DatabaseCommandTimeoutInSeconds -The amount of time to wait, in seconds, for database commands to time out. +### -WaitTime + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the amount of time (in seconds) that the cmdlet will wait before assuming that the data has been synced from the failed-over pool to the backup pool. ```yaml -Type: Int32 +Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -213,14 +227,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ServicesStopDelayMins -Specifies a number of minutes to wait for the services to stop. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -229,14 +245,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipDataVerification -When included in a command, Invoke-CsPoolFailback will proceed with the failback operation without first verifying data integrity. +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -250,14 +268,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Invoke-CsPoolFailOver cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Invoke-CsQoEDatabasePurge.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsQoEDatabasePurge.md similarity index 88% rename from skype/skype-ps/skype/Invoke-CsQoEDatabasePurge.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsQoEDatabasePurge.md index 573235dd3b..183d210fda 100644 --- a/skype/skype-ps/skype/Invoke-CsQoEDatabasePurge.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsQoEDatabasePurge.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-csqoedatabasepurge applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Invoke-CsQoEDatabasePurge -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/invoke-csqoedatabasepurge +schema: 2.0.0 +title: Invoke-CsQoEDatabasePurge --- # Invoke-CsQoEDatabasePurge @@ -55,7 +56,7 @@ Skype for Business Server Control Panel: The functions carried out by the Invoke ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Invoke-CsQoEDatabasePurge -Identity "service:MonitoringDatabase:atl-sql-001.litwareinc.com" -PurgeQoEDataOlderThanDays 10 @@ -64,7 +65,7 @@ Invoke-CsQoEDatabasePurge -Identity "service:MonitoringDatabase:atl-sql-001.litw The command shown in Example 1 purges all the QoE records more than 10 days old from the monitoring database on atl-sql-001.litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Invoke-CsQoEDatabasePurge -Identity "service:MonitoringDatabase:atl-sql-001.litwareinc.com" -PurgeQoEDataOlderThanDays 10 -Confirm:$False @@ -77,7 +78,7 @@ The command shown in Example 2 is a variation of the command shown in Example 1; That syntax suppresses the confirmation prompts that would otherwise appear when purging QoE records. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsService -MonitoringDatabase | Invoke-CsQoEDatabasePurge -PurgeQoEDataOlderThanDays 10 -Confirm:$False ``` @@ -90,7 +91,28 @@ In turn, the ForEach-Object cmdlet takes each database in the collection and the ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service Identity of the monitoring database to be purged. You can retrieve the Identities for your monitoring databases by running this command: @@ -101,8 +123,7 @@ Note that you cannot use the Identity parameter and the SqlServerFqdn parameter ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -112,6 +133,9 @@ Accept wildcard characters: False ``` ### -PurgeQoEDataOlderThanDays + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the age (in days) of the QoE records to be purged from the database; any records older than this value will be deleted. PurgeQoEDataOlderThanHours can be set to any integer value between 1 and 2147483647, inclusive. @@ -119,8 +143,7 @@ PurgeQoEDataOlderThanHours can be set to any integer value between 1 and 2147483 ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -129,70 +152,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlServerFqdn -Fully qualified domain name of the computer where the QoE database is located. -For example: +### -SqlInstanceName -`-SqlServerFqdn "atl-sql-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that you cannot use the Identity parameter and the SqlServerFqdn parameter in the same command. +SQL Server instance name for the QoE database. +For example: + +`-SqlInstanceName "archinst"` ```yaml Type: String Parameter Sets: SqlServer -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -SqlServerFqdn -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Fully qualified domain name of the computer where the QoE database is located. +For example: -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +`-SqlServerFqdn "atl-sql-001.litwareinc.com"` + +Note that you cannot use the Identity parameter and the SqlServerFqdn parameter in the same command. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: SqlServer +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlInstanceName -SQL Server instance name for the QoE database. -For example: +### -Confirm -`-SqlInstanceName "archinst"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String -Parameter Sets: SqlServer -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -202,13 +215,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -222,12 +237,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### +### Microsoft.Rtc.Management.Xds.DisplayMonitoringDatabase#Decorated The Invoke-CsQoEDatabasePurge cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.Xds.DisplayMonitoringDatabase#Decorated class. ## OUTPUTS -### +### Microsoft.Rtc.Management.Purge.QoEDataPurgeStatistics The Invoke-CsQoEDatabasePurge cmdlet returns instances of the Microsoft.Rtc.Management.Purge.QoEDataPurgeStatistics class. ## NOTES diff --git a/skype/skype-ps/skype/Invoke-CsRgsStoreReplicateData.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsRgsStoreReplicateData.md similarity index 94% rename from skype/skype-ps/skype/Invoke-CsRgsStoreReplicateData.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsRgsStoreReplicateData.md index a62fee6b1d..756ab11e04 100644 --- a/skype/skype-ps/skype/Invoke-CsRgsStoreReplicateData.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsRgsStoreReplicateData.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-csrgsstorereplicatedata applicable: Skype for Business Server 2019 -title: Invoke-CsRGSStoreReplicateData -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/invoke-csrgsstorereplicatedata +schema: 2.0.0 +title: Invoke-CsRGSStoreReplicateData --- # Invoke-CsRGSStoreReplicateData @@ -38,13 +39,15 @@ The command shown in Example 1 replicates the RGS data for the pool atl-cs-001.l ## PARAMETERS ### -Force + +> Applicable: Skype for Business Server 2019CU1 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019CU1 Required: False Position: Named @@ -54,6 +57,9 @@ Accept wildcard characters: False ``` ### -PoolFqdn + +> Applicable: Skype for Business Server 2019CU1 + Fully qualified domain name of the pool whose data will be replicated. For example: `-PoolFqdn "atl-cs-001.litwareinc.com"` @@ -62,7 +68,6 @@ For example: Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019CU1 Required: True Position: Named diff --git a/skype/skype-ps/skype/Invoke-CsStorageServiceFlush.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsStorageServiceFlush.md similarity index 89% rename from skype/skype-ps/skype/Invoke-CsStorageServiceFlush.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsStorageServiceFlush.md index 90e2298abf..7c667e19f6 100644 --- a/skype/skype-ps/skype/Invoke-CsStorageServiceFlush.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsStorageServiceFlush.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-csstorageserviceflush applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Invoke-CsStorageServiceFlush -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/invoke-csstorageserviceflush +schema: 2.0.0 +title: Invoke-CsStorageServiceFlush --- # Invoke-CsStorageServiceFlush @@ -48,7 +49,7 @@ Skype for Business Server Control Panel: The functions carried out by the Invoke ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Invoke-CsStorageServiceFlush -PoolFqdn "atl-cs-001.litwareinc.com" -FlushType "SteadyState" @@ -60,67 +61,53 @@ In a steady state flush, the only data removed from the queue (and written to di ## PARAMETERS -### -FlushType - -Specifies the type of storage flush to be performed. -Allowed values are: - -SteadyState - The only data that will be flushed is data that can be removed from the queue without affecting normal operations of the storage service. -This is typically done to remove older data from the queue. +### -Binding -FullFlush - Flushes all the data from the queue. -This is typically used when a pool is being failed over, and when there is no expectation that the queue will be receiving any new data. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Windows Communication Foundation (WCF) binding. +A WCF binding determines the transport, encoding, and protocol details required for clients and services to communicate with each other. +valid values are: +NetNamedPipe -```yaml -Type: FlushType -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +NetTCP -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -PoolFqdn -Fully qualified domain name of the pool containing the storage service to be flushed. ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: b -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Binding +### -FlushType -Windows Communication Foundation (WCF) binding. -A WCF binding determines the transport, encoding, and protocol details required for clients and services to communicate with each other. -valid values are: +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -NetNamedPipe +Specifies the type of storage flush to be performed. +Allowed values are: -NetTCP +SteadyState - The only data that will be flushed is data that can be removed from the queue without affecting normal operations of the storage service. +This is typically done to remove older data from the queue. + +FullFlush - Flushes all the data from the queue. +This is typically used when a pool is being failed over, and when there is no expectation that the queue will be receiving any new data. ```yaml -Type: String +Type: FlushType Parameter Sets: (All) -Aliases: b -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -128,13 +115,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -145,6 +134,8 @@ Accept wildcard characters: False ### -HostNameStorageService +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the server where the Skype for Business Server Storage Service is running. This parameter is required if the Binding is set to NetTCP. @@ -154,7 +145,6 @@ This parameter is required if the Binding is set to NetTCP. Type: String Parameter Sets: (All) Aliases: h -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -163,14 +153,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool containing the storage service to be flushed. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WaitTime + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the maximum amount of time the cmdlet will wait before assuming that flushing has begun and moving on to the next step in the flushing process. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,14 +194,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Invoke-CsStorageServiceFlush cmdlet does not accept pipelined data. ## OUTPUTS -### -String value. +### System.Stringvalue. ## NOTES diff --git a/skype/skype-ps/skype/Invoke-CsUcsRollback.md b/skype/skype-ps/SkypeForBusiness/Invoke-CsUcsRollback.md similarity index 88% rename from skype/skype-ps/skype/Invoke-CsUcsRollback.md rename to skype/skype-ps/SkypeForBusiness/Invoke-CsUcsRollback.md index b0d139bbd3..143652e5f4 100644 --- a/skype/skype-ps/skype/Invoke-CsUcsRollback.md +++ b/skype/skype-ps/SkypeForBusiness/Invoke-CsUcsRollback.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/invoke-csucsrollback applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Invoke-CsUcsRollback -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/invoke-csucsrollback +schema: 2.0.0 +title: Invoke-CsUcsRollback --- # Invoke-CsUcsRollback @@ -51,7 +53,7 @@ Skype for Business Server Control Panel: The functions carried out by the Invoke ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Invoke-CsUcsRollback -Identity "Ken Myer" @@ -60,7 +62,7 @@ Invoke-CsUcsRollback -Identity "Ken Myer" The command shown in Example 1 removes the user Ken Myer from the unified contact store. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUser -Filter {RegistrarPool -eq "atl-cs-001.litwareinc.com"} | Invoke-CsUcsRollback -Confirm:$False @@ -74,38 +76,32 @@ In order to suppress the confirmation prompt that would otherwise occur each tim ## PARAMETERS -### -Identity - -Indicates the Identity of the user account to be rolled back. -User Identities are typically specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). - -You can also reference a user account by using the user's Active Directory distinguished name. +### -DomainController -You can use the asterisk (*) wildcard character when using the Display Name as the user Identity. -For example, the Identity "* Smith" returns all the users who have a display name that ends with the string value " Smith". +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Enables you to connect to the specified domain controller in order to retrieve user information. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). ```yaml -Type: UserIdParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -Force -Prompts you for confirmation before executing the command. -To prevent a confirmation prompt from appearing each time you roll back a user account use this syntax: +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -`-Confirm:$False` +Suppresses the display of any non-fatal error message that might arise when running the command. @@ -113,8 +109,7 @@ To prevent a confirmation prompt from appearing each time you roll back a user a ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -123,29 +118,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the user account to be rolled back. +User Identities are typically specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). + +You can also reference a user account by using the user's Active Directory distinguished name. + +You can use the asterisk (*) wildcard character when using the Display Name as the user Identity. +For example, the Identity "* Smith" returns all the users who have a display name that ends with the string value " Smith". -Enables you to connect to the specified domain controller in order to retrieve user information. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). ```yaml -Type: Fqdn +Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Force +### -PassThru -Suppresses the display of any non-fatal error message that might arise when running the command. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to pass a user object through the pipeline that represents the user account being removed from the Unified Contact Store. +By default, the Invoke-CsUcsRollback cmdlet does not pass objects through the pipeline. @@ -153,8 +158,7 @@ Suppresses the display of any non-fatal error message that might arise when runn ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -163,10 +167,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru +### -Confirm -Enables you to pass a user object through the pipeline that represents the user account being removed from the Unified Contact Store. -By default, the Invoke-CsUcsRollback cmdlet does not pass objects through the pipeline. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. +To prevent a confirmation prompt from appearing each time you roll back a user account use this syntax: + +`-Confirm:$False` @@ -174,8 +182,7 @@ By default, the Invoke-CsUcsRollback cmdlet does not pass objects through the pi ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -186,6 +193,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. @@ -194,7 +203,6 @@ Describes what would happen if you executed the command without actually executi Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -208,22 +216,21 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser Invoke-CsUcsRollback accepts pipelined input of string values representing the Identity of a user account. The cmdlet also accepts pipelined input of user objects. ### Microsoft.Rtc.Management.AD.UserIdParameter -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The Invoke-CsUcsRollback cmdlet accepts pipelined input of string values representing the Identity of a user account. The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### -None. +### None ### System.Object diff --git a/skype/skype-ps/skype/Lock-CsClientPin.md b/skype/skype-ps/SkypeForBusiness/Lock-CsClientPin.md similarity index 90% rename from skype/skype-ps/skype/Lock-CsClientPin.md rename to skype/skype-ps/SkypeForBusiness/Lock-CsClientPin.md index 4e7c015374..0e36ee93c3 100644 --- a/skype/skype-ps/skype/Lock-CsClientPin.md +++ b/skype/skype-ps/SkypeForBusiness/Lock-CsClientPin.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/lock-csclientpin applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Lock-CsClientPin -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/lock-csclientpin +schema: 2.0.0 +title: Lock-CsClientPin --- # Lock-CsClientPin @@ -48,7 +49,7 @@ That means that you will not be able to run the Lock-CsClientPin cmdlet from a r ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Lock-CsClientPin -Identity "kenmyer@litwareinc.com" @@ -57,7 +58,7 @@ Lock-CsClientPin -Identity "kenmyer@litwareinc.com" In Example 1, the Lock-CsClientPin cmdlet is used to lock the PIN belonging to the user kenmyer@litwareinc.com. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsUser | Get-CsClientPinInfo | Where-Object {$_.IsPinSet -eq $True} | Lock-CsClientPin @@ -69,7 +70,7 @@ That collection is piped to the Get-CsClientPinInfo cmdlet, which is used, in co That filtered collection is then piped to the Lock-CsClientPin cmdlet, which locks the PIN for each user in the collection. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsUser | Get-CsClientPinInfo | Where-Object {$_.PinExpirationTime -lt (Get-Date)} | Lock-CsClientPin @@ -85,7 +86,28 @@ After that, the Lock-CsClientPin cmdlet is used to lock each of the expired PINs ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Identity of the user account for which the PIN should be locked. User Identities can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). You can also reference user Identities by using the user's Active Directory distinguished name. @@ -96,8 +118,7 @@ For example, the Identity "* Smith" returns all the users who have a display nam ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -106,14 +127,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -123,29 +146,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -159,14 +168,15 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String The Lock-CsClientPin cmdlet accepts pipelined input of string values representing the Identity of a user account. + +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.UserPinService.PinInfoDetails The Lock-CsClientPin cmdlet does not return a value or object. Instead, the cmdlet configures one or more instances of the Microsoft.Rtc.Management.UserPinService.PinInfoDetails object. diff --git a/skype/skype-ps/skype/Merge-CsLegacyTopology.md b/skype/skype-ps/SkypeForBusiness/Merge-CsLegacyTopology.md similarity index 90% rename from skype/skype-ps/skype/Merge-CsLegacyTopology.md rename to skype/skype-ps/SkypeForBusiness/Merge-CsLegacyTopology.md index c472df4e40..5af8dfbd90 100644 --- a/skype/skype-ps/skype/Merge-CsLegacyTopology.md +++ b/skype/skype-ps/SkypeForBusiness/Merge-CsLegacyTopology.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/merge-cslegacytopology applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Merge-CsLegacyTopology -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/merge-cslegacytopology +schema: 2.0.0 +title: Merge-CsLegacyTopology --- # Merge-CsLegacyTopology @@ -63,7 +64,7 @@ If you do not do this no Edge Servers will be included in your merged topology. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Merge-CsLegacyTopology -TopologyXmlFileName C:\New_Topology.xml @@ -73,7 +74,7 @@ The command shown in Example 1 merges topology information and trusted service e The required parameter TopologyXmlFileName is used to indicate the path to the output file generated when you run the Merge-CsLegacyTopology cmdlet. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Merge-CsLegacyTopology -TopologyXmlFileName C:\New_Topology.xml -UserInputFileName C:\EdgeServers.xml @@ -86,109 +87,121 @@ The parameter value C:\EdgeServers.xml points to a custom XML file containing Ed ## PARAMETERS -### -TopologyXmlFileName - -Path to the output file to be created when the Merge-CsLegacyTopology cmdlet is run. -Note that this file differs from the file specified using the Report parameter; the latter file is used for recording error information while the Topology XML file contains your newly created Skype for Business Server topology. -This file will later be used to publish the new topology. - -If the specified file already exists, it will be overwritten when you run the Merge-CsLegacyTopology cmdlet. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String -Parameter Sets: Topology -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserInputFileName - -Path to the XML file used to import Edge Server data from an earlier version of Skype for Business Server. -This XML file (which you must create following the guidelines detailed in the Skype for Business Server Deployment Guide) is required because Edge Server settings are not stored in Active Directory Domain Services. -If you do not need to import Edge Server information, then this parameter can be omitted. - -If this parameter is not used, remote and external access features (including federation) might not function as expected in an environment running both Communications Server 2007 R2 or Communications Server 2007 R2 and . +### -Report +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: `-Report "C:\Logs\MergeTopology.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Reserved + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to merge the topology using a topology object instead of a topology XML file. + + ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: PartialTopology +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: `-Report "C:\Logs\MergeTopology.html"` +### -TopologyXmlFileName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Path to the output file to be created when the Merge-CsLegacyTopology cmdlet is run. +Note that this file differs from the file specified using the Report parameter; the latter file is used for recording error information while the Topology XML file contains your newly created Skype for Business Server topology. +This file will later be used to publish the new topology. + +If the specified file already exists, it will be overwritten when you run the Merge-CsLegacyTopology cmdlet. + + ```yaml Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: Topology +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -UserInputFileName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Path to the XML file used to import Edge Server data from an earlier version of Skype for Business Server. +This XML file (which you must create following the guidelines detailed in the Skype for Business Server Deployment Guide) is required because Edge Server settings are not stored in Active Directory Domain Services. +If you do not need to import Edge Server information, then this parameter can be omitted. + +If this parameter is not used, remote and external access features (including federation) might not function as expected in an environment running both Communications Server 2007 R2 or Communications Server 2007 R2 and . + + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -197,19 +210,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Reserved - -Enables you to merge the topology using a topology object instead of a topology XML file. +### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: PSObject -Parameter Sets: PartialTopology -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -221,13 +233,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Merge-CsLegacyTopology cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The Merge-CsLegacyTopology cmdlet does not return any objects or values. ## NOTES diff --git a/skype/skype-ps/skype/Move-CsAnalogDevice.md b/skype/skype-ps/SkypeForBusiness/Move-CsAnalogDevice.md similarity index 85% rename from skype/skype-ps/skype/Move-CsAnalogDevice.md rename to skype/skype-ps/SkypeForBusiness/Move-CsAnalogDevice.md index 70102968cd..6a07a096cc 100644 --- a/skype/skype-ps/skype/Move-CsAnalogDevice.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsAnalogDevice.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/move-csanalogdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Move-CsAnalogDevice -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/move-csanalogdevice +schema: 2.0.0 +title: Move-CsAnalogDevice --- # Move-CsAnalogDevice @@ -59,7 +60,7 @@ The Move-CsAnalogDevice cmdlet provides a way for you to move an existing analog ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Move-CsAnalogDevice -Identity "CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com" -Target atl-cs-001.litwareinc.com @@ -68,7 +69,7 @@ Move-CsAnalogDevice -Identity "CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redm The command shown in Example 1 moves the analog device with the Identity CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com to the Registrar pool atl-cs-001.litwareinc.com. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsAnalogDevice | Where-Object {$_.DisplayName -eq "Building 14, Room 142"} | Move-CsAnalogDevice -Target atl-cs-001.litwareinc.com @@ -80,7 +81,7 @@ This collection is then piped to the Where-Object cmdlet, which picks out all th That filtered collection is then piped to the Move-CsAnalogDevice cmdlet, which moves all of the devices in the collection to the Registrar pool atl-cs-001.litwareinc.com. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsAnalogDevice | Where-Object {$_.DisplayName -like "Building 14*"} | Move-CsAnalogDevice -Target atl-cs-001.litwareinc.com @@ -94,50 +95,35 @@ The filtered collection is then piped to the Move-CsAnalogDevice cmdlet, which m ## PARAMETERS -### -Identity -Unique identifier for the analog device. -Analog devices are identified by using the Active Directory distinguished name of the associated contact object. -By default, analog devices use a GUID (globally unique identifier) as their common name, which means devices will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. - -```yaml -Type: UserIdParameter -Parameter Sets: (All), Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -ConcurrentMovesPerFE -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Target -The fully qualified domain name (FQDN) (for example, atl-cs-001.litwareinc.com) of the Registrar pool where the analog device should be moved. -In addition to a Registrar pool, the Target can also be the FQDN of a hosting provider. +PARAMVALUE: Int32 ```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Int32 +Parameter Sets: Users +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to move the analog device. To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-cs-001) or its FQDN (for example, atl-cs-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -146,18 +132,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyPool - -This parameter is used only for Skype for Business Online. -It should not be used with an on-premises implementation of Skype for Business Server. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +If present, moves the analog device but deletes any associated data (such as policies that were assigned to the device). +If not present, the device is moved along with any associated data. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -166,15 +151,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -If present, moves the analog device but deletes any associated data (such as policies that were assigned to the device). -If not present, the device is moved along with any associated data. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the analog device. +Analog devices are identified by using the Active Directory distinguished name of the associated contact object. +By default, analog devices use a GUID (globally unique identifier) as their common name, which means devices will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. + +```yaml +Type: UserIdParameter +Parameter Sets: (All), Identity +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -IgnoreBackendStoreException + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the common area phone despite those errors. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,14 +190,16 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to pass a user object through the pipeline that represents the user account being moved. By default, the Move-CsAnalogDevice cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -200,14 +208,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -ProxyPool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is used only for Skype for Business Online. +It should not be used with an on-premises implementation of Skype for Business Server. + + ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -216,14 +229,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Report + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: String ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Identity, Users +Aliases: Required: False Position: Named @@ -232,30 +247,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IgnoreBackendStoreException -When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the common area phone despite those errors. +### -Target + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The fully qualified domain name (FQDN) (for example, atl-cs-001.litwareinc.com) of the Registrar pool where the analog device should be moved. +In addition to a Registrar pool, the Target can also be the FQDN of a hosting provider. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -UserList + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: String ```yaml Type: String Parameter Sets: Users -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -264,14 +284,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConcurrentMovesPerFE -PARAMVALUE: Int32 +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Int32 -Parameter Sets: Users -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -280,14 +302,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -PARAMVALUE: String +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String -Parameter Sets: Identity, Users -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -301,13 +325,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String. +### System.String The Move-CsAnalogDevice cmdlet accepts a pipelined string value that represents the Identity of the analog device. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADAnalogDeviceContact By default, the Move-CsAnalogDevice cmdlet does not return any objects or values. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADAnalogDeviceContact object. diff --git a/skype/skype-ps/skype/Move-CsApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/Move-CsApplicationEndpoint.md similarity index 84% rename from skype/skype-ps/skype/Move-CsApplicationEndpoint.md rename to skype/skype-ps/SkypeForBusiness/Move-CsApplicationEndpoint.md index 1947fce031..0388a31e34 100644 --- a/skype/skype-ps/skype/Move-CsApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsApplicationEndpoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/move-csapplicationendpoint applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Move-CsApplicationEndpoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/move-csapplicationendpoint +schema: 2.0.0 +title: Move-CsApplicationEndpoint --- # Move-CsApplicationEndpoint @@ -41,7 +42,7 @@ Also, if an application originally designed to work against Skype for Business S ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Move-CsApplicationEndpoint -Identity sip:endpoint1@litwareinc.com -TargetApplicationPool TrustPoolA.litwareinc.com @@ -51,7 +52,7 @@ This example moves the application endpoint contact object with the SIP address Use this command to upgrade a UCMA 2.0 application to a Skype for Business Server application after coexistence. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Move-CsApplicationEndpoint -Identity sip:endpoint2@litwareinc.com -TargetApplicationPool TrustPoolA.litwareinc.com -Force @@ -65,68 +66,74 @@ This will update an existing object in Active Directory with the necessary attri ## PARAMETERS -### -Identity -The SIP address or distinguished name (DN) of the endpoint contact you want to move. +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to specify a domain controller. +If no domain controller is specified, the first available will be used. ```yaml -Type: UserIdParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetApplicationPool -The fully qualified domain name (FQDN) of the pool to which the endpoint is moving. -The target pool must have a Registrar service dependency. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This flag is required if you are moving a Microsoft Unified Communications Managed API (UCMA) 2.0 contact object to the same pool but on a Skype for Business Server deployment. +This will force routing to occur through the Skype for Business Server Registrar. + + ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: Target -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Allows you to specify a domain controller. -If no domain controller is specified, the first available will be used. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The SIP address or distinguished name (DN) of the endpoint contact you want to move. ```yaml -Type: Fqdn +Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Force - -This flag is required if you are moving a Microsoft Unified Communications Managed API (UCMA) 2.0 contact object to the same pool but on a Skype for Business Server deployment. -This will force routing to occur through the Skype for Business Server Registrar. +### -IgnoreBackendStoreException +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the application endpoint despite those errors. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -136,13 +143,15 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifying this parameter will return the application endpoint object after the object has been moved. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -151,30 +160,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -TargetApplicationPool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The fully qualified domain name (FQDN) of the pool to which the endpoint is moving. +The target pool must have a Registrar service dependency. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Target -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -183,14 +197,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IgnoreBackendStoreException -When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the application endpoint despite those errors. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -204,13 +220,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String. +### System.String Accepts a pipelined string value representing the Identity of an application endpoint. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact When used with the PassThru parameter, returns an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact. ## NOTES diff --git a/skype/skype-ps/skype/Move-CsCommonAreaPhone.md b/skype/skype-ps/SkypeForBusiness/Move-CsCommonAreaPhone.md similarity index 86% rename from skype/skype-ps/skype/Move-CsCommonAreaPhone.md rename to skype/skype-ps/SkypeForBusiness/Move-CsCommonAreaPhone.md index 55cd8f84f2..7e44731e2f 100644 --- a/skype/skype-ps/skype/Move-CsCommonAreaPhone.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsCommonAreaPhone.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/move-cscommonareaphone applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Move-CsCommonAreaPhone -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/move-cscommonareaphone +schema: 2.0.0 +title: Move-CsCommonAreaPhone --- # Move-CsCommonAreaPhone @@ -61,7 +62,7 @@ The Move-CsCommonAreaPhone cmdlet enables you to move an existing common area ph ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Move-CsCommonAreaPhone -Identity "CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com" -Target atl-cs-001.litwareinc.com @@ -69,7 +70,7 @@ Move-CsCommonAreaPhone -Identity "CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=R The command shown in Example 1 moves the common area phone with the Identity CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com to the Registrar pool atl-cs-001.litwareinc.com. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsCommonAreaPhone | Where-Object {$_.DisplayName -eq "Building 31 Cafeteria"} | Move-CsCommonAreaPhone -Target atl-cs-001.litwareinc.com @@ -80,7 +81,7 @@ To do this, the Get-CsCommonAreaPhone cmdlet is first called without any paramet This collection is then piped to the Where-Object cmdlet, which picks out only those phones where the DisplayName attribute is equal to "Building 31 Cafeteria." That filtered collection is then piped to the Move-CsCommonAreaPhone cmdlet, which moves each phone in the collection to atl-cs-001.litwareinc.com. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsCommonAreaPhone | Where-Object {$_.RegistrarPool -match "dublin-cs-001.litwareinc.com"} | Move-CsCommonAreaPhone -Target atl-cs-001.litwareinc.com @@ -91,7 +92,7 @@ To carry out this task, the command first calls the Get-CsCommonAreaPhone cmdlet This collection is then piped to the Where-Object cmdlet, which picks out all the common area phones where the RegistrarPool is equal to dublin-cs-001.litwareinc.com. This collection is then piped to the Move-CsCommonAreaPhone cmdlet, which moves each phone in the collection to the new Registrar pool atl-cs-001.litwareinc.com. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` Get-CsCommonAreaPhone | Where-Object {$_.RegistrarPool -match "dublin-cs-001.litwareinc.com"} | Move-CsCommonAreaPhone -Target atl-cs-001.litwareinc.com -PassThru | Grant-CsVoicePolicy -PolicyName AtlantaVoicePolicy @@ -104,50 +105,35 @@ To do this, the PassThru parameter is included when calling the Move-CsCommonAre ## PARAMETERS -### -Identity -Unique identifier for the common area phone. -Common area phones are identified using the Active Directory distinguished name of the associated contact object. -By default, common area phones use a globally unique identifier (GUID) as their common name, which means that phones will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. - -```yaml -Type: UserIdParameter -Parameter Sets: (All), Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -ConcurrentMovesPerFE -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Target -The fully qualified domain name (FQDN) of the Registrar pool where the common area phone should be moved; for example: atl-cs-001.litwareinc.com. -In addition to a Registrar pool, the Target can also be the FQDN of a hosting provider. +PARAMVALUE: Int32 ```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Int32 +Parameter Sets: Users +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to move the common area phone. To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-cs-001) or its FQDN (for example, atl-cs-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -156,18 +142,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyPool - -This parameter is used only for Skype for Business Online. -It should not be used with an on-premises implementation of Skype for Business Server. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +If present, moves the common area phone but deletes any associated data (such as policies that were assigned to the device). +If not present, the phone is moved along with any associated data. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -176,15 +161,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -If present, moves the common area phone but deletes any associated data (such as policies that were assigned to the device). -If not present, the phone is moved along with any associated data. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the common area phone. +Common area phones are identified using the Active Directory distinguished name of the associated contact object. +By default, common area phones use a globally unique identifier (GUID) as their common name, which means that phones will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. + +```yaml +Type: UserIdParameter +Parameter Sets: (All), Identity +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -IgnoreBackendStoreException + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the common area phone despite those errors. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -194,14 +200,16 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to pass a user object through the pipeline that represents the user account being moved. By default, the Move-CsCommonAreaPhone cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -210,14 +218,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -ProxyPool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is used only for Skype for Business Online. +It should not be used with an on-premises implementation of Skype for Business Server. + + ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -226,14 +239,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Report + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: String ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Identity, Users +Aliases: Required: False Position: Named @@ -242,30 +257,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IgnoreBackendStoreException -When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the common area phone despite those errors. +### -Target + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The fully qualified domain name (FQDN) of the Registrar pool where the common area phone should be moved; for example: atl-cs-001.litwareinc.com. +In addition to a Registrar pool, the Target can also be the FQDN of a hosting provider. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -UserList + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: String ```yaml Type: String Parameter Sets: Users -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -274,14 +294,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConcurrentMovesPerFE -PARAMVALUE: Int32 +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Int32 -Parameter Sets: Users -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -290,14 +312,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -PARAMVALUE: String +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String -Parameter Sets: Identity, Users -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -311,13 +335,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String. +### System.String The Move-CsCommonAreaPhone cmdlet accepts a pipelined string value that represents the Identity of the common area phone. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact By default, the Move-CsCommonAreaPhone cmdlet does not return any objects or values. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact object. diff --git a/skype/skype-ps/skype/Move-CsConferenceDirectory.md b/skype/skype-ps/SkypeForBusiness/Move-CsConferenceDirectory.md similarity index 87% rename from skype/skype-ps/skype/Move-CsConferenceDirectory.md rename to skype/skype-ps/SkypeForBusiness/Move-CsConferenceDirectory.md index 239a0646db..e45852a7cd 100644 --- a/skype/skype-ps/skype/Move-CsConferenceDirectory.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsConferenceDirectory.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/move-csconferencedirectory applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Move-CsConferenceDirectory -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/move-csconferencedirectory +schema: 2.0.0 +title: Move-CsConferenceDirectory --- # Move-CsConferenceDirectory @@ -48,7 +49,7 @@ For example, this command backs up conference directory 3 to the file C:\Logs\Co ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Move-CsConferenceDirectory -Identity 3 -TargetPool atl-cs-002.litwareinc.com @@ -57,7 +58,7 @@ Move-CsConferenceDirectory -Identity 3 -TargetPool atl-cs-002.litwareinc.com The command shown in Example 1 moves the conference directory with the Identity 3 to the pool atl-cs-002.litwareinc.com. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Move-CsConferenceDirectory -Identity 3 -TargetPool atl-cs-002.litwareinc.com -Force @@ -67,7 +68,7 @@ The command shown in Example 2 is a variation of the command shown in Example 1. In this case, however, the Force parameter is included to ensure that the move takes place even if the target pool is currently unavailable. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsConferenceDirectory | Move-CsConferenceDirectory -TargetPool atl-cs-002.litwareinc.com @@ -80,14 +81,40 @@ This collection is then piped to the Move-CsConferenceDirectory cmdlet, which mo ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, moves the conference directory even if the target pool is currently unavailable. +By default, the Move-CsConferenceDirectory cmdlet will not move directories if the target pool cannot be contacted. + +Before running the Move-CsConferenceDirectory cmdlet, note that if you use the -Force parameter, the dial-in code for existing meetings will be lost. +Users will still be able to join meetings using a Lync client, but unable to dial-in to meetings by phone dial in. + + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Numeric identity of the conference directory to be moved. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -97,14 +124,16 @@ Accept wildcard characters: False ``` ### -TargetPool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the pool where the conference directory is to be moved. For example: `-Identity atl-cs-002.litwareinc.com.` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -113,21 +142,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force - -When present, moves the conference directory even if the target pool is currently unavailable. -By default, the Move-CsConferenceDirectory cmdlet will not move directories if the target pool cannot be contacted. - -Before running the Move-CsConferenceDirectory cmdlet, note that if you use the -Force parameter, the dial-in code for existing meetings will be lost. -Users will still be able to join meetings using a Lync client, but unable to dial-in to meetings by phone dial in. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -137,29 +161,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -173,14 +183,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Move-CsConferenceDirectory cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Move-CsExUmContact.md b/skype/skype-ps/SkypeForBusiness/Move-CsExUmContact.md similarity index 83% rename from skype/skype-ps/skype/Move-CsExUmContact.md rename to skype/skype-ps/SkypeForBusiness/Move-CsExUmContact.md index fd94b648a5..1229d5fa86 100644 --- a/skype/skype-ps/skype/Move-CsExUmContact.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsExUmContact.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/move-csexumcontact applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Move-CsExUmContact -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/move-csexumcontact +schema: 2.0.0 +title: Move-CsExUmContact --- # Move-CsExUmContact @@ -52,7 +53,7 @@ When an Exchange UM contact object is moved, the AutoAttendant and IsSubscriberA ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Move-CsExUmContact -Identity "sip:exum1@fabrikam.com" -Target atl-cs-001.litwareinc.com @@ -63,7 +64,7 @@ Note that a confirmation prompt will be displayed when you run this command, eve This prompt will appear even if you include the Force parameter. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsExUmContact | Where-Object {$_.AutoAttendant -eq $True} | Move-CsExUmContact -Target atl-cs-001.litwareinc.com @@ -80,47 +81,53 @@ As in Example 1, you will be prompted for confirmation when running this command ## PARAMETERS -### -Identity -The unique identifier of the contact object you want to move. -Contact identities can be specified by using one of four formats: 1) the contact's SIP address; 2) the contact's user principal name (UPN); 3) the contact's domain name and logon name, in the form domain\logon (for example, litwareinc\exum1); and, 4) the contact's Active Directory display name (for example, Team Auto Attendant). +### -ConcurrentMovesPerFE + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: Int32 ```yaml -Type: UserIdParameter -Parameter Sets: (All), Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Int32 +Parameter Sets: Users +Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Target -The fully qualified domain name (FQDN) of the Registrar pool to which the contact is being moved. +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to connect to the specified domain controller. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-mcs-001) or its FQDN (for example, atl-mcs-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -129,31 +136,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to connect to the specified domain controller. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-mcs-001) or its FQDN (for example, atl-mcs-001.litwareinc.com). +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the contact object you want to move. +Contact identities can be specified by using one of four formats: 1) the contact's SIP address; 2) the contact's user principal name (UPN); 3) the contact's domain name and logon name, in the form domain\logon (for example, litwareinc\exum1); and, 4) the contact's Active Directory display name (for example, Team Auto Attendant). ```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: UserIdParameter +Parameter Sets: (All), Identity +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -IgnoreBackendStoreException + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the contact despite those errors. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -163,14 +174,16 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to pass a contact object through the pipeline that represents the contact account being moved. By default, the Move-CsExUmContact cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -181,6 +194,8 @@ Accept wildcard characters: False ### -ProxyPool +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is used only for hosted instances of Skype for Business Server. It should not be used with an on-premises implementation of Skype for Business Server. @@ -189,8 +204,7 @@ It should not be used with an on-premises implementation of Skype for Business S ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -199,14 +213,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Report + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: String ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Identity, Users +Aliases: Required: False Position: Named @@ -215,30 +231,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IgnoreBackendStoreException -When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the contact despite those errors. +### -Target + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The fully qualified domain name (FQDN) of the Registrar pool to which the contact is being moved. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -UserList + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: String ```yaml Type: String Parameter Sets: Users -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -247,14 +267,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConcurrentMovesPerFE -PARAMVALUE: Int32 +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Int32 -Parameter Sets: Users -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -263,14 +285,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -PARAMVALUE: String +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String -Parameter Sets: Identity, Users -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -284,13 +308,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -String. +### System.String Accepts a pipelined string value representing the Identity of an Exchange UM object to be moved. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact When called with the PassThru parameter, returns an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact. ## NOTES diff --git a/skype/skype-ps/skype/Move-CsLegacyUser.md b/skype/skype-ps/SkypeForBusiness/Move-CsLegacyUser.md similarity index 85% rename from skype/skype-ps/skype/Move-CsLegacyUser.md rename to skype/skype-ps/SkypeForBusiness/Move-CsLegacyUser.md index 9bc5c5ed52..2ff47ec8f5 100644 --- a/skype/skype-ps/skype/Move-CsLegacyUser.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsLegacyUser.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/move-cslegacyuser applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Move-CsLegacyUser -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/move-cslegacyuser +schema: 2.0.0 +title: Move-CsLegacyUser --- # Move-CsLegacyUser @@ -53,7 +54,7 @@ Before you can run the Merge-CsLegacyTopology, cmdlet you must first install the ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Move-CsLegacyUser -Identity "Pilar Ackerman" -Target "atl-cs-001.litwareinc.com" @@ -64,7 +65,7 @@ Because no additional parameters are included, any policies or settings previous That means that, if a legacy policy (such as a dial plan) was assigned to Pilar Ackerman, she will be assigned the Skype for Business Server equivalent when her account is moved. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Move-CsLegacyUser -Identity "Pilar Ackerman" -Target "atl-cs-001.litwareinc.com" -ExcludeDialPlan @@ -74,7 +75,7 @@ The command shown in Example 2 migrates Pilar Ackerman's user account, but does After the account is migrated, Pilar will not have an assigned dial plan. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` Get-CsUser -OU "ou=Finance,dc=litwareinc,dc=com" | Move-CsLegacyUser -Target "atl-cs-001.litwareinc.com" @@ -86,7 +87,7 @@ After the accounts have been retrieved, the collection is piped to the Move-CsLe This command assumes that all the users in the Finance OU are legacy users. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` Get-CsUser -UnassignedUser | Move-CsLegacyUser -Target "atl-cs-001.litwareinc.com" @@ -100,53 +101,39 @@ This example assumes that all of the unassigned users are legacy users. ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be migrated. -User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory Domain Services display name (for example, Ken Myer). -User Identities can also be reference by using the user's Active Directory distinguished name. - -You can use the asterisk (*) wildcard character when using the Display Name as the user Identity. -For example, the Identity "* Smith" returns all the users with a display name that ends with the string value " Smith". +### -Credential -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +Enables you to run the Move-CsLegacyUser cmdlet under alternate credentials. +This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with user objects. -### -Target -FQDN of the Registrar pool where the user account should be homed. -For example: `-Target atl-cs-001.litwareinc.com.` +To use the Credential parameter you must first create a PSCredential object using the Get-Credential cmdlet. +For details, see the Get-Credential cmdlet Help topic. ```yaml -Type: Fqdn +Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to move a user account. To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-cs-001) or its FQDN (for example, atl-cs-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -156,13 +143,15 @@ Accept wildcard characters: False ``` ### -ExcludeArchivingPolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, any archiving policies assigned to the user account are not retained when the account is migrated. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -172,13 +161,15 @@ Accept wildcard characters: False ``` ### -ExcludeConferencingPolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, any conferencing policies assigned to the user account are not retained when the account is migrated. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -188,13 +179,15 @@ Accept wildcard characters: False ``` ### -ExcludeDialPlan + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, any dial plans assigned to the user account are not retained when the account is migrated. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -204,13 +197,15 @@ Accept wildcard characters: False ``` ### -ExcludeExternalAccessPolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, any external access policies assigned to the user account are not retained when the account is migrated. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -220,13 +215,15 @@ Accept wildcard characters: False ``` ### -ExcludePresencePolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, any presence policies assigned to the user account are not retained when the account is migrated. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -236,13 +233,15 @@ Accept wildcard characters: False ``` ### -ExcludeVoicePolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, any voice policies assigned to the user account are not retained when the account is migrated. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -251,18 +250,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyPool - -This parameter is used only with Communications Server 2007 R2. -It should not be used with an on-premises implementation of Skype for Business Server. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -271,14 +268,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -HostedMigrationOverrideUrl + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL for the hosted migration service used when moving a user to the Office 365 version of Skype for Business Server. + + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -287,31 +288,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the user account being moved. -By default, the Move-CsLegacyUser cmdlet does not pass objects through the pipeline. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the user account to be migrated. +User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory Domain Services display name (for example, Ken Myer). +User Identities can also be reference by using the user's Active Directory distinguished name. + +You can use the asterisk (*) wildcard character when using the Display Name as the user Identity. +For example, the Identity "* Smith" returns all the users with a display name that ends with the string value " Smith". ```yaml -Type: SwitchParameter +Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -IgnoreBackendStoreException + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the user despite those errors. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -320,14 +329,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to pass a user object through the pipeline that represents the user account being moved. +By default, the Move-CsLegacyUser cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -336,18 +348,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Credential -Enables you to run the Move-CsLegacyUser cmdlet under alternate credentials. -This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with user objects. +### -ProxyPool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is used only with Communications Server 2007 R2. +It should not be used with an on-premises implementation of Skype for Business Server. + -To use the Credential parameter you must first create a PSCredential object using the Get-Credential cmdlet. -For details, see the Get-Credential cmdlet Help topic. ```yaml -Type: PSCredential +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -356,17 +369,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HostedMigrationOverrideUrl +### -Target -URL for the hosted migration service used when moving a user to the Office 365 version of Skype for Business Server. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +FQDN of the Registrar pool where the user account should be homed. +For example: `-Target atl-cs-001.litwareinc.com.` +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -375,14 +406,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IgnoreBackendStoreException -When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the user despite those errors. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -396,13 +429,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Move-CsLegacyUser cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The Move-CsLegacyUser cmdlet does not return any values or objects. Instead, the cmdlet moves instances of the Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. diff --git a/skype/skype-ps/skype/Move-CsManagementServer.md b/skype/skype-ps/SkypeForBusiness/Move-CsManagementServer.md similarity index 91% rename from skype/skype-ps/skype/Move-CsManagementServer.md rename to skype/skype-ps/SkypeForBusiness/Move-CsManagementServer.md index 5e869c100f..4d1302df58 100644 --- a/skype/skype-ps/skype/Move-CsManagementServer.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsManagementServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/move-csmanagementserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Move-CsManagementServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/move-csmanagementserver +schema: 2.0.0 +title: Move-CsManagementServer --- # Move-CsManagementServer @@ -88,7 +89,7 @@ Note that the Move-CsManagementServer cmdlet must be run locally; it cannot be c ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Move-CsManagementServer @@ -97,7 +98,7 @@ Move-CsManagementServer The command shown in Example 1 moves the Central Management Server from its existing pool to a new pool. To perform this live migration (that is, to move a Central Management Server that is online and accessible), you must run the command from a computer located in the pool where the server is to be moved. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Move-CsManagementServer -ConfigurationFileName "C:\CsConfiguration.zip" -LisConfigurationFileName "C:\CsLisConfiguration.zip" -Force @@ -112,6 +113,8 @@ In addition, you must include the ConfigurationFileName parameter to import your ### -ConfigurationFileName +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Full path to the Skype for Business Server configuration backup file created by running the Export-CsConfiguration cmdlet. This parameter should only be used in a disaster recovery scenario. @@ -121,7 +124,6 @@ This parameter should only be used in a disaster recovery scenario. Type: String Parameter Sets: (All) Aliases: CsConfiguration -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -130,15 +132,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LisConfigurationFileName -Full path to the E9-1-1 backup file created by running the Export-CsLisConfiguration cmdlet. -This parameter should only be used in a disaster recovery scenario. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Forces the Central Management Server move even if the existing store is offline; this parameter is required in a disaster recovery scenario. +Note that there is the potential for some data loss any time you force the movement of the Central Management Server. + +The Force parameter can also be used if your previous attempts at calling the Move-CsManagementServer cmdlet have failed. + + ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: CsLisConfiguration -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -147,20 +155,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force - -Forces the Central Management Server move even if the existing store is offline; this parameter is required in a disaster recovery scenario. -Note that there is the potential for some data loss any time you force the movement of the Central Management Server. - -The Force parameter can also be used if your previous attempts at calling the Move-CsManagementServer cmdlet have failed. +### -LisConfigurationFileName +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Full path to the E9-1-1 backup file created by running the Export-CsLisConfiguration cmdlet. +This parameter should only be used in a disaster recovery scenario. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: CsLisConfiguration Required: False Position: Named @@ -170,14 +175,16 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: `-Report "C:\Logs\MoveManagementServer.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -186,14 +193,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -TargetFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool where the Management Server should be moved to. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Fqdn +Parameter Sets: FromBackup +Aliases: Required: False Position: Named @@ -203,13 +212,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -218,14 +229,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetFqdn -Fully qualified domain name of the pool where the Management Server should be moved to. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Fqdn -Parameter Sets: FromBackup -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -239,14 +252,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Move-CsManagementServer cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None The Move-CsManagementServer cmdlet does not return any objects. ## NOTES diff --git a/skype/skype-ps/skype/Move-CsMeetingRoom.md b/skype/skype-ps/SkypeForBusiness/Move-CsMeetingRoom.md similarity index 87% rename from skype/skype-ps/skype/Move-CsMeetingRoom.md rename to skype/skype-ps/SkypeForBusiness/Move-CsMeetingRoom.md index 25aefd9c8e..a03f3df92e 100644 --- a/skype/skype-ps/skype/Move-CsMeetingRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsMeetingRoom.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/move-csmeetingroom applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Move-CsMeetingRoom -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/move-csmeetingroom +schema: 2.0.0 +title: Move-CsMeetingRoom --- # Move-CsMeetingRoom @@ -53,14 +54,14 @@ Skype for Business Server Control Panel: The functions carried out by the Move-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Move-CsMeetingRoom -Target "atl-cs-001.litwareinc.com" -Identity "Room 14" ``` The command shown in Example 1 moves the meeting room with the display name "Room 14" to the pool atl-cs-001.litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMeetingRoom | Move-CsMeetingRoom -Target "atl-cs-001.litwareinc.com" ``` @@ -69,7 +70,7 @@ Example 2 moves all the meeting rooms in the organization to the pool atl-cs-001 To do this, the command first calls the Get-CsMeetingRoom cmdlet without any parameters; that returns a collection of all the meeting rooms configured for use in the organization. That collection is then piped to the Move-CsMeetingRoom cmdlet, which moves each meeting room in the collection to the new pool. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Move-CsMeetingRoom -Identity "Room 15" -HostedMigrationOverrideUrl "https://admin2a.online.lync.com/HostedMigration/hostedmigrationservice.svc" -Target "sipfed.online.lync.com" -Credential $credential ``` @@ -78,48 +79,17 @@ The command shown in Example 3 moves the meeting room with the display name "Roo ## PARAMETERS -### -Identity -Indicates the Identity of the meeting room to be moved. -Meeting rooms can be specified using one of four formats: 1) the room's SIP address; 2) the room's user principal name (UPN); 3) the room's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the room's Active Directory display name (for example, Main Conference Room). -User Identities can also be referenced by using the room's Active Directory distinguished name. - -```yaml -Type: UserIdParameter -Parameter Sets: (All), Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Target -The FQDN (for example, atl-cs-001.litwareinc.com) of the Registrar pool where the meeting room should be moved. - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### -Credential +Enables you to run the Move-CsMeetingRoom cmdlet under alternate credentials. +This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with user objects. -### -Confirm -Prompts you for confirmation before executing the command. +To use the Credential parameter you must first create a PSCredential object using the Get-Credential cmdlet. +For details, see the Get-Credential cmdlet help topic. ```yaml -Type: SwitchParameter +Type: PSCredential Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -129,14 +99,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to move a meeting room. To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -145,15 +117,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Credential -Enables you to run the Move-CsMeetingRoom cmdlet under alternate credentials. -This might be required if the account you used to log on to Windows does not have the necessary privileges required to work with user objects. +### -Force -To use the Credential parameter you must first create a PSCredential object using the Get-Credential cmdlet. -For details, see the Get-Credential cmdlet help topic. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, instructs the Move-CsMeetingRoom cmdlet to ignore all errors that might occur when carrying out the move operation. +As a general rule, you should avoid using the Force parameter unless absolutely necessary. ```yaml -Type: PSCredential +Type: SwitchParameter Parameter Sets: (All) Aliases: @@ -164,15 +136,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -When present, instructs the Move-CsMeetingRoom cmdlet to ignore all errors that might occur when carrying out the move operation. -As a general rule, you should avoid using the Force parameter unless absolutely necessary. +### -HostedMigrationOverrideUrl +URL for the hosted migration service used when moving a user to Lync Online. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -181,29 +151,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HostedMigrationOverrideUrl -URL for the hosted migration service used when moving a user to Lync Online. +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the meeting room to be moved. +Meeting rooms can be specified using one of four formats: 1) the room's SIP address; 2) the room's user principal name (UPN); 3) the room's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the room's Active Directory display name (for example, Main Conference Room). +User Identities can also be referenced by using the room's Active Directory distinguished name. ```yaml -Type: String -Parameter Sets: (All) +Type: UserIdParameter +Parameter Sets: (All), Identity Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -IgnoreBackendStoreException + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to the move meeting room despite those errors. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -213,14 +190,16 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to pass a meeting room object through the pipeline that represents the meeting room being moved. By default, the Move-CsMeetingRoom cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -230,13 +209,15 @@ Accept wildcard characters: False ``` ### -ProxyPool + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is not used with the on-premises version of Skype for Business Online. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -245,14 +226,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Report + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the file path for the log file created when the cmdlet runs. +For example: -Report "C:\Logs\S1_FailOverLog.html". +If this file already exists, it will be overwritten. +By default, reports are written to the "AppData\Local\Temp" folder in your user profile. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Identity, Users +Aliases: Required: False Position: Named @@ -261,14 +247,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Target + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The FQDN (for example, atl-cs-001.litwareinc.com) of the Registrar pool where the meeting room should be moved. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -UserList + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: String ```yaml Type: String Parameter Sets: Users -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -277,17 +283,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Specifies the file path for the log file created when the cmdlet runs. -For example: -Report "C:\Logs\S1_FailOverLog.html". -If this file already exists, it will be overwritten. -By default, reports are written to the "AppData\Local\Temp" folder in your user profile. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String -Parameter Sets: Identity, Users -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -301,13 +324,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADMeetingRoom The Moves-CsMeetingRoom cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADMeetingRoom object. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Move-CsRgsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Move-CsRgsConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Move-CsRgsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Move-CsRgsConfiguration.md index c0b6514042..278c1b3317 100644 --- a/skype/skype-ps/skype/Move-CsRgsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsRgsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/move-csrgsconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Move-CsRgsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/move-csrgsconfiguration +schema: 2.0.0 +title: Move-CsRgsConfiguration --- # Move-CsRgsConfiguration @@ -47,7 +48,7 @@ That type of migration can only be done by using the new Import-CsRgsConfigurati ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Move-CsRgsConfiguration -Source atl-ocsrgs-001.litwareinc.com -Destination redmond-lyncrgs-001.litwareinc.com ``` @@ -58,13 +59,15 @@ The command shown in Example 1 migrates the Response Group application from atl- ## PARAMETERS ### -Destination + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of the computer where the newer server Response Group application is to be hosted (the "copy to" location). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 3 @@ -73,30 +76,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Source -FQDN of the pool where the legacy Response Group application is currently hosted (the "copy from" location). +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -ResolveNameConflicts + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When present, duplicate names will be resolved by appending a unique identifying number. For example, if there are two workflows named Help Desk Workflow one of the two will be renamed Help Desk Workflow (2). ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -105,17 +112,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ResolveNameConflicts -When present, duplicate names will be resolved by appending a unique identifying number. For example, if there are two workflows named Help Desk Workflow one of the two will be renamed Help Desk Workflow (2). +### -Source + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of the pool where the legacy Response Group application is currently hosted (the "copy from" location). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -126,13 +135,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None Move-CsRgsConfiguration does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableSettings.ServiceSettings Move-CsRgsConfiguration moves instances of the Microsoft.Rtc.Management.WritableSettings.ServiceSettings from one service to another. ## NOTES diff --git a/skype/skype-ps/skype/Move-CsThirdPartyVideoSystem.md b/skype/skype-ps/SkypeForBusiness/Move-CsThirdPartyVideoSystem.md similarity index 86% rename from skype/skype-ps/skype/Move-CsThirdPartyVideoSystem.md rename to skype/skype-ps/SkypeForBusiness/Move-CsThirdPartyVideoSystem.md index 6ab001cf5a..06fbd97f0c 100644 --- a/skype/skype-ps/skype/Move-CsThirdPartyVideoSystem.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsThirdPartyVideoSystem.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/move-csthirdpartyvideosystem applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Move-CsThirdPartyVideoSystem -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/move-csthirdpartyvideosystem +schema: 2.0.0 +title: Move-CsThirdPartyVideoSystem --- # Move-CsThirdPartyVideoSystem @@ -42,7 +43,7 @@ If you later decide to move a contact object to a different pool, you can do so ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Move-CsThirdPartyVideoSystem -Identity "CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com" -Target "atl-cs-001.litwareinc.com" @@ -51,7 +52,7 @@ Move-CsThirdPartyVideoSystem -Identity "CN={ce84964a-c4da-4622-ad34-c54ff3ed361f The command shown in Example 1 moves the third-party video system with the Identity CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com to the Registrar pool atl-cs-001.litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsThirdPartyVideoSystem | Move-CsThirdPartyVideoSystem -Target "atl-cs-001.litwareinc.com" @@ -64,83 +65,94 @@ That collection is then piped to the Move-CsThirdPartyVideoSystem cmdlet, which ## PARAMETERS -### -Identity -Unique identifier for the third-party video system to be moved. -Video systems are identified by using the Active Directory distinguished name of the associated contact object. -By default, video systems use a GUID (globally unique identifier) as their common name, which means systems will typically have an Identity similar to this: +### -ConcurrentMovesPerFE -CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: Int32 ```yaml -Type: UserIdParameter -Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: Int32 +Parameter Sets: Users +Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Target -The fully qualified domain name (FQDN) of the Registrar pool where the video system should be moved (for example, atl-cs-001.litwareinc.com). -In addition to a Registrar pool, the Target can also be the FQDN of a hosting provider. +### -DomainController + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to connect to the specified domain controller in order to move the video system. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-cs-001) or its FQDN (e.g., atl-cs-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserList -PARAMVALUE: String +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +If present, moves the video system but deletes any associated data (such as policies that were assigned to the system). +If not present, the video system is moved along with any associated data. ```yaml -Type: String -Parameter Sets: Users -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ConcurrentMovesPerFE -PARAMVALUE: Int32 +### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the third-party video system to be moved. +Video systems are identified by using the Active Directory distinguished name of the associated contact object. +By default, video systems use a GUID (globally unique identifier) as their common name, which means systems will typically have an Identity similar to this: + +CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com ```yaml -Type: Int32 -Parameter Sets: Users -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: UserIdParameter +Parameter Sets: Identity +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -IgnoreBackendStoreException + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the video system despite those errors. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -149,15 +161,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to connect to the specified domain controller in order to move the video system. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-cs-001) or its FQDN (e.g., atl-cs-001.litwareinc.com). +### -PassThru + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to pass a video system contact object through the pipeline that represents the video system being moved. +By default, the Move-CsThirdPartyVideoSystem cmdlet does not pass objects through the pipeline. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -166,15 +180,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -If present, moves the video system but deletes any associated data (such as policies that were assigned to the system). -If not present, the video system is moved along with any associated data. +### -ProxyPool + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is used only for Skype for Business Online. +It should not be used with an on-premises implementation of Skype for Business Server. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -183,14 +199,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IgnoreBackendStoreException -When present, instructs the computer to ignore any errors that might occur with the backend database and attempt to move the video system despite those errors. +### -Report + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: String ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -199,48 +217,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a video system contact object through the pipeline that represents the video system being moved. -By default, the Move-CsThirdPartyVideoSystem cmdlet does not pass objects through the pipeline. +### -Target + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +The fully qualified domain name (FQDN) of the Registrar pool where the video system should be moved (for example, atl-cs-001.litwareinc.com). +In addition to a Registrar pool, the Target can also be the FQDN of a hosting provider. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyPool -This parameter is used only for Skype for Business Online. -It should not be used with an on-premises implementation of Skype for Business Server. +### -UserList + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: String ```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Users +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -PARAMVALUE: String +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -250,13 +273,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -270,12 +295,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADThirdPartyVideoSystemContact The Move-CsThirdPartyVideoSystem cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADThirdPartyVideoSystemContact object. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADThirdPartyVideoSystemContact By default the Move-CsThirdPartyVideoSystem cmdlet does not return any data or objects. However, if you include the PassThru parameter you can instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADThirdPartyVideoSystemContact object through the pipeline. diff --git a/skype/skype-ps/skype/Move-CsUser.md b/skype/skype-ps/SkypeForBusiness/Move-CsUser.md similarity index 92% rename from skype/skype-ps/skype/Move-CsUser.md rename to skype/skype-ps/SkypeForBusiness/Move-CsUser.md index 29973fc914..6621d6074f 100644 --- a/skype/skype-ps/skype/Move-CsUser.md +++ b/skype/skype-ps/SkypeForBusiness/Move-CsUser.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/move-csuser applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Move-CsUser -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/move-csuser +schema: 2.0.0 +title: Move-CsUser --- # Move-CsUser @@ -121,42 +122,35 @@ Also, a detailed report is created in the out.csv file. ## PARAMETERS -### -Identity +### -BypassAudioConferencingCheck -Indicates the Identity of the user account to be moved. -User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). -User Identities can also be referenced by using the user's Active Directory distinguished name. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -You can use the asterisk (*) wildcard character when using the Display Name as the user Identity. -For example, the Identity "* Smith" returns all the users with who have a display name that ends with the string value " Smith". +This parameter has been deprecated and should not be used. ```yaml -Type: UserIdParameter -Parameter Sets: (All), Identity +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Target +### -BypassEnterpriseVoiceCheck -If moving to an on-premises pool (either from another pool or from Microsoft 365), this is the FQDN (for example, atl-cs-001.litwareinc.com) of the Registrar pool where the user account should be moved. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -If moving to Microsoft 365, this must be set to the ProxyFqdn value of the hosting provider. In most cases this is sipfed.online.lync.com. The value of the ProxyFqdn can be obtained using Get-CsHostingProvider +This parameter has been deprecated and should not be used. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -164,13 +158,14 @@ Accept wildcard characters: False ### -Credential +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to run the Move-CsUser cmdlet under alternate credentials, which is typically required when moving to Office 365. To use the Credential parameter you must first create a PSCredential object using the Get-Credential cmdlet. For details, see the Get-Credential cmdlet help topic. ```yaml Type: PSCredential Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -179,15 +174,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseOAuth +### -DomainController -This switch is no longer relevant. Previously, this switch ensured authentication between on-premises and the cloud. This switch also ensured Skype for Business Server 2015 CU8 to CU11 used the OAuth protocol (supported in those versions, but not used by default). All currently supported versions for migration to Teams (see the list earlier in this article) automatically use OAuth, so this switch is no longer required. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015 + Required: False Position: Named Default value: None @@ -195,15 +192,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BypassAudioConferencingCheck +### -Force -This parameter has been deprecated and should not be used. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If present, moves the user account without moving contacts or meetings. Contacts and meetings are not recoverable. +If not present, both the account and the associated data are moved. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Required: False Position: Named Default value: None @@ -211,15 +211,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BypassEnterpriseVoiceCheck +### -Identity -This parameter has been deprecated and should not be used. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the user account to be moved. +User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). +User Identities can also be referenced by using the user's Active Directory distinguished name. + +You can use the asterisk (*) wildcard character when using the Display Name as the user Identity. +For example, the Identity "* Smith" returns all the users with who have a display name that ends with the string value " Smith". + +```yaml +Type: UserIdParameter +Parameter Sets: (All), Identity +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -MoveConferenceData + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, moves meeting and conference data for users being transferred to a different Registrar pool. +Note that you should only use the MoveConferenceData parameter if you are moving users between on-premises pools and you should not use the MoveConferenceData parameter if you are moving users as part of a disaster recovery procedure. +Instead, you should rely on the backup service for moving conference data as part of a disaster recovery procedure. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -227,14 +253,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TenantAdminUserName +### -PassThru -This is an optional parameter that if, specified, pre-populates the username of the tenant admin when moving users to or from Office 365. This can be useful for scenarios involving smart card authentication or 2 factor auth. This parameter is only available with Skype for Business Server 2019 and CU8 for Skype for Business Server 2015. When specifying this parameter on Skype for Business Server 2015 with CU8, you must also specify the UseOAuth parameter. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to pass a user object through the pipeline that represents the user account being moved. +By default, the Move-CsUser cmdlet does not pass objects through the pipeline. ```yaml -Type: UserIdParameter +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Required: False Position: Named Default value: None @@ -244,13 +274,14 @@ Accept wildcard characters: False ### -ProxyPool +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This is an optional parameter that can be used to specify the front-end pool for user migration. ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -259,17 +290,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MoveConferenceData +### -Report -When present, moves meeting and conference data for users being transferred to a different Registrar pool. -Note that you should only use the MoveConferenceData parameter if you are moving users between on-premises pools and you should not use the MoveConferenceData parameter if you are moving users as part of a disaster recovery procedure. -Instead, you should rely on the backup service for moving conference data as part of a disaster recovery procedure. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +A CSV file to be created with detailed information about the move. You can supply the file name if you want to create the file in the current folder, or an absolute path. ```yaml -Type: SwitchParameter -Parameter Sets: (All) +Type: String +Parameter Sets: Identity, Users Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Required: False Position: Named Default value: None @@ -277,41 +308,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -Target -If present, moves the user account without moving contacts or meetings. Contacts and meetings are not recoverable. -If not present, both the account and the associated data are moved. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If moving to an on-premises pool (either from another pool or from Microsoft 365), this is the FQDN (for example, atl-cs-001.litwareinc.com) of the Registrar pool where the user account should be moved. + +If moving to Microsoft 365, this must be set to the ProxyFqdn value of the hosting provider. In most cases this is sipfed.online.lync.com. The value of the ProxyFqdn can be obtained using Get-CsHostingProvider ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm - -Enables you to bypass the confirmation prompt that would otherwise appear when you attempt to move a user. -To bypass the confirmation prompt, include the Confirm parameter using this syntax: +### -TenantAdminUserName -`-Confirm:$False` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -If you would prefer to have the confirmation prompt then use this syntax: - -`-Confirm` +This is an optional parameter that if, specified, pre-populates the username of the tenant admin when moving users to or from Office 365. This can be useful for scenarios involving smart card authentication or 2 factor auth. This parameter is only available with Skype for Business Server 2019 and CU8 for Skype for Business Server 2015. When specifying this parameter on Skype for Business Server 2015 with CU8, you must also specify the UseOAuth parameter. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - +Type: UserIdParameter +Aliases: Required: False Position: Named Default value: None @@ -319,16 +344,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report +### -UseOAuth -A CSV file to be created with detailed information about the move. You can supply the file name if you want to create the file in the current folder, or an absolute path. +> Applicable: Skype for Business Server 2015 + +This switch is no longer relevant. Previously, this switch ensured authentication between on-premises and the cloud. This switch also ensured Skype for Business Server 2015 CU8 to CU11 used the OAuth protocol (supported in those versions, but not used by default). All currently supported versions for migration to Teams (see the list earlier in this article) automatically use OAuth, so this switch is no longer required. ```yaml -Type: String -Parameter Sets: Identity, Users +Type: SwitchParameter +Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 - Required: False Position: Named Default value: None @@ -338,13 +363,14 @@ Accept wildcard characters: False ### -UserList +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + A text file with a list of users to be moved, in the following format example: "sip:user1@contoso.com,sip:user2@contoso.com,sip:user3@contoso.com". You can supply the file name if it's located in the current folder, or the absolute path to the file. ```yaml Type: String Parameter Sets: Users Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -353,32 +379,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -The DomainController parameter specifies the domain controller that's used by this cmdlet to read data from or write data to Active Directory. You identify the domain controller by its fully qualified domain name (FQDN). For example, dc01.contoso.com. +### -Confirm -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Enables you to bypass the confirmation prompt that would otherwise appear when you attempt to move a user. +To bypass the confirmation prompt, include the Confirm parameter using this syntax: -### -PassThru +`-Confirm:$False` -Enables you to pass a user object through the pipeline that represents the user account being moved. -By default, the Move-CsUser cmdlet does not pass objects through the pipeline. +If you would prefer to have the confirmation prompt then use this syntax: + +`-Confirm` ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -389,13 +406,14 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/New-CsAVEdgeConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsAVEdgeConfiguration.md similarity index 87% rename from skype/skype-ps/skype/New-CsAVEdgeConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsAVEdgeConfiguration.md index 89161bbc99..4121e90a47 100644 --- a/skype/skype-ps/skype/New-CsAVEdgeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAVEdgeConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csavedgeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsAVEdgeConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csavedgeconfiguration +schema: 2.0.0 +title: New-CsAVEdgeConfiguration --- # New-CsAVEdgeConfiguration @@ -48,7 +49,7 @@ Because of that, you will probably not need to create a new collection of settin ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsAVEdgeConfiguration -Identity site:Redmond -MaxTokenLifetime "04:00:00" @@ -58,7 +59,7 @@ The command shown in Example 1 creates a new collection of A/V Edge configuratio In this example, the MaxTokenLifetime property is set to 4 hours (04 hours : 00 minutes : 00 seconds). -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsAVEdgeConfiguration -Identity site:Redmond -InMemory @@ -78,7 +79,28 @@ The third command then uses the Set-CsAVEdgeConfiguration cmdlet to apply the se ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of A/V Edge configuration settings to be created. To create a collection of settings to be applied at the site scope, use syntax similar to this: `-Identity site:Redmond.` (Note that this command will fail if a collection of A/V Edge configuration settings have already been applied to the Redmond site.) Settings configured at the service scope should use syntax similar to this: `-Identity service:EdgeServer:atl-cs-001.litwareinc.com.` @@ -86,8 +108,7 @@ To create a collection of settings to be applied at the site scope, use syntax s ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -96,24 +117,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxTokenLifetime -The maximum amount of time that an authentication token can be used before it expires and must be renewed. -Token lifetimes are expressed using the following format: Days.Hours:Minutes:Seconds. -For example, 13 days must be expressed like this, with a period (.) following the number of days, and colons (:) used to separate the hours, minutes, and seconds: +### -InMemory -13.00:00:00 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The default value of 8 hours must be expressed like this: +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. -08:00:00 -The minimum allowed token lifetime is 1 minute (00:01:00); the maximum allowed lifetime is 180 days (180.00:00:00). ```yaml -Type: TimeSpan +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,14 +138,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -MaxBandwidthPerPortKb + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum amount of bandwidth (in kilobits per second) that can be allocated to a single port. +The maximum bandwidth can be set to any integer value between 1 and 4294967296 (4096 gigabits) per second; the default value is 3000. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,18 +157,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory - -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -MaxBandwidthPerUserKb +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Indicates the maximum amount of bandwidth (in kilobits per second) that can be allocated to any one user. +The maximum bandwidth can be set to any integer value between 1 and 4294967296 (4096 gigabits) per second; the default value is 10000. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,14 +176,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MaxTokenLifetime + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The maximum amount of time that an authentication token can be used before it expires and must be renewed. +Token lifetimes are expressed using the following format: Days.Hours:Minutes:Seconds. +For example, 13 days must be expressed like this, with a period (.) following the number of days, and colons (:) used to separate the hours, minutes, and seconds: + +13.00:00:00 + +The default value of 8 hours must be expressed like this: + +08:00:00 + +The minimum allowed token lifetime is 1 minute (00:01:00); the maximum allowed lifetime is 180 days (180.00:00:00). ```yaml -Type: SwitchParameter +Type: TimeSpan Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,13 +205,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -190,32 +222,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxBandwidthPerPortKb -Indicates the maximum amount of bandwidth (in kilobits per second) that can be allocated to a single port. -The maximum bandwidth can be set to any integer value between 1 and 4294967296 (4096 gigabits) per second; the default value is 3000. +### -WhatIf -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MaxBandwidthPerUserKb -Indicates the maximum amount of bandwidth (in kilobits per second) that can be allocated to any one user. -The maximum bandwidth can be set to any integer value between 1 and 4294967296 (4096 gigabits) per second; the default value is 10000. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: UInt32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -229,13 +245,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsAVEdgeConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.MediaRelaySettings Creates instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.MediaRelaySettings object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsAdditionalInternalDomain.md b/skype/skype-ps/SkypeForBusiness/New-CsAdditionalInternalDomain.md similarity index 87% rename from skype/skype-ps/skype/New-CsAdditionalInternalDomain.md rename to skype/skype-ps/SkypeForBusiness/New-CsAdditionalInternalDomain.md index 02cf488052..1e7538c90e 100644 --- a/skype/skype-ps/skype/New-CsAdditionalInternalDomain.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAdditionalInternalDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csadditionalinternaldomain applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsAdditionalInternalDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csadditionalinternaldomain +schema: 2.0.0 +title: New-CsAdditionalInternalDomain --- # New-CsAdditionalInternalDomain @@ -37,7 +38,7 @@ domains. ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` PS C:\> New-CsAdditionalInternalDomain -Identity fabrikam.com ``` @@ -46,30 +47,16 @@ The cmdlet shown in Example 1 creates a new additional internal domain, one that ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Domain -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Domain Fully qualified domain name (FQDN) for the new additional internal domain. ```yaml Type: String Parameter Sets: ParentAndRelativeKey Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -79,13 +66,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -95,13 +84,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) for the new additional internal domain. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 1 @@ -111,13 +102,33 @@ Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -127,13 +138,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/New-CsAddressBookConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsAddressBookConfiguration.md similarity index 86% rename from skype/skype-ps/skype/New-CsAddressBookConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsAddressBookConfiguration.md index 2e6b1c092e..43513c3cac 100644 --- a/skype/skype-ps/skype/New-CsAddressBookConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAddressBookConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csaddressbookconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsAddressBookConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csaddressbookconfiguration +schema: 2.0.0 +title: New-CsAddressBookConfiguration --- # New-CsAddressBookConfiguration @@ -51,7 +52,7 @@ Your command will also fail if the site in question already contains a collectio ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsAddressBookConfiguration -Identity site:Redmond -KeepDuration 15 -SynchronizePollingInterval 00:10:00 @@ -61,7 +62,7 @@ Example 1 creates a new collection of Address Book configuration settings with t To create the new collection you must call the New-CsAddressBookConfiguration cmdlet along with the Identity parameter and any other optional parameters (for example, the KeepDuration and SynchronizePollingInterval parameters). -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = Get-CsAddressBookConfiguration -Identity site:Redmond @@ -77,7 +78,7 @@ This command includes two optional parameters -- KeepDuration and SynchronizePol For example, KeepDuration uses the parameter value $x.KeepDuration; that parameter value represents the KeepDuration information copied from the Redmond site. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` $x = New-CsAddressBookConfiguration -Identity site:Redmond -InMemory @@ -99,33 +100,36 @@ The fourth and final command then uses the Set-CsAddressBookConfiguration cmdlet ## PARAMETERS -### -Identity -Unique identifier to be assigned to the new collection of Address Book settings. -Because you can only create new collections at the site scope, the Identity will always be the prefix "site:" followed by the site name; for example "site:Redmond". +### -EnableFileGeneration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) the Address Book server generates Address Book index files that can be downloaded by clients. +When set to False, these index files are not generated. +That means that client applications will have to use the Address Book Web Query service when searching for contacts. ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableFileGeneration -When set to True (the default value) the Address Book server generates Address Book index files that can be downloaded by clients. -When set to False, these index files are not generated. -That means that client applications will have to use the Address Book Web Query service when searching for contacts. +### -EnablePhotoSearch + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, user photos will be displayed in search results. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,20 +138,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IgnoreGenericRules +### -EnableSearchByDialPad -Indicates whether or not the Address Book server ignores the generic normalization rules used when parsing phone numbers. -Generic rules are the rules that are built into Skype for Business Server. -These rules cannot be changed; however, by setting the value of this property to True you can instruct your Address Book servers to ignore these rules and instead use custom rules that you create yourself. -The default value is False. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +When set to True, users will be able to search for contacts by using their mobile device keypad. +This can be a convenience for mobile users, but has the potential to greatly increase the size of your Address Book database. +The default value is True ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -156,20 +159,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -KeepDuration - -Specifies the amount of time (in days) that Address Book servers will keep change files. -Change files older than the value of the KeepDuration property will be deleted. -The KeepDuration can be set to any integer value between 1 and 90, inclusive. -The default value is 30 days. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: UInt32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -178,41 +177,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxDeltaFileSizePercentage - -When changes are made to Active Directory (such as a new user being enabled for Skype for Business Server) the Address Book server typically records these changes in a "delta file," a file consisting only of the updated information; Skype for Business can then download the delta files rather than a complete Address Book file. -The MaxDeltaFileSizePercentage property determines how large the delta files can get before they are incorporated into the complete Address Book file. -By default, delta files can be as large as 20 percent of the complete Address Book file before a new Address Book file is generated. -At that point, Lync clients will download the complete file rather than a delta file. - -MaxDeltaFileSizePercentage must be entered as a percentage value, from 1 to 100, inclusive. +### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Unique identifier to be assigned to the new collection of Address Book settings. +Because you can only create new collections at the site scope, the Identity will always be the prefix "site:" followed by the site name; for example "site:Redmond". ```yaml -Type: UInt32 +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RunTimeOfDay -Indicates the time of day when the servers generate new Address Book files. -The RunTimeOfDay property is based on a 24-hour clock (hours:minutes:seconds), with 00:00:00 representing midnight and 23:59:00 representing 11:59 P.M.. +### -IgnoreGenericRules + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not the Address Book server ignores the generic normalization rules used when parsing phone numbers. +Generic rules are the rules that are built into Skype for Business Server. +These rules cannot be changed; however, by setting the value of this property to True you can instruct your Address Book servers to ignore these rules and instead use custom rules that you create yourself. +The default value is False. + -The default value is 01:30:00 (1:30 A.M.). ```yaml -Type: DateTime +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -221,16 +219,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SynchronizePollingInterval -Indicates how often Address Book servers synchronize their information with the information stored in the User database. -The SynchronizePollingInterval can be set to any value between 5 seconds (00:00:05) and 3 hours (03:00:00). -The default value is 5 minutes (00:05:00). +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + ```yaml -Type: TimeSpan +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -239,17 +240,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseNormalizationRules -Indicates whether Address Book servers should use phone normalization rules when retrieving phone numbers. -If set to False, phone numbers will be retrieved as-is, and it will be up to the client application to apply normalization rules when displaying these numbers. +### -KeepDuration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the amount of time (in days) that Address Book servers will keep change files. +Change files older than the value of the KeepDuration property will be deleted. +The KeepDuration can be set to any integer value between 1 and 90, inclusive. +The default value is 30 days. + -The default value is True. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -258,14 +263,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -MaxDeltaFileSizePercentage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When changes are made to Active Directory (such as a new user being enabled for Skype for Business Server) the Address Book server typically records these changes in a "delta file," a file consisting only of the updated information; Skype for Business can then download the delta files rather than a complete Address Book file. +The MaxDeltaFileSizePercentage property determines how large the delta files can get before they are incorporated into the complete Address Book file. +By default, delta files can be as large as 20 percent of the complete Address Book file before a new Address Book file is generated. +At that point, Lync clients will download the complete file rather than a delta file. + +MaxDeltaFileSizePercentage must be entered as a percentage value, from 1 to 100, inclusive. + + ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -274,18 +288,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory - -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -MaxFileShareThreadCount +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Specifies the maximum number of system resources that can be used by the Address Book server if there are problems accessing the service file share. +The default value is 300. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -294,14 +307,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -PhotoCacheRefreshInterval + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: TimeSpan ```yaml -Type: SwitchParameter +Type: TimeSpan Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -310,14 +325,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -RunTimeOfDay + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the time of day when the servers generate new Address Book files. +The RunTimeOfDay property is based on a 24-hour clock (hours:minutes:seconds), with 00:00:00 representing midnight and 23:59:00 representing 11:59 P.M.. + +The default value is 01:30:00 (1:30 A.M.). ```yaml -Type: SwitchParameter +Type: DateTime Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -326,14 +346,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnablePhotoSearch -When set to True, user photos will be displayed in search results. +### -SynchronizePollingInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates how often Address Book servers synchronize their information with the information stored in the User database. +The SynchronizePollingInterval can be set to any value between 5 seconds (00:00:05) and 3 hours (03:00:00). +The default value is 5 minutes (00:05:00). ```yaml -Type: Boolean +Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -342,17 +366,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSearchByDialPad -When set to True, users will be able to search for contacts by using their mobile device keypad. -This can be a convenience for mobile users, but has the potential to greatly increase the size of your Address Book database. +### -UseNormalizationRules -The default value is True ($True). +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether Address Book servers should use phone normalization rules when retrieving phone numbers. +If set to False, phone numbers will be retrieved as-is, and it will be up to the client application to apply normalization rules when displaying these numbers. + +The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -361,15 +387,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxFileShareThreadCount -Specifies the maximum number of system resources that can be used by the Address Book server if there are problems accessing the service file share. -The default value is 300. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -378,14 +405,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PhotoCacheRefreshInterval -PARAMVALUE: TimeSpan +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: TimeSpan +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -399,13 +428,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsAddressBookConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookSettings Creates instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookSettings object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsAddressBookNormalizationConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsAddressBookNormalizationConfiguration.md similarity index 90% rename from skype/skype-ps/skype/New-CsAddressBookNormalizationConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsAddressBookNormalizationConfiguration.md index 3291177ad9..b838122d3e 100644 --- a/skype/skype-ps/skype/New-CsAddressBookNormalizationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAddressBookNormalizationConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csaddressbooknormalizationconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsAddressBookNormalizationConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csaddressbooknormalizationconfiguration +schema: 2.0.0 +title: New-CsAddressBookNormalizationConfiguration --- # New-CsAddressBookNormalizationConfiguration @@ -37,7 +38,7 @@ That means that, in some cases, you might need to create identical rules: one fo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsAddressBookNormalizationConfiguration -Identity "site:Redmond" @@ -50,24 +51,10 @@ Those rules are most-easily created using the New-CsAddressBookNormalizationRule ## PARAMETERS -### -Identity -Unique identifier for the new collection of Address Book normalization rules. -Because new rule collections can only be created at the site scope, the Identity will always be similar to this: `-Identity "site:Redmond"` - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -AddressBookNormalizationRules -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -AddressBookNormalizationRules One or more normalization rules to be assigned to the collection. Although these rules can be created directly using the New-CsAddressBookNormalizationConfiguration cmdlet, it is recommended that you create the normalization rules using the New-CsAddressBookNormalizationRule cmdlet instead. That cmdlet creates the rule and assigns it to the specified collection using a single command, and using much simpler syntax. @@ -75,8 +62,7 @@ That cmdlet creates the rule and assigns it to the specified collection using a ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -85,14 +71,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -101,31 +89,54 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the new collection of Address Book normalization rules. +Because new rule collections can only be created at the site scope, the Identity will always be similar to this: `-Identity "site:Redmond"` ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -135,13 +146,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -155,13 +168,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsAddressBookNormalizationConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationSettings The New-CsAddressBookNormalizationConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationSettings object cmdlet. ## NOTES diff --git a/skype/skype-ps/skype/New-CsAddressBookNormalizationRule.md b/skype/skype-ps/SkypeForBusiness/New-CsAddressBookNormalizationRule.md similarity index 88% rename from skype/skype-ps/skype/New-CsAddressBookNormalizationRule.md rename to skype/skype-ps/SkypeForBusiness/New-CsAddressBookNormalizationRule.md index 9aa677a96c..af4481d8e4 100644 --- a/skype/skype-ps/skype/New-CsAddressBookNormalizationRule.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAddressBookNormalizationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csaddressbooknormalizationrule applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsAddressBookNormalizationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csaddressbooknormalizationrule +schema: 2.0.0 +title: New-CsAddressBookNormalizationRule --- # New-CsAddressBookNormalizationRule @@ -39,7 +40,7 @@ That means that, in some cases, you might need to create identical rules: one fo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsAddressBookNormalizationRule -Parent "site:Redmond" -Name RedmondFourDigit -Description "Dialing with internal four-digit extension" -Pattern '^(\d{4})$' -Translation '+1425555$1' @@ -56,77 +57,76 @@ Single quotes are required for these values; double quotes (or no quotes) will c ## PARAMETERS -### -Identity -Unique identifier for the rule. -The Identity specified must include the scope followed by a slash followed by the name; for example: site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name. +### -Description -Note that the Identity is composed of the Parent (scope) and the Name. -If you use the Identity parameter then you cannot use the Name or the Parent parameters. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to provide explanatory text that accompanies a normalization rule. +For example, the Description might explain how the rule converts phone numbers. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The name to be given to the new rule. -This parameter is required if a value has been specified for the Parent parameter. -If no value has been specified for the Parent parameter, the Name defaults to the name used in the Identity parameter. -For example, if a rule is created with the Identity site:Redmond/RedmondRule, the Name will default to RedmondRule. -The Name parameter and the Identity parameter cannot be used in the same command. +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Parent -The scope at which the new normalization rule will be created. -Address book normalization rules can be created at the global scope, the site scope, or the service scope (for the Address Book service only). -Note that a collection of Address Book normalization configuration settings must already be assigned to the specified scope before you can add a rule to that scope. -For example, you cannot add a rule to the Redmond site unless you have already created Address Book normalization configuration settings for that site. +### -Identity -The Parent parameter is required unless the Identity parameter is specified. -You cannot include the Identity parameter and the Parent parameter in the same command. -If you include the Parent parameter, the Name parameter is also required. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the rule. +The Identity specified must include the scope followed by a slash followed by the name; for example: site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name. + +Note that the Identity is composed of the Parent (scope) and the Name. +If you use the Identity parameter then you cannot use the Name or the Parent parameters. ```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: True -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -InMemory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,50 +135,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide explanatory text that accompanies a normalization rule. -For example, the Description might explain how the rule converts phone numbers. +### -Name + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +The name to be given to the new rule. +This parameter is required if a value has been specified for the Parent parameter. +If no value has been specified for the Parent parameter, the Name defaults to the name used in the Identity parameter. +For example, if a rule is created with the Identity site:Redmond/RedmondRule, the Name will default to RedmondRule. +The Name parameter and the Identity parameter cannot be used in the same command. ```yaml Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Parent -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +The scope at which the new normalization rule will be created. +Address book normalization rules can be created at the global scope, the site scope, or the service scope (for the Address Book service only). +Note that a collection of Address Book normalization configuration settings must already be assigned to the specified scope before you can add a rule to that scope. +For example, you cannot add a rule to the Redmond site unless you have already created Address Book normalization configuration settings for that site. -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +The Parent parameter is required unless the Identity parameter is specified. +You cannot include the Identity parameter and the Parent parameter in the same command. +If you include the Parent parameter, the Name parameter is also required. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -186,6 +183,9 @@ Accept wildcard characters: False ``` ### -Pattern + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + A regular expression that the phone number must match in order for this rule to be applied. The default value is ^(\d{11})$. @@ -194,8 +194,7 @@ This expression represents any set of numbers up to 11 digits. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -205,6 +204,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The order in which rules are applied; this is required because a given phone number might match more than one rule. The Priority parameter sets the order in which the rules are tested against the number. If a phone number matches multiple rules, the rule with the highest priority will be selected to do the conversion. @@ -214,8 +216,7 @@ Note that, when you set a priority, any existing rules will renumber themselves ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,6 +226,9 @@ Accept wildcard characters: False ``` ### -Translation + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The regular expression pattern that will be applied to the number to convert it to E.164 format. The default value is +$. @@ -233,8 +237,25 @@ This prefixes the number with a plus sign (+). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -244,13 +265,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -264,13 +287,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsAddressBookNormalizationRule cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationRule The New-CsAddressBookNormalizationRule cmdlet creates instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationRule#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsAdminRole.md b/skype/skype-ps/SkypeForBusiness/New-CsAdminRole.md similarity index 90% rename from skype/skype-ps/skype/New-CsAdminRole.md rename to skype/skype-ps/SkypeForBusiness/New-CsAdminRole.md index afa8e62603..bf777aebb9 100644 --- a/skype/skype-ps/skype/New-CsAdminRole.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAdminRole.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csadminrole applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsAdminRole -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csadminrole +schema: 2.0.0 +title: New-CsAdminRole --- # New-CsAdminRole @@ -105,7 +106,7 @@ However, you can use the Set-CsAdminRole cmdlet to change the administrative sco ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsAdminRole -Identity "RedmondVoiceAdministrator" -Template "CsVoiceAdministrator" @@ -115,7 +116,7 @@ The command in Example 1 duplicates the RBAC role CsVoiceAdministrator. Because no additional parameters are used, the new role -- RedmondVoiceAdministrators -- will be an exact duplicate of CsVoiceAdministrator, which includes both the UserScopes and ConfigScopes properties being set to "global". -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsAdminRole -Identity "RedmondVoiceAdministrator" -Template "CsVoiceAdministrator" -UserScopes "OU:ou=Redmond,dc=litwareinc,dc=com" @@ -125,7 +126,7 @@ Example 2 creates a new RBAC role (RedmondVoiceAdministrator) and then configure To do this, the UserScopes parameter is included along with the following parameter value: "OU:ou=Redmond,dc=litwareinc,dc=com". This parameter value replaces the current value of the UserScopes property with one item: the OU with the distinguished name (DN) "ou=Redmond,dc=litwareinc,dc=com". -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` New-CsAdminRole -Identity "RedmondVoiceAdministrator" -Template "CsVoiceAdministrator" -UserScopes "OU:ou=Redmond,dc=litwareinc,dc=com","OU:ou=Portland,dc=litwareinc,dc=com" @@ -135,7 +136,7 @@ The command shown in Example 3 is a variation of the command shown in Example 2; This is done by assigning a comma-separated list to the Replace method: the two items in the list represent the identifiers for the two OUs (Redmond and Portland) to be assigned to the new RBAC role. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` New-CsAdminRole -Identity "RedmondVoiceAdministrator" -Template "CsVoiceAdministrator" -ConfigScopes "site:Redmond" @@ -147,36 +148,27 @@ Note that the syntax for the ConfigScopes property requires the use of the "site ## PARAMETERS -### -Identity -Unique identifier for the RBAC role to be created. -The Identity for an RBAC role must be the same as the SamAccountName for the Active Directory universal security group associated with that role. -For example, the help desk role has an Identity equal to CsHelpDesk; CsHelpDesk is also the SamAccountName of the Active Directory security group associated with that role. +### -Cmdlets -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify the cmdlets that will be available to users who hold the new RBAC role. +For example, to create a new role that provides access only to one cmdlet (the Export-CsArchivingData cmdlet) use syntax like this: + +`-Cmdlets "Export-CsArchivingData"` + +To allow access to multiple cmdlets, separate the cmdlet names using commas: + +`-Cmdlets "Export-CsArchivingData","Invoke-CsArchivingDatabasePurge"` -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -Template -Name of the built-in RBAC role that will serve as a template for the custom RBAC role being created. -All new RBAC roles must be based on an existing role; it is not possible to create a blank RBAC role (that is, a role with no cmdlets assigned to it or without values assigned to either the ConfigScopes or UserScopes properties). -However, after the custom role has been created, you can then use the Set-CsAdminRole cmdlet to modify the properties of the new role. ```yaml -Type: String +Type: System.Management.Automation.PSListModifier`1[Microsoft.Rtc.Management.WritableConfig.Settings.Roles.CmdletType] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -185,6 +177,8 @@ Accept wildcard characters: False ### -ConfigScopes +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Used to limit the scope of the cmdlet to configuration settings within the specified site. To limit the cmdlet scope to a single site, use syntax similar to this: `-ConfigScopes site:Redmond.` Multiple sites can be specified by using a comma-separated list: `-ConfigScopes "site:Redmond, "site:Dublin".` @@ -202,8 +196,7 @@ You must specify a value for either (or both) the ConfigScopes and UserScopes pr ```yaml Type: System.Management.Automation.PSListModifier`1[Microsoft.Rtc.Management.Core.ConfigScope] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -212,20 +205,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserScopes -Used to limit the scope of the cmdlet to user management activities within the specified organizational unit. -To limit the cmdlet scope to a single organizational unit, use syntax similar to this: `-UserScopes "OU:ou=Redmond,dc=litwareinc,dc=com".` -Multiple OUs can be specified by using a comma-separated list: `-UserScopes "OU:ou=Redmond,dc=litwareinc,dc=com", "OU:ou=Dublin,dc=litwareinc,dc=com".` -To add new scopes (or remove existing scopes) from a role, use the Windows PowerShell list modifiers syntax. -For details, see the Examples section of this Help topic. +### -Force -You must specify a value for either (or both) the ConfigScopes and UserScopes properties. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Rtc.Management.Core.UserScope] +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -234,17 +223,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the RBAC role to be created. +The Identity for an RBAC role must be the same as the SamAccountName for the Active Directory universal security group associated with that role. +For example, the help desk role has an Identity equal to CsHelpDesk; CsHelpDesk is also the SamAccountName of the Active Directory security group associated with that role. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -252,6 +245,8 @@ Accept wildcard characters: False ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. @@ -260,8 +255,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -270,14 +264,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -ScriptModules + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a function within a Windows PowerShell script that will then be available to users who hold the new RBAC role. +For example, this syntax provides access to a function named Reset in a script named UpdateDatabase.ps1 : + +`-ScriptModules "UpdateDatabase.ps1:Reset"` + + ```yaml -Type: SwitchParameter +Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -286,40 +287,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Template + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the built-in RBAC role that will serve as a template for the custom RBAC role being created. +All new RBAC roles must be based on an existing role; it is not possible to create a blank RBAC role (that is, a role with no cmdlets assigned to it or without values assigned to either the ConfigScopes or UserScopes properties). +However, after the custom role has been created, you can then use the Set-CsAdminRole cmdlet to modify the properties of the new role. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Cmdlets +### -UserScopes -Enables you to specify the cmdlets that will be available to users who hold the new RBAC role. -For example, to create a new role that provides access only to one cmdlet (the Export-CsArchivingData cmdlet) use syntax like this: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-Cmdlets "Export-CsArchivingData"` +Used to limit the scope of the cmdlet to user management activities within the specified organizational unit. +To limit the cmdlet scope to a single organizational unit, use syntax similar to this: `-UserScopes "OU:ou=Redmond,dc=litwareinc,dc=com".` +Multiple OUs can be specified by using a comma-separated list: `-UserScopes "OU:ou=Redmond,dc=litwareinc,dc=com", "OU:ou=Dublin,dc=litwareinc,dc=com".` +To add new scopes (or remove existing scopes) from a role, use the Windows PowerShell list modifiers syntax. +For details, see the Examples section of this Help topic. -To allow access to multiple cmdlets, separate the cmdlet names using commas: +You must specify a value for either (or both) the ConfigScopes and UserScopes properties. -`-Cmdlets "Export-CsArchivingData","Invoke-CsArchivingDatabasePurge"` +```yaml +Type: System.Management.Automation.PSListModifier`1[Microsoft.Rtc.Management.Core.UserScope] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Rtc.Management.WritableConfig.Settings.Roles.CmdletType] +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -328,20 +349,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ScriptModules - -Enables you to specify a function within a Windows PowerShell script that will then be available to users who hold the new RBAC role. -For example, this syntax provides access to a function named Reset in a script named UpdateDatabase.ps1 : - -`-ScriptModules "UpdateDatabase.ps1:Reset"` +### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: System.Management.Automation.PSListModifier`1[System.String] +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -355,12 +372,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Roles.Role The New-CsAdminRole cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Roles.Role object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsAllowedDomain.md b/skype/skype-ps/SkypeForBusiness/New-CsAllowedDomain.md similarity index 89% rename from skype/skype-ps/skype/New-CsAllowedDomain.md rename to skype/skype-ps/SkypeForBusiness/New-CsAllowedDomain.md index 4bd2464f78..42440248ed 100644 --- a/skype/skype-ps/skype/New-CsAllowedDomain.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAllowedDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csalloweddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsAllowedDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csalloweddomain +schema: 2.0.0 +title: New-CsAllowedDomain --- # New-CsAllowedDomain @@ -55,7 +56,7 @@ If you want to create a new federation relationship, you can use the New-CsAllow ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsAllowedDomain -Identity "fabrikam.com" @@ -66,7 +67,7 @@ In Example 1, the domain fabrikam.com is added to the list of allowed domains. To do this, the New-CsAllowedDomain cmdlet is called, along with the Identity parameter; this parameter is assigned the name of the domain to be added to the allowed list. Note that this command will fail if fabrikam.com is already on the allowed list or on the blocked list. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsAllowedDomain -Identity "fabrikam.com" -ProxyFqdn "proxyserver.fabrikam.com" -MarkForMonitoring $True -Comment "Contact: Ken Myer (kenmyer@fabrikam.com)" @@ -76,7 +77,7 @@ New-CsAllowedDomain -Identity "fabrikam.com" -ProxyFqdn "proxyserver.fabrikam.co Example 2 is a variation of the command shown in Example 1. In this case, however, two additional parameters are included along with Identity: ProxyFqdn is used to specify the FQDN of the proxy server for fabrikam.com, and MarkForMonitoring is used to add this federation connection to the list of items monitored by Monitoring Server. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` $x = New-CsAllowedDomain -Identity "fabrikam.com" -InMemory @@ -104,36 +105,17 @@ Fabrikam.com will not show up on the allowed list until after you have called th ## PARAMETERS -### -Identity -Fully qualified domain name (FQDN) of the domain to be added to the allowed list; for example, fabrikam.com. -You can use either the Identity or the Domain parameter (but not both) in order to specify the domain name. -If you use Identity, the Domain property will be set to the same value assigned to Identity. -If you use Domain, the Identity property will be set to the same value assigned to Domain. - -Note that Identities must be unique: if the specified domain already exists on either the blocked or the allowed list, your command will fail. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Comment -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Comment Optional string value that provides additional information about the domain being added to the allowed list. For example, you might add a Comment that provides contact information for the federated domain. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -143,6 +125,9 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN (for example, fabrikam.com) of the domain to be added to the allowed list. You can use either the Identity or the Domain parameter (but not both) in order to specify the domain name. If you use Identity, the Domain property will be set to the same value assigned to Identity. @@ -153,8 +138,7 @@ Note that Domains must be unique: if the specified domain already exists on eith ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -163,17 +147,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MarkForMonitoring -Indicates whether or not the federation connection between your domain and the remote domain will be monitored by Monitoring Server. -By default, MarkForMonitoring is set to False, meaning that the connection will not be monitored. +### -Force -This property will be ignored if you have not deployed Monitoring Server. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,34 +165,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyFqdn -FQDN (for example, proxy-server.fabrikam.com) of the SIP proxy server deployed in the domain being added to the allowed list. -This property is optional: if it is not specified then DNS SRV discovery procedures will be used to determine the location of the SIP proxy server. +### -Identity -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Fully qualified domain name (FQDN) of the domain to be added to the allowed list; for example, fabrikam.com. +You can use either the Identity or the Domain parameter (but not both) in order to specify the domain name. +If you use Identity, the Domain property will be set to the same value assigned to Identity. +If you use Domain, the Identity property will be set to the same value assigned to Domain. -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +Note that Identities must be unique: if the specified domain already exists on either the blocked or the allowed list, your command will fail. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -217,6 +190,8 @@ Accept wildcard characters: False ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. @@ -225,8 +200,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -235,14 +209,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MarkForMonitoring + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not the federation connection between your domain and the remote domain will be monitored by Monitoring Server. +By default, MarkForMonitoring is set to False, meaning that the connection will not be monitored. + +This property will be ignored if you have not deployed Monitoring Server. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -251,14 +230,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -ProxyFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN (for example, proxy-server.fabrikam.com) of the SIP proxy server deployed in the domain being added to the allowed list. +This property is optional: if it is not specified then DNS SRV discovery procedures will be used to determine the location of the SIP proxy server. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -268,6 +250,9 @@ Accept wildcard characters: False ``` ### -VerificationLevel + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Indicates how (or if) messages sent from a domain are verified to ensure that they were sent from that domain. The VerificationLevel must be set to one of the following values: @@ -290,8 +275,43 @@ This is the default value. ```yaml Type: VerificationLevelType Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -305,13 +325,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsAllowedDomain cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.AllowedDomain Creates instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.AllowedDomain object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsAnalogDevice.md b/skype/skype-ps/SkypeForBusiness/New-CsAnalogDevice.md similarity index 84% rename from skype/skype-ps/skype/New-CsAnalogDevice.md rename to skype/skype-ps/SkypeForBusiness/New-CsAnalogDevice.md index 78fd82666f..51e467a44a 100644 --- a/skype/skype-ps/skype/New-CsAnalogDevice.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAnalogDevice.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csanalogdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsAnalogDevice -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csanalogdevice +schema: 2.0.0 +title: New-CsAnalogDevice --- # New-CsAnalogDevice @@ -54,7 +55,7 @@ For details, see the OU and the DN parameter descriptions in this topic. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsAnalogDevice -LineUri tel:+14255556001 -DisplayName "Building 14 Receptionist" -RegistrarPool redmond-Cs-001.litwareinc.com -AnalogFax $False -Gateway 192.168.0.240 -OU "ou=Telecommunications,dc=litwareinc,dc=com" @@ -66,17 +67,17 @@ The command shown in Example 1 creates a new analog device with the phone number ## PARAMETERS -### -LineUri -Phone number for the analog device. -The line Uniform Resource Identifier (URI) should be specified by using the E.164 format, and be prefixed by the "TEL:" prefix. -For example: TEL:+14255551297. -Any extension number should be added to the end of the line URI, for example: "TEL:+14255551297;ext=51297". +### -AnalogFax + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Set to True ($True) if the analog device is a fax machine. +Set to False ($False) if the device is not a fax machine. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -85,19 +86,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipAddress - -Unique identifier (similar to an e-mail address) that allows the analog device to communicate with SIP devices such as Skype for Business. -The SIP address must be prefaced by the prefix "sip:". -For example: sip:bldg14lobby@litwareinc.com. +### -DisplayName +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Configures the Active Directory display name of the analog device. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -106,31 +104,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RegistrarPool -Fully qualified domain name (FQDN) of the Registrar pool where the contact object should be homed. -For example: -RegistrarPool "atl-cs-001.litwareinc.com". +### -DisplayNumber -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Phone number as displayed in Skype for Business. +The DisplayNumber property can be formatted any way you prefer; for example 1-800-555-1234; 1-(800)-555-1234; 1.800.555.1234; etc. -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -DisplayName -Configures the Active Directory display name of the analog device. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,35 +125,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayNumber +### -DN -Phone number as displayed in Skype for Business. -The DisplayNumber property can be formatted any way you prefer; for example 1-800-555-1234; 1-(800)-555-1234; 1.800.555.1234; etc. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Enables you to associate an existing Active Directory contact object with the analog device. +If you have a contact object you want to associate with an analog device, use the DN parameter followed by the distinguished name of that contact. +For example: `-DN "cn=Building 14 Lobby,dc=litwareinc,dc=com".` +Note that the command will fail if the specified contact does not exist. +You cannot use the OU and the DN parameters in the same command. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: ADObjectId +Parameter Sets: DN +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AnalogFax -Set to True ($True) if the analog device is a fax machine. -Set to False ($False) if the device is not a fax machine. +### -Gateway + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +IP address of the PSTN gateway to be used by the analog device. ```yaml -Type: Boolean +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -176,14 +166,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Gateway -IP address of the PSTN gateway to be used by the analog device. +### -LineUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Phone number for the analog device. +The line Uniform Resource Identifier (URI) should be specified by using the E.164 format, and be prefixed by the "TEL:" prefix. +For example: TEL:+14255551297. +Any extension number should be added to the end of the line URI, for example: "TEL:+14255551297;ext=51297". ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -193,6 +188,9 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Distinguished name of the Active Directory organizational unit (OU) where the contact object should be located. For example: `-OU "ou=Redmond,dc=litwareinc,dc=com".` @@ -202,8 +200,7 @@ As a result, the contact object will have a name similar to this: {ce84964a-c4da ```yaml Type: OUIdParameter Parameter Sets: OU -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -212,51 +209,57 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DN -Enables you to associate an existing Active Directory contact object with the analog device. -If you have a contact object you want to associate with an analog device, use the DN parameter followed by the distinguished name of that contact. -For example: `-DN "cn=Building 14 Lobby,dc=litwareinc,dc=com".` -Note that the command will fail if the specified contact does not exist. +### -PassThru -You cannot use the OU and the DN parameters in the same command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns an object representing the common area phone. ```yaml -Type: ADObjectId -Parameter Sets: DN -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Returns an object representing the common area phone. +### -RegistrarPool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the Registrar pool where the contact object should be homed. +For example: -RegistrarPool "atl-cs-001.litwareinc.com". ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier (similar to an e-mail address) that allows the analog device to communicate with SIP devices such as Skype for Business. +The SIP address must be prefaced by the prefix "sip:". +For example: sip:bldg14lobby@litwareinc.com. + + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -266,13 +269,33 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -286,13 +309,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsAnalogDevice cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADAnalogDeviceContact The New-CsAnalogDevice cmdlet creates new instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADAnalogDeviceContact object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsAnnouncement.md b/skype/skype-ps/SkypeForBusiness/New-CsAnnouncement.md similarity index 87% rename from skype/skype-ps/skype/New-CsAnnouncement.md rename to skype/skype-ps/SkypeForBusiness/New-CsAnnouncement.md index 5d2ff20332..b7cf6cc4a7 100644 --- a/skype/skype-ps/skype/New-CsAnnouncement.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAnnouncement.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csannouncement applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsAnnouncement -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csannouncement +schema: 2.0.0 +title: New-CsAnnouncement --- # New-CsAnnouncement @@ -50,7 +51,7 @@ You can assign announcements to unassigned numbers by calling the New-CsUnassign ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsAnnouncement -Identity ApplicationServer:redmond.litwareinc.com -Name "Help Desk Announcement" -TextToSpeechPrompt "Welcome to the Help Desk." -Language "en-US" @@ -70,7 +71,7 @@ You will see the full Identity after you create the new announcement; the GUID i That Identity will be similar to this: service:ApplicationServer:redmond.litwareinc.com/1951f734-c80f-4fb2-965d-51807c792b90. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsAnnouncement -Identity ApplicationServer:redmond.litwareinc.com -Name "Welcome Announcement" -AudioFilePrompt "WelcomeMessage.wav" @@ -83,7 +84,7 @@ This file must be in the File Store in order for this announcement to play. You can add audio files to the File Store by calling the Import-CsAnnouncementFile cmdlet. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` New-CsAnnouncement -Identity ApplicationServer:redmond.litwareinc.com -Name "Forward Announcement" -AudioFilePrompt "WelcomeMessage.wav" -TargetUri sip:kmyer@litwareinc.com @@ -95,7 +96,7 @@ However, in this example in addition to the Identity, Name, and AudioFilePrompt We pass this parameter the SIP URI of the user or phone to which the caller will be forwarded after the announcement has been played. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` New-CsAnnouncement -Identity ApplicationServer:redmond.litwareinc.com -Name "Forward Announcement" -AudioFilePrompt "WelcomeMessage.wav" -TargetUri "sip:+14255551212@litwareinc.com;user=phone" @@ -104,7 +105,7 @@ New-CsAnnouncement -Identity ApplicationServer:redmond.litwareinc.com -Name "For Example 4 is identical to Example 3 except that instead of forwarding the call based on a user's SIP address, the call is forwarded to a phone number. -### -------------------------- EXAMPLE 5 -------------------------- +### EXAMPLE 5 ``` New-CsAnnouncement -Identity ApplicationServer:redmond.litwareinc.com -Name "Busy" @@ -116,7 +117,50 @@ That means the caller will hear a busy signal when a call to an unassigned numbe ## PARAMETERS +### -AudioFilePrompt + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The name of the audio file to be played for the announcement. +Audio files are stored in the File Store. +To save an audio file to the File Store, use the Import-CsAnnouncementFile cmdlet. + +Valid file types: WAV and WMA + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier for the Announcement. For this value you must enter the Identity of the Application Server running the Response Group application. For example, ApplicationServer:redmond.litwareinc.com. @@ -135,8 +179,7 @@ You can create a new announcement with a matching Identity (including the GUID) ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -145,81 +188,86 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Parent -This parameter is identical to Identity, except that Identity will accept the service Identity and the GUID, whereas Parent will accept only the service Identity; the GUID will be automatically generated. -You cannot specify an Identity and a Parent. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + ```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name +### -Language -A descriptive name for the Announcement. -This name must be unique within the service. -This name will be used in the call to the New-CsUnassignedNumber cmdlet or to the Set-CsUnassignedNumber cmdlet to specify the Announcement associated with an unassigned number range. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The language in which the text-to-speech (TTS) prompt will be played. +If a value is entered for TextToSpeechPrompt, this parameter is required. + +Values are entered as a string representing the language and locale to be used. +The following is a list of valid values, followed by the language and locale in parentheses: ca-ES (Catalan, Spain); da-DK (Danish, Denmark); de-DE (German, Germany); en-AU (English, Australia); en-CA (English, Canada); en-GB (English, United Kingdom); en-IN (English, India); en-US (English, United States); es-ES (Spanish, Spain); es-MX (Spanish, Mexico); fi-FI (Finnish, Finland); fr-CA (French, Canada); fr-FR (French, France); it-IT (Italian, Italy); ja-JP (Japanese, Japan); ko-KR (Korean, Korea); nb-NO (Norwegian, Bokmal, Norway); nl-NL (Dutch, Netherlands); pl-PL (Polish, Poland); pt-BR (Portuguese, Brazil); pt-PT (Portuguese, Portugal); ru-RU (Russian, Russia); sv-SE (Swedish, Sweden); zh-CN (Chinese, People's Republic of China); zh-HK (Chinese, Hong Kong SAR); zh-TW (Chinese, Taiwan) ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AudioFilePrompt -The name of the audio file to be played for the announcement. -Audio files are stored in the File Store. -To save an audio file to the File Store, use the Import-CsAnnouncementFile cmdlet. +### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A descriptive name for the Announcement. +This name must be unique within the service. +This name will be used in the call to the New-CsUnassignedNumber cmdlet or to the Set-CsUnassignedNumber cmdlet to specify the Announcement associated with an unassigned number range. + -Valid file types: WAV and WMA ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Language - -The language in which the text-to-speech (TTS) prompt will be played. -If a value is entered for TextToSpeechPrompt, this parameter is required. - -Values are entered as a string representing the language and locale to be used. -The following is a list of valid values, followed by the language and locale in parentheses: ca-ES (Catalan, Spain); da-DK (Danish, Denmark); de-DE (German, Germany); en-AU (English, Australia); en-CA (English, Canada); en-GB (English, United Kingdom); en-IN (English, India); en-US (English, United States); es-ES (Spanish, Spain); es-MX (Spanish, Mexico); fi-FI (Finnish, Finland); fr-CA (French, Canada); fr-FR (French, France); it-IT (Italian, Italy); ja-JP (Japanese, Japan); ko-KR (Korean, Korea); nb-NO (Norwegian, Bokmal, Norway); nl-NL (Dutch, Netherlands); pl-PL (Polish, Poland); pt-BR (Portuguese, Brazil); pt-PT (Portuguese, Portugal); ru-RU (Russian, Russia); sv-SE (Swedish, Sweden); zh-CN (Chinese, People's Republic of China); zh-HK (Chinese, Hong Kong SAR); zh-TW (Chinese, Taiwan) +### -Parent +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +This parameter is identical to Identity, except that Identity will accept the service Identity and the GUID, whereas Parent will accept only the service Identity; the GUID will be automatically generated. +You cannot specify an Identity and a Parent. ```yaml Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -227,6 +275,9 @@ Accept wildcard characters: False ``` ### -TargetUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Uniform Resource Identifier (URI) to which the caller will be transferred after the announcement has been played. This value must be a SIP address entered in the format sip: followed by the SIP address. For example, sip:kmyer@litwareinc.com. @@ -235,8 +286,7 @@ Note that the SIP address can also be a telephone number or voice mail, for exam ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -246,6 +296,9 @@ Accept wildcard characters: False ``` ### -TextToSpeechPrompt + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A text-to-speech (TTS) prompt. This is a string that will be converted to audio and played as the announcement. @@ -254,8 +307,7 @@ If both AudioFilePrompt and TextToSpeechPrompt are specified for a single announ ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -264,34 +316,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory - -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -301,29 +335,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -337,12 +357,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.AnnouncementServiceSettings.Announcement Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.AnnouncementServiceSettings.Announcement. ## NOTES diff --git a/skype/skype-ps/skype/New-CsArchivingConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsArchivingConfiguration.md similarity index 86% rename from skype/skype-ps/skype/New-CsArchivingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsArchivingConfiguration.md index 16ef9e0722..f4d63d2dc9 100644 --- a/skype/skype-ps/skype/New-CsArchivingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsArchivingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csarchivingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsArchivingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csarchivingconfiguration +schema: 2.0.0 +title: New-CsArchivingConfiguration --- # New-CsArchivingConfiguration @@ -46,7 +47,7 @@ Alternatively, you can use the New-CsArchivingConfiguration cmdlet to create cus ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsArchivingConfiguration -Identity site:Redmond -EnableArchiving "ImOnly" @@ -56,7 +57,7 @@ The command shown in Example 1 creates a new collection of archiving configurati By adding the EnableArchiving parameter and setting the parameter value to "ImOnly", the command also enables IM session archiving (but not web conference archiving) for the Redmond site. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsArchivingConfiguration -Identity site:Redmond -InMemory @@ -77,34 +78,10 @@ If you do not call the Set-CsArchivingConfiguration cmdlet, these settings will ## PARAMETERS -### -Identity - -Unique identifier to be assigned to the new collection of archiving configuration settings. -In Skype for Business Server you can create new collections at the site scope or at the service scope. -To create new settings at the site scope, use syntax similar to this: - -`-Identity "site:Redmond"` - -To create settings at the service scope (for the Registrar service only) use syntax like this: - -`-Identity "service:Registrar:atl-cs-001.litwareinc.com"` - - - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -ArchiveDuplicateMessages -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -ArchiveDuplicateMessages Specifies how cross-pool instant messages should be archived. For example, Ken Myer (with an account in Pool 1) sends an instant message to Pilar Ackerman (who has an account in Pool 2). Pilar, in turn, sends a reply to Ken's instant message. @@ -114,8 +91,7 @@ If ArchiveDuplicateMessages is set to True (the default value), the transcript w ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -125,14 +101,16 @@ Accept wildcard characters: False ``` ### -BlockOnArchiveFailure + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If True, then the IM service will be suspended any time your instant message sessions cannot be archived. If set to False (the default value), instant messaging will continue even if sessions cannot be archived. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -143,6 +121,8 @@ Accept wildcard characters: False ### -CachePurgingInterval +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates how often (in hours) the system is purged of transcripts where none of the participants have been enabled for archiving. By design, all group IM sessions and conferencing sessions are recorded when they take place. At the specified interval, the system will determine whether any of the participants in these sessions have been enabled for archiving. @@ -156,8 +136,7 @@ The default value is 24. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,6 +146,9 @@ Accept wildcard characters: False ``` ### -EnableArchiving + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates which items (if any) are saved to the archiving database. Valid values are: @@ -183,8 +165,30 @@ Both IM and web conferencing sessions are archived to the database. ```yaml Type: EnableArchiving Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableExchangeArchiving + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, Skype for Business Server instant message and conferencing transcripts are stored in Exchange rather than a separate SQL Server database. +Note that if you enable Exchange archiving then users will be managed by the Exchange archiving policies instead of Skype for Business Server archiving policies. + +The default value is False. + + + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -194,6 +198,9 @@ Accept wildcard characters: False ``` ### -EnablePurging + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If True, archived instant messages will periodically be removed from the database, provided that these instant messages: 1) are older than the value specified in the KeepArchivingDataForDays property; or, 2) have been exported and marked for deletion. If False, instant messages will not be automatically deleted from the database. @@ -201,8 +208,7 @@ If False, instant messages will not be automatically deleted from the database. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -211,17 +217,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -KeepArchivingDataForDays -Number of days (between 1 and 2562) that archived instant messages are kept in the database before being automatically deleted. -The default value is 14. +### -Force -This property takes effect only if EnablePurging has been set to True. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: UInt32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -230,37 +235,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PurgeExportedArchivesOnly -If True, then the system will only purge instant messages that have been exported (and, as a result, have been marked for deletion). -Instant messages that have not been exported will remain in the database, even if those messages are older than the value specified by the KeepArchivingDataForDays property. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier to be assigned to the new collection of archiving configuration settings. +In Skype for Business Server you can create new collections at the site scope or at the service scope. +To create new settings at the site scope, use syntax similar to this: + +`-Identity "site:Redmond"` + +To create settings at the service scope (for the Registrar service only) use syntax like this: + +`-Identity "service:Registrar:atl-cs-001.litwareinc.com"` + + ```yaml -Type: Boolean +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PurgeHourOfDay -Indicates the time of day when expired records are deleted from the archiving database. -The time of day is specified using a 24-hour clock, with 0 representing midnight (12:00 AM) and 23 representing 11:00 PM. -Note that you can only specify the hour of the day. -This means that you can schedule purging to take place at 4:00 AM, but you cannot schedule it to take place at, for instance, 4:30 AM or 4:15 AM. -The default value is 2 (2:00 AM). +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + -Database purging takes place only if the EnablePurging property is set to True. ```yaml -Type: UInt32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -269,14 +284,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -KeepArchivingDataForDays + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Number of days (between 1 and 2562) that archived instant messages are kept in the database before being automatically deleted. +The default value is 14. + +This property takes effect only if EnablePurging has been set to True. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -285,18 +305,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory - -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -PurgeExportedArchivesOnly +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +If True, then the system will only purge instant messages that have been exported (and, as a result, have been marked for deletion). +Instant messages that have not been exported will remain in the database, even if those messages are older than the value specified by the KeepArchivingDataForDays property. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -305,14 +324,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -PurgeHourOfDay + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the time of day when expired records are deleted from the archiving database. +The time of day is specified using a 24-hour clock, with 0 representing midnight (12:00 AM) and 23 representing 11:00 PM. +Note that you can only specify the hour of the day. +This means that you can schedule purging to take place at 4:00 AM, but you cannot schedule it to take place at, for instance, 4:30 AM or 4:15 AM. +The default value is 2 (2:00 AM). + +Database purging takes place only if the EnablePurging property is set to True. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -322,13 +349,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -337,20 +366,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableExchangeArchiving - -When set to True, Skype for Business Server instant message and conferencing transcripts are stored in Exchange rather than a separate SQL Server database. -Note that if you enable Exchange archiving then users will be managed by the Exchange archiving policies instead of Skype for Business Server archiving policies. - -The default value is False. +### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -364,13 +389,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsArchivingConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings The New-CsArchivingConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsArchivingPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsArchivingPolicy.md similarity index 88% rename from skype/skype-ps/skype/New-CsArchivingPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsArchivingPolicy.md index 1abff2dd90..8f224e2ef9 100644 --- a/skype/skype-ps/skype/New-CsArchivingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsArchivingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csarchivingpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsArchivingPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csarchivingpolicy +schema: 2.0.0 +title: New-CsArchivingPolicy --- # New-CsArchivingPolicy @@ -54,7 +55,7 @@ You cannot create a new policy at the global scope. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsArchivingPolicy -Identity site:Redmond -ArchiveInternal $True @@ -64,7 +65,7 @@ In Example 1, the New-CsArchivingPolicy cmdlet is used to create a new archiving In addition, the ArchiveInternal parameter is set to True; that means that this new policy will enable archiving for internal IM sessions and conferences. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsArchivingPolicy -Identity site:Redmond -InMemory @@ -86,31 +87,10 @@ Finally, the last command in the example uses the Set-CsArchivingPolicy cmdlet t ## PARAMETERS -### -Identity -Indicates the unique Identity to be assigned to the policy. -New archiving policies can be created at the site scope or the per-user scope. -To create a new site policy, use the prefix "site:" followed by the name of the site. -For example, this syntax creates a new policy for the Redmond site: `-Identity site:Redmond.` -To create a new per-user policy, use an Identity similar to this: `-Identity SalesArchivingPolicy.` - -Note that you cannot create a new global policy; if you want to make changes to the global policy, use the Set-CsArchivingPolicy cmdlet instead. -Likewise, you cannot create a new site or per-user policy if a policy with that Identity already exists. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ArchiveExternal +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether external IM sessions are archived. (An external IM session is one in which at least one of the participants is an unauthenticated user who does not have an Active Directory account within your organization.) The default value is False, which means that IM sessions that include external users are not archived. @@ -119,8 +99,7 @@ Indicates whether external IM sessions are archived. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -130,14 +109,16 @@ Accept wildcard characters: False ``` ### -ArchiveInternal + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether internal IM sessions are archived. (An internal IM session is one in which all the participants are authenticated users who have Active Directory accounts within your organization.) The default value is False, which means that internal IM sessions are not archived. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -147,14 +128,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to provide a brief description of the archiving policy. For example, the Description might be used to detail which users the policy should be applied to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -164,13 +147,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,8 +164,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the unique Identity to be assigned to the policy. +New archiving policies can be created at the site scope or the per-user scope. +To create a new site policy, use the prefix "site:" followed by the name of the site. +For example, this syntax creates a new policy for the Redmond site: `-Identity site:Redmond.` +To create a new per-user policy, use an Identity similar to this: `-Identity SalesArchivingPolicy.` + +Note that you cannot create a new global policy; if you want to make changes to the global policy, use the Set-CsArchivingPolicy cmdlet instead. +Likewise, you cannot create a new site or per-user policy if a policy with that Identity already exists. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. @@ -189,8 +201,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -199,14 +210,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new archiving policy is being created. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -216,13 +236,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -231,21 +253,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new archiving policy is being created. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -259,13 +276,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsArchivingPolicy cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.IM.IMArchivingPolicy The New-CsArchivingPolicy cmdlet creates instances of the Microsoft.Rtc.Management.WritableConfig.Policy.IM.IMArchivingPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsAutodiscoverConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsAutodiscoverConfiguration.md similarity index 88% rename from skype/skype-ps/skype/New-CsAutodiscoverConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsAutodiscoverConfiguration.md index 0e9d77cb0a..d116d1b9a2 100644 --- a/skype/skype-ps/skype/New-CsAutodiscoverConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsAutodiscoverConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csautodiscoverconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsAutodiscoverConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csautodiscoverconfiguration +schema: 2.0.0 +title: New-CsAutodiscoverConfiguration --- # New-CsAutodiscoverConfiguration @@ -54,7 +55,7 @@ When you install Skype for Business Server a global collection of settings will ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsAutoDiscoverConfiguration -Identity "site:Redmond" @@ -64,7 +65,7 @@ The command shown in Example 1 creates a new collection of Autodiscover configur Because the WebLinks parameter was not included, these settings will not contain any Autodiscover URLs. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $Link1 = New-CsWebLink -Token "Fabrikam" -Href "https://LyncDiscover.fabrikam.com" @@ -83,33 +84,16 @@ That syntax causes the values stored in the variables $Link1 and $Link2 to be ad ## PARAMETERS -### -Identity -Unique identifier for the collection of Autodiscover configuration settings to be modified. -To create a collection configured at the site scope, use syntax similar to this: - -`-Identity "site:Redmond"` - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableCertificateProvisioningServiceUrl -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +When set to True (the default value), the Certificate Provisioning Service URL is included in Autodiscover Service responses. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,13 +103,15 @@ Accept wildcard characters: False ``` ### -ExternalSipClientAccessFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the server used for external client access. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,13 +121,15 @@ Accept wildcard characters: False ``` ### -ExternalSipClientAccessPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for eternal client access. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -151,13 +139,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -166,15 +156,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the collection of Autodiscover configuration settings to be modified. +To create a collection configured at the site scope, use syntax similar to this: + +`-Identity "site:Redmond"` + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of a command called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling the Set-CsAutoDiscoverConfiguration cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,14 +197,16 @@ Accept wildcard characters: False ``` ### -WebLinks + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Collection of Autodiscover URLs. These URLs must be created by using the New-CsWebLink cmdlet. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -200,14 +215,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -216,14 +233,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableCertificateProvisioningServiceUrl -When set to True (the default value), the Certificate Provisioning Service URL is included in Autodiscover Service responses. +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -237,15 +256,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### +### None New-CsAutoDiscoverConfiguration does not accept pipelined input. -### -The New-CsAutoDiscoverConfiguration cmdlet does not accept pipelined input. - ## OUTPUTS -### +### Microsoft.Rtc.Management.WriteableConfig.Settings.AutoDiscoverConfiguration.AutoDiscoverConfiguration Creates new instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.AutoDiscoverConfiguration.AutoDiscoverConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsBandwidthPolicyServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsBandwidthPolicyServiceConfiguration.md similarity index 84% rename from skype/skype-ps/skype/New-CsBandwidthPolicyServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsBandwidthPolicyServiceConfiguration.md index 3a2dc9990e..8506904706 100644 --- a/skype/skype-ps/skype/New-CsBandwidthPolicyServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsBandwidthPolicyServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csbandwidthpolicyserviceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsBandwidthPolicyServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csbandwidthpolicyserviceconfiguration +schema: 2.0.0 +title: New-CsBandwidthPolicyServiceConfiguration --- # New-CsBandwidthPolicyServiceConfiguration @@ -38,7 +39,7 @@ This cmdlet configures a new bandwidth policy service at the site level. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsBandwidthPolicyServiceConfiguration -Identity site:Redmond @@ -48,7 +49,7 @@ This example creates a new bandwidth policy service configuration at the site Re No other parameters are specified, so the defaults are used for all configuration values. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsBandwidthPolicyServiceConfiguration -Identity site:Dublin -EnableLogging $True -LogCleanupInterval 30.00:00:00 @@ -62,15 +63,55 @@ The LogCleanupInterval value is a TimeSpan object, which is in the format dd.hh: ## PARAMETERS +### -EnableLogging + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Set this parameter to True to generate CAC failure and link status logs related to the bandwidth policy service. + +Default: False + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier that contains the scope and name of the configuration. This configuration can be created only at the site scope, so the Identity will be in the following format: site:\, where \ is the name of the site to which the configuration applies. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -79,16 +120,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableLogging -Set this parameter to True to generate CAC failure and link status logs related to the bandwidth policy service. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + -Default: False ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -98,6 +142,9 @@ Accept wildcard characters: False ``` ### -LogCleanUpInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The period of time after which CAC failure and link status logs will be removed. This value must be within the range 1 day through 60 days. @@ -108,8 +155,7 @@ Default: 10 days (10.00:00:00) ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,6 +165,9 @@ Accept wildcard characters: False ``` ### -MaxLogFileSizeMb + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum size the log file is allowed to reach. The value for this parameter must be a positive number; it specifies the file size in megabytes. @@ -127,8 +176,7 @@ Default: 3 (MB) ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,6 +186,9 @@ Accept wildcard characters: False ``` ### -MaxTokenLifetime + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum amount of time the token issued by the Bandwidth Policy Authentication service will exist. This value must be in the range 1 hour through 24 hours. @@ -148,24 +199,7 @@ Default: 8 hours (08:00:00) ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -174,18 +208,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory - -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -195,29 +227,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -231,12 +249,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.BandwidthPolicyServiceConfiguration.BandwidthPolicyServiceConfiguration Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.BandwidthPolicyServiceConfiguration.BandwidthPolicyServiceConfiguration. ## NOTES diff --git a/skype/skype-ps/skype/New-CsBlockedDomain.md b/skype/skype-ps/SkypeForBusiness/New-CsBlockedDomain.md similarity index 89% rename from skype/skype-ps/skype/New-CsBlockedDomain.md rename to skype/skype-ps/SkypeForBusiness/New-CsBlockedDomain.md index 4b9231b7d5..9a40f8ec08 100644 --- a/skype/skype-ps/skype/New-CsBlockedDomain.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsBlockedDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csblockeddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsBlockedDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csblockeddomain +schema: 2.0.0 +title: New-CsBlockedDomain --- # New-CsBlockedDomain @@ -54,7 +55,7 @@ The New-CsBlockedDomain cmdlet enables you to add a domain to the list of blocke ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsBlockedDomain -Identity "fabrikam.com" -Comment "Blocked per Ken Myer." @@ -66,7 +67,7 @@ In addition, the Comment parameter is included in order to add a comment to the Note that this command will fail if fabrikam.com is already on the blocked list or on the allowed list. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsBlockedDomain -Identity "fabrikam.com" -InMemory @@ -90,36 +91,17 @@ Instead, the virtual domain will disappear as soon as you end your Windows Power ## PARAMETERS -### -Identity -Fully qualified domain name (FQDN) of the domain to be added to the blocked list; for example, "fabrikam.com". -You can use either the Identity or the Domain parameter (but not both) in order to specify the domain name. -If you use Identity, the Domain property will be set to the same value assigned to Identity. -If you use Domain, the Identity property will be set to the same value that is assigned to Domain. - -Note that Identities must be unique: if the specified domain already exists on either the blocked or the allowed list, the command will fail. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Comment -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Comment Optional string value that provides additional information about the blocked domain. For example, you might add a Comment that explains why the domain has been blocked. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -129,6 +111,9 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN (for example, fabrikam.com) of the domain to be added to the blocked list. You can use either the Identity or the Domain parameter (but not both) in order to specify the domain name. If you use Identity, the Domain property will be set to the same value that is assigned to Identity. @@ -139,8 +124,7 @@ Note that Domains must be unique: if the specified domain already exists on eith ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -150,13 +134,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -165,8 +151,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the domain to be added to the blocked list; for example, "fabrikam.com". +You can use either the Identity or the Domain parameter (but not both) in order to specify the domain name. +If you use Identity, the Domain property will be set to the same value assigned to Identity. +If you use Domain, the Identity property will be set to the same value that is assigned to Domain. + +Note that Identities must be unique: if the specified domain already exists on either the blocked or the allowed list, the command will fail. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. @@ -175,8 +186,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -185,14 +195,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -201,14 +213,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -222,13 +236,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsBlockedDomain cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.BlockedDomain Creates instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.BlockedDomain object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsCallParkOrbit.md b/skype/skype-ps/SkypeForBusiness/New-CsCallParkOrbit.md similarity index 87% rename from skype/skype-ps/skype/New-CsCallParkOrbit.md rename to skype/skype-ps/SkypeForBusiness/New-CsCallParkOrbit.md index fb35a67100..7349e80414 100644 --- a/skype/skype-ps/skype/New-CsCallParkOrbit.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsCallParkOrbit.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cscallparkorbit applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsCallParkOrbit -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cscallparkorbit +schema: 2.0.0 +title: New-CsCallParkOrbit --- # New-CsCallParkOrbit @@ -39,7 +40,7 @@ You can create multiple call park orbits; each must have a globally unique name ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsCallParkOrbit -Identity "Redmond CPO 1" -NumberRangeStart 100 -NumberRangeEnd 199 -CallParkService ApplicationServer:pool0.litwareinc.com @@ -49,7 +50,7 @@ This example creates a new call park orbit named "Redmond CPO 1" on the Applicat The available number range for this call park orbit is 100 through 199. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsCallParkOrbit -Identity "Redmond CPO 2" -NumberRangeStart "*1000" -NumberRangeEnd "*1999" -CallParkService pool0.litwareinc.com @@ -59,7 +60,7 @@ This example creates a new call park orbit named "Redmond CPO 2" on the Call Par The available range for this call park orbit is *1000 through *1999. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` New-CsCallParkOrbit -Identity "Redmond CPO 3" -NumberRangeStart "#1000" -NumberRangeEnd "#1999" -CallParkService ApplicationServer:redmond.litwareinc.com @@ -71,8 +72,47 @@ The available range for this call park orbit is #1000 through #1999. ## PARAMETERS +### -CallParkService + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The fully qualified domain name (FQDN) or service ID of the Application service that hosts the Call Park application. +All calls parked to numbers within the range specified by the NumberRangeStart and NumberRangeEnd parameters will be routed to this server or pool. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: CallParkServerFqdn + +Required: True +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name of the call park orbit range. This name must be unique within the Skype for Business Server deployment. This string can be any value, but should be something that allows for easy identification of the particular call park orbit range. @@ -83,8 +123,7 @@ All call park orbit ranges are created with a global scope. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -93,44 +132,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallParkService -The fully qualified domain name (FQDN) or service ID of the Application service that hosts the Call Park application. -All calls parked to numbers within the range specified by the NumberRangeStart and NumberRangeEnd parameters will be routed to this server or pool. +### -InMemory -```yaml -Type: String -Parameter Sets: (All) -Aliases: CallParkServerFqdn -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 5 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. -### -NumberRangeStart -The first number in the range for this call park orbit. -The value must be less than or equal to the NumberRangeEnd. -The value must also be the same length as the value of the NumberRangeEnd. -Valid values: Must match the regular expression string (\[\*|#\]?\[1-9\]\d{0,7})|(\[1-9\]\d{0,8}). -This means that the value must be a string beginning with either the character * or # or a number 1 through 9 (the first character cannot be a zero). -If the first character is * or # the following character must be a number 1 through 9 (it cannot be a zero). -Subsequent characters can be any number 0 through 9 up to seven additional characters. -(For example, #6000, *92000, and *95551212.) The number following the * or # must be greater than 100. -If the first character is not * or #, the first character must be a number 1 through 9 (it cannot be zero), followed by up to eight characters, each a number 0 through 9. -(For example, 915551212;41212;300) ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 3 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -138,6 +155,8 @@ Accept wildcard characters: False ### -NumberRangeEnd +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The last number in the range for this call park orbit. The value must be greater than or equal to the NumberRangeStart. The value must also be the same length as the value of the NumberRangeStart. @@ -156,8 +175,7 @@ Subsequent characters can be any number 0 through 9 up to seven additional chara ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 4 @@ -166,50 +184,59 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -NumberRangeStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The first number in the range for this call park orbit. +The value must be less than or equal to the NumberRangeEnd. +The value must also be the same length as the value of the NumberRangeEnd. + +Valid values: Must match the regular expression string (\[\*|#\]?\[1-9\]\d{0,7})|(\[1-9\]\d{0,8}). +This means that the value must be a string beginning with either the character * or # or a number 1 through 9 (the first character cannot be a zero). +If the first character is * or # the following character must be a number 1 through 9 (it cannot be a zero). +Subsequent characters can be any number 0 through 9 up to seven additional characters. +(For example, #6000, *92000, and *95551212.) The number following the * or # must be greater than 100. +If the first character is not * or #, the first character must be a number 1 through 9 (it cannot be zero), followed by up to eight characters, each a number 0 through 9. +(For example, 915551212;41212;300) ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -Type -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Specifies the type of call park orbit being created. +Skype for Business Server allows for two different types of call park orbits: +CallPark. +This is the standard call park orbit, in which a user places a call on hold and then can retrieve that call from any phone by dialing the specified call park number. +CallPark is the default orbit type and will be used if the Type parameter is not specified. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +GroupPickup. +With group pickup, users can answer any incoming call that is made to any member of their call pickup group. +Call pickup groups are configured by administrators. -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +To specify a call park orbit type, use syntax similar to this: -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +`-Type GroupPickup` + +This parameter was introduced in the February 2013 release of Lync Server 2013. ```yaml -Type: SwitchParameter +Type: OrbitType Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -219,13 +246,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -234,29 +263,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -Specifies the type of call park orbit being created. -Skype for Business Server allows for two different types of call park orbits: - -CallPark. -This is the standard call park orbit, in which a user places a call on hold and then can retrieve that call from any phone by dialing the specified call park number. -CallPark is the default orbit type and will be used if the Type parameter is not specified. - -GroupPickup. -With group pickup, users can answer any incoming call that is made to any member of their call pickup group. -Call pickup groups are configured by administrators. +### -WhatIf -To specify a call park orbit type, use syntax similar to this: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-Type GroupPickup` - -This parameter was introduced in the February 2013 release of Lync Server 2013. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: OrbitType +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -270,12 +286,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.Helpers.DisplayCallParkOrbit This cmdlet creates an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayCallParkOrbit. ## NOTES diff --git a/skype/skype-ps/skype/New-CsCallViaWorkPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsCallViaWorkPolicy.md similarity index 86% rename from skype/skype-ps/skype/New-CsCallViaWorkPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsCallViaWorkPolicy.md index cc14b7f786..bb13e3fda7 100644 --- a/skype/skype-ps/skype/New-CsCallViaWorkPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsCallViaWorkPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cscallviaworkpolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsCallViaWorkPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cscallviaworkpolicy +schema: 2.0.0 +title: New-CsCallViaWorkPolicy --- # New-CsCallViaWorkPolicy @@ -28,7 +29,7 @@ This cmdlet creates a new call via work policy. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsCallViaWorkPolicy -Identity Site:Redmond -Enabled $true -AdminCallbackNumber +14258881234 -UseAdminCallbackNumber $true @@ -40,32 +41,10 @@ The policy is enabled, the administrative callback number is specified and enfor ## PARAMETERS -### -Identity -Unique identity to be assigned to the policy. -New policies can be created at the site or per-user scope. -To create a new site policy, use the prefix "site:" and the name of the site as the Identity. -For example, to create a new policy for the Redmond site you would use this syntax: `-Identity site:Redmond`. -To create a new per-user policy, this syntax: `-Identity SalesDepartmentPolicy`. - -You cannot create a new global policy. -If you want to make changes to the global policy, use the Set-CsCallViaWorkPolicy cmdlet instead. -Likewise, you cannot create a new site or per-user policy if a policy with that Identity already exists. -If you need to make changes to an existing policy, use the Set-CsCallViaWorkPolicy cmdlet. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -AdminCallbackNumber -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -AdminCallbackNumber Specifies the number that will be called during the call back to the Skype for Business user before placing the external call. Typically this is the user's desk phone. If you want the user be able to change the callback number, use the UseAdminCallbackNumber switch. @@ -75,8 +54,7 @@ For instance, "12068881234" or "+12068881234". ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -85,14 +63,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Enabled + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies whether the policy is enabled at creation. +The default is false ($False). ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -101,15 +82,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Enabled -Specifies whether the policy is enabled at creation. -The default is false ($False). +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -118,31 +100,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. +### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identity to be assigned to the policy. +New policies can be created at the site or per-user scope. +To create a new site policy, use the prefix "site:" and the name of the site as the Identity. +For example, to create a new policy for the Redmond site you would use this syntax: `-Identity site:Redmond`. +To create a new per-user policy, this syntax: `-Identity SalesDepartmentPolicy`. + +You cannot create a new global policy. +If you want to make changes to the global policy, use the Set-CsCallViaWorkPolicy cmdlet instead. +Likewise, you cannot create a new site or per-user policy if a policy with that Identity already exists. +If you need to make changes to an existing policy, use the Set-CsCallViaWorkPolicy cmdlet. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -152,13 +147,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -168,6 +165,9 @@ Accept wildcard characters: False ``` ### -UseAdminCallbackNumber + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + If true ($True), the number specified in the AdminCallbackNumber is the only number that will be used for the callback to the user, or first leg, of the outbound call. If false ($False), the user has the opportunity to change the callback number through the client. The user might choose to change the call back number to a personal phone number like a mobile, home, or hotel phone number. @@ -175,8 +175,25 @@ The user might choose to change the call back number to a personal phone number ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -186,13 +203,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -206,12 +225,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.CallViaWork.CallViaWorkPolicy The New-CsCallViaWorkPolicy returns Microsoft.Rtc.Management.WritableConfig.Policy.CallViaWork.CallViaWorkPolicy instances. ## NOTES diff --git a/skype/skype-ps/skype/New-CsCdrConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsCdrConfiguration.md similarity index 87% rename from skype/skype-ps/skype/New-CsCdrConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsCdrConfiguration.md index 68b89ad829..23248b0fe6 100644 --- a/skype/skype-ps/skype/New-CsCdrConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsCdrConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cscdrconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsCdrConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cscdrconfiguration +schema: 2.0.0 +title: New-CsCdrConfiguration --- # New-CsCdrConfiguration @@ -49,7 +50,7 @@ If you try this, the command will fail. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsCdrConfiguration -Identity site:Redmond -EnableCDR $False @@ -60,7 +61,7 @@ In addition to the Identity site:Redmond, the new settings also have the EnableC Because site settings take precedence over global settings, this means that CDR will not be used in the Redmond site, regardless of whether or not CDR has been enabled at the global scope. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsCdrConfiguration -Identity site:Redmond -InMemory @@ -81,32 +82,17 @@ If the Set-CsCdrConfiguration cmdlet was not called, the virtual collection woul ## PARAMETERS -### -Identity -Represents the unique identifier to be assigned to the new collection of CDR configuration settings. -Because you can only create new collections at the site scope, the Identity will always be the prefix "site:" followed by the site name; for example "site:Redmond". - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableCDR -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableCDR Indicates whether or not CDR is enabled. The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,6 +102,9 @@ Accept wildcard characters: False ``` ### -EnablePurging + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether or not CDR records will periodically be deleted from the CDR database. If True (the default value), records will be deleted after the time period specified by the properties KeepCallDetailForDays (CDR records) and the KeepErrorReportForDays (CDR errors). If False, CDR records will be maintained indefinitely. @@ -123,8 +112,65 @@ If False, CDR records will be maintained indefinitely. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Represents the unique identifier to be assigned to the new collection of CDR configuration settings. +Because you can only create new collections at the site scope, the Identity will always be the prefix "site:" followed by the site name; for example "site:Redmond". + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -134,6 +180,9 @@ Accept wildcard characters: False ``` ### -KeepCallDetailForDays + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the number of days that CDR records will be kept in the CDR database; any records older than the specified number of days will automatically be deleted. (Note that purging will take place only if the EnablePurging property has been set to True.) @@ -143,8 +192,7 @@ The default value is 60. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -155,6 +203,8 @@ Accept wildcard characters: False ### -KeepErrorReportForDays +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the number of days that CDR error reports are kept; any reports older than the specified number of days will automatically be deleted. CDR error reports are diagnostic reports uploaded by client applications such as Skype for Business. @@ -166,8 +216,7 @@ The default value is 60. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -177,6 +226,9 @@ Accept wildcard characters: False ``` ### -PurgeHourOfDay + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the local time of day when expired records are deleted from the CDR database. The time of day is specified using a 24-hour clock, with 0 representing midnight (12:00 A.M.) and 23 representing 11:00 P.M. Note that you can only specify the hour of the day; that means that you can schedule purging to take place at 4:00 A.M. @@ -190,8 +242,7 @@ Database purging takes place only if the EnablePurging property is set to True. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -200,34 +251,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory - -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -237,29 +270,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -273,13 +292,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsCdrConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CallDetailRecording.CdrSettings Creates instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CallDetailRecording.CdrSettings object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsClientPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsClientPolicy.md similarity index 81% rename from skype/skype-ps/skype/New-CsClientPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsClientPolicy.md index 38bddfb4fe..2793275139 100644 --- a/skype/skype-ps/skype/New-CsClientPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClientPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csclientpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsClientPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/new-csclientpolicy +schema: 2.0.0 +title: New-CsClientPolicy --- # New-CsClientPolicy @@ -84,7 +86,7 @@ The following parameters are not applicable to Skype for Business Online: Addres ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- (Skype for Business Server) +### EXAMPLE 1 (Skype for Business Server) ``` New-CsClientPolicy -Identity RedmondClientPolicy -DisableCalendarPresence $True -DisablePhonePresence $True -DisplayPhoto "PhotosFromADOnly" ``` @@ -92,7 +94,7 @@ New-CsClientPolicy -Identity RedmondClientPolicy -DisableCalendarPresence $True The command shown in Example 1 creates a new client policy with the Identity RedmondClientPolicy. In addition to specifying the Identity, this command also includes three optional parameters and their parameter values: DisableCalendarPresence, DisablePhonePresence, and DisplayPhoto. -### -------------------------- EXAMPLE 2 -------------------------- (Skype for Business Server) +### EXAMPLE 2 (Skype for Business Server) ``` $x = New-CsClientPolicy -Identity RedmondClientPolicy -InMemory @@ -117,28 +119,10 @@ If you do not call the Set-CsClientPolicy cmdlet the policy RedmondClientPolicy ## PARAMETERS -### -Identity - -Unique Identity to be assigned to the new policy. -New client policies can be created at the site or per-user scope. -To create a new site policy, use the prefix "site:" and the name of the site as your Identity. -For example, use this syntax to create a new policy for the Redmond site: `-Identity site:Redmond.` -To create a new per-user policy, use an identity similar to this: `-Identity SalesClientPolicy.` - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +### -AddressBookAvailability -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -AddressBookAvailability Indicates how users are allowed to access information by using the Address Book Web Query service and/or by downloading a copy of the Address Book to their local computer). AddressBookAvailability must be set to one of the following values: @@ -151,8 +135,7 @@ FileDownloadOnly ```yaml Type: AddressBookAvailability Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,14 +145,16 @@ Accept wildcard characters: False ``` ### -AttendantSafeTransfer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, Attendant operates in "safe transfer" mode; this means that transferred calls that do not reach the intended recipient will reappear in the incoming area along with a "Failed Transfer" notice. When set to False, transferred calls that fail to reach the intended recipient will not reappear in the incoming area. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,6 +164,9 @@ Accept wildcard characters: False ``` ### -AutoDiscoveryRetryInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + After a failed connection attempt, specifies the amount of time Skype for Business waits before trying again to connect to Skype for Business Server. The AutoDiscoveryRetryInterval can be set to value between 1 second and 60 minutes (1 hour), inclusive. @@ -188,8 +176,7 @@ For example, to set the interval to 25 minutes use this syntax: `- AutoDiscovery ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -199,6 +186,9 @@ Accept wildcard characters: False ``` ### -BlockConversationFromFederatedContacts + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, contacts from outside your organization will not be allowed to initiate instant messaging conversations with any user that this policy applies to. However, outside users will be able to participate in conversations as long as the internal user initiates that conversation. When set to False, outside contacts are allowed to send unsolicited instant messages to users in your organization. @@ -206,8 +196,7 @@ When set to False, outside contacts are allowed to send unsolicited instant mess ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -217,6 +206,9 @@ Accept wildcard characters: False ``` ### -CalendarStatePublicationInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the amount of time, in seconds, that Skype for Business waits before retrieving calendar information from Microsoft Outlook and adding this data to your presence information. For example, to set the CalendarStatePublicationInterval to 10 minutes (600 seconds) use this syntax: @@ -226,8 +218,7 @@ For example, to set the CalendarStatePublicationInterval to 10 minutes (600 seco ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -237,6 +228,9 @@ Accept wildcard characters: False ``` ### -ConferenceIMIdleTimeout + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the number of minutes that a user can remain in an instant messaging session without either sending or receiving an instant message. The ConferenceIMIdleTimeout must be less than or equal to 1 hour, and must be specified using the format hours:minutes:seconds. @@ -247,8 +241,7 @@ For example, this syntax sets the timeout value to 45 minutes: ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -258,6 +251,9 @@ Accept wildcard characters: False ``` ### -CustomizedHelpUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + URL for custom help set up by an organization. This help, rather than the default product help, will be displayed any time a user clicks the Help menu in Skype for Business. @@ -268,8 +264,7 @@ This parameter has been deprecated for use with Skype for Business Server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -279,6 +274,9 @@ Accept wildcard characters: False ``` ### -CustomLinkInErrorMessages + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + URL for the website that can be added to error messages that appear in Skype for Business. If a URL is specified, that URL will appear at the bottom of any error message that occurs in Skype for Business. Users can then click that link and be taken to a custom website that contains additional information, such as troubleshooting tips. @@ -286,8 +284,7 @@ Users can then click that link and be taken to a custom website that contains ad ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -297,14 +294,16 @@ Accept wildcard characters: False ``` ### -CustomStateUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the location of the XML file used to add custom presence states to Skype for Business. (Skype for Business allows up to four custom presence states in addition to the built-in states such as Available, Busy, and Do Not Disturb.) The location of the XML file should be specified using the HTTPS protocol. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -314,14 +313,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Allows administrators to provide additional information about a policy. For example, the Description might indicate which users the policy should be assigned to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -331,6 +332,9 @@ Accept wildcard characters: False ``` ### -DGRefreshInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the amount of time Skype for Business waits before automatically refreshing the membership list of any distribution group that has been "expanded" in the Contacts list. (Expanding a distribution group means displaying all the members in that group.) DGRefreshInterval can be set to any integer value between 30 seconds and 28,800 seconds (8 hours), inclusive. The default value is 28,800 seconds. @@ -338,8 +342,7 @@ The default value is 28,800 seconds. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -349,6 +352,9 @@ Accept wildcard characters: False ``` ### -DisableCalendarPresence + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, calendar data taken from Microsoft Outlook will not be included in your presence information. When set to False, calendar data will be included in your presence information. For example, free/busy information will be reported in your contact card. @@ -357,8 +363,7 @@ Likewise, your status will automatically be set to Busy any time Outlook shows t ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -368,14 +373,16 @@ Accept wildcard characters: False ``` ### -DisableContactCardOrganizationTab + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, the contact card Organization tab is not visible within the Skype for Business user interface. When set to False, the contact card Organization tab is available in Skype for Business. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -385,6 +392,9 @@ Accept wildcard characters: False ``` ### -DisableEmailComparisonCheck + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, Skype for Business will not attempt to verify that any currently running instance of Microsoft Outlook belongs to the same user running Skype for Business; for example, the software will not verify that both Outlook and Skype for Business are running under Ken Myer's user account. Instead, it will be assumed that the two applications are running under the same account and, in turn, will include contact and calendar data in Outlook with Skype for Business. @@ -394,8 +404,7 @@ If the SMTP addresses do not match, then contact and calendar data in Outlook wi ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -405,6 +414,9 @@ Accept wildcard characters: False ``` ### -DisableEmoticons + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, users will not be able to send or receive emoticons in their instant messages; instead they will be see the text equivalent of those emoticons. For example, instead of seeing a graphical "smiley face," users will see the text equivalent: @@ -415,8 +427,7 @@ When set to False, users will be able to include emoticons in their instant mess ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -426,14 +437,16 @@ Accept wildcard characters: False ``` ### -DisableFederatedPromptDisplayName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, any notification dialog box generated when you are added to a federated user's Contacts list will use the federated user's SIP address (for example, sip:kenmyer@fabrikam.com). When set to False, the notification dialog box will use the federated user's display name (for example, Ken Myer) instead. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -443,14 +456,16 @@ Accept wildcard characters: False ``` ### -DisableFeedsTab + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, the activity feeds tab will not be displayed in Skype for Business. When set to False, the feeds tab will be available within Skype for Business. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -460,6 +475,9 @@ Accept wildcard characters: False ``` ### -DisableFreeBusyInfo + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, free/busy information retrieved from Microsoft Outlook will not be displayed in your contact card. When set to False, free/busy information is displayed in your contact card. For example, your contact card might include a note similar to this: @@ -469,8 +487,7 @@ Calendar: Free until 2:00 PM ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -480,6 +497,9 @@ Accept wildcard characters: False ``` ### -DisableHandsetOnLockedMachine + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, users will not be able to use their Polycom handset if the computer that the handset is connected to is locked. To use the handset, users will first have to unlock the computer. @@ -488,8 +508,7 @@ When set to False, users will be allowed to use their Polycom handset even if th ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -499,6 +518,9 @@ Accept wildcard characters: False ``` ### -DisableHtmlIm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, any HTML text copied from a webpage will be converted to plain text when pasted into an instant message. When set to False, HTML formatting (such as font size and color, drop-down lists, and buttons) will be retained when pasted into an instant message. @@ -508,8 +530,7 @@ You can copy and paste buttons and other controls into a message, but any script ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -519,6 +540,9 @@ Accept wildcard characters: False ``` ### -DisableICE + +> Applicable: Lync Server 2010 + When set to True, Lync 2010 will not use the Interactive Connectivity Establishment (ICE) protocol to traverse firewalls and network address translation (NAT) devices; this effectively prevents users from making Lync 2010 calls across the Internet. When set to False, Lync 2010 will use the ICE protocol to enable Lync 2010 calls to traverse firewalls and NAT devices. @@ -527,8 +551,7 @@ This setting is equivalent to the Communications Server 2007 R2 Group Policy set ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010 +Aliases: Required: False Position: Named @@ -538,14 +561,38 @@ Accept wildcard characters: False ``` ### -DisableInkIM + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, users will not be allowed to receive instant messages containing Tablet PC ink. (Ink is a technology that enables you to insert handwritten notes into a document.) When set to False, users will be allowed to receive messages that contain Tablet PC ink. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableMeetingSubjectAndLocation + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to False, detailed information about a meeting -- namely, the meeting subject and the location where the meeting is being held -- will be displayed as a tooltip when you view free/busy information in a contact card. +When set to True, this detailed information will not be displayed. +To completely prevent the display of meeting-related information you should also set DisableCalendarPresence to True. + + + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -555,6 +602,9 @@ Accept wildcard characters: False ``` ### -DisableOneNote12Integration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, the ability to start Microsoft OneNote from within Skype for Business (and the ability to automatically link instant messaging sessions and OneNote notes) is disabled. When set to False, the option Take Notes Using OneNote is enabled in Skype for Business. In addition, if you locate an instant message transcript in Microsoft Outlook's Conversation History, you can retrieve any OneNote notes associated with that conversation just by clicking the Edit conversation notes button. @@ -562,8 +612,7 @@ In addition, if you locate an instant message transcript in Microsoft Outlook's ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -573,6 +622,9 @@ Accept wildcard characters: False ``` ### -DisableOnlineContextualSearch + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, disables the Find Previous Conversations menu option that appears when you right-click a user in your Contacts list. (This option enables you to search the Microsoft Outlook Conversation History folder for previous instant messaging sessions involving the user in question.) When set to False, the Find Previous Conversations option will be available when you right-click a user in your Contacts list. @@ -584,8 +636,7 @@ Cached searches are not affected by this setting. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -595,6 +646,9 @@ Accept wildcard characters: False ``` ### -DisablePhonePresence + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, Skype for Business does not take phone calls into consideration when determining your current status. When set to False, phone calls are taken into consideration when determining your status. For example, any time you are on the phone your status will automatically be set to Busy. @@ -602,8 +656,7 @@ For example, any time you are on the phone your status will automatically be set ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -613,14 +666,16 @@ Accept wildcard characters: False ``` ### -DisablePICPromptDisplayName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, any notification dialog box generated when you are added to the Contacts list of a user with an account on a public instant messaging service such as MSN will display that person's SIP address (for example, sip:kenmyer@litwareinc.com). When set to False, the notification dialog box will use the person's display name (for example, Ken Myer) instead. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -631,6 +686,8 @@ Accept wildcard characters: False ### -DisablePoorDeviceWarnings +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, Skype for Business will not issue warnings (for example, upon startup, in the Tuning Wizard, and in the Conversation window) if an audio or video device is not working correctly. When set to False, these warnings will be issued. @@ -639,8 +696,7 @@ When set to False, these warnings will be issued. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -651,6 +707,8 @@ Accept wildcard characters: False ### -DisablePoorNetworkWarnings +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, Skype for Business will not display warnings about poor network quality. @@ -658,8 +716,7 @@ When set to True, Skype for Business will not display warnings about poor networ ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -670,6 +727,8 @@ Accept wildcard characters: False ### -DisablePresenceNote +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, any Out of Office message you configure in Microsoft Outlook will not be displayed as part of your presence information. When set to False, your Out of Office message will be displayed any time a user holds the mouse over your name in their Contacts list. @@ -678,8 +737,7 @@ When set to False, your Out of Office message will be displayed any time a user ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -690,6 +748,8 @@ Accept wildcard characters: False ### -DisableRTFIM +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When both this setting and the DisableHtmlIm setting are set to True, prevents rich text formatting (for example, different fonts, font sizes, and font colors) from being used in instant messages; instead, all messages sent and received will be converted to plain text format. When set to False, rich text formatting will be allowed in instant messages. @@ -698,8 +758,7 @@ When set to False, rich text formatting will be allowed in instant messages. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -710,6 +769,8 @@ Accept wildcard characters: False ### -DisableSavingIM +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, the options for saving an instant messaging session are removed from the menu bar in the Skype for Business Conversation window. When set to False, these options are available in the Conversation window. @@ -721,8 +782,7 @@ However, it does not prevent users from copying all the text in a transcript to ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -733,6 +793,8 @@ Accept wildcard characters: False ### -DisplayPhoto +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether or not photos (of both the user and his or her contacts) will be displayed in Skype for Business. Valid settings are: @@ -749,8 +811,7 @@ The default value is AllPhotos. ```yaml Type: DisplayPhoto Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -761,6 +822,8 @@ Accept wildcard characters: False ### -EnableAppearOffline +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True an additional presence state, Appear Offline, is available in Skype for Business. This state makes it appear as though the user is offline; however, he or she will actually be online and available to answer phone calls and respond to instant messages. When set to False, the Appear Offline presence state will not be available in Skype for Business. @@ -770,8 +833,7 @@ When set to False, the Appear Offline presence state will not be available in Sk ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -782,6 +844,8 @@ Accept wildcard characters: False ### -EnableCallLogAutoArchiving +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, information about your incoming and outgoing phone calls is automatically saved to the Conversation History folder in Microsoft Outlook. (The actual call itself is not recorded. What is recorded is information such as who took part in the call; the length of the call; and whether this was an incoming or an outgoing call.) When set to False, this information is not saved to Outlook. @@ -791,8 +855,25 @@ What is recorded is information such as who took part in the call; the length of ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableClientAutoPopulateWithTeam + +> Applicable: Skype for Business Online + +When set to true, allows a user's Skype client to be autopopulated with members of his or her immediate team. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -803,6 +884,8 @@ Accept wildcard characters: False ### -EnableClientMusicOnHold +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, music will be played any time a caller is placed on hold. When set to False, music will not be played any time a caller is placed on hold. The default value is False. @@ -813,8 +896,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -825,6 +907,8 @@ Accept wildcard characters: False ### -EnableConversationWindowTabs +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, supplemental information related to an instant messaging session will be displayed in a separate browser window. This type of information is available only for custom applications that use the Microsoft Unified Communications APIs. For example, customer service or support team personnel can automatically access related information while chatting with someone. @@ -839,8 +923,7 @@ This parameter has been deprecated for use with Skype for Business Server. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -851,6 +934,8 @@ Accept wildcard characters: False ### -EnableEnterpriseCustomizedHelp +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, users who click the Help menu in Skype for Business will be given custom help set up by the organization. This parameter has been deprecated for use with Skype for Business Server. @@ -860,8 +945,7 @@ This parameter has been deprecated for use with Skype for Business Server. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -872,6 +956,8 @@ Accept wildcard characters: False ### -EnableEventLogging +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, detailed information about Skype for Business will be recorded in the Application event log. When set to False, only major events (such as the failure to connect to Skype for Business Server) are recorded in the event log. @@ -880,8 +966,7 @@ When set to False, only major events (such as the failure to connect to Skype fo ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -890,17 +975,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableExchangeContactSync - -When set to True (the default value) Skype for Business creates a corresponding personal contact in Microsoft Outlook for each person on a user's Skype for Business Contacts list. +### -EnableExchangeContactsFolder +> Applicable: Skype for Business Online +When set to false, this allows admins to hide Skype for Business contacts from showing up in users' Outlook and Outlook on the Web clients. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -909,18 +993,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableExchangeDelegateSync +### -EnableExchangeContactSync -When set to True, delegates that a user has configured in Microsoft Exchange will be allowed to schedule meetings for that user. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True (the default value) Skype for Business creates a corresponding personal contact in Microsoft Outlook for each person on a user's Skype for Business Contacts list. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -929,18 +1013,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableFullScreenVideo +### -EnableExchangeDelegateSync + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, delegates that a user has configured in Microsoft Exchange will be allowed to schedule meetings for that user. -When set to True, this parameter does two things: 1) enables full-screen video (with the correct aspect ratio) for Skype for Business calls; and, 2) disables video preview for Skype for Business calls. -When set to False, full-screen video is not available in Skype for Business, but video preview is available. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -949,22 +1034,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableHotdesking +### -EnableFullScreenVideo -When set to True, enables users to log on to a phone running Skype for Business Phone Edition in a shared workspace by using their Skype for Business Server account. -(Among other things, this provides the user access to his or her contacts.) When set to False, users are not allowed to log on to a phone by using their own credentials. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Note that this setting applies only to common area phones and not to users. -When set to True and applied to a common area phone, any user will be able to log on to that phone using his or her credentials. -When set to False, no users will be allowed to log on to a common area phone where this policy setting has been applied. +When set to True, this parameter does two things: 1) enables full-screen video (with the correct aspect ratio) for Skype for Business calls; and, 2) disables video preview for Skype for Business calls. +When set to False, full-screen video is not available in Skype for Business, but video preview is available. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -973,19 +1055,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableIMAutoArchiving - -When set to True, a transcript of every instant messaging session that a user takes part in will be saved to the Conversation History folder in Microsoft Outlook. -When set to False, these transcripts will not be saved automatically. -(However, users will have the option to manually save instant messaging transcripts.) +### -EnableHighPerformanceConferencingAppSharing +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True, enables better performance in applications (such as CAD/CAM applications) that have a high screen refresh rate. +However, this improved performance will reduce the system resources and network bandwidth available to other applications. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -994,24 +1074,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSQMData - -Note: This setting has been deprecated for Skype for Business Server. - -When EnableSQMData is set to True, the user will not automatically be enrolled in the Customer Experience Program. -However, Skype for Business will provide the user with the option to join the program. - -When set to False, the user will not be enrolled in the Customer Experience Improvement Program. -In addition, Skype for Business will not give users the option of joining the program. -The only way for a user to participate in the CEIP program is for EnableSQMData to be set to True and the user to then manually opt-in to the program. +### -EnableHighPerformanceP2PAppSharing +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True, allows a peer-to-peer application sharing session to exceed the maximum frame rate of 2.5 frames per second. +The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1020,19 +1093,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableTracing +### -EnableHotdesking -When set to True, software tracing will be enabled in Skype for Business; when set to False, software tracing will be disabled. -Software tracing involves keeping a detailed record of everything that a program does (including tracking API calls). -Tracing is mostly useful to developers and to application support personnel. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, enables users to log on to a phone running Skype for Business Phone Edition in a shared workspace by using their Skype for Business Server account. +(Among other things, this provides the user access to his or her contacts.) When set to False, users are not allowed to log on to a phone by using their own credentials. + +Note that this setting applies only to common area phones and not to users. +When set to True and applied to a common area phone, any user will be able to log on to that phone using his or her credentials. +When set to False, no users will be allowed to log on to a common area phone where this policy setting has been applied. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1041,18 +1118,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableUnencryptedFileTransfer +### -EnableIMAutoArchiving -When set to True, users will be allowed to exchange files with external users whose instant messaging software does not support encrypted file transfers. -When set to False, users will only be able to exchange files with external users who have software that supports encrypted file transfers. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, a transcript of every instant messaging session that a user takes part in will be saved to the Conversation History folder in Microsoft Outlook. +When set to False, these transcripts will not be saved automatically. +(However, users will have the option to manually save instant messaging transcripts.) ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1061,21 +1140,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableVOIPCallDefault - -When set to True, a Skype for Business call will be placed any time a user employs the click-to-call feature. - -This policy setting only affects the initial state of the click-to-call feature. -If the user modifies the value of the click-to-call setting then the user-selected value will override this policy setting. -After a user has modified the click-to-call setting that setting will remain in use and will not be affected by the EnableVOIPCallDefault policy. +### -EnableMediaRedirection +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True ($True) allows audio and video streams to be separated from other network traffic; in turn, this allows client devices to do encoding and decoding of audio and video locally. +Media redirection typically results in lower bandwidth usage, higher server scalability, and a more-optimal user experience compared to similar techniques such as device remoting or codec compression. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1084,19 +1159,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludedContactFolders +### -EnableMeetingEngagement -Indicates which Microsoft Outlook contact folders (if any) should not be searched any time Skype for Business searches for new contacts. -Multiple folders can be specified by separating the folder names using semicolons; for example, `-ExcludedContactFolders "SenderPhotoContacts;OtherContacts".` +> Applicable: Skype for Business Online -NOTE: When using a Skype for Business client, with either Office 2013 or Office 2016, this policy won't work in the same way. -In that combination, the Skype for Business client uses the search capabilities of Office (mso.dll), which finds contacts from Exchange mailbox contact folders. There isn't an option to suppress the search of those contact folders for the Office search component. +{{Fill EnableMeetingEngagement Description}} ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1105,25 +1177,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HotdeskingTimeout - -Timeout interval for a user logged on to a hot-desked phone. -(A hot-desked phone is a phone running Skype for Business Phone Edition that is located in a shared workspace, and that users can log on to by using their Skype for Business Server account.) The hot-desk timeout specifies the number of minutes that can elapse before a user is automatically logged off of a hot-desked phone. -When specifying a hot desking timeout you must use the format hours:minutes:seconds. -For example, this syntax sets the hot desking timeout interval to 45 minutes: +### -EnableNotificationForNewSubscribers -`-HotdeskingTimeout 00:45:00` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Note that this policy setting applies only to common area phones and not to users. -The default value is 5 minutes (00:05:00), and the minimum value is 30 seconds (00:00:30). +When set to True, any time you are added to someone's Contacts list you will receive notification that you have been added to the list. +In addition, the notification dialog box will provide options for you to add this person to your Contacts list, or to block them from viewing your presence information. +When set to False, you will not be notified if you are added to someone's Contacts list. ```yaml -Type: TimeSpan +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1132,23 +1199,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IMWarning - -When configured, the specified message appears in the Conversation window each time a user takes part in an instant messaging session. -For example, if IMWarning is set to "All information is the property of Litwareinc" then that message will appear in the Conversation window each time a user takes part in an instant messaging session. - -If set to a null value ($Null), then no message appears in the Conversation window. - -Your warning message should be limited to 256 characters, and can only contain plain text. -You cannot use any formatting (such as boldface or italics) and you cannot clickable URLs within the text. +### -EnableOnlineFeedback +> Applicable: Skype for Business Online +When set to true, allows users to provide feedback through the "help->report a problem" menu options in the client. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1157,25 +1217,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MAPIPollInterval - -> [!IMPORTANT] -> This parameter has been deprecated for use with Skype for Business Server. - -For users of Microsoft Exchange Server 2003, MAPIPollInterval specifies how often Skype for Business retrieves calendar data from the Exchange public folders. -MAPIPollInterval can be set to any value between 1 second and 1 hour; inclusive. -To configure the MAPI poll interval, use the format hours:minutes:seconds. -For example, this command sets the MAPI poll interval to 45 minutes: - -`-MapiPollInterval 00:45:00` +### -EnableOnlineFeedbackScreenshots +> Applicable: Skype for Business Online +When set to true, allows users to provide screenshots of their clients when reporting problems. ```yaml -Type: TimeSpan +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1184,21 +1235,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaximumDGsAllowedInContactList - -Indicates the maximum number of distribution groups that a user can configure as a contact. -MaximumDGsAllowedInContactList can be set to any integer value between 0 and 64, inclusive. -The default value is 10. - +### -EnableServerConversationHistory +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True ($True), allows conversation histories, missed call notifications, and missed IM notifications to be stored on the server instead of in client mailboxes. +This makes it easier for users to retrieve that information from a mobile device. +The default value is False ($False). ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1207,19 +1256,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaximumNumberOfContacts - -Indicates the maximum number of contacts a user is allowed to have. -The maximum contacts can be set to any integer value between 0 and 1000, inclusive. -When set to 0, that prevents the user from having any contacts. +### -EnableSkypeUI +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True ($True), this parameter allows administrators to enable the Skype for Business user interface instead of the Lync interface for the Skype for Business client. ```yaml -Type: UInt16 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1228,20 +1274,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MusicOnHoldAudioFile +### -EnableSQMData -Path to the audio file to be played when a caller is placed on hold. -If a value is configured for this property, then music on hold will be enabled and users will not be allowed to disable the feature. -If no value is configured for this property, then users can specify their own music-on-hold file, provided that EnableClientMusicOnHold is set to True. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Note: This setting has been deprecated for Skype for Business Server. + +When EnableSQMData is set to True, the user will not automatically be enrolled in the Customer Experience Program. +However, Skype for Business will provide the user with the option to join the program. + +When set to False, the user will not be enrolled in the Customer Experience Improvement Program. +In addition, Skype for Business will not give users the option of joining the program. +The only way for a user to participate in the CEIP program is for EnableSQMData to be set to True and the user to then manually opt-in to the program. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1250,30 +1301,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -P2PAppSharingEncryption - -Indicates whether or not desktop and application sharing data exchanged during a peer-to-peer conversation is encrypted. -Allowed values are: - -Supported. -Desktop and application sharing data will be encrypted, if possible. - -Enforced. -Desktop and application sharing data must be encrypted. -If the data cannot be encrypted, then desktop and application sharing will not be enabled for the conversation. - -NotSupported. -Desktop and application sharing data will not be encrypted. +### -EnableTracing +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True, software tracing will be enabled in Skype for Business; when set to False, software tracing will be disabled. +Software tracing involves keeping a detailed record of everything that a program does (including tracking API calls). +Tracing is mostly useful to developers and to application support personnel. ```yaml -Type: P2PAppSharingEncryption +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1282,18 +1323,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PlayAbbreviatedDialTone +### -EnableUnencryptedFileTransfer -When set to True, a 3-second dial tone will be played any time a Skype for Business-compatible handset is taken off the hook. -(A Skype for Business handset looks like a standard telephone, but plugs into a USB port on a computer and is used to make Skype for Business calls rather than "regular" phone calls.) When set to False, a 30-second dial tone is played any time a Skype for Business-compatible handset is taken off the hook. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, users will be allowed to exchange files with external users whose instant messaging software does not support encrypted file transfers. +When set to False, users will only be able to exchange files with external users who have software that supports encrypted file transfers. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1302,23 +1344,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyEntry - -Provides a way to add settings not covered by the default parameters. -For example, when testing pre-release versions of Lync 2010 it was possible to add a Send Feedback option to the user interface. -That was done by using code similar to this: +### -EnableURL -`$x = New-CsClientPolicyEntry -Name "OnlineFeedbackURL" -Value "https://www.litwareinc.com/feedback"Set-CsClientPolicy -Identity global -PolicyEntry @{Add=$x}` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -For more details and examples, see the New-CsClientPolicyEntry cmdlet help topic. +When set to True, hyperlinks embedded in an instant message will be "clickable;" that is, users can click that link and their web browser will open to the specified location. +When set to False, hyperlinks will appear in instant messages as plain text. +To navigate to the location, users will need to copy the link text and paste it into their web browser. ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1327,41 +1366,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchPrefixFlags - -Represents the Address Book attributes that should be used any time a user searches for a new contact. -The search prefix flags are constructed as a binary number like 11101111, in which a 1 indicates that the attribute should be searched and a 0 indicates that the attribute should not be searched. -The attributes in the binary value are (from right to left): - -Primary email address - -Email alias - -All email addresses - -Company - -Display name - -First name - -Last name - -The binary value 1110111 means that all attributes should be searched except attribute 4: Company. -To search only last name, first name, and display name you would construct this value: - -1110000 +### -EnableViewBasedSubscriptionMode -After the binary value has been constructed, it must then be converted to a decimal value before being assigned to SearchPrefixFlags. -To convert a binary number to a decimal number, you can use a Windows PowerShell command similar to this: +> Applicable: Skype for Business Online -`[Convert]::ToInt32("1110111", 2)` +{{Fill EnableViewBasedSubscriptionMode Description}} ```yaml -Type: UInt16 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1370,23 +1384,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowManagePrivacyRelationships +### -EnableVOIPCallDefault -When set to True, shows the Relationships option in the Skype for Business Contacts list window. -When set to False, hides the Relationships option. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Note that this setting applies only to Lync 2010. -Skype for Business will not show these relationships even if ShowManagePrivacyRelationships has been set to True. +When set to True, a Skype for Business call will be placed any time a user employs the click-to-call feature. -The default value is False. +This policy setting only affects the initial state of the click-to-call feature. +If the user modifies the value of the click-to-call setting then the user-selected value will override this policy setting. +After a user has modified the click-to-call setting that setting will remain in use and will not be affected by the EnableVOIPCallDefault policy. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1395,17 +1408,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowRecentContacts +### -ExcludedContactFolders -This parameter currently has no effect on the client. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Indicates which Microsoft Outlook contact folders (if any) should not be searched any time Skype for Business searches for new contacts. +Multiple folders can be specified by separating the folder names using semicolons; for example, `-ExcludedContactFolders "SenderPhotoContacts;OtherContacts".` +NOTE: When using a Skype for Business client, with either Office 2013 or Office 2016, this policy won't work in the same way. +In that combination, the Skype for Business client uses the search capabilities of Office (mso.dll), which finds contacts from Exchange mailbox contact folders. There isn't an option to suppress the search of those contact folders for the Office search component. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1414,18 +1430,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowSharepointPhotoEditLink +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. -If set to True, Skype for Business will include a link that enables users to edit the personal photo stored on their SharePoint My Site. -The default value is False, which means that Skype for Business will not include a link to the SharePoint My Site. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1434,23 +1451,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SPSearchCenterExternalURL - -External URL for the SharePoint site used for keyword searches (also known as expert searches). -This URL will appear at the bottom of any keyword search results that appear in Skype for Business. -If the user clicks this URL, his or her web browser will open up to the SharePoint site, giving the user the opportunity to conduct searches using the search capabilities of SharePoint. -(SharePoint offers more search options than does Skype for Business.) - -SPSearchCenterExternalURL represents the URL for external users; that is, for users logging on from outside the organization's firewall. -The parameter SPSearchCenterInternalURL is for users who log on from inside the firewall. +### -HelpEnvironment +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to Office 365, the Skype for Business Online client help documentation for Skype for Business will be shown to users rather than the on-premises help shown by default. +You can either set HelpEnvironment to Office 365 or to a null value ($Null). +If set to a null value (the default value) then the on-premises help will be shown to users. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1459,23 +1471,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SPSearchCenterInternalURL +### -HotdeskingTimeout -Internal URL for the SharePoint site used for keyword searches (also known as expert searches). -This URL will appear at the bottom of any keyword search results that appear in Skype for Business. -If the user clicks this URL, his or her web browser will open up to the SharePoint site, giving the user the opportunity to conduct searches using the search capabilities of SharePoint. -(SharePoint offers more search options than Skype for Business does.) +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -SPSearchCenterInternalURL represents the URL for internal users; that is, for users logging on from inside the organization's firewall. -The parameter SPSearchCenterExternalURL is for users who log on from outside the firewall. +Timeout interval for a user logged on to a hot-desked phone. +(A hot-desked phone is a phone running Skype for Business Phone Edition that is located in a shared workspace, and that users can log on to by using their Skype for Business Server account.) The hot-desk timeout specifies the number of minutes that can elapse before a user is automatically logged off of a hot-desked phone. +When specifying a hot desking timeout you must use the format hours:minutes:seconds. +For example, this syntax sets the hot desking timeout interval to 45 minutes: + +`-HotdeskingTimeout 00:45:00` + +Note that this policy setting applies only to common area phones and not to users. +The default value is 5 minutes (00:05:00), and the minimum value is 30 seconds (00:00:30). ```yaml -Type: String +Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1484,38 +1499,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SPSearchExternalURL - -External URL for the SharePoint site used for keyword searches (also known as expert searches). -Skype for Business will use the SharePoint site located at this URL any time an external user (that is, a user who has accessed the system from outside the organization's firewall) conducts a keyword search. +### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Unique Identity to be assigned to the new policy. +New client policies can be created at the site or per-user scope. +To create a new site policy, use the prefix "site:" and the name of the site as your Identity. +For example, use this syntax to create a new policy for the Redmond site: `-Identity site:Redmond.` +To create a new per-user policy, use an identity similar to this: `-Identity SalesClientPolicy.` ```yaml -Type: String +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SPSearchInternalURL - -Internal URL for the SharePoint site used for keyword searches (also known as expert searches). -Skype for Business will use the SharePoint site located at this URL any time an internal user (that is, a user who has logged on from inside the organization's firewall) conducts a keyword search. +### -IMLatencyErrorThreshold +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +If IM latency is greater than the threshold value (in milliseconds), the client will submit a CER. ```yaml -Type: String +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1524,18 +1539,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TabURL - -Specifies the location of the XML file used to create custom tabs located at the bottom of the Skype for Business Contacts list window. -This parameter has been deprecated for use with Skype for Business Server. +### -IMLatencySpinnerDelay +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Amount of time, in milliseconds, to wait before showing the spinner in the client when IM message delivery is delayed. ```yaml -Type: String +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1544,25 +1557,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WebServicePollInterval +### -IMWarning -For users of Microsoft Exchange Server 2007 and later versions of the product, WebServicePollInterval specifies how often Skype for Business retrieves calendar data from Microsoft Exchange Server Web Services. -WebServicePollInterval can be set to any value between 1 second and 1 hour; inclusive. -To configure the Web Service poll interval, use the format hours:minutes:seconds. -For example, this command sets the Web Service poll interval to 45 minutes: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -`-WebServicePollInterval 00:45:00` +When configured, the specified message appears in the Conversation window each time a user takes part in an instant messaging session. +For example, if IMWarning is set to "All information is the property of Litwareinc" then that message will appear in the Conversation window each time a user takes part in an instant messaging session. -Note that this setting does not apply to users whose email account is on Exchange 2003. -For those users, calendar retrieval is managed using MAPIPollInterval. +If set to a null value ($Null), then no message appears in the Conversation window. + +Your warning message should be limited to 256 characters, and can only contain plain text. +You cannot use any formatting (such as boldface or italics) and you cannot clickable URLs within the text. ```yaml -Type: TimeSpan +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1571,18 +1583,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -InMemory -Suppresses the display of any non-fatal error message that might occur when running the command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1591,18 +1604,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -MAPIPollInterval -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +> [!IMPORTANT] +> This parameter has been deprecated for use with Skype for Business Server. + +For users of Microsoft Exchange Server 2003, MAPIPollInterval specifies how often Skype for Business retrieves calendar data from the Exchange public folders. +MAPIPollInterval can be set to any value between 1 second and 1 hour; inclusive. +To configure the MAPI poll interval, use the format hours:minutes:seconds. +For example, this command sets the MAPI poll interval to 45 minutes: + +`-MapiPollInterval 00:45:00` ```yaml -Type: SwitchParameter +Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1611,18 +1632,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf +### -MaximumDGsAllowedInContactList + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum number of distribution groups that a user can configure as a contact. +MaximumDGsAllowedInContactList can be set to any integer value between 0 and 64, inclusive. +The default value is 10. -Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1631,18 +1656,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -MaximumNumberOfContacts -Prompts you for confirmation before executing the command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Indicates the maximum number of contacts a user is allowed to have. +The maximum contacts can be set to any integer value between 0 and 1000, inclusive. +When set to 0, that prevents the user from having any contacts. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1651,19 +1678,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableMeetingSubjectAndLocation +### -MaxPhotoSizeKB -When set to False, detailed information about a meeting -- namely, the meeting subject and the location where the meeting is being held -- will be displayed as a tooltip when you view free/busy information in a contact card. -When set to True, this detailed information will not be displayed. -To completely prevent the display of meeting-related information you should also set DisableCalendarPresence to True. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum size (in kilobytes) for photos displayed in Skype for Business. + +The default value is 30 kilobytes. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1672,19 +1700,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableNotificationForNewSubscribers +### -MusicOnHoldAudioFile + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Path to the audio file to be played when a caller is placed on hold. +If a value is configured for this property, then music on hold will be enabled and users will not be allowed to disable the feature. +If no value is configured for this property, then users can specify their own music-on-hold file, provided that EnableClientMusicOnHold is set to True. -When set to True, any time you are added to someone's Contacts list you will receive notification that you have been added to the list. -In addition, the notification dialog box will provide options for you to add this person to your Contacts list, or to block them from viewing your presence information. -When set to False, you will not be notified if you are added to someone's Contacts list. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1693,40 +1723,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableURL - -When set to True, hyperlinks embedded in an instant message will be "clickable;" that is, users can click that link and their web browser will open to the specified location. -When set to False, hyperlinks will appear in instant messages as plain text. -To navigate to the location, users will need to copy the link text and paste it into their web browser. +### -P2PAppSharingEncryption +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Indicates whether or not desktop and application sharing data exchanged during a peer-to-peer conversation is encrypted. +Allowed values are: -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Supported. +Desktop and application sharing data will be encrypted, if possible. -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Enforced. +Desktop and application sharing data must be encrypted. +If the data cannot be encrypted, then desktop and application sharing will not be enabled for the conversation. -### -MaxPhotoSizeKB +NotSupported. +Desktop and application sharing data will not be encrypted. -Indicates the maximum size (in kilobytes) for photos displayed in Skype for Business. -The default value is 30 kilobytes. ```yaml -Type: UInt32 +Type: P2PAppSharingEncryption Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1735,15 +1756,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMediaRedirection -When set to True ($True) allows audio and video streams to be separated from other network traffic; in turn, this allows client devices to do encoding and decoding of audio and video locally. -Media redirection typically results in lower bandwidth usage, higher server scalability, and a more-optimal user experience compared to similar techniques such as device remoting or codec compression. +### -PlayAbbreviatedDialTone + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, a 3-second dial tone will be played any time a Skype for Business-compatible handset is taken off the hook. +(A Skype for Business handset looks like a standard telephone, but plugs into a USB port on a computer and is used to make Skype for Business calls rather than "regular" phone calls.) When set to False, a 30-second dial tone is played any time a Skype for Business-compatible handset is taken off the hook. + + ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1752,16 +1777,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HelpEnvironment -When set to Office 365, the Skype for Business Online client help documentation for Skype for Business will be shown to users rather than the on-premises help shown by default. -You can either set HelpEnvironment to Office 365 or to a null value ($Null). -If set to a null value (the default value) then the on-premises help will be shown to users. +### -PolicyEntry + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Provides a way to add settings not covered by the default parameters. +For example, when testing pre-release versions of Lync 2010 it was possible to add a Send Feedback option to the user interface. +That was done by using code similar to this: + +`$x = New-CsClientPolicyEntry -Name "OnlineFeedbackURL" -Value "https://www.litwareinc.com/feedback"Set-CsClientPolicy -Identity global -PolicyEntry @{Add=$x}` + +For more details and examples, see the New-CsClientPolicyEntry cmdlet help topic. + + ```yaml -Type: String +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1770,24 +1803,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TracingLevel -Enables Administrators to manage event tracing and logging in Skype for Business. -Allowed values are: - -Off - Tracing is disabled and the user cannot change this setting. - -Light - Minimal tracing is performed, and the user cannot change this setting. - -Full - Verbose tracing is performed, and the user cannot change this setting. +### -PublicationBatchDelay -By default TracingLevel is set to Light. +> Applicable: Skype for Business Online +{{Fill PublicationBatchDelay Description}} ```yaml -Type: TracingLevel +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1796,14 +1821,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableClientAutoPopulateWithTeam -When set to true, allows a user's Skype client to be autopopulated with members of his or her immediate team. +### -RateMyCallAllowCustomUserFeedback + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, a free-text input field will be displayed in the Rate My Call window for users to submit custom feedback. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -1812,14 +1839,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableExchangeContactsFolder -When set to false, this allows admins to hide Skype for Business contacts from showing up in users' Outlook and Outlook on the Web clients. +### -RateMyCallDisplayPercentage + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter controls how often the form is shown. ```yaml -Type: Boolean +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -1828,15 +1857,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableHighPerformanceConferencingAppSharing -When set to True, enables better performance in applications (such as CAD/CAM applications) that have a high screen refresh rate. -However, this improved performance will reduce the system resources and network bandwidth available to other applications. +### -RequireContentPin + +> Applicable: Skype for Business Online + +{{Fill RequireContentPin Description}} ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1845,15 +1875,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableHighPerformanceP2PAppSharing -When set to True, allows a peer-to-peer application sharing session to exceed the maximum frame rate of 2.5 frames per second. -The default value is False. +### -SearchPrefixFlags + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Represents the Address Book attributes that should be used any time a user searches for a new contact. +The search prefix flags are constructed as a binary number like 11101111, in which a 1 indicates that the attribute should be searched and a 0 indicates that the attribute should not be searched. +The attributes in the binary value are (from right to left): + +Primary email address + +Email alias + +All email addresses + +Company + +Display name + +First name + +Last name + +The binary value 1110111 means that all attributes should be searched except attribute 4: Company. +To search only last name, first name, and display name you would construct this value: + +1110000 + +After the binary value has been constructed, it must then be converted to a decimal value before being assigned to SearchPrefixFlags. +To convert a binary number to a decimal number, you can use a Windows PowerShell command similar to this: + +`[Convert]::ToInt32("1110111", 2)` ```yaml -Type: Boolean +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1862,14 +1919,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMeetingEngagement -{{Fill EnableMeetingEngagement Description}} +### -ShowManagePrivacyRelationships + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, shows the Relationships option in the Skype for Business Contacts list window. +When set to False, hides the Relationships option. + +Note that this setting applies only to Lync 2010. +Skype for Business will not show these relationships even if ShowManagePrivacyRelationships has been set to True. + +The default value is False. + + ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -1878,14 +1945,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOnlineFeedback -When set to true, allows users to provide feedback through the "help->report a problem" menu options in the client. +### -ShowRecentContacts + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter currently has no effect on the client. + + ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -1894,14 +1965,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOnlineFeedbackScreenshots -When set to true, allows users to provide screenshots of their clients when reporting problems. +### -ShowSharepointPhotoEditLink + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True, Skype for Business will include a link that enables users to edit the personal photo stored on their SharePoint My Site. +The default value is False, which means that Skype for Business will not include a link to the SharePoint My Site. + + ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -1910,17 +1986,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableServerConversationHistory -When set to True ($True), allows conversation histories, missed call notifications, and missed IM notifications to be stored on the server instead of in client mailboxes. -This makes it easier for users to retrieve that information from a mobile device. +### -SPSearchCenterExternalURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +External URL for the SharePoint site used for keyword searches (also known as expert searches). +This URL will appear at the bottom of any keyword search results that appear in Skype for Business. +If the user clicks this URL, his or her web browser will open up to the SharePoint site, giving the user the opportunity to conduct searches using the search capabilities of SharePoint. +(SharePoint offers more search options than does Skype for Business.) + +SPSearchCenterExternalURL represents the URL for external users; that is, for users logging on from outside the organization's firewall. +The parameter SPSearchCenterInternalURL is for users who log on from inside the firewall. + -The default value is False ($False). ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1929,14 +2012,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSkypeUI -When set to True ($True), this parameter allows administrators to enable the Skype for Business user interface instead of the Lync interface for the Skype for Business client. +### -SPSearchCenterInternalURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Internal URL for the SharePoint site used for keyword searches (also known as expert searches). +This URL will appear at the bottom of any keyword search results that appear in Skype for Business. +If the user clicks this URL, his or her web browser will open up to the SharePoint site, giving the user the opportunity to conduct searches using the search capabilities of SharePoint. +(SharePoint offers more search options than Skype for Business does.) + +SPSearchCenterInternalURL represents the URL for internal users; that is, for users logging on from inside the organization's firewall. +The parameter SPSearchCenterExternalURL is for users who log on from outside the firewall. + + ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1945,14 +2038,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableViewBasedSubscriptionMode -{{Fill EnableViewBasedSubscriptionMode Description}} +### -SPSearchExternalURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +External URL for the SharePoint site used for keyword searches (also known as expert searches). +Skype for Business will use the SharePoint site located at this URL any time an external user (that is, a user who has accessed the system from outside the organization's firewall) conducts a keyword search. + + ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -1961,14 +2059,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IMLatencyErrorThreshold -If IM latency is greater than the threshold value (in milliseconds), the client will submit a CER. +### -SPSearchInternalURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Internal URL for the SharePoint site used for keyword searches (also known as expert searches). +Skype for Business will use the SharePoint site located at this URL any time an internal user (that is, a user who has logged on from inside the organization's firewall) conducts a keyword search. + + ```yaml -Type: UInt32 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1977,14 +2080,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IMLatencySpinnerDelay -Amount of time, in milliseconds, to wait before showing the spinner in the client when IM message delivery is delayed. +### -SupportModernFilePicker + +> Applicable: Skype for Business Online + +{{Fill SupportModernFilePicker Description}} ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1993,14 +2098,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PublicationBatchDelay -{{Fill PublicationBatchDelay Description}} +### -TabURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the location of the XML file used to create custom tabs located at the bottom of the Skype for Business Contacts list window. +This parameter has been deprecated for use with Skype for Business Server. + + ```yaml -Type: UInt32 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -2009,14 +2119,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RateMyCallAllowCustomUserFeedback -When set to True, a free-text input field will be displayed in the Rate My Call window for users to submit custom feedback. +### -TelemetryTier + +> Applicable: Skype for Business Online + +{{Fill TelemetryTier Description}} ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -2025,14 +2137,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RateMyCallDisplayPercentage -This parameter controls how often the form is shown. +### -Tenant + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new client policy is being created. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: UInt16 +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -2041,14 +2162,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequireContentPin -{{Fill RequireContentPin Description}} +### -TracingLevel + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables Administrators to manage event tracing and logging in Skype for Business. +Allowed values are: + +Off - Tracing is disabled and the user cannot change this setting. + +Light - Minimal tracing is performed, and the user cannot change this setting. + +Full - Verbose tracing is performed, and the user cannot change this setting. + +By default TracingLevel is set to Light. + ```yaml -Type: String +Type: TracingLevel Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -2057,14 +2190,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SupportModernFilePicker -{{Fill SupportModernFilePicker Description}} +### -WebServicePollInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +For users of Microsoft Exchange Server 2007 and later versions of the product, WebServicePollInterval specifies how often Skype for Business retrieves calendar data from Microsoft Exchange Server Web Services. +WebServicePollInterval can be set to any value between 1 second and 1 hour; inclusive. +To configure the Web Service poll interval, use the format hours:minutes:seconds. +For example, this command sets the Web Service poll interval to 45 minutes: + +`-WebServicePollInterval 00:45:00` + +Note that this setting does not apply to users whose email account is on Exchange 2003. +For those users, calendar retrieval is managed using MAPIPollInterval. + + ```yaml -Type: Boolean +Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -2073,14 +2218,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TelemetryTier -{{Fill TelemetryTier Description}} +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + + + ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -2089,21 +2239,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new client policy is being created. -For example: +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: -`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -2119,15 +2267,14 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ### None -### -None. +### None The New-CsClientPolicy cmdlet does not accept pipelined input. ## OUTPUTS ### System.Object -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Client.ClientPolicy The New-CsClientPolicy cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Client.ClientPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsClientPolicyEntry.md b/skype/skype-ps/SkypeForBusiness/New-CsClientPolicyEntry.md similarity index 92% rename from skype/skype-ps/skype/New-CsClientPolicyEntry.md rename to skype/skype-ps/SkypeForBusiness/New-CsClientPolicyEntry.md index 4fb43fb573..d8ba17567d 100644 --- a/skype/skype-ps/skype/New-CsClientPolicyEntry.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClientPolicyEntry.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csclientpolicyentry applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsClientPolicyEntry -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csclientpolicyentry +schema: 2.0.0 +title: New-CsClientPolicyEntry --- # New-CsClientPolicyEntry @@ -43,7 +44,7 @@ Instead, you will need to wait for notification from Microsoft regarding names a ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $x = New-CsClientPolicyEntry -Name "OnlineFeedbackURL" -Value "https://www.litwareinc.com/feedback" @@ -71,7 +72,7 @@ Finally, the last command in the example uses the Set-CsClientPolicy cmdlet to w If you do not call the Set-CsClientPolicy cmdlet, your changes will exist only in memory, and will disappear as soon as you end your Windows PowerShell session or delete the variable $x. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsClientPolicyEntry -Name "OnlineFeedbackURL" -Value "https://www.litwareinc.com/feedback" @@ -87,7 +88,7 @@ After the command finishes running the only item in the PolicyEntry property wil Any items contained in that property before the Set-CsClientPolicy cmdlet was called will have replaced by the new entry. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` $y = Get-CsClientPolicy -Identity global @@ -107,7 +108,7 @@ The syntax RemoveAt(0) means that the first policy entry will be removed. As soon as the policy entry has been removed from the in-memory instance of the global policy, the Set-CsClientPolicy cmdlet is then called in order to write these changes to the actual instance of the global client policy. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` Set-CsClientPolicy -Identity global -PolicyEntry $Null @@ -120,14 +121,16 @@ This is done by using the PolicyEntry parameter and setting the parameter value ## PARAMETERS ### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the new policy entry. For example: `-Name "OnlineFeedbackURL".` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -137,14 +140,16 @@ Accept wildcard characters: False ``` ### -Value + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Value to be assigned to the new policy entry. For example: `-Value https://www.litwareinc.com/feedback.` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -158,13 +163,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsClientPolicyEntry cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Client.PolicyEntryType The New-CsClientPolicyEntry cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Client.PolicyEntryType object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsClientVersionConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsClientVersionConfiguration.md similarity index 89% rename from skype/skype-ps/skype/New-CsClientVersionConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsClientVersionConfiguration.md index a361347d9f..05afa9bf27 100644 --- a/skype/skype-ps/skype/New-CsClientVersionConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClientVersionConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csclientversionconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsClientVersionConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csclientversionconfiguration +schema: 2.0.0 +title: New-CsClientVersionConfiguration --- # New-CsClientVersionConfiguration @@ -56,7 +57,7 @@ The technology relies on self-reporting from client applications, and does not a ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsClientVersionConfiguration -Identity site:Redmond -Enabled $False @@ -66,7 +67,7 @@ The command shown in Example 1 creates a new collection of client version config In this command, the Enabled parameter is set to False, which means that client filtering is disabled for the Redmond site. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsClientVersionConfiguration -Identity site:Redmond -InMemory @@ -86,25 +87,10 @@ In command 3, the Set-CsClientVersionConfiguration cmdlet is used to transform t ## PARAMETERS -### -Identity -Represents the unique identifier to be assigned to the new collection of client version configuration settings. -Because you can only create new collections at the site scope, the Identity will always be the prefix "site:" followed by the site name; for example "site:Redmond". -Note that the preceding command will fail if a collection of settings with the Identity site:Redmond already exists. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -DefaultAction -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -DefaultAction Indicates the action to be taken if a user tries to log on from a client application with a version number that cannot be found in the appropriate client version policy. DefaultAction must be set to one of the following values: @@ -130,8 +116,26 @@ When the Enabled property is set to False, then no client version filtering of a ```yaml Type: DefaultAction Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the URL of the webpage where users can download an approved client application. +If specified, and if the DefaultAction is set to BlockWithUrl, this URL will appear in the "Access denied" message box displayed any time a user tries to log on from an unsupported client application. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -141,6 +145,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether client version filtering is enabled or disabled. If the Enabled property is True, the server will check the version number of each client application that attempts to log on; the server will then allow or deny access based on the appropriate client version policy. If the Enabled property is False, then any client application capable of logging on will be allowed to log on. @@ -150,8 +157,7 @@ The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -161,13 +167,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -176,34 +184,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory - -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Represents the unique identifier to be assigned to the new collection of client version configuration settings. +Because you can only create new collections at the site scope, the Identity will always be the prefix "site:" followed by the site name; for example "site:Redmond". +Note that the preceding command will fail if a collection of settings with the Identity site:Redmond already exists. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -213,13 +226,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -228,15 +243,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DefaultURL -Specifies the URL of the webpage where users can download an approved client application. -If specified, and if the DefaultAction is set to BlockWithUrl, this URL will appear in the "Access denied" message box displayed any time a user tries to log on from an unsupported client application. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -250,13 +266,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsClientVersionConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionConfiguration Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsClientVersionPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsClientVersionPolicy.md similarity index 89% rename from skype/skype-ps/skype/New-CsClientVersionPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsClientVersionPolicy.md index d8e270a440..3a9bfe6142 100644 --- a/skype/skype-ps/skype/New-CsClientVersionPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClientVersionPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csclientversionpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsClientVersionPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csclientversionpolicy +schema: 2.0.0 +title: New-CsClientVersionPolicy --- # New-CsClientVersionPolicy @@ -56,7 +57,7 @@ Client version policies enforced in your organization do not override the client ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsClientVersionPolicy -Identity site:Redmond @@ -66,7 +67,7 @@ In Example 1, a new client version policy is created for the Redmond site. Because no parameters are specified (other than the mandatory Identity parameter), the new policy will contain all of the default values for a client version policy. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsSite | Select-Object Identity | ForEach-Object {New-CsClientVersionPolicy -Identity ("site:" + $_.Identity)} @@ -80,8 +81,47 @@ Those Identities are then piped to the ForEach-Object cmdlet, which takes each s ## PARAMETERS +### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to provide explanatory text about the policy. +For example, you might include information about the users that the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the policy to be created. To create a policy at the site scope, use syntax similar to this: `-Identity "site:Redmond".` To create a policy at the service scope, use syntax similar to this: `-Identity "Registrar:atl-cs-001.litwareinc.com".` @@ -95,8 +135,7 @@ To create a per-user policy, use syntax similar to this: `-Identity "SalesDepart ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -105,15 +144,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables you to provide explanatory text about the policy. -For example, you might include information about the users that the policy should be assigned to. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -124,6 +167,8 @@ Accept wildcard characters: False ### -Rules +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Collection of client version policy rules. You can add and remove rules from a policy by using the New-CsClientVersionPolicyRule cmdlet and the Remove-CsClientVersionPolicyRule cmdlet. To add a rule at the time you create the new policy, create the rule and store the value in a variable (for example, $x). @@ -136,8 +181,7 @@ You can then use syntax similar to this when creating the new policy: ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -146,34 +190,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new client version policy is being created. +For example: -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,30 +215,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -214,21 +233,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new client version policy is being created. -For example: +### -WhatIf -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: - -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -242,13 +256,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The Get-CsClientVersionPolicy cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionPolicy The New-CsClientVersionPolicy cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsClientVersionPolicyRule.md b/skype/skype-ps/SkypeForBusiness/New-CsClientVersionPolicyRule.md similarity index 87% rename from skype/skype-ps/skype/New-CsClientVersionPolicyRule.md rename to skype/skype-ps/SkypeForBusiness/New-CsClientVersionPolicyRule.md index 2cb0dc194e..1287ad4b80 100644 --- a/skype/skype-ps/skype/New-CsClientVersionPolicyRule.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClientVersionPolicyRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csclientversionpolicyrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsClientVersionPolicyRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csclientversionpolicyrule +schema: 2.0.0 +title: New-CsClientVersionPolicyRule --- # New-CsClientVersionPolicyRule @@ -87,7 +88,7 @@ Client version policies enforced in your organization do not override the client ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $x = [guid]::NewGuid() @@ -105,7 +106,7 @@ This command uses four parameters: Parent, with a parameter value representing t In this case, the UserAgent parameter represents an in-house client application. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = [guid]::NewGuid() @@ -130,84 +131,10 @@ When those tasks are complete, the final command in the example and the Set-CsCl ## PARAMETERS -### -Identity - -Unique identifier for the client version policy rule to be created. -The Identity of a client version policy rule consists of the scope where the rule has been configured plus a globally unique identifier (GUID). -That means that a rule will have an Identity similar to this: site:Redmond/1987d3c2-4544-489d-bbe3-59f79f530a83. - -Instead of using the Identity parameter you can use the Parent and RuleId parameters to have the New-CsClientVerisonPolicyRule cmdlet create the Identity for you. - - - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MajorVersion -Major version of the software. -For example, if your copy of Communicator is version 2.0.6362.111, then the MajorVersion is 2. -Major versions equate to primary releases of the software. -You must assign a value to the MajorVersion property any time you create a new rule. - -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MinorVersion -Minor version of the software. -For example, if your copy of Communicator is version 2.0.6362.111, then the MinorVersion is 0. -Minor versions equate to interim releases of the software. - -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserAgent -Designator used to identify the software client. -For example, OC is the user agent designation for Communicator. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Action -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Action Action to be taken any time the rule is triggered (that is, any time someone attempts to log on by using the specified software). Valid values are: @@ -233,8 +160,7 @@ The user can then try to log on by using the new client application. ```yaml Type: Action Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -244,14 +170,16 @@ Accept wildcard characters: False ``` ### -ActionUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URL where users can download the latest version of Lync. This property is required if the Action is set to BlockWithUrl or AllowWithUrl. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -261,6 +189,9 @@ Accept wildcard characters: False ``` ### -BuildNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Build number of the software. For example, if your copy of Communicator is version 2.0.6362.111, then the BuildNumber is 6362. Build numbers represent internal versions of the software during the development process, and help to ensure that you are using the final release version as opposed to a pre-release version. @@ -268,8 +199,7 @@ Build numbers represent internal versions of the software during the development ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -279,6 +209,9 @@ Accept wildcard characters: False ``` ### -CompareOp + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Comparison operator used to determine if the client software attempting to log on was released before, after, or at the same time as the version specified in the rule. Valid values are: @@ -297,8 +230,7 @@ LEQ (less than or equal to) ```yaml Type: CompareOp Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -308,14 +240,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to provide additional information about the client version rule. For example, the Description might include information about who to contact if you believe the rule should be changed. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -325,6 +259,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether or not the client version rule is to be used. If the Enabled property is set to False ($False), then the rule will be ignored any time a user attempts to log on with the specified software. The default value is True. @@ -332,8 +269,111 @@ The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the client version policy rule to be created. +The Identity of a client version policy rule consists of the scope where the rule has been configured plus a globally unique identifier (GUID). +That means that a rule will have an Identity similar to this: site:Redmond/1987d3c2-4544-489d-bbe3-59f79f530a83. + +Instead of using the Identity parameter you can use the Parent and RuleId parameters to have the New-CsClientVerisonPolicyRule cmdlet create the Identity for you. + + + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MajorVersion + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Major version of the software. +For example, if your copy of Communicator is version 2.0.6362.111, then the MajorVersion is 2. +Major versions equate to primary releases of the software. +You must assign a value to the MajorVersion property any time you create a new rule. + +```yaml +Type: UInt16 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -MinorVersion + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Minor version of the software. +For example, if your copy of Communicator is version 2.0.6362.111, then the MinorVersion is 0. +Minor versions equate to interim releases of the software. + +```yaml +Type: UInt16 +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -344,6 +384,8 @@ Accept wildcard characters: False ### -Parent +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Scope information for the new rule. To use the Parent parameter and create a new rule for the global policy, use this syntax: `-Parent global.` To create a new rule for a site policy, use syntax similar to this: `-Parent "site:Redmond".` @@ -357,8 +399,7 @@ You must use either the Identity parameter or both the Parent and RuleId paramet ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -368,6 +409,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Relative priority of the rule. Rules are processed in priority order, with the rule that has priority 0 being processed first, the rule that has priority 1 being processed second, and so on. If you assign a priority that is already in use, the new rule will use that priority and other rules will be renumbered accordingly. @@ -375,8 +419,7 @@ If you assign a priority that is already in use, the new rule will use that prio ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -386,6 +429,9 @@ Accept wildcard characters: False ``` ### -QfeNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Quick fix engineering number of the software. For example, if your copy of Communicator is version 2.0.6362.111, then the QfeNumber is 111. QFE numbers represent planned updates to an application that are made available after the software's official release. @@ -393,8 +439,7 @@ QFE numbers represent planned updates to an application that are made available ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -404,6 +449,9 @@ Accept wildcard characters: False ``` ### -RuleId + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) for the rule. In Windows PowerShell, you can create a GUID by using the following command: @@ -412,8 +460,7 @@ In Windows PowerShell, you can create a GUID by using the following command: ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -422,34 +469,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Tenant -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -InMemory +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new client version policy rule is being created. +For example: -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -458,14 +494,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -UserAgent + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Designator used to identify the software client. +For example, OC is the user agent designation for Communicator. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -474,14 +513,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -UserAgentFullName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to provide a friendly name for the user agent. +For example, instead of relying on the user agent UCCP to identify the agent administrators might spell the name out in full: Microsoft Unified Communications Client. + + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -490,18 +534,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserAgentFullName - -Enables administrators to provide a friendly name for the user agent. -For example, instead of relying on the user agent UCCP to identify the agent administrators might spell the name out in full: Microsoft Unified Communications Client. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -510,21 +552,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new client version policy rule is being created. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -538,13 +575,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsClientVersionPolicyRule cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.Rule The New-CsClientVersionPolicyRule cmdlet creates new instances of Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.Rule object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsCloudCallDataConnectorConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsCloudCallDataConnectorConfiguration.md similarity index 94% rename from skype/skype-ps/skype/New-CsCloudCallDataConnectorConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsCloudCallDataConnectorConfiguration.md index 9508f13493..ca597b0ac9 100644 --- a/skype/skype-ps/skype/New-CsCloudCallDataConnectorConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsCloudCallDataConnectorConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cscloudcalldataconnectorconfiguration applicable: Skype for Business Server 2019 -title: New-CsCloudCallDataConnectorConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cscloudcalldataconnectorconfiguration +schema: 2.0.0 +title: New-CsCloudCallDataConnectorConfiguration --- # New-CsCloudCallDataConnectorConfiguration @@ -55,29 +56,16 @@ If the Set-CsCloudCallDataConnectorConfiguration cmdlet was not called, the virt ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -EnableCallDataConnector -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2019 -### -EnableCallDataConnector Enables upload of call data (CDR and QoE). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -86,13 +74,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -101,13 +91,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2019 + Represents the unique identifier to be assigned to the new collection of CloudCallDataConnector configuration settings. Because you can only create new collections at the site scope, the Identity will always be the prefix "site:" followed by the site name; for example, "site:Redmond". ```yaml Type: XdsIdentity Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: True Position: 1 Default value: None @@ -116,13 +108,32 @@ Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2019 + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named Default value: None @@ -131,6 +142,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -138,7 +152,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None diff --git a/skype/skype-ps/skype/New-CsClsConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsClsConfiguration.md similarity index 83% rename from skype/skype-ps/skype/New-CsClsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsClsConfiguration.md index 123753063b..bbe0b89ed2 100644 --- a/skype/skype-ps/skype/New-CsClsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csclsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsClsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csclsconfiguration +schema: 2.0.0 +title: New-CsClsConfiguration --- # New-CsClsConfiguration @@ -55,7 +56,7 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsClsConfiguration -Identity "site:Redmond" -EtlFileRolloverSizeMB 40 -EtlFileRolloverMinutes 120 @@ -67,26 +68,10 @@ In this new collection, the ETL file rollover size is set to 40 megabytes, and t ## PARAMETERS -### -Identity -Unique identifier for the centralized logging configuration settings to be created. -Because these settings can only be created at the site scope, use syntax similar to this, with the prefix "site:" followed by the name of the site: - -`-Identity "site:Redmond"` +### -CacheFileLocalFolders -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CacheFileLocalFolders One or more full paths to the local folders where the cache files will be stored. The default value is %TEMP%\Tracing. If more than one path is specified, then separate them with semi-colons. @@ -94,8 +79,7 @@ If more than one path is specified, then separate them with semi-colons. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -105,14 +89,16 @@ Accept wildcard characters: False ``` ### -CacheFileLocalMaxDiskUsage + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum amount of disk space (percentage) that can be used for the cache files. The default value is 80. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,14 +108,16 @@ Accept wildcard characters: False ``` ### -CacheFileLocalRetentionPeriod + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum number of days that cache files are retained locally. The default value is 14. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,14 +127,16 @@ Accept wildcard characters: False ``` ### -CacheFileNetworkFolder + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Full UNC path to the network cache folder. There is no default value. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -156,14 +146,16 @@ Accept wildcard characters: False ``` ### -ComponentThrottleLimit + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum rate at which a component is allowed to generate trace records before its tracing is throttled. The default value is 5000 trace calls per second. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -173,14 +165,16 @@ Accept wildcard characters: False ``` ### -ComponentThrottleSample + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum number of times the ComponentThrottleLimit can be exceeded within a one minute interval. The default value is 3. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -189,23 +183,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -EtlFileFolder -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -EtlFileFolder Full path to the folder where the event log trace files will be stored. The default value is %TEMP%\Tracing. Note that %TEMP% is evaluated in the contents of the CLS Service so it actual expands to %WINDIR%\ServiceProfiles\NetworkService\AppData\Local @@ -213,8 +194,7 @@ Note that %TEMP% is evaluated in the contents of the CLS Service so it actual ex ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -224,14 +204,16 @@ Accept wildcard characters: False ``` ### -EtlFileRolloverMinutes + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum amount of time (in minutes) that can elapse before a new event log trace file is created. (This new file will be created even if the existing trace file has not reached the specified rollover size.) The default value is 60. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -241,14 +223,16 @@ Accept wildcard characters: False ``` ### -EtlFileRolloverSizeMB + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum size (in megabytes) that at event trace log file can reach before a new file is created. The default value is 20. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -258,13 +242,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -273,15 +259,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the centralized logging configuration settings to be created. +Because these settings can only be created at the site scope, use syntax similar to this, with the prefix "site:" followed by the name of the site: + +`-Identity "site:Redmond"` + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -292,6 +301,8 @@ Accept wildcard characters: False ### -MinimumClsAgentServiceVersion +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the minimum version of the centralized logging service agent to be used when logging data; any computers with an agent version lower than the minimum value will be excluded from the logging operations. The default value is 6, representing Skype for Business Server. This parameter is intended for use with Skype for Business Online. @@ -301,8 +312,45 @@ This parameter is intended for use with Skype for Business Online. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkUsagePacketSize + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Packet size (in kilobytes) for transmitting agent search results and copying cache files over the network. +The default value is 64 KB. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -NetworkUsageThreshold + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Bandwidth usage threshold (in MB per second) for transmitting agent search results and copying cache files over the network. +The default value is 10. + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -313,6 +361,8 @@ Accept wildcard characters: False ### -Regions +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Collection of regions defined for the centralized logging configuration settings. Regions are defined using the New-CsClsRegion cmdlet. @@ -323,8 +373,7 @@ This parameter is intended for use with Skype for Business Online. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -334,14 +383,16 @@ Accept wildcard characters: False ``` ### -Scenarios + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Collection of components/situations that can be traced using centralized logging. Scenarios are managed using the CsClsScenario cmdlets. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -351,14 +402,16 @@ Accept wildcard characters: False ``` ### -SearchTerms + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Collection of terms that help determine the personally identifiable information available to technical support personnel who search the centralized logging files. Search terms are managed using the CsClsSearchTerm cmdlets. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -369,6 +422,8 @@ Accept wildcard characters: False ### -SecurityGroups +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Security groups who are allowed to access the log files. This parameter is intended for use with Skype for Business Online. @@ -378,8 +433,7 @@ This parameter is intended for use with Skype for Business Online. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -389,14 +443,16 @@ Accept wildcard characters: False ``` ### -TmfFileSearchPath + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Search path for TMF (trace message format) files. TMF files convert binary trace messages to a human-readable format. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -405,31 +461,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Version -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -NetworkUsagePacketSize -Packet size (in kilobytes) for transmitting agent search results and copying cache files over the network. -The default value is 64 KB. +This parameter is reserved for internal Microsoft use. ```yaml -Type: UInt32 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -438,15 +479,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkUsageThreshold -Bandwidth usage threshold (in MB per second) for transmitting agent search results and copying cache files over the network. -The default value is 10. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: UInt32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -455,14 +497,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Version -This parameter is reserved for internal Microsoft use. +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -476,13 +520,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsClsConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.CentralizedLoggingConfiguration The New-CsClsConfiguration cmdlet creates new instances of the icrosoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.CentralizedLoggingConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsClsProvider.md b/skype/skype-ps/SkypeForBusiness/New-CsClsProvider.md similarity index 89% rename from skype/skype-ps/skype/New-CsClsProvider.md rename to skype/skype-ps/SkypeForBusiness/New-CsClsProvider.md index 33da9f6a09..40c3123438 100644 --- a/skype/skype-ps/skype/New-CsClsProvider.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClsProvider.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csclsprovider applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csclsprovider +schema: 2.0.0 --- # New-CsClsProvider @@ -48,7 +49,7 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $provider = New-CsClsProvider -Name "WebInfrastructure" -Type "WPP" -Level "Warning" -Flags "All" @@ -61,7 +62,7 @@ To do this, the first command in the example uses the New-CsClsProvider cmdlet t The second command in the example then adds this new provider to the scenario site:Redmond/WAC. Because the command uses the syntax @{Add=$provider} the new provider will be added to the WAC scenario in addition to any other providers already configured for that -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $provider = New-CsClsProvider -Name "WebInfrastructure" -Type "WPP" -Level "Warning" -Flags "All" @@ -77,6 +78,9 @@ This is done by using the syntax @{Replace=$provider}. ## PARAMETERS ### -Flags + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies individual protocols and subcomponents involved in the trace. For example, the SipStack provider includes the following flags: TF_COMPONENT, TF_RTCHTTP, TF_CONNECTION, TF_DIAG. @@ -85,8 +89,7 @@ Most providers are configured to use all available flags. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -95,8 +98,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Guid + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Globally unique identifier assigned to the provider. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Level +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Tracing level for events recorded by the provider: Allowed values are: * Fatal @@ -111,8 +134,7 @@ Tracing level for events recorded by the provider: Allowed values are: ```yaml Type: ProviderLevel Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -122,13 +144,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique name for the new provider. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -137,62 +161,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Type - -Type of tracing used by the provider. -Allowed values are: - -WPP (Windows software trace preprocessor) +### -Role -EventLog +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -IISLog +Skype for Business Server server role for the provider. +For example, FE for Front End server or Edge for Edge Server. ```yaml -Type: ProviderType +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Guid -Globally unique identifier assigned to the provider. +### -Type -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Type of tracing used by the provider. +Allowed values are: -### -Role +WPP (Windows software trace preprocessor) -Skype for Business Server server role for the provider. -For example, FE for Front End server or Edge for Edge Server. +EventLog + +IISLog ```yaml -Type: String +Type: ProviderType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -204,13 +214,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The New-CsClsProvider cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Provider The New-CsClsProvider cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Provider object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsClsRegion.md b/skype/skype-ps/SkypeForBusiness/New-CsClsRegion.md similarity index 86% rename from skype/skype-ps/skype/New-CsClsRegion.md rename to skype/skype-ps/SkypeForBusiness/New-CsClsRegion.md index e25b134904..88863d80a0 100644 --- a/skype/skype-ps/skype/New-CsClsRegion.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClsRegion.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csclsregion applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csclsregion +schema: 2.0.0 --- # New-CsClsRegion @@ -49,7 +50,7 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsClsRegion -Identity "global/Europe" -SecurityGroupSuffix "EMEA" -OtherRegionAccess "global/US" @@ -61,7 +62,28 @@ The new region uses the security group suffix EMEA and also allows access by the ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the new region. Region Identities consist of the centralized logging configuration scope where the region will be created plus a unique region name. For example, to create a global region named Redmond use this syntax: @@ -73,8 +95,7 @@ If you use the Identity parameter then you cannot use either the name parameter ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -83,7 +104,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique name for the new region. For example: @@ -95,8 +138,7 @@ However, you should not use the Identity parameter in the same command as the Na ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -106,13 +148,15 @@ Accept wildcard characters: False ``` ### -OtherRegionAccess + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of an additional region that can be accessed by authorized users for this region. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -122,6 +166,9 @@ Accept wildcard characters: False ``` ### -Parent + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Scope of the centralized logging configuration settings where the new region will be located. For example, to add the new region to the global settings, use this syntax: @@ -137,8 +184,7 @@ However, you should not use the Identity parameter in the same command as the Na ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -148,13 +194,15 @@ Accept wildcard characters: False ``` ### -SecurityGroupSuffix + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suffix to be added to the end of the name of any security group that will be authorized for this region. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -163,47 +211,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### -Sites -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Sites contained within this region. +These correspond to the SiteId attribute values in the topology document. -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -212,18 +232,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Sites - -Sites contained within this region. -These correspond to the SiteId attribute values in the topology document. +### -Confirm +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -233,13 +251,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -253,13 +273,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The New-CsClsRegion cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Region The New-CsClsRegion cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Region#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsClsScenario.md b/skype/skype-ps/SkypeForBusiness/New-CsClsScenario.md similarity index 88% rename from skype/skype-ps/skype/New-CsClsScenario.md rename to skype/skype-ps/SkypeForBusiness/New-CsClsScenario.md index c8ab273146..9e260f7a32 100644 --- a/skype/skype-ps/skype/New-CsClsScenario.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClsScenario.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csclsscenario applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csclsscenario +schema: 2.0.0 --- # New-CsClsScenario @@ -51,7 +52,7 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- (Lync Server 2013) +### Example 1 (Lync Server 2013) ``` $provider = New-CsClsProvider -Name "RedmondHybridVoice" -Type "WPP" -Level "Info" -Flags "All" @@ -65,7 +66,7 @@ After the description and the provider have been created, the final command in t -### -------------------------- Example 1 -------------------------- (Skype for Business Server 2015) +### Example 1 (Skype for Business Server 2015) ``` $provider = New-CsClsProvider -Name "RedmondHybridVoice" -Type "WPP" -Level "Info" -Flags "All" @@ -81,7 +82,28 @@ After the description and the provider have been created, the final command in t ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the new scenario. A scenario consists of two parts: the scope where the scenario is configured (that is, the collection of centralized logging configuration settings where the scenario can be found) and the scenario name. For example: @@ -93,8 +115,7 @@ If you use the Identity parameter then you cannot use either the name parameter ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -103,7 +124,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique name for the new scenario. For example: @@ -115,8 +160,7 @@ However, you should not use the Identity parameter in the same command as the Na ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -126,6 +170,9 @@ Accept wildcard characters: False ``` ### -Parent + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Scope of the centralized logging configuration settings where the new scenario will be located. For example, to add the new scenario to the global settings, use this syntax: @@ -141,8 +188,7 @@ However, you should not use the Identity parameter in the same command as the Na ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -151,30 +197,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Provider -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Logging provider for the scenario. +New providers must be created using the New-CsClsProvider cmdlet. +For example: -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +`$provider = New-CsClsProvider -Name "UserServices" -Type "WPP" -Level "Info" -Flags "All"` ```yaml -Type: SwitchParameter +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -183,18 +219,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory - -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -Confirm +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -203,34 +237,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Provider -Logging provider for the scenario. -New providers must be created using the New-CsClsProvider cmdlet. -For example: - -`$provider = New-CsClsProvider -Name "UserServices" -Type "WPP" -Level "Info" -Flags "All"` - -```yaml -Type: PSListModifier -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -244,13 +260,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The New-CsClsScenario cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Scenario#Decorated The New-CsClsScenario cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Scenario#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsClsSecurityGroup.md b/skype/skype-ps/SkypeForBusiness/New-CsClsSecurityGroup.md similarity index 87% rename from skype/skype-ps/skype/New-CsClsSecurityGroup.md rename to skype/skype-ps/SkypeForBusiness/New-CsClsSecurityGroup.md index 6e4d1cada3..236480e69c 100644 --- a/skype/skype-ps/skype/New-CsClsSecurityGroup.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsClsSecurityGroup.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csclssecuritygroup applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csclssecuritygroup +schema: 2.0.0 --- # New-CsClsSecurityGroup @@ -49,7 +50,7 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsClsSecurityGroup -Identity "global/HelpDesk" -AccessLevel "Tier3" @@ -61,6 +62,9 @@ In this example, the AccessLevel property is set to Tier3. ## PARAMETERS ### -AccessLevel + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + String value specifying the access level assigned to the group. Access levels are arbitrary string values assigned by administrators and used to categorize security groups. For example: @@ -73,8 +77,7 @@ Currently the only values that have meaning are "Tier3", "Tier2", "Product", "Op ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -83,7 +86,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the new security group. Security group Identities consist of the centralized logging configuration scope where the group will be created plus a unique security group name. For example, to create a global security group named HelpDesk use this syntax: @@ -95,8 +119,7 @@ If you use the Identity parameter then you cannot use either the name parameter ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -105,7 +128,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique name for the new security group. For example: @@ -117,8 +162,7 @@ However, you should not use the Identity parameter in the same command as the Na ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -128,6 +172,9 @@ Accept wildcard characters: False ``` ### -Parent + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Scope of the centralized logging configuration settings where the new security group will be located. For example, to add the new security group to the global settings, use this syntax: @@ -143,8 +190,7 @@ However, you should not use the Identity parameter in the same command as the Na ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -154,29 +200,15 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -185,31 +217,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -223,13 +240,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The New-CsClsSecurityGroup cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.SecurityGroup#Decorated The New-CsClsSecurityGroup cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.SecurityGroup#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsCommonAreaPhone.md b/skype/skype-ps/SkypeForBusiness/New-CsCommonAreaPhone.md similarity index 87% rename from skype/skype-ps/skype/New-CsCommonAreaPhone.md rename to skype/skype-ps/SkypeForBusiness/New-CsCommonAreaPhone.md index 948f235f55..e0999c3120 100644 --- a/skype/skype-ps/skype/New-CsCommonAreaPhone.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsCommonAreaPhone.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cscommonareaphone applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cscommonareaphone +schema: 2.0.0 --- # New-CsCommonAreaPhone @@ -58,7 +59,7 @@ For more details, see the OU and the DN parameter descriptions in this topic. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsCommonAreaPhone -LineUri tel:+14255556710 -RegistrarPool redmond-cs-001.litwareinc.com -DisplayName "Building 14 Lobby" -OU "ou=Telecommunications,dc=litwareinc,dc=com" @@ -68,7 +69,7 @@ The command shown in Example 1 creates a new common area phone for the phone num (Note that the LineUri must be specified using the E.164 format.) In addition to specifying the phone number, the command also specifies the Registrar pool (RegistrarPool); the Active Directory display name (DisplayName); and the distinguished name of the OU where the corresponding contact object should be created (OU). -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsCommonAreaPhone -LineUri tel:+14255556710 -RegistrarPool redmond-cs-001.litwareinc.com -DN "cn=Building 14 Lobby,ou=Telecommunications,dc=litwareinc,dc=com" @@ -82,51 +83,17 @@ In this command the DisplayName is also left out, which means that the new commo ## PARAMETERS -### -LineUri -Phone number for the common area phone. -The line Uniform Resource Identifier (URI) should be specified using the E.164 format, and be prefixed by the "TEL:" prefix. -For example: TEL:+14255551297. -Any extension number should be added to the end of the line URI, for example: TEL:+14255551297;ext=51297. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RegistrarPool -Fully qualified domain name (FQDN) of the Registrar pool where the contact object should be homed. -For example: `-RegistrarPool "atl-cs-001.litwareinc.com".` - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Description -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Description Enables you to set the Active Directory Description attribute for the common area phone. In turn, this provides a way for you to supply additional information about the phone; for example, you might want to provide details about who to contact in case of problems with the phone. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -136,13 +103,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to set the Active Directory display name of the common area phone. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -153,6 +122,8 @@ Accept wildcard characters: False ### -DisplayNumber +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Phone number as displayed in Skype for Business. The DisplayNumber property can be formatted any way you prefer; for example 1-800-555-1234; 1-(800)-555-1234; 1.800.555.1234; and so on. When choosing a display number, keep in mind that this number will be shown on the display screen of the common area phone only if the number can be normalized. @@ -163,8 +134,7 @@ When choosing a display number, keep in mind that this number will be shown on t ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,6 +145,8 @@ Accept wildcard characters: False ### -DN +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to associate an existing Active Directory contact object with the new common area phone. If you have a contact object you want to associate with a common area phone, use the DN parameter followed by the distinguished name of that contact. For example: -DN "cn=Building 14 Lobby,dc=litwareinc,dc=com". @@ -193,8 +165,28 @@ You cannot use the OU and the DN parameters in the same command. ```yaml Type: ADObjectId Parameter Sets: DN -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LineUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Phone number for the common area phone. +The line Uniform Resource Identifier (URI) should be specified using the E.164 format, and be prefixed by the "TEL:" prefix. +For example: TEL:+14255551297. +Any extension number should be added to the end of the line URI, for example: TEL:+14255551297;ext=51297. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: True Position: Named @@ -204,6 +196,9 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Distinguished name of the Active Directory organizational unit (OU) where the contact object should be located. For example: `-OU "ou=Redmond,dc=litwareinc,dc=com".` @@ -213,8 +208,7 @@ As a result, the contact object will have a name similar to this: {ce84964a-c4da ```yaml Type: OUIdParameter Parameter Sets: OU -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -223,19 +217,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipAddress - -Unique identifier that allows the common area phone to communicate with SIP devices such as Skype for Business. -The SIP address must be prefaced by the prefix "sip:" and must include a valid SIP domain. -For example: sip:bldg14lobby@litwareinc.com. +### -PassThru +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Returns an object representing the common area phone. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -244,30 +235,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Returns an object representing the common area phone. +### -RegistrarPool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the Registrar pool where the contact object should be homed. +For example: `-RegistrarPool "atl-cs-001.litwareinc.com".` ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier that allows the common area phone to communicate with SIP devices such as Skype for Business. +The SIP address must be prefaced by the prefix "sip:" and must include a valid SIP domain. +For example: sip:bldg14lobby@litwareinc.com. + + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -277,13 +277,33 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -297,13 +317,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The New-CsCommonAreaPhone cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact The New-CsCommonAreaPhone cmdlet creates new instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsConferenceDirectory.md b/skype/skype-ps/SkypeForBusiness/New-CsConferenceDirectory.md similarity index 85% rename from skype/skype-ps/skype/New-CsConferenceDirectory.md rename to skype/skype-ps/SkypeForBusiness/New-CsConferenceDirectory.md index 4a9c8747e0..13d43adccf 100644 --- a/skype/skype-ps/skype/New-CsConferenceDirectory.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsConferenceDirectory.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csconferencedirectory applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csconferencedirectory +schema: 2.0.0 --- # New-CsConferenceDirectory @@ -40,7 +41,7 @@ New conference directories can be created by calling the New-CsConferenceDirecto ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsConferenceDirectory -Identity 42 -HomePool "atl-cs-001.litwareinc.com" @@ -51,34 +52,35 @@ This directory will be hosted on the pool atl-cs-001.litwareinc.com. ## PARAMETERS -### -Identity -Unique numeric identifier for the new conference directory. -Identities can be any integer value between 0 and 9999 inclusive; however, Identities must be unique. -(For example, you cannot have two directories with the Identity 575.) You do not need to follow a numeric order when creating new directories. -For example, you can create a directory with the Identity 999 followed by a directory with the Identity 2 followed by a directory with the Identity 438, and so on. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: XdsGlobalRelativeIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` ### -HomePool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the Registrar pool where the new conference directory will be hosted. For example: `-Identity atl-cs-001.litwareinc.com.` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -87,30 +89,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique numeric identifier for the new conference directory. +Identities can be any integer value between 0 and 9999 inclusive; however, Identities must be unique. +(For example, you cannot have two directories with the Identity 575.) You do not need to follow a numeric order when creating new directories. +For example, you can create a directory with the Identity 999 followed by a directory with the Identity 2 followed by a directory with the Identity 438, and so on. ```yaml -Type: SwitchParameter +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -119,14 +128,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -140,13 +151,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The New-CsConferenceDirectory cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.PstnConf.ConferenceDirectories Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PstnConf.ConferenceDirectories object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsConferencingConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsConferencingConfiguration.md similarity index 83% rename from skype/skype-ps/skype/New-CsConferencingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsConferencingConfiguration.md index dd911eb816..c28db76dba 100644 --- a/skype/skype-ps/skype/New-CsConferencingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsConferencingConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csconferencingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csconferencingconfiguration +schema: 2.0.0 --- # New-CsConferencingConfiguration @@ -58,7 +59,7 @@ If you try to create new settings for the Redmond site and the Redmond site alre ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsConferencingConfiguration -Identity site:Redmond -Organization Litwareinc @@ -69,7 +70,7 @@ In this example, one additional parameter is included (Organization) which is us Note that this command will fail if the Redmond site already has a collection of conferencing configuration settings. That's because you can have only one such collection per site. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsConferencingConfiguration -Identity site:Redmond -InMemory @@ -90,26 +91,10 @@ Instead, they will disappear as soon as you end your Windows PowerShell session ## PARAMETERS -### -Identity -Unique identifier for the collection of conferencing configuration settings to be modified. -To refer to a collection configured at the site scope, use syntax similar to this: `-Identity "site:Redmond".` -To refer to a collection at the service scope, use syntax like the following: `-Identity "service:ConferencingServer:atl-cs-001.litwareinc.com".` -Note the Web Conferencing service is the only service that can host these configuration settings. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -ClientAppSharingPort -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -ClientAppSharingPort Represents the starting port number used for application sharing. The ClientAppSharingPort must be a value port number between 1024 and 65535, inclusive. The default value is 5350. @@ -117,8 +102,7 @@ The default value is 5350. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,6 +112,9 @@ Accept wildcard characters: False ``` ### -ClientAppSharingPortRange + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the total number of ports available for application sharing. (The default value is 40.) To determine the actual ports used for application sharing, use this value and the ClientAppSharingPort value. For example, if ClientAppSharingPort is set to 5350 and ClientAppSharingPortRange is set to 3, then the following 3 ports are available for application sharing: 5350; 5351; 5352. @@ -135,8 +122,7 @@ For example, if ClientAppSharingPort is set to 5350 and ClientAppSharingPortRang ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -146,6 +132,9 @@ Accept wildcard characters: False ``` ### -ClientAudioPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the starting port number used for client audio. The ClientAudioPort must be a value port number between 1024 and 65535, inclusive. The default value is 5350. @@ -153,8 +142,7 @@ The default value is 5350. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -164,6 +152,9 @@ Accept wildcard characters: False ``` ### -ClientAudioPortRange + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the total number of ports available for client audio. (The default value is 40.) To determine the actual ports used for client audio, use this value and the ClientAudioPort value. For example, if ClientAudioPort is set to 5350 and ClientAudioPortRange is set to 3, then the following 3 ports are available for client audio: 5350; 5351; 5352. @@ -171,8 +162,7 @@ For example, if ClientAudioPort is set to 5350 and ClientAudioPortRange is set t ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,6 +172,9 @@ Accept wildcard characters: False ``` ### -ClientFileTransferPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the starting port number used for file transfers. The ClientFileTransferPort must be a value port number between 1024 and 65535, inclusive. The default value is 5350. @@ -189,8 +182,7 @@ The default value is 5350. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -200,6 +192,9 @@ Accept wildcard characters: False ``` ### -ClientFileTransferPortRange + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the total number of ports available for file transfers. (The default value is 40.) To determine the actual ports used for file transfers, use this value and the ClientFileTransferPort value. For example, if ClientFileTransferPort is set to 5350 and ClientFileTransferPortRange is set to 3, then the following three ports are available for file transfers: 5350; 5351; 5352. @@ -207,8 +202,7 @@ For example, if ClientFileTransferPort is set to 5350 and ClientFileTransferPort ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -219,6 +213,8 @@ Accept wildcard characters: False ### -ClientMediaPort +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the starting port number used for client media. Use this parameter for Microsoft Office Communicator 2007 R2 clients. The ClientMediaPort must be a value port number between 1024 and 65535, inclusive. @@ -229,8 +225,7 @@ The default value is 5350. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -241,6 +236,8 @@ Accept wildcard characters: False ### -ClientMediaPortRange +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the total number of ports available for client media. (The default value is 40.) Use this parameter for Office Communicator 2007 R2 clients. To determine the actual ports used for client media, use this value and the ClientMediaPort value. @@ -251,8 +248,7 @@ For example, if ClientMediaPort is set to 5350 and ClientMediaPortRange is set t ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -262,14 +258,16 @@ Accept wildcard characters: False ``` ### -ClientMediaPortRangeEnabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, clients will use the specified port range for media traffic. When set to False (the default value) any available port (from port 1024 through port 65535) will be used to accommodate media traffic. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -279,6 +277,9 @@ Accept wildcard characters: False ``` ### -ClientSipDynamicPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the starting port number used for SIP traffic. The ClientSipDynamicPort must be a value port number between 1024 and 65535, inclusive. The default value is 7100. @@ -286,8 +287,7 @@ The default value is 7100. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -297,6 +297,9 @@ Accept wildcard characters: False ``` ### -ClientSipDynamicPortRange + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the total number of ports available for SIP traffic. (The default value is 3.) To determine the actual ports used for SIP traffic, use this value and the ClientSipDynamicPort value. For example, if ClientSipDynamicPort is set to 7100 and ClientSipDynamicPortRange is set to 3, then the following three ports are available for client media: 7100; 7101; 7102. @@ -304,8 +307,7 @@ For example, if ClientSipDynamicPort is set to 7100 and ClientSipDynamicPortRang ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -315,6 +317,9 @@ Accept wildcard characters: False ``` ### -ClientVideoPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the starting port number used for client video. The ClientVideoPort must be a value port number between 1024 and 65535, inclusive. The default value is 5350. @@ -322,8 +327,7 @@ The default value is 5350. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -333,6 +337,9 @@ Accept wildcard characters: False ``` ### -ClientVideoPortRange + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the total number of ports available for client video. (The default value is 40.) To determine the actual ports used for client video, use this value and the ClientVideoPort value. For example, if ClientVideoPort is set to 5350 and ClientVideoPortRange is set to 3, then the following three ports are available for client video: 5350; 5351; 5352. @@ -340,8 +347,43 @@ For example, if ClientVideoPort is set to 5350 and ClientVideoPortRange is set t ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudPollServicePrimaryUrl + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not currently used with Skype for Business Server. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudPollServiceSecondaryUrl + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not currently used with Skype for Business Server. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -352,6 +394,8 @@ Accept wildcard characters: False ### -ConsoleDownloadExternalUrl +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URL where external users can download a supported client such as Skype for Business. Note that this setting applies only to legacy clients (such as Microsoft Office Communicator 2007 R2) that are logging on to a Skype for Business Server 2015 pool. @@ -360,8 +404,7 @@ Note that this setting applies only to legacy clients (such as Microsoft Office ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -372,6 +415,8 @@ Accept wildcard characters: False ### -ConsoleDownloadInternalUrl +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URL where internal users can download a supported client such as Skype for Business. Note that this setting applies only to legacy clients (such as Microsoft Office Communicator 2007 R2) that are logging on to a Skype for Business Server pool. @@ -380,8 +425,7 @@ Note that this setting applies only to legacy clients (such as Microsoft Office ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -392,6 +436,8 @@ Accept wildcard characters: False ### -ContentGracePeriod +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates how long conference content will remain on the server following the end of a meeting. The ContentGracePeriod must be specified using the format Days.Hours:Minutes:Seconds. For example, to set the content grace period to 30 days use this syntax: `-ContentGracePeriod 30.00:00:00.` @@ -404,8 +450,7 @@ The default value is 15 days (15.00:00:00). ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -414,30 +459,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HelpdeskExternalUrl -URL where external users who click Help during a conference will be directed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -HelpdeskInternalUrl -URL where internal users who click Help during a conference will be directed. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -446,16 +477,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxBandwidthPerAppSharingServiceMb -Indicates the maximum amount of bandwidth (in megabytes) set aside for the Application Sharing Conferencing service. -MaxBandwidthPerAppSharingServiceMb can be set to any integer value between 50 and 100000, inclusive. -The default value is 375 megabytes. +### -HelpdeskExternalUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL where external users who click Help during a conference will be directed. ```yaml -Type: UInt64 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -464,19 +495,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxContentStorageMb - -Maximum amount of file space (in megabytes) allowed for the storage of conference content. -MaxContentStorageMb can be set to any integer value between 50 and 1024 (1 gigabyte), inclusive. -The default value is 500. +### -HelpdeskInternalUrl +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +URL where internal users who click Help during a conference will be directed. ```yaml -Type: UInt16 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -485,17 +513,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Organization -Name of the organization hosting the conference. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the collection of conferencing configuration settings to be modified. +To refer to a collection configured at the site scope, use syntax similar to this: `-Identity "site:Redmond".` +To refer to a collection at the service scope, use syntax like the following: `-Identity "service:ConferencingServer:atl-cs-001.litwareinc.com".` +Note the Web Conferencing service is the only service that can host these configuration settings. ```yaml -Type: String +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -503,6 +536,8 @@ Accept wildcard characters: False ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. @@ -511,8 +546,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -521,14 +555,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -MaxBandwidthPerAppSharingServiceMb + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum amount of bandwidth (in megabytes) set aside for the Application Sharing Conferencing service. +MaxBandwidthPerAppSharingServiceMb can be set to any integer value between 50 and 100000, inclusive. +The default value is 375 megabytes. ```yaml -Type: SwitchParameter +Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -537,14 +575,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MaxContentStorageMb + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Maximum amount of file space (in megabytes) allowed for the storage of conference content. +MaxContentStorageMb can be set to any integer value between 50 and 1024 (1 gigabyte), inclusive. +The default value is 500. + + ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -553,14 +597,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -MaxUploadFileSizeMb + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Maximum total size of the files (including handouts and PowerPoint slides) that can be used in a given conference. +This setting is typically used when conference content is being archived in Microsoft Exchange Server: by setting a maximum upload file size you can ensure that the content used in the conference (and thus the content which must be archived) does not exceed the maximum file size configured for Microsoft Exchange. +The default value is 500 megabytes. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -569,16 +617,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxUploadFileSizeMb -Maximum total size of the files (including handouts and PowerPoint slides) that can be used in a given conference. -This setting is typically used when conference content is being archived in Microsoft Exchange Server: by setting a maximum upload file size you can ensure that the content used in the conference (and thus the content which must be archived) does not exceed the maximum file size configured for Microsoft Exchange. -The default value is 500 megabytes. +### -Organization + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the organization hosting the conference. ```yaml -Type: UInt16 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -587,14 +635,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CloudPollServicePrimaryUrl -This parameter is not currently used with Skype for Business Server. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -603,14 +653,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CloudPollServiceSecondaryUrl -This parameter is not currently used with Skype for Business Server. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -624,13 +676,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The New-CsConferencingConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConfSettings The New-CsConferencingConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConfSettings object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsConferencingPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsConferencingPolicy.md similarity index 84% rename from skype/skype-ps/skype/New-CsConferencingPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsConferencingPolicy.md index 08fab2b313..a9bf4651ab 100644 --- a/skype/skype-ps/skype/New-CsConferencingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsConferencingPolicy.md @@ -1,12 +1,14 @@ --- +applicable: Skype for Business Server 2019, Skype for Business Server 2015, Lync Server 2013, Lync Server 2010, +author: tomkau external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csconferencingpolicy -applicable: Skype for Business Server 2019, Skype for Business Server 2015, Lync Server 2013, Lync Server 2010, -schema: 2.0.0 +Locale: en-US manager: bulenteg -author: tomkau +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/new-csconferencingpolicy +schema: 2.0.0 --- # New-CsConferencingPolicy @@ -81,26 +83,10 @@ All other policy properties will use the default values. ## PARAMETERS -### -Identity -Unique identifier for the conferencing policy to be created. -In Skype for Business Server, Conferencing policies can be created at the site or per-user scopes. In Skype for Business Online, Conferencing policies can created on a per-user scope only. -To create a site policy, use syntax similar to this: `-Identity site:Redmond.` -To create a per-user policy, use syntax similar to this: `-Identity SalesConferencingPolicy.` - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +### -AllowAnnotations -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -AllowAnnotations Indicates whether or not participants are allowed to make on-screen annotations on any content shared during the meeting; in addition, this setting determines whether or not whiteboarding is allowed in the conference. The default value is True. @@ -117,7 +103,6 @@ However, the user can participate in other conferences where annotations are all Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -128,6 +113,8 @@ Accept wildcard characters: False ### -AllowAnonymousParticipantsInMeetings +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether anonymous users are allowed to participate in the meeting. If set to False then only authenticated users (that is, users logged on to your Active Directory Domain Services or the Active Directory of a federated partner) are allowed to attend the meeting. The default value is True. @@ -141,7 +128,6 @@ However, the user can take part in other conferences where anonymous participant Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -152,6 +138,8 @@ Accept wildcard characters: False ### -AllowAnonymousUsersToDialOut +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether or not anonymous users (unauthenticated users) are allowed to join a conference using dial-out phoning. With dial-out phoning, the conferencing server telephones the user; when the user answers the phone, he or she will be joined to the conference. @@ -170,7 +158,6 @@ The default value is False. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -181,6 +168,8 @@ Accept wildcard characters: False ### -AllowConferenceRecording +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether users are allowed to record the meeting. The default value is False. @@ -192,7 +181,6 @@ This setting applies to all users taking part in the conference. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -203,6 +191,8 @@ Accept wildcard characters: False ### -AllowExternalUserControl +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether external users (either anonymous users or federated users) are allowed to take control of shared applications or desktops. The default value is False. @@ -214,7 +204,6 @@ That means that some users in a session might be allowed to give up control of a Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -223,14 +212,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowExternalUsersToSaveContent +### -AllowExternalUsersToRecordMeeting -Indicates whether external users (that is, users not currently logged-on to your network) are allowed to save handouts, slides, and other meeting content. -The default value is True. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow external users to save content. -However, the user can take part in other conferences where external users are allowed to save content. +Indicates whether external users (either anonymous users or federated users) are allowed to record the meeting. +The default value is False. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow external users to record conferences. +However, the user can take part in other conferences where external users are allowed to record meetings. + +Note that this setting takes effect only if the AllowConferenceRecording property is set to True. @@ -238,7 +230,6 @@ However, the user can take part in other conferences where external users are al Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -247,20 +238,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowIPAudio +### -AllowExternalUsersToSaveContent -Indicates whether or not computer audio is allowed in the meeting. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether external users (that is, users not currently logged-on to your network) are allowed to save handouts, slides, and other meeting content. The default value is True. -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow IP audio. -However, the user can take part in other conferences where IP audio is allowed. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow external users to save content. +However, the user can take part in other conferences where external users are allowed to save content. + + ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -269,21 +263,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowIPVideo - -Indicates whether or not computer video is allowed in the meeting. -The default value is True. - -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow IP video. -However, the user can take part in other conferences where IP video is allowed. +### -AllowFederatedParticipantJoinAsSameEnterprise +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True ($True), allows federated meeting participants to join the meeting as though they were internal users rather than external users. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -292,21 +281,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowParticipantControl +### -AllowIPAudio -Indicates whether or not meeting participants are allowed to take control of applications or desktops shared during the meeting. -The default value is True. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow participant control. -However, the user can take part in other conferences where participant control is allowed. +Indicates whether or not computer audio is allowed in the meeting. +The default value is True. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow IP audio. +However, the user can take part in other conferences where IP audio is allowed. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -315,13 +304,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPolls +### -AllowIPVideo -Indicates whether or not users are allowed to conduct online polls during a meeting. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not computer video is allowed in the meeting. The default value is True. -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow polls. -However, the user can take part in other conferences where polls are allowed. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow IP video. +However, the user can take part in other conferences where IP video is allowed. @@ -329,7 +320,6 @@ However, the user can take part in other conferences where polls are allowed. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -338,21 +328,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowUserToScheduleMeetingsWithAppSharing +### -AllowLargeMeetings -Indicates whether or not users are allowed to organize meetings that include application sharing. -The default value is True. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow application sharing. -However, the user can take part in other conferences where application sharing is allowed. +When set to True, all online meetings are treated as "large meeting." With a large meeting, restrictions are placed on the number of notifications that are sent to participants as well as the size of the meeting roster that is transmitted by default. +The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -361,18 +349,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -AllowMultiView -Enables administrators to provider explanatory text about the conferencing policy. -For example, the Description might indicate the users the policy should be assigned to. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True (the default value) enables users to schedule conferences that allow multiview; that is, clients can receive multiple video streams during a given conference. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy can include multiview. +However, the user can participate in other conferences where multiview is allowed. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -381,31 +370,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAppDesktopSharing - -Indicates whether participants are allowed to share applications (or their desktop) during the course of a meeting. -Allowed values are: - -Desktop. -Users are allowed to share their entire desktop. +### -AllowNonEnterpriseVoiceUsersToDialOut -SingleApplication. -Users are allowed to share a single application. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -None. -Users are not allowed to share applications or their desktop. +Indicates whether or users who have not been enabled for Enterprise Voice are allowed to join a conference using dial-out phoning. +With dial-out phoning the conferencing server will telephone the user; when the user answers the phone, he or she will be joined to the conference. -This setting is enforced at the per-user level. -That means that some users in a conference might be allowed to share their desktop or applications while other users in the same conference might not be allowed to do so. +Note that dial-in conferencing is allowed even when this setting is False. -The default value is Desktop. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow users who have not been enabled for Enterprise Voice to join the conference via dial-out phoning. +However, the user can take part in other conferences where users who have not been enabled for Enterprise Voice can join via dial out. +The default value is False ($False). ```yaml -Type: EnableAppDesktopSharing +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -414,20 +396,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableDataCollaboration - -Indicates whether users can organize meetings that include data collaboration activities such as whiteboarding and annotations. - -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow data collaboration. -However, the user can take part in other conferences where data collaboration is allowed. +### -AllowOfficeContent +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to False, prevents users from using Office content in their conferences. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -436,20 +414,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableDialInConferencing +### -AllowParticipantControl -Indicates whether users are able to join the meeting by dialing in with a public switched telephone network (PSTN) telephone. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not meeting participants are allowed to take control of applications or desktops shared during the meeting. The default value is True. -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow dial-in conferencing. -However, the user can take part in other conferences where dial-in conferencing is allowed. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow participant control. +However, the user can take part in other conferences where participant control is allowed. + ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -458,13 +438,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableFileTransfer +### -AllowPolls -Indicates whether file transfers to all the meeting participants are allowed during the meeting. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not users are allowed to conduct online polls during a meeting. The default value is True. -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow file transfers. -However, the user can take part in other conferences where file transfers are allowed. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow polls. +However, the user can take part in other conferences where polls are allowed. @@ -472,7 +454,6 @@ However, the user can take part in other conferences where file transfers are al Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -481,21 +462,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableP2PFileTransfer - -Indicates whether peer-to-peer file transfers (that is, file transfers that do not involve all participants) are allowed during the meeting. -The default value is True. +### -AllowQandA -This setting is enforced at the per-user level. -That means that one user in a peer-to-peer communication session might be allowed to transfer files while the other user is not. +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True (the default value) the user will be able to include the Questions and Answers Manager in any online conference that he or she organizes. +When set to False, the user will be prohibited from including Questions and Answers Manager in any of his or her conferences. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow the use of the Questions and Answers Manager. +However, the user can make use of the Questions and Answers Manager in other conferences where polls are allowed. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -504,19 +484,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableP2PRecording +### -AllowSharedNotes + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) any open OneNote notebooks linked to the conference will automatically be updated with information such as conference participants and details about content shared during the conference. + -If True, users will be able to record peer-to-peer conferencing sessions. -The default value is False. -This setting is enforced at the per-user level. -That means that one user in a peer-to-peer communication session might be allowed to record the session while the other user is not. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -525,13 +505,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableP2PVideo +### -AllowUserToScheduleMeetingsWithAppSharing -If True, users will be able to take part in peer-to-peer video conferencing sessions. -The default value is False. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -This setting is enforced at the per-user level. -That means that one user in a peer-to-peer communication session might be allowed to use video the session while the other user is not. +Indicates whether or not users are allowed to organize meetings that include application sharing. +The default value is True. + +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow application sharing. +However, the user can take part in other conferences where application sharing is allowed. @@ -539,7 +521,6 @@ That means that one user in a peer-to-peer communication session might be allowe Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -548,24 +529,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxMeetingSize - -Indicates the maximum number of people who are allowed to attend a meeting. -After the maximum number of participants has been reached, anyone else who tries to join the meeting will be turned away with the notice that the meeting is full. -The number of participants specified in this value can be any 32-bit whole number (any value between 1 and 4,294,967,295), but the recommended size is between 2 and 250, inclusive; the default value is 250. - -250 is the maximum for shared pool deployments, based on Microsoft testing. -For information about supporting meeting with more than 250 participants, see "Microsoft Lync Server 2010 Support for Large Meetings" at https://go.microsoft.com/fwlink/p/?linkId=242073 (https://go.microsoft.com/fwlink/p/?linkId=242073). +### -ApplicationSharingMode -This setting applies to the user who organizes the conference: no conference created by a user affected by this policy will allow more than the specified number of participants. -However, the user can take part in other conferences where additional participants are allowed. +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Determines the protocol used for screen sharing - VbSS vs RDP. This parameter is used only in SfB Server. To disable VbSS for a user, use the value "RDP". ```yaml -Type: UInt32 +Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -574,27 +547,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxVideoConferenceResolution - -Indicates the maximum resolution for meeting video. -Allowed values are: - -CIF. -Common Intermediate Format (CIF) has a resolution of 352 pixels by 288 pixels. - -VGA. -VGA has a resolution of 640 pixels by 480 pixels. - -The default value is VGA. +### -AppSharingBitRateKb +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Bit rate (in kilobits) used for application sharing. +The default value is 50000. ```yaml -Type: MaxVideoConferenceResolution +Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -603,16 +567,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -AudioBitRateKb + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Bit rate (in kilobits) used for audio transmissions. +The audio bit rate can be any whole number between 20 and 200, inclusive; the default value is 200. + +This setting is enforced at the per-user level, and for both conferences and peer-to-peer communication sessions. -Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -621,18 +590,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory - -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -CloudRecordingServiceSupport +> Applicable: Skype for Business Online +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: CloudRecordingServiceSupport Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Accepted values: NotSupported, Supported, Required Required: False Position: Named @@ -641,17 +609,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf +### -Description -Describes what would happen if you executed the command without actually executing the command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to provider explanatory text about the conferencing policy. +For example, the Description might indicate the users the policy should be assigned to. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -660,17 +630,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -DisablePowerPointAnnotations -Prompts you for confirmation before executing the command. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True ($True) users will not be able to add annotations to PowerPoint slides used in a conference. +However (depending on the value of the AllowAnnotations property), users will still have access to other whiteboarding features. +The default value is False, meaning that PowerPoint annotations are allowed. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -679,23 +651,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowExternalUsersToRecordMeeting - -Indicates whether external users (either anonymous users or federated users) are allowed to record the meeting. -The default value is False. +### -EnableAppDesktopSharing -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow external users to record conferences. -However, the user can take part in other conferences where external users are allowed to record meetings. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Note that this setting takes effect only if the AllowConferenceRecording property is set to True. +Indicates whether participants are allowed to share applications (or their desktop) during the course of a meeting. +Allowed values are: +Desktop. +Users are allowed to share their entire desktop. + +SingleApplication. +Users are allowed to share a single application. + +None. +Users are not allowed to share applications or their desktop. + +This setting is enforced at the per-user level. +That means that some users in a conference might be allowed to share their desktop or applications while other users in the same conference might not be allowed to do so. + +The default value is Desktop. ```yaml -Type: Boolean +Type: EnableAppDesktopSharing Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -704,17 +685,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AppSharingBitRateKb +### -EnableDataCollaboration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether users can organize meetings that include data collaboration activities such as whiteboarding and annotations. + +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow data collaboration. +However, the user can take part in other conferences where data collaboration is allowed. -Bit rate (in kilobits) used for application sharing. -The default value is 50000. ```yaml -Type: Int64 +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -723,20 +708,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AudioBitRateKb +### -EnableDialInConferencing -Bit rate (in kilobits) used for audio transmissions. -The audio bit rate can be any whole number between 20 and 200, inclusive; the default value is 200. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -This setting is enforced at the per-user level, and for both conferences and peer-to-peer communication sessions. +Indicates whether users are able to join the meeting by dialing in with a public switched telephone network (PSTN) telephone. +The default value is True. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow dial-in conferencing. +However, the user can take part in other conferences where dial-in conferencing is allowed. ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -745,18 +731,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FileTransferBitRateKb +### -EnableFileTransfer -Bit rate (in kilobits) used for file transfers. -The default value is 50000. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether file transfers to all the meeting participants are allowed during the meeting. +The default value is True. + +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow file transfers. +However, the user can take part in other conferences where file transfers are allowed. ```yaml -Type: Int64 +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -765,22 +755,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VideoBitRateKb - -Bit rate (in kilobits) used for video transmissions. -The default value is 400. +### -EnableMultiViewJoin -This setting is enforced at the per-user level, and for both conferences and peer-to-peer communication sessions. In Skype for Business Online, this setting is also enforced for producers of Skype for Business Online Broadcast meetings. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -**Note:** As a result of unprecedented demand for video conferencing during the COVID-19 situation, when creating policies in Skype for Business Online, this setting cannot be changed from its default value. If you are using broadcast meeting functionality and require a a higher video bit rate, please contact your Technical Account Manager or Support to request this change. +When set to True (the default value) clients will attempt to join a conference using multiview (which allows the client to receive multiple video streams during the conference). +This parameter will be ignored if multiview is not allowed in the conference being joined. +This setting is enforced at the per-user level, and for both conferences and peer-to-peer communication sessions. +That means that some users in a session might be allowed to have multiple video streams while other users in the same conference might not. ```yaml -Type: Int64 +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015, Lync Server 2013, Lync Server 2010, Required: False Position: Named @@ -789,18 +778,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowLargeMeetings - -When set to True, all online meetings are treated as "large meeting." With a large meeting, restrictions are placed on the number of notifications that are sent to participants as well as the size of the meeting roster that is transmitted by default. +### -EnableOnlineMeetingPromptForLyncResources -The default value is False ($False). +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +When set to True, users will be prompted any time they schedule a meeting in Outlook that includes invitees (such as a meeting room) that would benefit from having the meeting held online. +The default value is False. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -809,18 +797,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowMultiView +### -EnableP2PFileTransfer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether peer-to-peer file transfers (that is, file transfers that do not involve all participants) are allowed during the meeting. +The default value is True. + +This setting is enforced at the per-user level. +That means that one user in a peer-to-peer communication session might be allowed to transfer files while the other user is not. -When set to True (the default value) enables users to schedule conferences that allow multiview; that is, clients can receive multiple video streams during a given conference. -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy can include multiview. -However, the user can participate in other conferences where multiview is allowed. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -829,23 +821,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowNonEnterpriseVoiceUsersToDialOut - -Indicates whether or users who have not been enabled for Enterprise Voice are allowed to join a conference using dial-out phoning. -With dial-out phoning the conferencing server will telephone the user; when the user answers the phone, he or she will be joined to the conference. +### -EnableP2PRecording -Note that dial-in conferencing is allowed even when this setting is False. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow users who have not been enabled for Enterprise Voice to join the conference via dial-out phoning. -However, the user can take part in other conferences where users who have not been enabled for Enterprise Voice can join via dial out. +If True, users will be able to record peer-to-peer conferencing sessions. +The default value is False. -The default value is False ($False). +This setting is enforced at the per-user level. +That means that one user in a peer-to-peer communication session might be allowed to record the session while the other user is not. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -854,10 +843,15 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSharedNotes +### -EnableP2PVideo -When set to True (the default value) any open OneNote notebooks linked to the conference will automatically be updated with information such as conference participants and details about content shared during the conference. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +If True, users will be able to take part in peer-to-peer video conferencing sessions. +The default value is False. + +This setting is enforced at the per-user level. +That means that one user in a peer-to-peer communication session might be allowed to use video the session while the other user is not. @@ -865,7 +859,6 @@ When set to True (the default value) any open OneNote notebooks linked to the co Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -874,18 +867,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisablePowerPointAnnotations +### -EnableReliableConferenceDeletion -When set to True ($True) users will not be able to add annotations to PowerPoint slides used in a conference. -However (depending on the value of the AllowAnnotations property), users will still have access to other whiteboarding features. -The default value is False, meaning that PowerPoint annotations are allowed. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +PARAMVALUE: $true | $false ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -894,20 +885,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMultiViewJoin +### -FileTransferBitRateKb -When set to True (the default value) clients will attempt to join a conference using multiview (which allows the client to receive multiple video streams during the conference). -This parameter will be ignored if multiview is not allowed in the conference being joined. -This setting is enforced at the per-user level, and for both conferences and peer-to-peer communication sessions. -That means that some users in a session might be allowed to have multiple video streams while other users in the same conference might not. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Bit rate (in kilobits) used for file transfers. +The default value is 50000. ```yaml -Type: Boolean +Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -916,18 +906,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TotalReceiveVideoBitRateKb +### -Force -Indicates the maximum allowed bitrate (in kilobytes per second) for all the video used in a conference; that is, the combined total for all the video streams. -The default value is 50000 kilobytes per second. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Int64 +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -936,14 +925,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowFederatedParticipantJoinAsSameEnterprise -When set to True ($True), allows federated meeting participants to join the meeting as though they were internal users rather than external users. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the conferencing policy to be created. +In Skype for Business Server, Conferencing policies can be created at the site or per-user scopes. In Skype for Business Online, Conferencing policies can created on a per-user scope only. +To create a site policy, use syntax similar to this: `-Identity site:Redmond.` +To create a per-user policy, use syntax similar to this: `-Identity SalesConferencingPolicy.` ```yaml -Type: Boolean +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + + +```yaml +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -952,14 +967,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowOfficeContent -When set to False, prevents users from using Office content in their conferences. +### -MaxMeetingSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum number of people who are allowed to attend a meeting. +After the maximum number of participants has been reached, anyone else who tries to join the meeting will be turned away with the notice that the meeting is full. +The number of participants specified in this value can be any 32-bit whole number (any value between 1 and 4,294,967,295), but the recommended size is between 2 and 250, inclusive; the default value is 250. + +250 is the maximum for shared pool deployments, based on Microsoft testing. +For information about supporting meeting with more than 250 participants, see "Microsoft Lync Server 2010 Support for Large Meetings" at https://go.microsoft.com/fwlink/p/?linkId=242073 (https://go.microsoft.com/fwlink/p/?linkId=242073). + +This setting applies to the user who organizes the conference: no conference created by a user affected by this policy will allow more than the specified number of participants. +However, the user can take part in other conferences where additional participants are allowed. + ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -968,18 +994,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowQandA -When set to True (the default value) the user will be able to include the Questions and Answers Manager in any online conference that he or she organizes. -When set to False, the user will be prohibited from including Questions and Answers Manager in any of his or her conferences. +### -MaxVideoConferenceResolution + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum resolution for meeting video. +Allowed values are: + +CIF. +Common Intermediate Format (CIF) has a resolution of 352 pixels by 288 pixels. + +VGA. +VGA has a resolution of 640 pixels by 480 pixels. + +The default value is VGA. + + -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow the use of the Questions and Answers Manager. -However, the user can make use of the Questions and Answers Manager in other conferences where polls are allowed. ```yaml -Type: Boolean +Type: MaxVideoConferenceResolution Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -988,14 +1024,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplicationSharingMode -Determines the protocol used for screen sharing - VbSS vs RDP. This parameter is used only in SfB Server. To disable VbSS for a user, use the value "RDP". +### -Tenant + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new conferencing policy is being created. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: String +Type: Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -1004,15 +1049,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CloudRecordingServiceSupport -This parameter is reserved for internal Microsoft use. +### -TotalReceiveVideoBitRateKb + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum allowed bitrate (in kilobytes per second) for all the video used in a conference; that is, the combined total for all the video streams. +The default value is 50000 kilobytes per second. + + ```yaml -Type: CloudRecordingServiceSupport +Type: Int64 Parameter Sets: (All) Aliases: -Accepted values: NotSupported, Supported, Required -Applicable: Skype for Business Online Required: False Position: Named @@ -1021,15 +1070,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOnlineMeetingPromptForLyncResources -When set to True, users will be prompted any time they schedule a meeting in Outlook that includes invitees (such as a meeting room) that would benefit from having the meeting held online. -The default value is False. +### -VideoBitRateKb + +> Applicable: Skype for Business Online, Skype for Business Server 2019, Skype for Business Server 2015, Lync Server 2013, Lync Server 2010, + +Bit rate (in kilobits) used for video transmissions. +The default value is 400. + +This setting is enforced at the per-user level, and for both conferences and peer-to-peer communication sessions. In Skype for Business Online, this setting is also enforced for producers of Skype for Business Online Broadcast meetings. + +**Note:** As a result of unprecedented demand for video conferencing during the COVID-19 situation, when creating policies in Skype for Business Online, this setting cannot be changed from its default value. If you are using broadcast meeting functionality and require a a higher video bit rate, please contact your Technical Account Manager or Support to request this change. + + ```yaml -Type: Boolean +Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -1038,14 +1095,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableReliableConferenceDeletion -PARAMVALUE: $true | $false +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + + ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -1054,21 +1115,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new conferencing policy is being created. -For example: +### -WhatIf -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: -`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/New-CsCpsConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsCpsConfiguration.md similarity index 85% rename from skype/skype-ps/skype/New-CsCpsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsCpsConfiguration.md index dfaf405eee..89c6f06c20 100644 --- a/skype/skype-ps/skype/New-CsCpsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsCpsConfiguration.md @@ -1,12 +1,13 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cscpsconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cscpsconfiguration +schema: 2.0.0 --- # New-CsCpsConfiguration @@ -44,7 +45,7 @@ In addition, Call Park service can be configured to play music on hold to the ca ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsCpsConfiguration -Identity site:Redmond -EnableMusicOnHold $False ``` @@ -54,7 +55,7 @@ This configuration will be created with default values with the exception of Ena This command sets this property to False, meaning the caller whose call has been parked will not hear anything while on hold. (EnableMusicOnHold is set to True by default, assuming Call Park service has been deployed.) -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsCpsConfiguration -Identity site:Redmond -OnTimeoutURI sip:kenmyer@litwareinc.com @@ -66,7 +67,7 @@ In this case the OnTimeoutURI is set to sip:kenmyer@litwareinc.com. The value passed to this parameter must begin with the string "sip:" and should point to a user or Response Group that will receive parked calls that aren't picked up after a specified number of ringback attempts. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` New-CsCpsConfiguration -Identity site:Redmond -MaxCallPickupAttempts 2 @@ -79,25 +80,10 @@ That means the call rings back up to two times. ## PARAMETERS -### -Identity -The site to which the settings are applied. -This must be entered in the format site:\, such as site:Redmond. -A configuration will always exist at the global scope and can't be removed, so a global configuration can't be re-created with this cmdlet. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -CallPickupTimeoutThreshold -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -CallPickupTimeoutThreshold The amount of time that will elapse after a call has been parked before it will ring back to the phone on which the call was answered. This must be entered in the format hh:mm:ss (hh = hours, mm = minutes, ss = seconds) @@ -107,8 +93,7 @@ Default: 00:01:30 (90 seconds); Minimum Value: 10 seconds (00:00:10); Maximum Va ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,6 +104,8 @@ Accept wildcard characters: False ### -EnableMusicOnHold +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether music plays for the caller while a call is parked. Skype for Business Server ships with a default Music on Hold file. @@ -131,8 +118,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,17 +127,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxCallPickupAttempts -The number of times a parked call will ring back to the answering phone before giving up and forwarding the call to the fallback Uniform Resource Identifier (URI). -The fallback URI is set with the OnTimeoutURI parameter. +### -Force -Default: 1; Minimum Value: 1; Maximum Value: 10 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -160,35 +145,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OnTimeoutURI -The SIP address of the user or Response Group to which unanswered parked calls will be routed. -The parked call will be routed after the number of ringbacks defined with the MaxCallPickupAttempts parameter. -If that parameter is set to Null, the OnTimeoutURI will be ignored and the parked call will be disconnected after unsuccessful ringback attempts. +### -Identity -Values must be SIP URIs, beginning with the string sip:. -For example, sip:rgs1@litwareinc.com. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The site to which the settings are applied. +This must be entered in the format site:\, such as site:Redmond. +A configuration will always exist at the global scope and can't be removed, so a global configuration can't be re-created with this cmdlet. ```yaml -Type: String +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -197,18 +186,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -MaxCallPickupAttempts -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +The number of times a parked call will ring back to the answering phone before giving up and forwarding the call to the fallback Uniform Resource Identifier (URI). +The fallback URI is set with the OnTimeoutURI parameter. +Default: 1; Minimum Value: 1; Maximum Value: 10 ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -217,14 +207,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -OnTimeoutURI + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The SIP address of the user or Response Group to which unanswered parked calls will be routed. +The parked call will be routed after the number of ringbacks defined with the MaxCallPickupAttempts parameter. +If that parameter is set to Null, the OnTimeoutURI will be ignored and the parked call will be disconnected after unsuccessful ringback attempts. + +Values must be SIP URIs, beginning with the string sip:. +For example, sip:rgs1@litwareinc.com. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -234,13 +231,33 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -254,12 +271,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CallParkServiceSettings.CallParkServiceSettings This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.CallParkServiceSettings.CallParkServiceSettings. ## NOTES diff --git a/skype/skype-ps/skype/New-CsDeviceUpdateConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsDeviceUpdateConfiguration.md similarity index 90% rename from skype/skype-ps/skype/New-CsDeviceUpdateConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsDeviceUpdateConfiguration.md index e0f256355d..de47343c5e 100644 --- a/skype/skype-ps/skype/New-CsDeviceUpdateConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsDeviceUpdateConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csdeviceupdateconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsDeviceUpdateConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csdeviceupdateconfiguration +schema: 2.0.0 +title: New-CsDeviceUpdateConfiguration --- # New-CsDeviceUpdateConfiguration @@ -98,7 +99,7 @@ That's because you can only have one collection of device update configuration s ## EXAMPLES -### -------------------------- Example 1 ------------------------ (Lync Server 2010) +### Example 1 (Lync Server 2010) ``` New-CsDeviceUpdateConfiguration -Identity site:Redmond ``` @@ -106,7 +107,7 @@ New-CsDeviceUpdateConfiguration -Identity site:Redmond The command shown in Example 1 creates a new set of device update configuration settings with the Identity site:Redmond. Because no other parameters are included in the command, this new collection of configuration settings will use the default values for each property. -### -------------------------- EXAMPLE 1 -------------------------- (Lync Server 2013) +### EXAMPLE 1 (Lync Server 2013) ``` ``` @@ -116,7 +117,7 @@ Because no other parameters are included in the command, this new collection of New-CsDeviceUpdateConfiguration -Identity site:Redmond -### -------------------------- EXAMPLE 1 -------------------------- (Skype for Business Server 2015) +### EXAMPLE 1 (Skype for Business Server 2015) ``` ``` @@ -126,7 +127,7 @@ Because no other parameters are included in the command, this new collection of New-CsDeviceUpdateConfiguration -Identity site:Redmond -### -------------------------- Example 2 ------------------------ (Lync Server 2010) +### Example 2 (Lync Server 2010) ``` New-CsDeviceUpdateConfiguration -Identity site:Redmond -MaxLogFileSize 204800 -LogCleanUpInterval 7.00:00:00 ``` @@ -135,7 +136,7 @@ The preceding command also creates a new set of device update configuration sett In this case, two additional parameters are used in order to customize the new settings: MaxLogFileSize is used to set the maximum log file size to 2048000 bytes, while LogCleanUpInterval is used to set the log cleanup interval time to 7 days (7 days . 00 hours : 00 minutes : 00 seconds). -### -------------------------- EXAMPLE 2 -------------------------- (Lync Server 2013) +### EXAMPLE 2 (Lync Server 2013) ``` ``` @@ -146,7 +147,7 @@ In this case, two additional parameters are used in order to customize the new s New-CsDeviceUpdateConfiguration -Identity site:Redmond -MaxLogFileSize 204800 -LogCleanUpInterval 7.00:00:00 -### -------------------------- EXAMPLE 2 -------------------------- (Skype for Business Server 2015) +### EXAMPLE 2 (Skype for Business Server 2015) ``` ``` @@ -159,15 +160,35 @@ New-CsDeviceUpdateConfiguration -Identity site:Redmond -MaxLogFileSize 204800 -L ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the new device update configuration settings. Because new settings can only be created at the site scope, the Identity will look something like this: -Identity "site:Redmond". ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -176,7 +197,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +**Below Content Applies To:** Lync Server 2010, Lync Server 2013 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. + + + +**Below Content Applies To:** Skype for Business Server 2015 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -LogCleanUpInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the amount of time a device update log file is kept before it is deleted by the system. The value must be entered in the format dd.hh:mm:ss where dd is days, hh is hours, mm is minutes, and ss is seconds. @@ -191,8 +245,7 @@ Default: 10.00:00:00 (10 Days) ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -202,6 +255,9 @@ Accept wildcard characters: False ``` ### -LogCleanUpTimeOfDay + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the time of day when the system checks to see if there are any expired log files that should be deleted. (Expired log files are any files older than the value specified in by the LogCleanupInterval property.) @@ -214,8 +270,7 @@ The default value is null. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,6 +280,9 @@ Accept wildcard characters: False ``` ### -LogFlushInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates how often information stored in the log file cache is written to the actual log file. By default, device update information is not immediately written to the log file; instead, that information is cached in memory until: 1) the log flush time interval has expired; or, 2) the cache has reached its maximum size. If this value is set to 10 minutes (00:10:00), then information in the cache will be written to the log file every 10 minutes. @@ -241,8 +299,7 @@ Default: 00:05:00 ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -252,6 +309,9 @@ Accept wildcard characters: False ``` ### -MaxLogCacheLimit + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the maximum amount of information (in bytes) that can be held in the log file cache before that cache must be cleared and the data written to a log file. By default, log files are "flushed" every X number of minutes. (For details, see the description of the parameter LogFlushInterval.) However, if the cache reaches its maximum size, the information in it will automatically be written to a log file (and the cache cleared) even if the log flush interval has not yet expired. @@ -261,8 +321,7 @@ Default: 512000 ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -272,6 +331,9 @@ Accept wildcard characters: False ``` ### -MaxLogFileSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the maximum size, in bytes, for an individual log file. When a file reaches the maximum size, the next batch of data is automatically written to a new log file. The old log file will be retained until the log cleanup interval has expired. @@ -281,8 +343,7 @@ Default: 1024000 ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -292,6 +353,9 @@ Accept wildcard characters: False ``` ### -ValidLogFileExtensions + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + **Below Content Applies To:** Lync Server 2010 Indicates the valid log file extensions that can be used with the Device Update Web service. @@ -322,8 +386,7 @@ Default: .dmp, .clg, .clg2, .bak, .kdmp, .dat, .bin, .cat, .xml, .txt, .hex ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -333,6 +396,9 @@ Accept wildcard characters: False ``` ### -ValidLogFileTypes + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + **Below Content Applies To:** Lync Server 2010 Indicates the log file types retained by the device update system. @@ -341,7 +407,7 @@ The default file types include the following: Watson. Log files automatically generated by a device in the event of a system crash. -Config. +Config. Microsoft RoundTable conferencing device profiles that are created any time you configure a RoundTable device. DiagLog. @@ -393,8 +459,7 @@ For example, if you do not want to store CELog files then you can remove the CEL ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -403,42 +468,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory -**Below Content Applies To:** Lync Server 2010, Lync Server 2013 - -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. - - - -**Below Content Applies To:** Skype for Business Server 2015 - -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -448,29 +487,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -484,17 +509,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None New-CsDeviceUpdateConfiguration does not accept pipelined input. -### -None. -The New-CsDeviceUpdateConfiguration cmdlet does not accept pipelined input. - ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdateConfiguration The New-CsDeviceUpdateConfiguration cmdlet creates instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdateConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsDiagnosticConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsDiagnosticConfiguration.md similarity index 89% rename from skype/skype-ps/skype/New-CsDiagnosticConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsDiagnosticConfiguration.md index db23830811..26d1974178 100644 --- a/skype/skype-ps/skype/New-CsDiagnosticConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsDiagnosticConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csdiagnosticconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsDiagnosticConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csdiagnosticconfiguration +schema: 2.0.0 +title: New-CsDiagnosticConfiguration --- # New-CsDiagnosticConfiguration @@ -102,14 +103,14 @@ For example, your command will fail if you try to create a new collection for th ## EXAMPLES -### -------------------------- Example 1 ------------------------ (Lync Server 2010) +### Example 1 (Lync Server 2010) ``` New-CsDiagnosticConfiguration -Identity site:Redmond ``` The preceding command creates a new collection of diagnostic configuration settings for the Redmond site. -### -------------------------- EXAMPLE 1 -------------------------- (Lync Server 2013) +### EXAMPLE 1 (Lync Server 2013) ``` ``` @@ -118,7 +119,7 @@ Example 1 creates a new collection of diagnostic configuration settings for the New-CsDiagnosticConfiguration -Identity site:Redmond -### -------------------------- EXAMPLE 1 -------------------------- (Skype for Business Server 2015) +### EXAMPLE 1 (Skype for Business Server 2015) ``` ``` @@ -127,9 +128,9 @@ Example 1 creates a new collection of diagnostic configuration settings for the New-CsDiagnosticConfiguration -Identity site:Redmond -### -------------------------- Example 2 ------------------------ (Lync Server 2010) +### Example 2 (Lync Server 2010) ``` -$x = New-CsDiagnosticsFilter -Fqdn fabrikam.com -Uri "sip:user@fabrikam.com" -Enabled $False +$x = New-CsDiagnosticsFilter -Fqdn fabrikam.com -Uri "sip:user@fabrikam.com" -Enabled $False New-CsDiagnosticConfiguration -Identity site:Redmond -Filter $x ``` @@ -142,7 +143,7 @@ The resulting virtual filter is then stored in the variable $x. In command 2, New-CsDiagnosticConfiguration is used to create a new diagnostic configuration settings collection for the Redmond site. These new settings will use the diagnostic filter stored in the variable $x. -### -------------------------- EXAMPLE 2 -------------------------- (Lync Server 2013) +### EXAMPLE 2 (Lync Server 2013) ``` ``` @@ -159,7 +160,7 @@ $x = New-CsDiagnosticsFilter -Fqdn fabrikam.com -Uri "sip:user@fabrikam.com" -En New-CsDiagnosticConfiguration -Identity site:Redmond -Filter $x -### -------------------------- EXAMPLE 2 -------------------------- (Skype for Business Server 2015) +### EXAMPLE 2 (Skype for Business Server 2015) ``` ``` @@ -176,7 +177,7 @@ $x = New-CsDiagnosticsFilter -Fqdn fabrikam.com -Uri "sip:user@fabrikam.com" -En New-CsDiagnosticConfiguration -Identity site:Redmond -Filter $x -### -------------------------- Example 3 ------------------------ (Lync Server 2010) +### Example 3 (Lync Server 2010) ``` $x = New-CsDiagnosticConfiguration -Identity site:Redmond -InMemory $x.LoggingShare = "\\atl-fs-001\logs" @@ -192,7 +193,7 @@ The final command is then used to transform the virtual diagnostic configuration Note that this final command is mandatory. If you do not call Set-CsDiagnosticConfiguration, no settings will be applied to the Redmond site, and the virtual settings will disappear as soon as you end your Windows PowerShell session or delete the variable $x. -### -------------------------- EXAMPLE 3 -------------------------- (Lync Server 2013) +### EXAMPLE 3 (Lync Server 2013) ``` ``` @@ -212,7 +213,7 @@ $x.LoggingShare = "\\\\atl-fs-001\logs" Set-CsDiagnosticConfiguration -Instance $x -### -------------------------- EXAMPLE 3 -------------------------- (Skype for Business Server 2015) +### EXAMPLE 3 (Skype for Business Server 2015) ``` ``` @@ -234,24 +235,10 @@ Set-CsDiagnosticConfiguration -Instance $x ## PARAMETERS -### -Identity -Unique identifier for the diagnostics configuration settings to be created. -Because new settings can only be created at the site scope you must use syntax similar to this: -Identity "site:Redmond". - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Filter -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Filter Collection of domains and URIs whose traffic will be logged if diagnostic filtering is enabled. The Filter property consists of three separate items: @@ -269,8 +256,7 @@ Enabled - Indicates whether or not the filter should be activated. ```yaml Type: Filter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -279,14 +265,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LoggingShare -Shared folder where the diagnostic logs can be uploaded. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -295,23 +283,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the diagnostics configuration settings to be created. +Because new settings can only be created at the site scope you must use syntax similar to this: -Identity "site:Redmond". ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + **Below Content Applies To:** Lync Server 2010, Lync Server 2013 Creates an object reference without actually committing the object as a permanent change. @@ -329,8 +323,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -339,14 +332,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -LogAllSipHeaders + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to False, only the core SIP headers are recorded in the logs. +Setting this value to False can help reduce the size of the log files. +When set to True, all SIP headers are logged. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -LoggingShare + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Shared folder where the diagnostic logs can be uploaded. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -356,13 +371,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -371,16 +388,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LogAllSipHeaders -When set to False, only the core SIP headers are recorded in the logs. -Setting this value to False can help reduce the size of the log files. -When set to True, all SIP headers are logged. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -394,22 +411,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None New-CsDiagnosticConfiguration does not accept pipelined input. -### -None. -The New-CsDiagnosticConfiguration cmdlet does not accept pipelined input. - ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticFilterSettings New-CsDiagnosticConfiguration creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticFilterSettings. -### -The New-CsDiagnosticConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticFilterSettings. - ## NOTES ## RELATED LINKS diff --git a/skype/skype-ps/skype/New-CsDiagnosticHeaderConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsDiagnosticHeaderConfiguration.md similarity index 89% rename from skype/skype-ps/skype/New-CsDiagnosticHeaderConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsDiagnosticHeaderConfiguration.md index 7906c3c207..cc779bbdff 100644 --- a/skype/skype-ps/skype/New-CsDiagnosticHeaderConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsDiagnosticHeaderConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csdiagnosticheaderconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsDiagnosticHeaderConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csdiagnosticheaderconfiguration +schema: 2.0.0 +title: New-CsDiagnosticHeaderConfiguration --- # New-CsDiagnosticHeaderConfiguration @@ -56,7 +57,7 @@ Likewise, your command will fail if you try to create a new collection at the gl ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsDiagnosticHeaderConfiguration -Identity site:Redmond -SendToOutsideUnauthenticatedUsers $True ``` @@ -66,7 +67,7 @@ In addition to specifying the Identity, the command also uses the SendToOutsideA -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsDiagnosticHeaderConfiguration -Identity site:Redmond -InMemory @@ -90,7 +91,28 @@ If you do not call the Set-CsDiagnosticHeaderConfiguration cmdlet, no settings w ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the diagnostic header configuration settings to be created. To create a new settings collection at the site scope, use syntax similar to this: `-Identity "site:Redmond".` To create a new settings collection at the service scope, use syntax like this: `-Identity "service:EdgeServer:atl-cs-001.litwareinc.com".` @@ -101,8 +123,7 @@ In addition, you cannot create new settings at the site or service scope if the ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -111,17 +132,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SendToExternalNetworks +### -InMemory -When set to True, diagnostic headers will be attached to messages sent to external users. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -130,33 +153,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SendToOutsideUnauthenticatedUsers -When set to True, diagnostic headers will be attached to messages sent to outside users. -Outside users are users who have connected from outside the internal network (for example, through a proxy server) and have not yet been authenticated. +### -SendToExternalNetworks -The default value is False. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True, diagnostic headers will be attached to messages sent to external users. -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -165,18 +173,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory - -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -SendToExternalNetworksOnServiceEdge +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +When set to True, diagnostic headers will be attached to messages sent to networks on the service edge. +The default value is False. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -185,14 +192,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SendToOutsideUnauthenticatedUsers + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, diagnostic headers will be attached to messages sent to outside users. +Outside users are users who have connected from outside the internal network (for example, through a proxy server) and have not yet been authenticated. + +The default value is False. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -202,13 +214,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -217,15 +231,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SendToExternalNetworksOnServiceEdge -When set to True, diagnostic headers will be attached to messages sent to networks on the service edge. -The default value is False. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -240,14 +255,13 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsDiagnosticHeaderConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings The New-CsDiagnosticHeaderConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsDiagnosticsFilter.md b/skype/skype-ps/SkypeForBusiness/New-CsDiagnosticsFilter.md similarity index 90% rename from skype/skype-ps/skype/New-CsDiagnosticsFilter.md rename to skype/skype-ps/SkypeForBusiness/New-CsDiagnosticsFilter.md index d2f329786f..03fb932d37 100644 --- a/skype/skype-ps/skype/New-CsDiagnosticsFilter.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsDiagnosticsFilter.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csdiagnosticsfilter applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsDiagnosticsFilter -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csdiagnosticsfilter +schema: 2.0.0 +title: New-CsDiagnosticsFilter --- # New-CsDiagnosticsFilter @@ -87,6 +88,9 @@ To do this, both names (separated by a comma) are used as parameter values for t ## PARAMETERS ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether or not the filter should be employed. The default value is True ($True). @@ -94,7 +98,6 @@ The default value is True ($True). Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -104,6 +107,9 @@ Accept wildcard characters: False ``` ### -ExcludeConferenceMessages + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If set to True, information about conference messages (that is, any message with a conference URI in its To or From header) will not be recorded in the log files. The default value is False. @@ -111,7 +117,6 @@ The default value is False. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -120,15 +125,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludePresenceNotifications -If set to True, information about presence notifications (that is, any message that uses the NOTIFY or BENOTIFY method) will not be recorded in the log files. -The default value is False. +### -ExcludeMidDialogRequests +If set to True, information about mid-dialog SIP requests will not be recorded in the log files. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -137,15 +140,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeRegisterMessages -If set to True, information about client registrations (that is, any message that uses the REGISTER method) will not be recorded in the log files. +### -ExcludePresenceNotifications + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True, information about presence notifications (that is, any message that uses the NOTIFY or BENOTIFY method) will not be recorded in the log files. The default value is False. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -154,17 +159,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Fqdn -Collection of domains to be included in the filter. -(More technically, these domains represent the host portion of a SIP address.) For the FQDN property you can use a fully qualified domain name (FQDN) like this: fabrikam.com. -Alternatively, you can use wildcards to represent multiple domains: *.fabrikam.com. -You can have more than one domain in a single filter. +### -ExcludeRegisterMessages + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True, information about client registrations (that is, any message that uses the REGISTER method) will not be recorded in the log files. +The default value is False. ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -173,23 +178,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Uri -Collection of URIs to be included in the filter. -(The URI is the user@host portion of a SIP address.) A URI can consist of any of the following patterns: +### -ExcludeSubscribeMessages -user@fabrikam.com +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -user@* +If set to True, information about client subscriptions (that is, any message that uses the SUBSCRIBE method) will not be recorded in the log files. +The default value is False. -*@fabrikam.com -You can include multiple URIs in a single filter. ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -198,18 +199,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeSubscribeMessages - -If set to True, information about client subscriptions (that is, any message that uses the SUBSCRIBE method) will not be recorded in the log files. -The default value is False. +### -ExcludeSuccessfulRequests +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +If set to True. +Information about successful SIP requests will not be recorded in the log files. +Instead, only information about unsuccessful requests will be saved. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -218,16 +219,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeSuccessfulRequests -If set to True. -Information about successful SIP requests will not be recorded in the log files. -Instead, only information about unsuccessful requests will be saved. +### -ExcludeTypingNotifications +If set to True, information about typing notifications SIP messages will not be recorded in the log files. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -236,13 +234,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeMidDialogRequests -If set to True, information about mid-dialog SIP requests will not be recorded in the log files. +### -Fqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Collection of domains to be included in the filter. +(More technically, these domains represent the host portion of a SIP address.) For the FQDN property you can use a fully qualified domain name (FQDN) like this: fabrikam.com. +Alternatively, you can use wildcards to represent multiple domains: *.fabrikam.com. +You can have more than one domain in a single filter. ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -251,13 +255,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludeTypingNotifications -If set to True, information about typing notifications SIP messages will not be recorded in the log files. +### -Uri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Collection of URIs to be included in the filter. +(The URI is the user@host portion of a SIP address.) A URI can consist of any of the following patterns: + +user@fabrikam.com + +user@* + +*@fabrikam.com + +You can include multiple URIs in a single filter. ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named diff --git a/skype/skype-ps/skype/New-CsDialInConferencingAccessNumber.md b/skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingAccessNumber.md similarity index 87% rename from skype/skype-ps/skype/New-CsDialInConferencingAccessNumber.md rename to skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingAccessNumber.md index 96f6b14689..0be2af9703 100644 --- a/skype/skype-ps/skype/New-CsDialInConferencingAccessNumber.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingAccessNumber.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csdialinconferencingaccessnumber applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsDialInConferencingAccessNumber -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csdialinconferencingaccessnumber +schema: 2.0.0 +title: New-CsDialInConferencingAccessNumber --- # New-CsDialInConferencingAccessNumber @@ -73,7 +74,7 @@ That simply means you must first create a dial plan, and specify a region for th ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsDialInConferencingAccessNumber -PrimaryUri "sip:RedmondDialIn@litwareinc.com" -DisplayNumber "1-800-555-1234" -LineUri "tel:+18005551234" -Pool atl-cs-001.litwareinc.com -PrimaryLanguage "en-US" -Regions "Redmond" ``` @@ -82,7 +83,7 @@ Example 1 creates a new dial-in conferencing access number with the primary URI In addition to the PrimaryUri parameter, the command also includes parameters that configure the telephone number as displayed in Skype for Business (DisplayNumber); the telephone number in the E.164 format (LineUri); the Registrar pool the new number is assigned to `(-Pool): the primary language for the number (PrimaryLanguage)`; and the region the new number is assigned to (Regions). -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsDialInConferencingAccessNumber -PrimaryUri "sip:RedmondDialIn@litwareinc.com" -DisplayNumber "1-800-555-1234" -LineUri "tel:+18005551234" -Pool atl-cs-001.litwareinc.com -PrimaryLanguage "en-US" -Regions "Redmond" -SecondaryLanguages "fr-CA", "fr-FR" @@ -92,7 +93,7 @@ The command shown in Example 2 is a variation of the command shown in Example 1; To assign these secondary languages, the SecondaryLanguages parameter is included, along with a comma-separated list of the languages to be assigned (fr-CA and fr-FR). -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` New-CsDialInConferencingAccessNumber -PrimaryUri "sip:RedmondDialIn@litwareinc.com" -DisplayNumber "1-800-555-1234" -LineUri "tel:+18005551234" -Pool atl-cs-001.litwareinc.com -PrimaryLanguage "en-US" -Regions "Redmond" -ScopeToSite ``` @@ -104,58 +105,56 @@ To do this, the command includes the parameter ScopeToSite. ## PARAMETERS -### -PrimaryUri +### -DisplayName +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Unique SIP address to be assigned to the new contact object. -When specifying the PrimaryUri you must include the "sip:" prefix. -For example: `-PrimaryUri "sip:RedmondDialIn@litwareinc.com".` -Note that the sip: prefix must be entered in all lowercase letters. +Active Directory display name for the new contact object. +This is the name that will also be displayed in Skype for Business. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayName - -Active Directory display name for the new contact object. -This is the name that will also be displayed in Skype for Business. +### -DisplayNumber +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Phone number as displayed in meeting invitations and on the dial-in conferencing webpage. +The DisplayNumber can be formatted any way you prefer; for example 1-800-555-1234; 1-(800)-555-1234; or 1.800.555.1234. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayNumber -Phone number as displayed in meeting invitations and on the dial-in conferencing webpage. -The DisplayNumber can be formatted any way you prefer; for example 1-800-555-1234; 1-(800)-555-1234; or 1.800.555.1234. +### -HostingProviderProxyFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the hosting provider that hosts your dial-in conferencing service. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Fqdn +Parameter Sets: Hosting +Aliases: HostingProvider Required: True Position: Named @@ -165,6 +164,9 @@ Accept wildcard characters: False ``` ### -LineURI + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The actual dial-in conferencing phone number. The LineURI must be specified using the following syntax: the tel: prefix followed by a plus sign (+) followed by the country/region calling code, area code, and phone number. For example: tel:+18005551234. @@ -175,8 +177,7 @@ LineURIs must be unique throughout Active Directory. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -185,18 +186,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Regions -Dial plan regions associated with the dial-in number. -If a region is not included in at least one dial plan, then it cannot be associated with a dial-in conferencing access number. -To specify multiple regions, use a comma-separated list: `-Regions "Northwest", "Southwest"` +### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to pass a contact object through the pipeline that represents the new dial-in conferencing access number. +By default, the New-CsDialInConferencingAccessNumber cmdlet does not pass objects through the pipeline. ```yaml -Type: Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.String] -Parameter Sets: (All), Onprem -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -204,13 +206,15 @@ Accept wildcard characters: False ``` ### -Pool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Home pool for the new contact object. ```yaml Type: Fqdn Parameter Sets: (All), Onprem -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -220,6 +224,9 @@ Accept wildcard characters: False ``` ### -PrimaryLanguage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Primary language used for making dial-in conferencing announcements. The language must be configured using one of the available dial-in conferencing language codes; for example, en-US for U.S. English; fr-FR for French; etc. @@ -230,8 +237,7 @@ To return a list of the available language codes, type the following command at ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -240,67 +246,61 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SecondaryLanguages -Optional collection of languages that can also be used for making dial-in conferencing announcements. -Secondary languages must be configured as a comma-separated list of language codes; for example, the following syntax sets French Canadian and French as secondary languages; `-SecondaryLanguages "fr-CA", "fr-FR".` +### -PrimaryUri -A single access number can have as many as four secondary languages. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.String] -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Unique SIP address to be assigned to the new contact object. +When specifying the PrimaryUri you must include the "sip:" prefix. +For example: `-PrimaryUri "sip:RedmondDialIn@litwareinc.com".` +Note that the sip: prefix must be entered in all lowercase letters. + -### -ScopeToSite -If present, the new number will be scoped to the same site as the contact object's home pool. -If the ScopeToSite parameter is not included, the new number will be assigned to the global scope. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a contact object through the pipeline that represents the new dial-in conferencing access number. -By default, the New-CsDialInConferencingAccessNumber cmdlet does not pass objects through the pipeline. +### -Regions + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Dial plan regions associated with the dial-in number. +If a region is not included in at least one dial plan, then it cannot be associated with a dial-in conferencing access number. +To specify multiple regions, use a comma-separated list: `-Regions "Northwest", "Southwest"` ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.String] +Parameter Sets: (All), Onprem +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -ScopeToSite + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If present, the new number will be scoped to the same site as the contact object's home pool. +If the ScopeToSite parameter is not included, the new number will be assigned to the global scope. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -309,14 +309,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -SecondaryLanguages + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Optional collection of languages that can also be used for making dial-in conferencing announcements. +Secondary languages must be configured as a comma-separated list of language codes; for example, the following syntax sets French Canadian and French as secondary languages; `-SecondaryLanguages "fr-CA", "fr-FR".` + +A single access number can have as many as four secondary languages. ```yaml -Type: SwitchParameter +Type: Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.String] Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -327,6 +332,8 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new dial-in conferencing access number is being created. For example: @@ -341,8 +348,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -351,16 +357,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HostingProviderProxyFqdn -Fully qualified domain name of the hosting provider that hosts your dial-in conferencing service. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Fqdn -Parameter Sets: Hosting -Aliases: HostingProvider -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf -Required: True +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi + +Required: False Position: Named Default value: None Accept pipeline input: False @@ -372,14 +398,13 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsDialInConferencingAccessNumber cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.Xds.AccessNumber The New-CsDialInConferencingAccessNumber cmdlet creates new instances of the Microsoft.Rtc.Management.Xds.AccessNumber object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsDialInConferencingConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingConfiguration.md similarity index 86% rename from skype/skype-ps/skype/New-CsDialInConferencingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingConfiguration.md index d05fb34422..bb22fd50d0 100644 --- a/skype/skype-ps/skype/New-CsDialInConferencingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csdialinconferencingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsDialInConferencingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csdialinconferencingconfiguration +schema: 2.0.0 +title: New-CsDialInConferencingConfiguration --- # New-CsDialInConferencingConfiguration @@ -43,7 +44,7 @@ These conference "join behaviors" are managed using dial-in conferencing configu ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CSDialInConferencingConfiguration -Identity site:Redmond -EnableNameRecording $False ``` @@ -52,7 +53,7 @@ The command shown in Example 1 creates a new collection of dial-in conferencing In addition, the optional parameter EnableNameRecording is included in order to set the EnableNameRecording property to False. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CSDialInConferencingConfiguration -Identity site:Redmond -InMemory @@ -68,27 +69,31 @@ Finally, line 3 in the example calls the Set-CSDialInConferencingConfiguration c ## PARAMETERS -### -Identity -Indicates the Identity of the dial-in conferencing configuration settings to be created. -Because these settings can only be created at the site scope, use syntax similar to this, with the prefix "site:" followed by the name of the site: `-Identity site:Redmond.` +### -AllowAnonymousPstnActivation -Note that there can only be one set of dial-in conferencing configuration settings per site. -The sample command will fail if a collection of settings with the Identity site:Redmond already exists. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies whether unauthenticated callers can start a meeting if they are the first person to join. +An unauthenticated caller is defined as a participant who joins a meeting over the phone and doesn't provide a PIN when joining the meeting. +$True to allow anonymous activation, otherwise $False. +The default is $False. ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -EnableNameRecording + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether or not users are asked to record their name before entering the conference. Set to True ($True) to require name recording; set to False ($False) to bypass name recording. The default value is True. @@ -96,8 +101,7 @@ The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -107,14 +111,16 @@ Accept wildcard characters: False ``` ### -EntryExitAnnouncementsEnabledByDefault + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If set to True announcements will be played each time a participant enters or exits a conference. If set to False (the default value), entry and exit announcements will not be played. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -124,6 +130,9 @@ Accept wildcard characters: False ``` ### -EntryExitAnnouncementsType + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the action taken by the system any time a participant enters or leaves a conference. Valid values are: @@ -139,8 +148,7 @@ Note that announcements are played only if the EntryExitAnnouncementsEnabledByDe ```yaml Type: EntryExitAnnouncementsType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,13 +158,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -165,34 +175,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -Identity -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Indicates the Identity of the dial-in conferencing configuration settings to be created. +Because these settings can only be created at the site scope, use syntax similar to this, with the prefix "site:" followed by the name of the site: `-Identity site:Redmond.` +Note that there can only be one set of dial-in conferencing configuration settings per site. +The sample command will fail if a collection of settings with the Identity site:Redmond already exists. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -201,14 +218,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -PinAuthType + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies which users are allowed to use PIN authentication. +Allowed values are: + +Everyone + +OrganizerOnly ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -217,17 +241,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAnonymousPstnActivation -Specifies whether unauthenticated callers can start a meeting if they are the first person to join. -An unauthenticated caller is defined as a participant who joins a meeting over the phone and doesn't provide a PIN when joining the meeting. -$True to allow anonymous activation, otherwise $False. -The default is $False. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -236,19 +259,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PinAuthType -Specifies which users are allowed to use PIN authentication. -Allowed values are: +### -WhatIf -Everyone +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -OrganizerOnly +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -262,13 +282,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsDialInConferencingConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingConfiguration Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsDialInConferencingDtmfConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingDtmfConfiguration.md similarity index 86% rename from skype/skype-ps/skype/New-CsDialInConferencingDtmfConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingDtmfConfiguration.md index 80d7835196..dcca03b1fd 100644 --- a/skype/skype-ps/skype/New-CsDialInConferencingDtmfConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsDialInConferencingDtmfConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csdialinconferencingdtmfconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsDialInConferencingDtmfConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csdialinconferencingdtmfconfiguration +schema: 2.0.0 +title: New-CsDialInConferencingDtmfConfiguration --- # New-CsDialInConferencingDtmfConfiguration @@ -67,7 +68,7 @@ To disable a command, set its value to Null ($Null). ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CSDialInConferencingDtmfConfiguration -Identity site:Redmond -MuteUnmuteCommand 4 -AudienceMuteCommand 6 ``` @@ -77,7 +78,7 @@ In this example, the MuteUnmuteCommand property is set to 4 and the AudienceMute -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CSDialInConferencingDtmfConfiguration -Identity site:Redmond -AdmitAll $Null ``` @@ -86,7 +87,7 @@ Example 2 creates a new set of DTMF configuration settings for the Redmond site. In this example, the AdmitAll property is disabled; that's done by using the AdmitAll parameter and setting the parameter value to null. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` $x = New-CSDialInConferencingDtmfConfiguration -Identity site:Redmond -InMemory @@ -110,32 +111,17 @@ The final command then uses the Set-CSDialInConferencingDtmfConfiguration cmdlet ## PARAMETERS -### -Identity -Unique identifier to be assigned to the new collection of DTMF configuration settings. -Because you can only create new collections at the site scope, the Identity will always be the prefix "site:" followed by the site name; for example "site:Redmond". - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AdmitAll -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AdmitAll Indicates the key to be pressed in order to allow all the users in the lobby to immediately join the conference. The default value is 8. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -145,14 +131,16 @@ Accept wildcard characters: False ``` ### -AudienceMuteCommand + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the key a presenter can press to mute or unmute everyone else in the conference (that is, everyone other than the presenter will be muted or unmuted). The default key is 4. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,6 +150,9 @@ Accept wildcard characters: False ``` ### -CommandCharacter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the key to be pressed at the beginning of a command. The default key is the asterisk (*). The only other allowed value is #. @@ -169,8 +160,7 @@ The only other allowed value is #. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -180,14 +170,34 @@ Accept wildcard characters: False ``` ### -EnableDisableAnnouncementsCommand + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the key to be pressed to enable or disable announcements each time someone joins or leaves the conference. The default key is 9. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -197,14 +207,16 @@ Accept wildcard characters: False ``` ### -HelpCommand + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the key to be pressed in order to privately play a description of all the DTMF commands. The default key is 1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -213,36 +225,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LockUnlockConferenceCommand -Indicates the key to be pressed to lock or unlock a conference. -If a conference is locked, then no new participants will be allowed to join that conference, at least not until the conference has been unlocked. -The default key is 7. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier to be assigned to the new collection of DTMF configuration settings. +Because you can only create new collections at the site scope, the Identity will always be the prefix "site:" followed by the site name; for example "site:Redmond". ```yaml -Type: String +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MuteUnmuteCommand +### -InMemory -Indicates the key to be pressed to mute or unmute yourself; the same key is used to toggle back and forth between muting and unmuting. -The default key is 6. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -251,15 +265,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PrivateRollCallCommand -Indicates the key to be pressed to privately play the name of each conference participant. -The default key is 3. +### -LockUnlockConferenceCommand + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the key to be pressed to lock or unlock a conference. +If a conference is locked, then no new participants will be allowed to join that conference, at least not until the conference has been unlocked. +The default key is 7. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -268,14 +285,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -MuteUnmuteCommand + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the key to be pressed to mute or unmute yourself; the same key is used to toggle back and forth between muting and unmuting. +The default key is 6. + + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -284,18 +306,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory - -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -OperatorLineUri +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Phone number that the dial-in conferencing auto-attendant will connect a PSTN user to any time that user presses *0 on their telephone keypad. +Pressing *0 is designed to connect dial-in conferencing users to operator assistance. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -304,14 +325,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -PrivateRollCallCommand + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the key to be pressed to privately play the name of each conference participant. +The default key is 3. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -321,13 +345,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -336,15 +362,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OperatorLineUri -Phone number that the dial-in conferencing auto-attendant will connect a PSTN user to any time that user presses *0 on their telephone keypad. -Pressing *0 is designed to connect dial-in conferencing users to operator assistance. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -358,13 +385,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsDialInConferencingDtmfConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingDtmfConfiguration Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingDtmfConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsDialPlan.md b/skype/skype-ps/SkypeForBusiness/New-CsDialPlan.md similarity index 86% rename from skype/skype-ps/skype/New-CsDialPlan.md rename to skype/skype-ps/SkypeForBusiness/New-CsDialPlan.md index aff1a6f077..7e4d45af5a 100644 --- a/skype/skype-ps/skype/New-CsDialPlan.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsDialPlan.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csdialplan applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsDialPlan -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csdialplan +schema: 2.0.0 +title: New-CsDialPlan --- # New-CsDialPlan @@ -44,7 +45,7 @@ New normalization rules can be added to a dial plan by calling the New-CsVoiceNo ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsDialPlan -Identity RedmondDialPlan ``` @@ -54,7 +55,7 @@ The command shown in Example 1 creates a new dial plan with the Identity Redmond Dial plans created at the per-user scope can be directly assigned to users and groups.) All other properties of the dial plan will be assigned default values. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsDialPlan -Identity site:Redmond -SimpleName RedmondSiteDialPlan @@ -72,7 +73,7 @@ Multiple normalization rules can be applied to one dial plan, so each normalizat -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` New-CsDialPlan -Identity RedmondDialPlan -Description "Dial plan for Redmond users" ``` @@ -84,26 +85,46 @@ The command shown in Example 3 creates a new dial plan with the Identity Redmond ## PARAMETERS -### -Identity -A unique identifier designating the scope and name (site), the service role and FQDN, or the name (per user) to identify the dial plan. -For example, a site Identity would be entered in the format site:\, where sitename is the name of the site. -A dial plan at the service scope must be a Registrar or PSTN gateway service, where the Identity value is formatted like this: Registrar:Redmond.litwareinc.com. -A per-user Identity would be entered simply as a unique string value. +### -City + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not used with this cmdlet. ```yaml -Type: XdsIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CountryCode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not used with this cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A description of this dial plan--what it's for, what type of user it applies to, or any other information that will be helpful in identifying the purpose of the dial plan. Maximum characters: 512 @@ -111,8 +132,7 @@ Maximum characters: 512 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,6 +142,9 @@ Accept wildcard characters: False ``` ### -DialinConferencingRegion + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name of the region associated with this dial plan. Specify a value for this parameter if the dial plan will be used for dial-in conferencing. This allows the correct access number to be assigned when the conference organizer sets up the conference. @@ -132,8 +155,7 @@ Maximum characters: 512 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -143,6 +165,9 @@ Accept wildcard characters: False ``` ### -ExternalAccessPrefix + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A number (or set of numbers) that designates the call as external to the organization. (For example, to dial an outside line, first press 9.) This prefix will be ignored by the normalization rules, although these rules will be applied to the rest of the number. @@ -156,8 +181,67 @@ Default: 9 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier designating the scope and name (site), the service role and FQDN, or the name (per user) to identify the dial plan. +For example, a site Identity would be entered in the format site:\, where sitename is the name of the site. +A dial plan at the service scope must be a Registrar or PSTN gateway service, where the Identity value is formatted like this: Registrar:Redmond.litwareinc.com. +A per-user Identity would be entered simply as a unique string value. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -168,6 +252,8 @@ Accept wildcard characters: False ### -NormalizationRules +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A list of normalization rules that are applied to this dial plan. While this list and these rules can be created directly with this cmdlet, we recommend that you create the normalization rules with the New-CsVoiceNormalizationRule cmdlet, which creates the rule and assigns it to the specified dial plan. @@ -185,8 +271,7 @@ You can create a new normalization rule by calling the New-CsVoiceNormalizationR ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -196,6 +281,9 @@ Accept wildcard characters: False ``` ### -OptimizeDeviceDialing + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Setting this parameter to True will apply the prefix in the ExternalAccessPrefix parameter to calls made outside the organization. This value can be set to True only if a value has been specified for the ExternalAccessPrefix parameter. @@ -204,8 +292,7 @@ Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -216,6 +303,8 @@ Accept wildcard characters: False ### -SimpleName +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A display name for the dial plan. This name must be unique among all dial plans within the Skype for Business Server deployment. @@ -235,8 +324,7 @@ The default for a per-user dial plan is the Identity of the dial plan. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -246,29 +334,15 @@ Accept wildcard characters: False ``` ### -State -This parameter is not used with this cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -City This parameter is not used with this cmdlet. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -277,30 +351,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CountryCode -This parameter is not used with this cmdlet. +### -Confirm -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses any confirmation prompts before making changes. +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -309,50 +369,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory - -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. - - +### -WhatIf -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -366,12 +392,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile. ## NOTES diff --git a/skype/skype-ps/skype/New-CsEmergencyNumber.md b/skype/skype-ps/SkypeForBusiness/New-CsEmergencyNumber.md similarity index 89% rename from skype/skype-ps/skype/New-CsEmergencyNumber.md rename to skype/skype-ps/SkypeForBusiness/New-CsEmergencyNumber.md index f871386781..4fb895fe5f 100644 --- a/skype/skype-ps/skype/New-CsEmergencyNumber.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsEmergencyNumber.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csemergencynumber applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsEmergencyNumber -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csemergencynumber +schema: 2.0.0 +title: New-CsEmergencyNumber --- # New-CsEmergencyNumber @@ -29,21 +30,21 @@ With the November 2016 Cumulative Update, the number of support emergency number ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` PS C:\> New-CsEmergencyNumber -DialString 911 ``` This example creates a new emergency number with dial string 911. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` PS C:\> New-CsEmergencyNumber -DialString 911 -DialMask 112 ``` This example creates a new emergency number with dial string 911 and single dial mask 112. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` PS C:\> New-CsEmergencyNumber -DialString 911 -DialMask 112;999 ``` @@ -53,13 +54,15 @@ This example creates an emergency number with multiple dial masks. ## PARAMETERS ### -DialMask + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + For each emergency number, you can specify zero or more emergency dial masks. A dial mask is a number that you want to translate into the value of the emergency dial number value when it is dialed. For example, assume you enter a value of 212 in this field and the emergency dial number field has a value of 911. When a user dials 212, the number will be translated to 911. This allows for alternate emergency numbers to be dialed and still have the call reach emergency services (for example, if someone from a country or region with a different emergency number attempts to dial that country or region's number rather than the number for the country or region they are currently in). You can define multiple emergency dial masks by separating the values with semicolons. For example, 212;414. The string limit for a dial mask is 100 characters. Each character must be a digit 0 through 9. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -69,13 +72,15 @@ Accept wildcard characters: False ``` ### -DialString + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the phone number to call out with this emergency number. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named diff --git a/skype/skype-ps/skype/New-CsExUmContact.md b/skype/skype-ps/SkypeForBusiness/New-CsExUmContact.md similarity index 86% rename from skype/skype-ps/skype/New-CsExUmContact.md rename to skype/skype-ps/SkypeForBusiness/New-CsExUmContact.md index a9107cd958..e0b7600df8 100644 --- a/skype/skype-ps/skype/New-CsExUmContact.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsExUmContact.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csexumcontact applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsExUmContact -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csexumcontact +schema: 2.0.0 +title: New-CsExUmContact --- # New-CsExUmContact @@ -40,7 +41,7 @@ From the policies retrieved you can determine whether an appropriate global or s ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsExUmContact -SipAddress sip:exumsa1@fabrikam.com -RegistrarPool RedmondPool.litwareinc.com -OU "OU=ExUmContacts,DC=litwareinc,DC=com" -DisplayNumber 2065554567 ``` @@ -53,7 +54,7 @@ Because we didn't specifically set the AutoAttendant parameter, the default of F -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsExUmContact -SipAddress sip:exumaa1@fabrikam.com -RegistrarPool RedmondPool.litwareinc.com -OU "OU=ExUmContacts,DC=litwareinc,DC=com" -DisplayNumber 2065559876 -AutoAttendant $True ``` @@ -67,45 +68,42 @@ The difference in this example is that we set the optional parameter AutoAttenda ## PARAMETERS -### -SipAddress +### -AutoAttendant -The SIP address of the contact. -This must be a new address that does not already exist as a user or contact in Active Directory Domain Services. -This value must begin with the string sip: followed by the SIP address. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies whether this contact object is an Auto Attendant. +(Auto Attendant provides a set of voice prompts that allow callers to navigate the phone system and reach the intended party.) + +Default: False ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RegistrarPool - - -The fully qualified domain name (FQDN) of the pool on which the Registrar service is running. - -Note that an Exchange UM contact in Skype for Business Server cannot be moved to pools that are part of Microsoft Office Communications Server 2007 or Microsoft Office Communications Server 2007 R2 deployments. - -Full data type: Microsoft.Rtc.Management.Deploy.Fqdn +### -Description +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +A description of this contact. +The description is for use by administrators to identify the type of contact (Auto Attendant or Subscriber Access), the location, provider, or any other information that will identify the purpose of each Exchange UM contact. ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -113,6 +111,9 @@ Accept wildcard characters: False ``` ### -DisplayNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The telephone number of the contact. Display numbers for each contact must be unique (for instance, no two Exchange UM contacts can have the same display number). @@ -122,8 +123,7 @@ The first digit cannot be zero. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -133,6 +133,9 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The organizational unit (OU) where this contact will be located in Active Directory. Full data type: Microsoft.Rtc.Management.AD.OUIdParameter @@ -140,8 +143,7 @@ Full data type: Microsoft.Rtc.Management.AD.OUIdParameter ```yaml Type: OUIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -150,20 +152,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AutoAttendant - -Specifies whether this contact object is an Auto Attendant. -(Auto Attendant provides a set of voice prompts that allow callers to navigate the phone system and reach the intended party.) - -Default: False +### -PassThru +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Returns the results of this command. +Running this cmdlet will display the newly created object; including this parameter will simply repeat that output, making the use of this parameter redundant. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -172,48 +171,63 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -A description of this contact. -The description is for use by administrators to identify the type of contact (Auto Attendant or Subscriber Access), the location, provider, or any other information that will identify the purpose of each Exchange UM contact. +### -RegistrarPool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + + +The fully qualified domain name (FQDN) of the pool on which the Registrar service is running. + +Note that an Exchange UM contact in Skype for Business Server cannot be moved to pools that are part of Microsoft Office Communications Server 2007 or Microsoft Office Communications Server 2007 R2 deployments. + +Full data type: Microsoft.Rtc.Management.Deploy.Fqdn + + ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Returns the results of this command. -Running this cmdlet will display the newly created object; including this parameter will simply repeat that output, making the use of this parameter redundant. +### -SipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The SIP address of the contact. +This must be a new address that does not already exist as a user or contact in Active Directory Domain Services. +This value must begin with the string sip: followed by the SIP address. + + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -222,14 +236,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -243,12 +259,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact Creates an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact. ## NOTES diff --git a/skype/skype-ps/skype/New-CsExtendedTest.md b/skype/skype-ps/SkypeForBusiness/New-CsExtendedTest.md similarity index 91% rename from skype/skype-ps/skype/New-CsExtendedTest.md rename to skype/skype-ps/SkypeForBusiness/New-CsExtendedTest.md index 0b33391159..9bc75f4f37 100644 --- a/skype/skype-ps/skype/New-CsExtendedTest.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsExtendedTest.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csextendedtest applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsExtendedTest -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csextendedtest +schema: 2.0.0 +title: New-CsExtendedTest --- # New-CsExtendedTest @@ -42,7 +43,7 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $x = New-CsExtendedTest -TestUsers "sip:kenmyer@litwareinc.com", "sip:pilar@litwareinc.com" -Name "PSTN Test" -TestType "PSTN" @@ -61,13 +62,15 @@ This is done by using the ExtendedTests parameter and the syntax @{Add=$x}. ## PARAMETERS ### -Name + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Friendly name to be given to the extended test. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -TestType + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Type of testing to be carried out by the extended test. Allowed values are: @@ -88,8 +94,7 @@ You can only specify a single TestType per extended test. ```yaml Type: TestType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -99,6 +104,9 @@ Accept wildcard characters: False ``` ### -TestUsers + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address of the user account(s) that will serve as test users. Multiple accounts can be specified by separating those accounts using commas; for example: @@ -109,8 +117,7 @@ You must specify at least two test users when using the PSTN TestType. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -124,13 +131,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsExtendedTest cmdlet does not accept pipelined input ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.ExtendedTest The New-CsExtendedTest cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.ExtendedTest object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsExternalAccessPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsExternalAccessPolicy.md similarity index 89% rename from skype/skype-ps/skype/New-CsExternalAccessPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsExternalAccessPolicy.md index 0e86942e9c..74ff892329 100644 --- a/skype/skype-ps/skype/New-CsExternalAccessPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsExternalAccessPolicy.md @@ -1,12 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csexternalaccesspolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsExternalAccessPolicy -schema: 2.0.0 author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/new-csexternalaccesspolicy +schema: 2.0.0 +title: New-CsExternalAccessPolicy --- # New-CsExternalAccessPolicy @@ -68,7 +70,7 @@ The following parameters are not applicable to Skype for Business Online/Microso ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsExternalAccessPolicy -Identity site:Redmond -EnableFederationAccess $True -EnableOutsideAccess $True ``` @@ -76,7 +78,7 @@ New-CsExternalAccessPolicy -Identity site:Redmond -EnableFederationAccess $True The command shown in Example 1 creates a new external access policy that has the Identity site:Redmond; upon creation, this policy will automatically be assigned to the Redmond site. Note that this new policy sets both the EnableFederationAccess and the EnableOutsideAccess properties to True. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsExternalAccessPolicy -Identity Global -EnableAcsFederationAccess $true New-CsExternalAccessPolicy -Identity AcsFederationNotAllowed -EnableAcsFederationAccess $false @@ -84,7 +86,7 @@ New-CsExternalAccessPolicy -Identity AcsFederationNotAllowed -EnableAcsFederatio In this example, the Global policy is updated to allow Teams-ACS federation for all users, then a new external access policy instance is created with Teams-ACS federation disabled and which can then be assigned to selected users for which Team-ACS federation will not be allowed. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` New-CsExternalAccessPolicy -Identity site:Redmond -EnableTeamsConsumerAccess $True -EnableTeamsConsumerInbound $False ``` @@ -92,7 +94,7 @@ New-CsExternalAccessPolicy -Identity site:Redmond -EnableTeamsConsumerAccess $Tr The command shown in Example 3 creates a new external access policy that has the Identity site:Redmond; upon creation, this policy will automatically be assigned to the Redmond site. Note that this new policy enables communication with people using Teams with an account that's not managed by an organization and limits this to only be initiated by people in your organization. This means that people using Teams with an account that's not managed by an organization will not be able to discover or start a conversation with people with this policy assigned. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` $x = New-CsExternalAccessPolicy -Identity RedmondAccessPolicy -InMemory @@ -114,48 +116,50 @@ Should that happen, an external access policy with the Identity RedmondAccessPol ## PARAMETERS -### -Identity -Unique Identity to be assigned to the policy. -New external access policies can be created at the site or per-user scope. -To create a new site policy, use the prefix "site:" and the name of the site as your Identity. -For example, use this syntax to create a new policy for the Redmond site: `-Identity site:Redmond.` -To create a new per-user policy, use an Identity similar to this: `-Identity SalesAccessPolicy.` +### -Description -Note that you cannot create a new global policy; if you want to make changes to the global policy, use the Set-CsExternalAccessPolicy cmdlet instead. -Likewise, you cannot create a new site or per-user policy if a policy with that Identity already exists. -If you need to make changes to an existing policy, use the Set-CsExternalAccessPolicy cmdlet. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to provide explanatory text to accompany the policy. +For example, the Description might include information about the users the policy should be assigned to. ```yaml -Type: XdsIdentity +Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide explanatory text to accompany the policy. -For example, the Description might include information about the users the policy should be assigned to. +### -EnableAcsFederationAccess + +> Applicable: Microsoft Teams + +Indicates whether Teams meetings organized by the user can be joined by users of customer applications built using Azure Communication Services (ACS). This policy setting only applies if ACS Teams federation has been enabled at the tenant level using the cmdlet Set-CsTeamsAcsFederationConfiguration. Additionally, Azure Communication Services users would be able to call Microsoft 365 users that have assigned policies with enabled federation. + +To enable for all users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to True. It can be disabled for selected users by assigning them a policy with federation disabled. + +To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 - Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` ### -EnableFederationAccess + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the user is allowed to communicate with people who have SIP accounts with a federated organization. Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. The default value is True. @@ -164,7 +168,6 @@ The default value is True. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -173,58 +176,59 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableTeamsConsumerAccess -(Microsoft Teams Only) Indicates whether the user is allowed to communicate with people who have who are using Teams with an account that's not managed by an organization. +### -EnableOutsideAccess -To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. -The default value is True. +Indicates whether the user is allowed to connect to Skype for Business Server over the Internet, without logging on to the organization's internal network. +The default value is False. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableTeamsConsumerInbound -(Microsoft Teams Only) Indicates whether the user is allowed to be discoverable by people who are using Teams with an account that's not managed by an organization. It also controls if people who are using Teams with an account that's not managed by an organization can start the communication with the user. +### -EnablePublicCloudAudioVideoAccess -To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. -The default value is True. +Indicates whether the user is allowed to conduct audio/video conversations with people who have SIP accounts with a public Internet connectivity provider such as MSN. +When set to False, audio and video options in Skype for Business Server will be disabled any time a user is communicating with a public Internet connectivity contact. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAcsFederationAccess -Indicates whether Teams meetings organized by the user can be joined by users of customer applications built using Azure Communication Services (ACS). This policy setting only applies if ACS Teams federation has been enabled at the tenant level using the cmdlet Set-CsTeamsAcsFederationConfiguration. Additionally, Azure Communication Services users would be able to call Microsoft 365 users that have assigned policies with enabled federation. +### -EnableTeamsConsumerAccess -To enable for all users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to True. It can be disabled for selected users by assigning them a policy with federation disabled. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +(Microsoft Teams Only) Indicates whether the user is allowed to communicate with people who have who are using Teams with an account that's not managed by an organization. To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. +Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. +The default value is True. + ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams Required: False Position: Named Default value: True @@ -232,32 +236,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOutsideAccess -Indicates whether the user is allowed to connect to Skype for Business Server over the Internet, without logging on to the organization's internal network. -The default value is False. +### -EnableTeamsConsumerInbound + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +(Microsoft Teams Only) Indicates whether the user is allowed to be discoverable by people who are using Teams with an account that's not managed by an organization. It also controls if people who are using Teams with an account that's not managed by an organization can start the communication with the user. + +To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. + +Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. +The default value is True. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -EnablePublicCloudAudioVideoAccess -Indicates whether the user is allowed to conduct audio/video conversations with people who have SIP accounts with a public Internet connectivity provider such as MSN. -When set to False, audio and video options in Skype for Business Server will be disabled any time a user is communicating with a public Internet connectivity contact. +### -EnableXmppAccess + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether the user is allowed to communicate with users who have SIP accounts with a federated XMPP (Extensible Messaging and Presence Protocol) partner. +The default value is False. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -267,13 +278,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -282,31 +295,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique Identity to be assigned to the policy. +New external access policies can be created at the site or per-user scope. +To create a new site policy, use the prefix "site:" and the name of the site as your Identity. +For example, use this syntax to create a new policy for the Redmond site: `-Identity site:Redmond.` +To create a new per-user policy, use an Identity similar to this: `-Identity SalesAccessPolicy.` + +Note that you cannot create a new global policy; if you want to make changes to the global policy, use the Set-CsExternalAccessPolicy cmdlet instead. +Likewise, you cannot create a new site or per-user policy if a policy with that Identity already exists. +If you need to make changes to an existing policy, use the Set-CsExternalAccessPolicy cmdlet. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -315,14 +340,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Tenant + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new external access policy is being created. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -331,15 +365,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableXmppAccess -Indicates whether the user is allowed to communicate with users who have SIP accounts with a federated XMPP (Extensible Messaging and Presence Protocol) partner. -The default value is False. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -348,21 +383,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new external access policy is being created. -For example: +### -WhatIf -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: - -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -376,13 +406,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsExternalAccessPolicy cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy object. ### System.Object diff --git a/skype/skype-ps/skype/New-CsExternalUserCommunicationPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsExternalUserCommunicationPolicy.md similarity index 96% rename from skype/skype-ps/skype/New-CsExternalUserCommunicationPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsExternalUserCommunicationPolicy.md index 728455d346..e5032dbdcf 100644 --- a/skype/skype-ps/skype/New-CsExternalUserCommunicationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsExternalUserCommunicationPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csexternalusercommunicationpolicy applicable: Skype for Business Online -title: New-CsExternalUserCommunicationPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/new-csexternalusercommunicationpolicy +schema: 2.0.0 +title: New-CsExternalUserCommunicationPolicy --- # New-CsExternalUserCommunicationPolicy @@ -39,14 +41,13 @@ This example creates a new policy to block external file transfer. Then you can ## PARAMETERS -### -EnableP2PFileTransfer -Indicates whether file transfers to Federated partners are allowed. The default value is True. +### -AllowPresenceVisibility +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -55,7 +56,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableFileTransfer +### -AllowTitleVisibility This parameter is reserved for internal Microsoft use. ```yaml @@ -70,7 +71,7 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPresenceVisibility +### -EnableFileTransfer This parameter is reserved for internal Microsoft use. ```yaml @@ -85,13 +86,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowTitleVisibility -This parameter is reserved for internal Microsoft use. +### -EnableP2PFileTransfer + +> Applicable: Skype for Business Online + +Indicates whether file transfers to Federated partners are allowed. The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -100,13 +104,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Force +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf +Aliases: Required: False Position: Named @@ -116,13 +120,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + Unique identifier for the external user communication policy to be created. ```yaml Type: XdsIdentity Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: 1 @@ -131,21 +137,6 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -InMemory {{Fill InMemory Description}} @@ -162,6 +153,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Globally unique identifier (GUID) of the tenant account whose external user communication policy are being created. For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` @@ -176,7 +170,21 @@ If you are using a remote session of Windows PowerShell and are connected only t Type: Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +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 @@ -186,13 +194,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/New-CsFIPSConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsFIPSConfiguration.md similarity index 89% rename from skype/skype-ps/skype/New-CsFIPSConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsFIPSConfiguration.md index 64a8204ef3..11d9866850 100644 --- a/skype/skype-ps/skype/New-CsFIPSConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsFIPSConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csfipsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsFIPSConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csfipsconfiguration +schema: 2.0.0 +title: New-CsFIPSConfiguration --- # New-CsFIPSConfiguration @@ -47,7 +48,7 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $x = New-CsFIPSConfiguration -Identity "global" -RequireFIPSCompliantMedia $False -InMemory @@ -65,35 +66,16 @@ Although this example works, it is easier to modify FIPS configuration settings ## PARAMETERS -### -Identity - -Unique identifier for the new collection of FIPS configuration settings. -Because Skype for Business Server only supports a single, global collection of FIPS settings, the only way you can use this parameter is to create a "new" global collection that exists only in memory. -You will also need to use the InMemory parameter in order to do that. - - - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -102,31 +84,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the new collection of FIPS configuration settings. +Because Skype for Business Server only supports a single, global collection of FIPS settings, the only way you can use this parameter is to create a "new" global collection that exists only in memory. +You will also need to use the InMemory parameter in order to do that. + + ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -137,6 +127,8 @@ Accept wildcard characters: False ### -RequireFIPSCompliantMedia +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, Skype for Business Server will only allow media sessions with entities that use FIPS compliant algorithms for authentication and authorization. Note that, if you require FIPS compliance, then your users will no longer be able to connect to your system by using a Microsoft Lync Server 2010 A/V Edge server. @@ -149,8 +141,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -161,6 +152,8 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new FIPS configuration settings are being created. For example: @@ -175,8 +168,25 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -186,13 +196,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -206,13 +218,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsFIPSConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.FIPSConfiguration.FIPSConfiguration The New-CsFIPSConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.FIPSConfiguration.FIPSConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsFileTransferFilterConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsFileTransferFilterConfiguration.md similarity index 88% rename from skype/skype-ps/skype/New-CsFileTransferFilterConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsFileTransferFilterConfiguration.md index 166f9d2ba7..eb3c3f0f9d 100644 --- a/skype/skype-ps/skype/New-CsFileTransferFilterConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsFileTransferFilterConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csfiletransferfilterconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsFileTransferFilterConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csfiletransferfilterconfiguration +schema: 2.0.0 +title: New-CsFileTransferFilterConfiguration --- # New-CsFileTransferFilterConfiguration @@ -47,7 +48,7 @@ Likewise, you cannot create a new configuration for a site that already has one ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsFileTransferFilterConfiguration -Identity site:Redmond ``` @@ -57,7 +58,7 @@ Because no additional parameters were specified, the configuration will be creat -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsFileTransferFilterConfiguration -Identity site:Redmond -Extensions @{Add=".ps1"} ``` @@ -69,7 +70,7 @@ This new extension is added by using the Extensions parameter and the list modif -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` New-CsFileTransferFilterConfiguration -Identity site:Redmond -Extensions @{Replace=".vbs",".ps1"} @@ -81,7 +82,7 @@ This means that the complete set of file extensions will be replaced by the two In this case the only files blocked at the Redmond site will be .vbs and .ps1. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` New-CsFileTransferFilterConfiguration -Identity site:Redmond -Action "BlockAll" @@ -105,25 +106,10 @@ Note that this same task can be accomplished in one step with the following comm ## PARAMETERS -### -Identity -Unique identifier to be given to the file transfer filter configuration. -The Identity for the new configuration is simply the prefix "site:" followed by the site name. -For example, to create a new configuration for the Redmond site, you would use this syntax: `-Identity site:Redmond.` - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Action -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Action Determines the action to be taken if file transfer filtering is enabled. If set to BlockAll then all file transfers will be prohibited, regardless of file extension. If set to Block (the default value) file transfers will be allowed unless the file extension appears as one of the prohibited file types listed in the Extensions property. @@ -133,8 +119,7 @@ To allow unrestricted file transfers (that is, to allow users to exchange any ty ```yaml Type: FileFilterAction Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -144,6 +129,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables or disables file transfer filtering. If this parameter is set to True, files with the specified extensions (or all files, depending on the value of the Action property) cannot be transferred by a Skype for Business Server client. If this parameter is set to False, any file can be transferred. @@ -155,8 +143,7 @@ Default: True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,6 +154,8 @@ Accept wildcard characters: False ### -Extensions +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + List of file extensions that will be blocked. If you attempt to use a Skype for Business Server client to transfer a file that has a file extension matching one of the extensions in this list, that transfer will be blocked and the file will not be transferred. This list is ignored if Action is set to BlockAll (all file transfers are blocked) or if Enabled is set to False (no file transfers are blocked). @@ -180,8 +169,7 @@ By default, the following file extensions are included in the Extensions propert ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -191,13 +179,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -206,8 +196,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier to be given to the file transfer filter configuration. +The Identity for the new configuration is simply the prefix "site:" followed by the site name. +For example, to create a new configuration for the Redmond site, you would use this syntax: `-Identity site:Redmond.` + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. @@ -216,8 +228,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -226,14 +237,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -242,14 +255,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -263,12 +278,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.FileTransferFilterConfiguration The New-CsFileTransferFilterConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.FileTransferFilterConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsGroupPickupUserOrbit.md b/skype/skype-ps/SkypeForBusiness/New-CsGroupPickupUserOrbit.md similarity index 87% rename from skype/skype-ps/skype/New-CsGroupPickupUserOrbit.md rename to skype/skype-ps/SkypeForBusiness/New-CsGroupPickupUserOrbit.md index 2b89c659fb..499eb5d270 100644 --- a/skype/skype-ps/skype/New-CsGroupPickupUserOrbit.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsGroupPickupUserOrbit.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csgrouppickupuserorbit applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsGroupPickupUserOrbit -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csgrouppickupuserorbit +schema: 2.0.0 +title: New-CsGroupPickupUserOrbit --- # New-CsGroupPickupUserOrbit @@ -27,7 +28,7 @@ This cmdlet will throw an exception if the user is already assigned a group pick ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsGroupPickupUserOrbit -User sip:KenMyers@Contoso.com -Orbit "*100" ``` @@ -36,7 +37,7 @@ This example adds a user specified by the SIP address to the *100 orbit. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsGroupPickupUserOrbit "Ken Myers" -Orbit 2103 ``` @@ -49,7 +50,28 @@ The first parameter after the cmdlet is assumed to be the User parameter value. ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Orbit + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the group pickup orbit number to be assigned to the user. The number must be within an orbit pickup range that was created with a type of GroupPickup. For more information on creating call park orbits, see [New-CsCallParkOrbit](https://learn.microsoft.com/powershell/module/skype/New-CsCallParkOrbit). @@ -59,8 +81,7 @@ Values for the Orbit parameter must match the regular expression (\[\*|#\]?\[1-9 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -70,6 +91,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the user whose group pickup orbit number will be assigned. Because User is a positional parameter, the -User syntax is not required. The first parameter after the cmdlet is assumed to be the User parameter value. @@ -81,7 +105,6 @@ You can also reference a user account by using the user's Active Directory disti Type: String Parameter Sets: (All) Aliases: DisplayName, SipAddress, Identity -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 1 @@ -91,13 +114,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -106,30 +131,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -143,12 +154,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### +### System.String This cmdlet supports pipelined input from the Get-CsUser cmdlet. ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.Helpers.GroupPickup.DisplayGroupPickupUserOrbit This cmdlet returns an instance of the Microsoft.Rtc.Management.Voice.Helpers.GroupPickup.DisplayGroupPickupUserOrbit object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsHealthMonitoringConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsHealthMonitoringConfiguration.md similarity index 88% rename from skype/skype-ps/skype/New-CsHealthMonitoringConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsHealthMonitoringConfiguration.md index 836ccad607..ac37fc1801 100644 --- a/skype/skype-ps/skype/New-CsHealthMonitoringConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsHealthMonitoringConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cshealthmonitoringconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsHealthMonitoringConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cshealthmonitoringconfiguration +schema: 2.0.0 +title: New-CsHealthMonitoringConfiguration --- # New-CsHealthMonitoringConfiguration @@ -65,7 +66,7 @@ However, test users cannot be assigned to Office Communications Server pools. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsHealthMonitoringConfiguration -Identity atl-cs-001.litwareinc.com -FirstTestUserSipUri "sip:kenmyer@litwareinc.com" -SecondTestUserSipUri "sip:pilar@litwareinc.com" ``` @@ -75,7 +76,7 @@ These new settings will use sip:kenmyer@litwareinc.com and sip:pilar@litwareinc. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = Get-CsService -Registrar | Select-Object PoolFqdn @@ -98,46 +99,39 @@ Each collection is also assigned the same two test accounts: sip:kenmyer@litware ## PARAMETERS -### -Identity - -FQDN of the pool where the health monitoring configuration settings are to be assigned (for example: `-Identity atl-cs-001.litwareinc.com`). -Your command will fail if the specified pool already hosts a collection of health monitoring configuration settings. +### -FirstTestSamAccountName -The Identity is equivalent to the TargetFqdn parameter. -When creating a new collection of settings, you can use either parameter. -If you leave out both parameters, the New-CsHealthMonitoringConfiguration cmdlet will prompt you to enter the Identity. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +SamAccountName of the first test user. +The FirstTestSamAccountName must be entered by using the format domain\username; for example: +`-FirstTestSamAccountName litwareinc\kenmyer` ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetFqdn - -FQDN of the pool where the health monitoring configuration settings are to be assigned (for example: `-TargetFqdn atl-cs-001.litwareinc.com`). -Your command will fail if the specified pool already hosts a collection of health monitoring configuration settings. - -The TargetFqdn is equivalent to the Identity parameter. -When creating a new collection of settings, you can use either parameter. -If you leave out both parameters, the New-CsHealthMonitoringConfiguration cmdlet will prompt you to enter the Identity. +### -FirstTestUserSipUri +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +SIP address of the first test user to be configured for use by this collection of health monitoring settings. +Note that the SIP address must include the sip: prefix. +For example: `-FirstTestUserSipUri "sip:kenmyer@litwareinc.com".` ```yaml Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: Required: True Position: Named @@ -146,17 +140,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FirstTestSamAccountName -SamAccountName of the first test user. -The FirstTestSamAccountName must be entered by using the format domain\username; for example: +### -Force -`-FirstTestSamAccountName litwareinc\kenmyer` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -165,18 +158,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FirstTestUserSipUri -SIP address of the first test user to be configured for use by this collection of health monitoring settings. -Note that the SIP address must include the sip: prefix. -For example: `-FirstTestUserSipUri "sip:kenmyer@litwareinc.com".` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of the pool where the health monitoring configuration settings are to be assigned (for example: `-Identity atl-cs-001.litwareinc.com`). +Your command will fail if the specified pool already hosts a collection of health monitoring configuration settings. + +The Identity is equivalent to the TargetFqdn parameter. +When creating a new collection of settings, you can use either parameter. +If you leave out both parameters, the New-CsHealthMonitoringConfiguration cmdlet will prompt you to enter the Identity. + + ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False Position: Named Default value: None Accept pipeline input: False @@ -184,6 +205,9 @@ Accept wildcard characters: False ``` ### -SecondTestSamAccountName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SamAccountName of the second test user. The SecondTestSamAccountName must be entered by using the format domain\username; for example: @@ -192,8 +216,7 @@ The SecondTestSamAccountName must be entered by using the format domain\username ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -203,6 +226,9 @@ Accept wildcard characters: False ``` ### -SecondTestUserSipUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address of the second test user to be configured for use by this collection of health monitoring settings. Note that the SIP address must include the sip: prefix. For example: `-SecondTestUserSipUri "sip:pilar@litwareinc.com".` @@ -210,8 +236,7 @@ For example: `-SecondTestUserSipUri "sip:pilar@litwareinc.com".` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -220,50 +245,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -TargetFqdn -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -InMemory +FQDN of the pool where the health monitoring configuration settings are to be assigned (for example: `-TargetFqdn atl-cs-001.litwareinc.com`). +Your command will fail if the specified pool already hosts a collection of health monitoring configuration settings. -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +The TargetFqdn is equivalent to the Identity parameter. +When creating a new collection of settings, you can use either parameter. +If you leave out both parameters, the New-CsHealthMonitoringConfiguration cmdlet will prompt you to enter the Identity. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -272,14 +288,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -293,13 +311,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsHealthMonitoringConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.HealthMonitoring.HealthMonitoringSettings The New-CsHealthMonitoringConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.HealthMonitoring.HealthMonitoringSettings object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsHostedVoicemailPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsHostedVoicemailPolicy.md similarity index 87% rename from skype/skype-ps/skype/New-CsHostedVoicemailPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsHostedVoicemailPolicy.md index 31d525c270..6d1f6f04b7 100644 --- a/skype/skype-ps/skype/New-CsHostedVoicemailPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsHostedVoicemailPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cshostedvoicemailpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsHostedVoicemailPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cshostedvoicemailpolicy +schema: 2.0.0 +title: New-CsHostedVoicemailPolicy --- # New-CsHostedVoicemailPolicy @@ -44,7 +45,7 @@ Policies created at the per-user scope must be assigned to users or contact obje ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsHostedVoicemailPolicy -Identity ExRedmond -Destination ExUM.fabrikam.com -Description "Hosted voicemail policy for Redmond users." -Organization "corp1.litwareinc.com, corp2.litwareinc.com" ``` @@ -56,7 +57,7 @@ This policy is described as (has a Description parameter value of) "Hosted voice -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $x = New-CsHostedVoiceMailPolicy -Identity global -Tenant "73d355dd-ce5d-4ab9-bf49-7b822c18dd98" -Destination ExUM.fabrikam.com -Description "Hosted voicemail policy for Redmond users." -Organization "corp1.litwareinc.com, corp2.litwareinc.com" @@ -74,31 +75,16 @@ To create the new policy, the second command then calls the Set-CsHostedVoiceMai ## PARAMETERS -### -Identity -A unique identifier for the policy, which includes the scope and site (for a site policy, such as site:Redmond), or the policy name (for a per-user policy, such as RenoHostedVoicemail). -A global policy will always exist and can't be removed, so you cannot create a global policy. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Description -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Description A friendly description of the policy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -109,6 +95,8 @@ Accept wildcard characters: False ### -Destination +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The value assigned to this parameter is the fully qualified domain name (FQDN) of the hosted Exchange UM service. Note that the chosen destination must be trusted for routing. @@ -121,8 +109,7 @@ This value must be 255 characters or less and in the form of an FQDN, such as se ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,18 +118,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Organization - -This parameter contains a comma-separated list of the Exchange tenants that contain Skype for Business Server users. -Each tenant must be specified as an FQDN of the tenant on the hosted Exchange Service. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -151,17 +136,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier for the policy, which includes the scope and site (for a site policy, such as site:Redmond), or the policy name (for a per-user policy, such as RenoHostedVoicemail). +A global policy will always exist and can't be removed, so you cannot create a global policy. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -169,6 +157,8 @@ Accept wildcard characters: False ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. @@ -177,8 +167,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -187,14 +176,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Organization + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter contains a comma-separated list of the Exchange tenants that contain Skype for Business Server users. +Each tenant must be specified as an FQDN of the tenant on the hosted Exchange Service. + + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -203,14 +197,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new hosted voicemail policy is being created. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` + + ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -219,24 +224,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant +### -Confirm -Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new hosted voicemail policy is being created. -For example: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +Prompts you for confirmation before executing the command. -You can return the tenant ID for each of your tenants by running this command: +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf -`Get-CsTenant | Select-Object DisplayName, TenantID` +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: wi Required: False Position: Named @@ -250,12 +265,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.HostedVoicemailPolicy This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.HostedVoicemailPolicy ## NOTES diff --git a/skype/skype-ps/skype/New-CsHostingProvider.md b/skype/skype-ps/SkypeForBusiness/New-CsHostingProvider.md similarity index 87% rename from skype/skype-ps/skype/New-CsHostingProvider.md rename to skype/skype-ps/SkypeForBusiness/New-CsHostingProvider.md index ef1f878ccf..3de5cebe95 100644 --- a/skype/skype-ps/skype/New-CsHostingProvider.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsHostingProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cshostingprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsHostingProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cshostingprovider +schema: 2.0.0 +title: New-CsHostingProvider --- # New-CsHostingProvider @@ -69,7 +70,7 @@ Note, too that you cannot federate with a hosting provider if your Edge Servers ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsHostingProvider -Identity Fabrikam.com -ProxyFqdn "proxyserver.fabrikam.com" -Enabled $True ``` @@ -79,7 +80,7 @@ In addition to specifying the Identity, the command also includes the other two If you leave out any of the required parameters, the New-CsHostingProvider cmdlet will prompt you to enter those values before continuing. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsHostingProvider -Identity Fabrikam.com -ProxyFqdn "proxyserver.fabrikam.com" -Enabled $True -HostsOCSUsers $True -EnabledSharedAddressSpace $True @@ -93,27 +94,31 @@ To create a split domain provider that hosts non-Skype for Business Server servi ## PARAMETERS -### -Identity -Unique identifier for the hosting provider to be created. -The Identity is a string value; the Identity might be the FQDN of the hosting provider (for example, fabrikam.com) or perhaps the name of the company providing the services (Fabrikam, Inc.). +### -AutodiscoverUrl + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL for the autodiscover service used by a hosting provider that hosts Skype for Business Server accounts. +The autodiscover service enables client applications to determine how to access resources such as a user's home pool. + -Hosting provider Identities must be unique. -Your command will fail if you try to create a new hosting provider with the same Identity as an existing provider. ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the network connection between your domain and the hosting provider is enabled. Messages cannot be exchanged between the two organizations until this value is set to True. The default value is False. @@ -121,8 +126,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -131,16 +135,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyFqdn -The FQDN for the proxy server used by the hosting provider. -Note that this value cannot be modified. -If the hosting provider later changes its proxy server or if you make a mistake when you first specify the proxy FQDN you will need to delete and then recreate the entry for that provider. +### -EnabledSharedAddressSpace + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, indicates that the hosting provider is being used in a split domain scenario. +The default value is False. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -149,17 +154,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnabledSharedAddressSpace -If True, indicates that the hosting provider is being used in a split domain scenario. -The default value is False. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -168,6 +174,8 @@ Accept wildcard characters: False ### -HostsOCSUsers +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If True, indicates that the hosting provider is used to host Skype for Business Server accounts. If False, that indicates that the provider hosts other account types, such as Microsoft Exchange accounts. The default value is False. @@ -177,8 +185,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -187,49 +194,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsLocal +### -Identity -If True, indicates that the proxy server used by the hosting provider is contained within your Skype for Business Server topology. -The default value is False. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Unique identifier for the hosting provider to be created. +The Identity is a string value; the Identity might be the FQDN of the hosting provider (for example, fabrikam.com) or perhaps the name of the company providing the services (Fabrikam, Inc.). +Hosting provider Identities must be unique. +Your command will fail if you try to create a new hosting provider with the same Identity as an existing provider. ```yaml -Type: Boolean +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -VerificationLevel -Indicates the allowed verification level for messages sent to and from the hosted provider. -The VerificationLevel must be set to one of the following values: +### -InMemory -AlwaysVerifiable. -Indicates that all messages sent from the hosting provider are considered verifiable. -That means that no messages from the hosting provider will be rejected. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -AlwaysUnverifiable. -Indicates that all messages sent from the hosting provider are considered unverifiable. -As a result, messages are passed only if the user on the hosting provider is also in your Contacts list. +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. -UseSourceVerification. -Relies on the verification level included in messages sent from the hosting provider. -If this level is not specified, then the message will be rejected as being unverifiable. -The default value is AlwayVerifiable. ```yaml -Type: VerificationLevelType +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -238,14 +237,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -IsLocal + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, indicates that the proxy server used by the hosting provider is contained within your Skype for Business Server topology. +The default value is False. + + ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -254,34 +258,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory - -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -ProxyFqdn +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +The FQDN for the proxy server used by the hosting provider. +Note that this value cannot be modified. +If the hosting provider later changes its proxy server or if you make a mistake when you first specify the proxy FQDN you will need to delete and then recreate the entry for that provider. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SipClientPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Port used by the provider for communicating with SIP clients; the default value is 443. +Note that, by default, the SipClientPort is not displayed when you run the Get-CsHostingProvider cmdlet. +To see the SipClientPort, use a command similar to this: + +`Get-CsHostingProvider | Select-Object *` ```yaml -Type: SwitchParameter +Type: UInt64 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -290,14 +300,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -VerificationLevel + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the allowed verification level for messages sent to and from the hosted provider. +The VerificationLevel must be set to one of the following values: + +AlwaysVerifiable. +Indicates that all messages sent from the hosting provider are considered verifiable. +That means that no messages from the hosting provider will be rejected. + +AlwaysUnverifiable. +Indicates that all messages sent from the hosting provider are considered unverifiable. +As a result, messages are passed only if the user on the hosting provider is also in your Contacts list. + +UseSourceVerification. +Relies on the verification level included in messages sent from the hosting provider. +If this level is not specified, then the message will be rejected as being unverifiable. + +The default value is AlwayVerifiable. ```yaml -Type: SwitchParameter +Type: VerificationLevelType Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -306,18 +333,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AutodiscoverUrl - -URL for the autodiscover service used by a hosting provider that hosts Skype for Business Server accounts. -The autodiscover service enables client applications to determine how to access resources such as a user's home pool. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -326,18 +351,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipClientPort -Port used by the provider for communicating with SIP clients; the default value is 443. -Note that, by default, the SipClientPort is not displayed when you run the Get-CsHostingProvider cmdlet. -To see the SipClientPort, use a command similar to this: +### -WhatIf -`Get-CsHostingProvider | Select-Object *` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: UInt64 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -351,13 +374,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsHostingProvider cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayHostingProvider Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayHostingProvider object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsHybridApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/New-CsHybridApplicationEndpoint.md similarity index 87% rename from skype/skype-ps/skype/New-CsHybridApplicationEndpoint.md rename to skype/skype-ps/SkypeForBusiness/New-CsHybridApplicationEndpoint.md index 55b09cfd15..d6c42e2a20 100644 --- a/skype/skype-ps/skype/New-CsHybridApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsHybridApplicationEndpoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cshybridapplicationendpoint applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsHybridApplicationEndpoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cshybridapplicationendpoint +schema: 2.0.0 +title: New-CsHybridApplicationEndpoint --- # New-CsHybridApplicationEndpoint @@ -33,7 +34,7 @@ Hybrid connectivity between Skype for Business Server and Skype for Business Onl ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> New-CsHybridApplicationEndpoint -ApplicationId 41ec7d50-ba91-1208-73ee-136b88859725 -DisplayName NewBot1 -SipAddress sip:newbot1@litwareinc.com -OU "ou=Redmond,dc=litwareinc,dc=com" ``` @@ -43,6 +44,9 @@ This example creates a hybrid application endpoint named NewBot1 in Skype for Bu ## PARAMETERS ### -ApplicationId + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The ApplicationId or Client Id for which the endpoint is being created. There are predefined values if you are creating an on-premises resource account for Skype for Business hybrid deployments: @@ -53,7 +57,6 @@ There are predefined values if you are creating an on-premises resource account Type: Guid Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -62,30 +65,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -DisplayName -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DisplayName Friendly name for the application endpoint is being created. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -95,13 +84,15 @@ Accept wildcard characters: False ``` ### -LineUri + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Valid phone number for the application endpoint is being created. (Not currently supported through BOT framework) ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -111,13 +102,15 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Active Directory Organizational Unit (OU) for the disabled user to be created. Wait for the newly created user object to be directory synced to the Microsoft Entra ID or start a new directory sync cycle by running the [Start-ADSyncSyncCycle](https://learn.microsoft.com/azure/active-directory/connect/active-directory-aadconnectsync-feature-scheduler#start-the-scheduler) on the domain controller machine. ```yaml Type: OUIdParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -127,13 +120,15 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -143,13 +138,15 @@ Accept wildcard characters: False ``` ### -SipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The SipUri for the Endpoint. SIP Uri must be lowercase. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -158,14 +155,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/New-CsHybridPSTNSite.md b/skype/skype-ps/SkypeForBusiness/New-CsHybridPSTNSite.md similarity index 91% rename from skype/skype-ps/skype/New-CsHybridPSTNSite.md rename to skype/skype-ps/SkypeForBusiness/New-CsHybridPSTNSite.md index 7bd818bd11..9d8e17bb7b 100644 --- a/skype/skype-ps/skype/New-CsHybridPSTNSite.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsHybridPSTNSite.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cshybridpstnsite applicable: Skype for Business Online -title: New-CsHybridPSTNSite -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/new-cshybridpstnsite +schema: 2.0.0 +title: New-CsHybridPSTNSite --- # New-CsHybridPSTNSite @@ -35,7 +37,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsHybridPSTNSite -Identity "SeattlePSTN" -EdgeFQDN "Contoso.Denver.Edge.com" -BitsUpdateTimeWindow @{add="FirstWeekend","Night"} -OsUpdateTimeWindow @{add="Weekday"} ``` @@ -46,49 +48,16 @@ This example creates a new hybrid public switched telephone network (PSTN) site ## PARAMETERS -### -EdgeFQDN -Specifies the fully qualified domain name of the edge server. -For example: `-EdgeFQDN Contoso.Denver.Edge.com` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Specifies the identity of the hybrid public switched telephone network (PSTN) site. -For example: `-Identity "SeattlePSTN".` -If the identity provided is not unique within the tenant, the cmdlet will fail. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +### -BitsUpdateTimeWindow -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Online -### -BitsUpdateTimeWindow Time window for updating Skype for Business Cloud Connector Edition bits on the appliance. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -97,14 +66,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing, and requires confirmation to proceed. +### -EdgeFQDN + +> Applicable: Skype for Business Online + +Specifies the fully qualified domain name of the edge server. +For example: `-EdgeFQDN Contoso.Denver.Edge.com` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -114,6 +86,9 @@ Accept wildcard characters: False ``` ### -EnableAutoUpdate + +> Applicable: Skype for Business Online + If set to $true, automatic updates will be turned on for the Skype for Business Cloud Connector Edition appliance. If set to $false, automatic updates will be turned off for the Skype for Business Cloud Connector Edition appliance. The default is $true. @@ -121,8 +96,7 @@ The default is $true. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -132,6 +106,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Online + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -139,8 +116,7 @@ If the Force switch isn't provided in the command, you're prompted for administr ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -149,14 +125,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Skype for Business Online + +Specifies the identity of the hybrid public switched telephone network (PSTN) site. +For example: `-Identity "SeattlePSTN".` +If the identity provided is not unique within the tenant, the cmdlet will fail. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InMemory + +> Applicable: Skype for Business Online + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -166,13 +164,15 @@ Accept wildcard characters: False ``` ### -OsUpdateTimeWindow + +> Applicable: Skype for Business Online + Time window for updating the operating system on the appliance. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -182,6 +182,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Specifies the global unique identifier (GUID) of the Skype for Business Online tenant account on which the cmdlet will operate. For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308".` @@ -194,8 +197,25 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Online + +The Confirm switch causes the command to pause processing, and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -205,6 +225,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -212,7 +235,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named @@ -226,12 +248,11 @@ This cmdlet supports the common parameters:` -Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### HybridPstnSite The New-CsHybridPSTNSite cmdlet returns instances of the HybridPstnSite object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsImConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsImConfiguration.md similarity index 85% rename from skype/skype-ps/skype/New-CsImConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsImConfiguration.md index bff157c1c2..782bf2461b 100644 --- a/skype/skype-ps/skype/New-CsImConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsImConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csimconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsImConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csimconfiguration +schema: 2.0.0 +title: New-CsImConfiguration --- # New-CsImConfiguration @@ -28,7 +29,7 @@ Use the New-CsImConfiguration cmdlet to create a new Instant Messaging (IM) conf ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsImConfiguration -Identity "Site:Redmond" -EnableOfflineIm $true ``` @@ -37,30 +38,16 @@ This example creates a new Instant Messaging (IM) configuration for the Redmond ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableOfflineIm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableOfflineIm Enables or disables Offline Instant Messaging. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -70,13 +57,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -86,13 +75,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier specifying the scope and, in some cases the name, of the IM configuration. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -102,13 +93,15 @@ Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -118,13 +111,33 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -134,13 +147,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/New-CsImFilterConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsImFilterConfiguration.md similarity index 86% rename from skype/skype-ps/skype/New-CsImFilterConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsImFilterConfiguration.md index 07c90a6de3..0235223a0f 100644 --- a/skype/skype-ps/skype/New-CsImFilterConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsImFilterConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csimfilterconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsImFilterConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csimfilterconfiguration +schema: 2.0.0 +title: New-CsImFilterConfiguration --- # New-CsImFilterConfiguration @@ -40,7 +41,7 @@ Calling the New-CsImFilterConfiguration cmdlet with only an Identity specified w ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsImFilterConfiguration -Identity site:Redmond @@ -51,7 +52,7 @@ In Example 1, the New-CsImFilterConfiguration cmdlet is used to create a new IM -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsImFilterConfiguration -Identity site:Redmond -Prefixes @{add="rtsp:","urn:"} ``` @@ -61,7 +62,7 @@ Because the Prefixes parameter has been specified, the new configuration will co We add these prefixes by using the add list modifier to add these prefixes to the default list. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` New-CsImFilterConfiguration -Identity site:Redmond -Prefixes @{replace="rtsp:","urn:"} ``` @@ -75,27 +76,10 @@ Therefore, only URIs with prefixes of rtsp: or urn: will be filtered within inst ## PARAMETERS -### -Identity -A unique identifier specifying the scope of the IM filter configuration. -Global settings exist by default and cannot be re-created with the New-CsImFilterConfiguration cmdlet, but you can create site-level settings by specifying an Identity of site:\, where \ is the name of the site to which the settings will be applied (for example, site:Redmond). - -Full Data Type: Microsoft.Rtc.Management.Xds.XdsIdentity - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Action +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The value of this parameter determines the action that will be taken when a hyperlink is included in an instant message: Allow - Hyperlinks are prefixed with an underscore so that the links are no longer active. @@ -116,8 +100,7 @@ Full Data Type: Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.UrlFil ```yaml Type: UrlFilterAction Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -127,14 +110,16 @@ Accept wildcard characters: False ``` ### -AllowMessage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If a value is specified for this parameter, that string is inserted at the beginning of each message containing hyperlinks when the value of the Action property is set to Allow. You can use this message to notify users of things such as the potential dangers of clicking unknown links, or your organization's relevant policies and requirements. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -144,6 +129,9 @@ Accept wildcard characters: False ``` ### -BlockFileExtension + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If this parameter is set to True, a hyperlink that contains a file path with an extension specified by the Extensions property defined in the applicable file transfer filter configuration (retrieved by calling the Get-CsFileTransferFilterConfiguration cmdlet) is blocked and an error message is returned to the sender. If this parameter is set to False, no special check is made for file extensions. @@ -152,8 +140,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -163,6 +150,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables or disables this feature. If this parameter is set to True, instant messages will be scanned for hyperlinks and the rules in this configuration will be applied. If this parameter is set to False, messages will not be checked for hyperlinks. @@ -172,8 +162,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,17 +171,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IgnoreLocal -The value of this parameter controls whether filtering is performed on local Intranet URIs passed in instant messages.If this parameter is set to True, any URI that is defined in the Intranet zone of the local computer is ignored. -(The local computer is the Front End Server running the IM Filter application.) If this parameter is set to False, the specified filtering is applied to all hyperlinks. +### -Force -Default: True +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -201,34 +189,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Prefixes -The list of URI prefixes that will be filtered. -Any hyperlink included in an instant message with a prefix matching one of the prefixes in this list will be filtered according to the specified settings. +### -Identity -Default: callto:, file:, ftp., ftp:, gopher:, href, http:, https:, ldap:, mailto:, news:, nntp:, sip:, sips:, tel:, telnet:, www*. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier specifying the scope of the IM filter configuration. +Global settings exist by default and cannot be re-created with the New-CsImFilterConfiguration cmdlet, but you can create site-level settings by specifying an Identity of site:\, where \ is the name of the site to which the settings will be applied (for example, site:Redmond). + +Full Data Type: Microsoft.Rtc.Management.Xds.XdsIdentity ```yaml -Type: PSListModifier +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WarnMessage -This parameter contains the warning message that is inserted at the beginning of each instant message that contains hyperlinks when the value of the Action property is set to Warn. -Typically this message would be used for such things as stating the potential dangers of clicking unknown links, or referring to your organization's relevant policies and requirements. +### -IgnoreLocal + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The value of this parameter controls whether filtering is performed on local Intranet URIs passed in instant messages.If this parameter is set to True, any URI that is defined in the Intranet zone of the local computer is ignored. +(The local computer is the Front End Server running the IM Filter application.) If this parameter is set to False, the specified filtering is applied to all hyperlinks. + +Default: True ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -237,14 +231,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -253,18 +252,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -Prefixes -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +The list of URI prefixes that will be filtered. +Any hyperlink included in an instant message with a prefix matching one of the prefixes in this list will be filtered according to the specified settings. +Default: callto:, file:, ftp., ftp:, gopher:, href, http:, https:, ldap:, mailto:, news:, nntp:, sip:, sips:, tel:, telnet:, www*. ```yaml -Type: SwitchParameter +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -273,14 +273,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -WarnMessage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter contains the warning message that is inserted at the beginning of each instant message that contains hyperlinks when the value of the Action property is set to Warn. +Typically this message would be used for such things as stating the potential dangers of clicking unknown links, or referring to your organization's relevant policies and requirements. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -290,13 +293,33 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -310,12 +333,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration. ## NOTES diff --git a/skype/skype-ps/skype/New-CsImTranslationConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsImTranslationConfiguration.md similarity index 79% rename from skype/skype-ps/skype/New-CsImTranslationConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsImTranslationConfiguration.md index 02129499f3..2d55540669 100644 --- a/skype/skype-ps/skype/New-CsImTranslationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsImTranslationConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csimtranslationconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsImTranslationConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csimtranslationconfiguration +schema: 2.0.0 +title: New-CsImTranslationConfiguration --- # New-CsImTranslationConfiguration @@ -28,7 +29,7 @@ This cmdlet is reserved for internal Microsoft use. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` This cmdlet is reserved for internal Microsoft use. @@ -39,30 +40,16 @@ This cmdlet is reserved for internal Microsoft use. ## PARAMETERS -### -Identity -This parameter is reserved for internal Microsoft use. +### -AccessTokenUri -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AccessTokenUri This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -72,13 +59,15 @@ Accept wildcard characters: False ``` ### -ApplicationId + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -88,13 +77,15 @@ Accept wildcard characters: False ``` ### -ClientId + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -104,13 +95,15 @@ Accept wildcard characters: False ``` ### -ClientSecret + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,14 +112,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,30 +130,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -168,13 +167,15 @@ Accept wildcard characters: False ``` ### -ServiceUri + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,13 +185,33 @@ Accept wildcard characters: False ``` ### -TranslationType + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -200,13 +221,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/New-CsIssuedCertId.md b/skype/skype-ps/SkypeForBusiness/New-CsIssuedCertId.md similarity index 93% rename from skype/skype-ps/skype/New-CsIssuedCertId.md rename to skype/skype-ps/SkypeForBusiness/New-CsIssuedCertId.md index 0303d409ac..c3386abeae 100644 --- a/skype/skype-ps/skype/New-CsIssuedCertId.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsIssuedCertId.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csissuedcertid applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsIssuedCertId -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csissuedcertid +schema: 2.0.0 +title: New-CsIssuedCertId --- # New-CsIssuedCertId @@ -61,7 +62,7 @@ You do not need to use the New-CsIssuedCertId cmdlet if you create a static rout ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $cert = New-CsIssuedCertId -Issuer "Fabrikam" -SerialNumber 0x10,0x14,0x3A,0x1A @@ -81,13 +82,15 @@ To ensure that this object uses the Fabrikam-issued certificate for authenticati ## PARAMETERS ### -Issuer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the certification authority (CA) that issued the certificate to be used in the static route. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -SerialNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Serial number of the certificate to be used in the static route. Serial numbers must be passed as a byte array. This means you must pass the serial number as an array of two-character values, with each of these two-character values prefaced by 0x. @@ -105,8 +111,7 @@ For example: `-SerialNumber 0x01, 0x23, 0x45, 0x67, 0x89.` ```yaml Type: Byte[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -120,13 +125,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None New-CsIssuedCertId does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.BaseTypes.IssuedCertId New-CsIssuedCertId creates instances of the Microsoft.Rtc.Management.WritableConfig.BaseTypes.IssuedCertId object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsKerberosAccount.md b/skype/skype-ps/SkypeForBusiness/New-CsKerberosAccount.md similarity index 86% rename from skype/skype-ps/skype/New-CsKerberosAccount.md rename to skype/skype-ps/SkypeForBusiness/New-CsKerberosAccount.md index 85ed0abd14..3c48527970 100644 --- a/skype/skype-ps/skype/New-CsKerberosAccount.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsKerberosAccount.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cskerberosaccount applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsKerberosAccount -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cskerberosaccount +schema: 2.0.0 +title: New-CsKerberosAccount --- # New-CsKerberosAccount @@ -43,7 +44,7 @@ SPNs provide a way for client applications to locate a particular service. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsKerberosAccount -UserAccount "litwareinc\kerberostest" -ContainerDN "cn=Computers,dc=litwareinc,dc=com" @@ -65,6 +66,8 @@ After you make the new account assignment, the final command calls the Enable-Cs ### -ContainerDN +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Distinguished name of the Active Directory container where the new account is to be created. For example: `-ContainerDN "ou=Finance,dc=litwareinc,dc=com".` If this parameter is not specified, then the New-CsKerberosAccount cmdlet will create the new account in the Computers container in Active Directory. @@ -74,8 +77,7 @@ If this parameter is not specified, then the New-CsKerberosAccount cmdlet will c ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -84,37 +86,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserAccount - -Account name for the new account, using the format domain_name\user_name. -For example: `-UserAccount "litwareinc\kerberostest".` -Note that your command will fail if the specified account already exists. - -Note, too that, despite the name UserAccount, the account created by running the New-CsKerberosAccount cmdlet is actually a computer account, not a user account. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: `-Report "C:\Logs\KerberosAccount.html".` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -123,31 +123,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: `-Report "C:\Logs\KerberosAccount.html".` +### -UserAccount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Account name for the new account, using the format domain_name\user_name. +For example: `-UserAccount "litwareinc\kerberostest".` +Note that your command will fail if the specified account already exists. + +Note, too that, despite the name UserAccount, the account created by running the New-CsKerberosAccount cmdlet is actually a computer account, not a user account. + + ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -156,14 +165,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -177,13 +188,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsKerberosAccount cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.KerberosAccount.KerberosAccount The New-CsKerberosAccount cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.KerberosAccount.KerberosAccount object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsKerberosAccountAssignment.md b/skype/skype-ps/SkypeForBusiness/New-CsKerberosAccountAssignment.md similarity index 87% rename from skype/skype-ps/skype/New-CsKerberosAccountAssignment.md rename to skype/skype-ps/SkypeForBusiness/New-CsKerberosAccountAssignment.md index d02844a752..85cf3c1866 100644 --- a/skype/skype-ps/skype/New-CsKerberosAccountAssignment.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsKerberosAccountAssignment.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cskerberosaccountassignment applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsKerberosAccountAssignment -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cskerberosaccountassignment +schema: 2.0.0 +title: New-CsKerberosAccountAssignment --- # New-CsKerberosAccountAssignment @@ -45,7 +46,7 @@ To change a site that is already associated with a Kerberos account, use the Set ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsKerberosAccountAssignment -UserAccount "litwareinc\kerberostest" -Identity "site:Redmond" @@ -60,54 +61,56 @@ The second command then calls the Enable-CsTopology cmdlet in order to create th ## PARAMETERS -### -Identity -Unique identifier of the site where the Kerberos account is to be assigned. -(This is the Identity of the site, not of the computer account.) For example: `-Identity "site:Redmond".` +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserAccount - -Account name for the account to be assigned, using the format domain_name\user_name. -For example: `-UserAccount "litwareinc\kerberostest".` -The user name portion of the account (kerberostest) is a NETBIOS name and can contain a maximum of 15 characters. - -Note that, despite the name UserAccount, the account is actually a computer account, not a user account. +### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Unique identifier of the site where the Kerberos account is to be assigned. +(This is the Identity of the site, not of the computer account.) For example: `-Identity "site:Redmond".` ```yaml -Type: String +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,18 +119,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -UserAccount -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Account name for the account to be assigned, using the format domain_name\user_name. +For example: `-UserAccount "litwareinc\kerberostest".` +The user name portion of the account (kerberostest) is a NETBIOS name and can contain a maximum of 15 characters. + +Note that, despite the name UserAccount, the account is actually a computer account, not a user account. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -136,14 +143,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -152,14 +161,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -173,13 +184,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsKerberosAccountAssignment cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.KerberosAccount.KerberosAccountAssignment The New-CsKerberosAccountAssignment cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.KerberosAccount.KerberosAccountAssignment object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsLocationPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsLocationPolicy.md similarity index 87% rename from skype/skype-ps/skype/New-CsLocationPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsLocationPolicy.md index bea3233f4e..98c7f4e45a 100644 --- a/skype/skype-ps/skype/New-CsLocationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsLocationPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cslocationpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsLocationPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cslocationpolicy +schema: 2.0.0 +title: New-CsLocationPolicy --- # New-CsLocationPolicy @@ -52,7 +53,7 @@ If the user calls from a location that is unknown or unmapped in the organizatio ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsLocationPolicy -Identity site:Redmond -EnhancedEmergencyServicesEnabled $True ``` @@ -60,7 +61,7 @@ New-CsLocationPolicy -Identity site:Redmond -EnhancedEmergencyServicesEnabled $T Example 1 uses the New-CsLocationPolicy cmdlet to create a new location policy for the Redmond site that enables all users on that site for E9-1-1. To create this policy, the New-CsLocationPolicy cmdlet is called along with two parameters: one to set the Identity, which in this case is the string site: followed by the name of the site to which this policy will apply; the other to set the value of the EnhancedEmergencyServicesEnabled property to True. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsLocationPolicy -Identity Reno -Description "All users located at the Reno site" -EnhancedEmergencyServicesEnabled $True -PstnUsage Emergency -EmergencyDialString 911 ``` @@ -78,31 +79,10 @@ This value must match a value in the list of PSTN usages. ## PARAMETERS -### -Identity - -A unique identifier for the location policy. -This cmdlet can be used to create policies at the site or per-user scope. -(A global policy exists by default and cannot be removed.) For a policy created at the site scope, this value must be in the form site:\, where site name is the name of a site defined in the Skype for Business Server deployment. -For example, site:Redmond. -A policy created at the per-user scope can be assigned any string value, such as Reno. - - - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -ConferenceMode +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If a value is specified for the ConferenceUri parameter, the ConferenceMode parameter determines whether a third party can participate in the call or can only listen in. Available values are: @@ -115,8 +95,7 @@ Twoway: Third party can listen in and participate in the call between the caller ```yaml Type: ConferenceModeEnum Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -126,6 +105,9 @@ Accept wildcard characters: False ``` ### -ConferenceUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The SIP Uniform Resource Identifier (URI), in this case the telephone number, of a third party that will be conferenced in to any emergency calls that are made. For example, the company security office could receive a call when an emergency call is made and listen in or participate in that call (depending on the value of the ConferenceMode property). @@ -134,8 +116,7 @@ The string must be from 1 to 256 characters in length and must begin with the pr ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -145,14 +126,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A detailed description of this location. For example, "Reno corporate users". ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,6 +145,9 @@ Accept wildcard characters: False ``` ### -EmergencyDialMask + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A number that is dialed that will be translated into the value of the EmergencyDialString property. For example, if EmergencyDialMask has a value of "212" and EmergencyDialString has a value of "911", if a user dials 212 the call will be made to 911. This allows for alternate emergency numbers to be dialed and still have the call reach emergency services (for example, if someone from a country/region with a different emergency number attempts to dial that country/region's number rather than the number for the country/region they're currently in). @@ -179,8 +165,7 @@ Each character must be a digit 0 through 9. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -190,6 +175,9 @@ Accept wildcard characters: False ``` ### -EmergencyDialString + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number that is dialed to reach emergency services. In the United States this value is 911. @@ -198,8 +186,7 @@ The string must be made of the digits 0 through 9 and can be from 1 to 10 digits ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -208,20 +195,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnhancedEmergencyServicesEnabled - -Specifies whether the users associated with this policy are enabled for E9-1-1. -Set the value to True to enable E9-1-1 so Skype for Business Server clients will retrieve location information on registration and include that information when an emergency call is made. - -Default Value: False +### -EmergencyNumbers +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +{{Fill EmergencyNumbers Description}} ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -230,25 +213,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocationRequired +### -EnhancedEmergencyServiceDisclaimer -If the client was unable to retrieve a location from the location configuration database, the user can be prompted to manually enter a location. -This parameter accepts the following values: +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -- no: The user will not be prompted for a location. When a call is made with no location information, the Emergency Service Provider will answer the call and ask for a location. -- yes: The user will be prompted to input location information when the client registers at a new location. The user can dismiss the prompt without entering any information. If information is entered, a call made to 911 will first be answered by the Emergency Service Provider to verify the location before being routed to the PSAP operator (the 911 operator). -- disclaimer: This option is the same as yes except that if the user dismisses the prompt disclaimer text will be displayed that can alert the user to the consequences of declining to enter location information. (The disclaimer text must be set by calling the Set-CsEnhancedEmergencyServiceDisclaimer cmdlet.) +Text value containing information that will be displayed to users who are connected from locations that cannot be resolved by the location mapping (wiremap) who choose not to enter their location manually. +To remove a service disclaimer from a location policy set this property to a null value: -This value is ignored if EnhancedEmergencyServicesEnabled is set to False (the default). -Users will not be prompted for location information. +`-EnhancedEmergencyServiceDisclaimer $Null` + +Location policies, and the EnhancedEmergencyServiceDisclaimer property, should be used in Skype for Business Server to set disclaimers for the E9-1-1 service. +By using location policies to set these disclaimers, you can create different disclaimers for different locales or different sets of users. ```yaml -Type: LocationRequiredEnum +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -257,25 +239,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NotificationUri +### -EnhancedEmergencyServicesEnabled -One or more SIP URIs to be notified when an emergency call is made. -For example, the company security office could be notified through an instant message whenever an emergency call is made. -If the caller's location is available that location will be included in the notification. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Multiple SIP URIs can be included as a comma-separated list. -For example, `-NotificationUri sip:security@litwareinc.com,sip:kmyer@litwareinc.com.` -Note that distribution lists can be configured as a notification URI. +Specifies whether the users associated with this policy are enabled for E9-1-1. +Set the value to True to enable E9-1-1 so Skype for Business Server clients will retrieve location information on registration and include that information when an emergency call is made. -The string must be from 1 to 256 characters in length and must begin with the prefix sip:. +Default Value: False ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -284,19 +262,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PstnUsage -The public switched telephone network (PSTN) usage that will be used to determine which voice route will be used to route emergency calls from clients using this profile. -The route associated with this usage should point to a SIP trunk dedicated to emergency calls. +### -Force -The usage must already exist in the global list of PSTN usages. -Call the Get-CsPstnUsage cmdlet to retrieve a list of usages. -To create a new usage, call the Set-CsPstnUsage cmdlet. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -305,37 +280,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseLocationForE911Only - -Location information can be used by the Skype for Business Server client for various reasons (such as notifying teammates of current location). -Set this value to True to ensure location information is available only for use with an emergency call. - +### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +A unique identifier for the location policy. +This cmdlet can be used to create policies at the site or per-user scope. +(A global policy exists by default and cannot be removed.) For a policy created at the site scope, this value must be in the form site:\, where site name is the name of a site defined in the Skype for Business Server deployment. +For example, site:Redmond. +A policy created at the per-user scope can be assigned any string value, such as Reno. -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -343,6 +306,8 @@ Accept wildcard characters: False ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. @@ -351,8 +316,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -361,14 +325,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -LocationRefreshInterval + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the amount of time (in hours) between client requests for Location Information service location update. +The LocationRefreshInterval can be set to any value between 1 and 12; the default value is 4. ```yaml -Type: SwitchParameter +Type: Int64 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -377,14 +344,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -LocationRequired + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If the client was unable to retrieve a location from the location configuration database, the user can be prompted to manually enter a location. +This parameter accepts the following values: + +- no: The user will not be prompted for a location. When a call is made with no location information, the Emergency Service Provider will answer the call and ask for a location. +- yes: The user will be prompted to input location information when the client registers at a new location. The user can dismiss the prompt without entering any information. If information is entered, a call made to 911 will first be answered by the Emergency Service Provider to verify the location before being routed to the PSAP operator (the 911 operator). +- disclaimer: This option is the same as yes except that if the user dismisses the prompt disclaimer text will be displayed that can alert the user to the consequences of declining to enter location information. (The disclaimer text must be set by calling the Set-CsEnhancedEmergencyServiceDisclaimer cmdlet.) + +This value is ignored if EnhancedEmergencyServicesEnabled is set to False (the default). +Users will not be prompted for location information. + + ```yaml -Type: SwitchParameter +Type: LocationRequiredEnum Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -393,23 +372,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnhancedEmergencyServiceDisclaimer +### -NotificationUri -Text value containing information that will be displayed to users who are connected from locations that cannot be resolved by the location mapping (wiremap) who choose not to enter their location manually. -To remove a service disclaimer from a location policy set this property to a null value: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-EnhancedEmergencyServiceDisclaimer $Null` +One or more SIP URIs to be notified when an emergency call is made. +For example, the company security office could be notified through an instant message whenever an emergency call is made. +If the caller's location is available that location will be included in the notification. -Location policies, and the EnhancedEmergencyServiceDisclaimer property, should be used in Skype for Business Server to set disclaimers for the E9-1-1 service. -By using location policies to set these disclaimers, you can create different disclaimers for different locales or different sets of users. +Multiple SIP URIs can be included as a comma-separated list. +For example, `-NotificationUri sip:security@litwareinc.com,sip:kmyer@litwareinc.com.` +Note that distribution lists can be configured as a notification URI. + +The string must be from 1 to 256 characters in length and must begin with the prefix sip:. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -418,15 +400,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocationRefreshInterval -Specifies the amount of time (in hours) between client requests for Location Information service location update. -The LocationRefreshInterval can be set to any value between 1 and 12; the default value is 4. +### -PstnUsage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The public switched telephone network (PSTN) usage that will be used to determine which voice route will be used to route emergency calls from clients using this profile. +The route associated with this usage should point to a SIP trunk dedicated to emergency calls. + +The usage must already exist in the global list of PSTN usages. +Call the Get-CsPstnUsage cmdlet to retrieve a list of usages. +To create a new usage, call the Set-CsPstnUsage cmdlet. ```yaml -Type: Int64 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -436,6 +424,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new location policy is being created. For example: @@ -448,8 +439,7 @@ You can return the tenant ID for each of your Skype for Business Online tenants ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -458,14 +448,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EmergencyNumbers -{{Fill EmergencyNumbers Description}} +### -UseLocationForE911Only + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Location information can be used by the Skype for Business Server client for various reasons (such as notifying teammates of current location). +Set this value to True to ensure location information is available only for use with an emergency call. + + ```yaml -Type: PSListModifier +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -479,12 +510,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationPolicy Creates an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationPolicy. ## NOTES diff --git a/skype/skype-ps/skype/New-CsMcxConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsMcxConfiguration.md similarity index 90% rename from skype/skype-ps/skype/New-CsMcxConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsMcxConfiguration.md index 58a5312e5f..ef269628dd 100644 --- a/skype/skype-ps/skype/New-CsMcxConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsMcxConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csmcxconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsMcxConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csmcxconfiguration +schema: 2.0.0 +title: New-CsMcxConfiguration --- # New-CsMcxConfiguration @@ -45,7 +46,7 @@ When you install Skype for Business Server, a single collection of Mobility Serv ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsMcxConfiguration -Identity "site:Redmond" -ExposedWebURL Internal -SessionShortExpirationInterval 7200 @@ -55,7 +56,7 @@ In Example 1, a new collection of Mobility Service configuration settings is cre In this example, two changes are made to the default Mobility Service configuration settings: the ExposedWebURL property is to Internal, and the SessionShortExpirationInterval property is set to 7200 seconds. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsService -WebServer | ForEach-Object {New-CsMcxConfiguration -Identity $_.Identity -ExposedWebURL Internal -SessionShortExpirationInterval 7200} @@ -67,7 +68,7 @@ In turn, the ForEach-Object cmdlet takes each server in the collection and runs -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` $x = New-CsMcxConfiguration -Identity "site:Redmond" -InMemory @@ -90,38 +91,37 @@ Note that if you do not call the Set-CsMcxConfiguration cmdlet, no settings will ## PARAMETERS -### -Identity -Unique identifier of the collection of Mobility Service configuration settings to be created. -To create settings at the site scope, use the prefix "site:" followed by the site name. -For example: +### -ExposedWebURL -`-Identity "site:Redmond"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -To create settings configured at the service scope, use syntax like this: +Indicates whether the URL used by the Autodiscovery Service is accessible to users both inside and outside the organization firewall (External) or only accessible to users inside the firewall (Internal). -`-Identity service:WebServer:atl-cs-001.litwareinc.com` +Allowed values are: Internal or External. +The default value is External. ```yaml -Type: XdsIdentity +Type: ExposedWebURL Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -130,50 +130,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExposedWebURL -Indicates whether the URL used by the Autodiscovery Service is accessible to users both inside and outside the organization firewall (External) or only accessible to users inside the firewall (Internal). +### -Identity -Allowed values are: Internal or External. -The default value is External. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: ExposedWebURL -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Unique identifier of the collection of Mobility Service configuration settings to be created. +To create settings at the site scope, use the prefix "site:" followed by the site name. +For example: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +`-Identity "site:Redmond"` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +To create settings configured at the service scope, use syntax like this: + +`-Identity service:WebServer:atl-cs-001.litwareinc.com` ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of a command called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -183,6 +176,9 @@ Accept wildcard characters: False ``` ### -PushNotificationProxyUri + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URI of a service provider that can forward push notification requests to the Apple Push Notification Service and the Microsoft Push Notification Service. The PushNotificationProxyUri must be in the form of a SIP address; for example: @@ -191,8 +187,7 @@ The PushNotificationProxyUri must be in the form of a SIP address; for example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -203,6 +198,8 @@ Accept wildcard characters: False ### -SessionExpirationInterval +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Length of time, in seconds, of a mobile session for iPhone or Windows Phone users. If Skype for Business is running in the background on these phones, users will receive push notifications as long as the session expiration interval has not expired. @@ -218,8 +215,7 @@ Note that the value of the SessionExpirationInterval property must be greater th ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -230,6 +226,8 @@ Accept wildcard characters: False ### -SessionShortExpirationInterval +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Length of time, in seconds, of a mobile session for Android or Nokia phone users. The mobile device must send a notice to the server indicating that the device is still active before the session timeout is reached. @@ -244,8 +242,25 @@ Note that the value of the SessionExpirationInterval property must be greater th ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -255,13 +270,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -275,13 +292,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsMcxConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WriteableConfig.Settings.McxConfiguration.McxConfiguration Creates new instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.McxConfiguration.McxConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsMediaConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsMediaConfiguration.md similarity index 84% rename from skype/skype-ps/skype/New-CsMediaConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsMediaConfiguration.md index b90eef34a2..48602e92db 100644 --- a/skype/skype-ps/skype/New-CsMediaConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsMediaConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csmediaconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsMediaConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csmediaconfiguration +schema: 2.0.0 +title: New-CsMediaConfiguration --- # New-CsMediaConfiguration @@ -38,7 +39,7 @@ This cmdlet creates a new collection of settings that define the behavior of spe ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsMediaConfiguration -Identity site:Redmond1 -EncryptionLevel RequireEncryption ``` @@ -49,7 +50,7 @@ That requirement is put in place by adding the EncryptionLevel parameter and set -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsMediaConfiguration -Identity MediationServer:pool0.litwareinc.com -EnableSiren $True ``` @@ -61,60 +62,55 @@ This new configuration will have an EnableSiren value of True, which means that ## PARAMETERS -### -Identity - -A unique identifier specifying the scope at which this configuration is applied (site or service). -A configuration at the site scope would be entered as site:\, such as site:Redmond. -A service would be entered as \:\, such as MediationServer:pool0.litwareinc.com. -A media configuration at the global scope will always exist and cannot be removed, so a new global configuration cannot be created. - -Media configurations created at the service scope can be created for only the A/V Conferencing service, Mediation Server, and Application Server. +### -EnableAdaptiveBandWidthEstimation +> Applicable: Lync Server 2013 +When set to True (the default value) Microsoft Lync Server will select the bandwidth rate at which to play a video stream. +This selection will be based on such factors as the network congestion and the client's quality of the client's current network connection. ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableQoS -QoS monitors the quality of voice signals over a network. When set to True, enables call Quality of Service (QoS) settings. +### -EnableG722StereoCodec + +> Applicable: Lync Server 2013 + +When set to True (the default value) allows the use of the G.722 wideband speech codec. +G.722 is a standard voice codec commonly used with Voice over IP applications; with a sampling rate of 16 KHz G.722 provides higher voice quality and clarity than many other commonly-used speech codecs. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSiren - -By default, the Mediation Server does not negotiate Siren as a possible codec for calls between itself and clients. -If this setting is True, Siren will be included as a possible codec for use between the Mediation Server and other clients. - -Default: False +### -EnableH264Codec +> Applicable: Lync Server 2013 +When set to True (the default value) allows the use of the H.264/MPEG-4 AVC video codec. +H.264 is a standard codec commonly used for recording, compressing, and distributing high-definition video. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -123,26 +119,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EncryptionLevel -The level of encryption between unified communications devices. - -Valid values: - -SupportEncryption - secure real-time transport protocol (SRTP) will be used if it can be negotiated. - -RequireEncryption - SRTP must be negotiated. - -DoNotSupportEncryption - SRTP must not be used. - -Default: RequireEncryption +### -EnableInCallQoS +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Enables or disables the ability of Skype for Business clients to send the raw data that's required to generate InCallQuality messages. ```yaml -Type: EncryptionLevel +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -151,42 +137,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxVideoRateAllowed -The maximum rate at which video signals will be transferred at the client endpoints. - -Valid values: Hd720p15M, VGA600K, CIF250K - -Hd720p15M - High definition, with a resolution of 1280 x 720 and aspect ratio 16:9. - -VGA600K - VGA, with a resolution of 640 x 480, 25 fps with the aspect ratio 4:3. +### -EnableQoS -CIF250K - Common Intermediate Format (CIF) video format, 15 fps with a resolution of 352 x 288. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that these values are not case sensitive; values will be converted to appropriate casing when the configuration is created. - -Default: VGA600K +QoS monitors the quality of voice signals over a network. When set to True, enables call Quality of Service (QoS) settings. ```yaml -Type: MaxVideoRateAllowed +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -EnableRtpRtcpMultiplexing + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables or disables the use of RTP/RTCP Multiplexing, if enabled, when negotiating, only one candidate will be used for both RTP and RTCP. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -195,17 +173,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -EnableSiren + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +By default, the Mediation Server does not negotiate Siren as a possible codec for calls between itself and clients. +If this setting is True, Siren will be included as a possible codec for use between the Mediation Server and other clients. + +Default: False ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -214,14 +196,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -EnableVideoBasedSharing + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables the use of Video Based Sharing, for more information, see [Video based Screen Sharing for Skype for Business Server](https://learn.microsoft.com/skypeforbusiness/manage/video-based-screen-sharing) ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -230,14 +214,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -EncryptionLevel + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The level of encryption between unified communications devices. + +Valid values: + +SupportEncryption - secure real-time transport protocol (SRTP) will be used if it can be negotiated. + +RequireEncryption - SRTP must be negotiated. + +DoNotSupportEncryption - SRTP must not be used. + +Default: RequireEncryption + + ```yaml -Type: SwitchParameter +Type: EncryptionLevel Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -246,15 +244,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAdaptiveBandWidthEstimation -When set to True (the default value) Microsoft Lync Server will select the bandwidth rate at which to play a video stream. -This selection will be based on such factors as the network congestion and the client's quality of the client's current network connection. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013 +Aliases: Required: False Position: Named @@ -263,32 +262,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableG722StereoCodec -When set to True (the default value) allows the use of the G.722 wideband speech codec. -G.722 is a standard voice codec commonly used with Voice over IP applications; with a sampling rate of 16 KHz G.722 provides higher voice quality and clarity than many other commonly-used speech codecs. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier specifying the scope at which this configuration is applied (site or service). +A configuration at the site scope would be entered as site:\, such as site:Redmond. +A service would be entered as \:\, such as MediationServer:pool0.litwareinc.com. +A media configuration at the global scope will always exist and cannot be removed, so a new global configuration cannot be created. + +Media configurations created at the service scope can be created for only the A/V Conferencing service, Mediation Server, and Application Server. + + ```yaml -Type: Boolean +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableH264Codec -When set to True (the default value) allows the use of the H.264/MPEG-4 AVC video codec. -H.264 is a standard codec commonly used for recording, compressing, and distributing high-definition video. +### -InCallQoSIntervalSeconds + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the interval between call QoS actions. ```yaml -Type: Boolean +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013 +Aliases: Required: False Position: Named @@ -297,14 +305,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableInCallQoS -Enables or disables the ability of Skype for Business clients to send the raw data that's required to generate InCallQuality messages. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -313,14 +326,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableRtpRtcpMultiplexing -Enables or disables the use of RTP/RTCP Multiplexing, if enabled, when negotiating, only one candidate will be used for both RTP and RTCP. +### -MaxVideoRateAllowed + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The maximum rate at which video signals will be transferred at the client endpoints. + +Valid values: Hd720p15M, VGA600K, CIF250K + +Hd720p15M - High definition, with a resolution of 1280 x 720 and aspect ratio 16:9. + +VGA600K - VGA, with a resolution of 640 x 480, 25 fps with the aspect ratio 4:3. + +CIF250K - Common Intermediate Format (CIF) video format, 15 fps with a resolution of 352 x 288. + +Note that these values are not case sensitive; values will be converted to appropriate casing when the configuration is created. + +Default: VGA600K ```yaml -Type: Boolean +Type: MaxVideoRateAllowed Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -329,14 +356,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InCallQoSIntervalSeconds -Specifies the interval between call QoS actions. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: UInt16 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -345,14 +374,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableVideoBasedSharing -Enables the use of Video Based Sharing, for more information, see [Video based Screen Sharing for Skype for Business Server](https://learn.microsoft.com/skypeforbusiness/manage/video-based-screen-sharing) +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -366,12 +397,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings. ## NOTES diff --git a/skype/skype-ps/skype/New-CsMeetingConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsMeetingConfiguration.md similarity index 86% rename from skype/skype-ps/skype/New-CsMeetingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsMeetingConfiguration.md index 77faa8bbc2..420c30ffd7 100644 --- a/skype/skype-ps/skype/New-CsMeetingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsMeetingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csmeetingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsMeetingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csmeetingconfiguration +schema: 2.0.0 +title: New-CsMeetingConfiguration --- # New-CsMeetingConfiguration @@ -53,7 +54,7 @@ If you try to create new settings for the Redmond site, and the Redmond site alr ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsMeetingConfiguration -Identity site:Redmond -EnableAssignedConferenceType $False -AssignedConferenceTypeByDefault $False -AdmitAnonymousUsersByDefault $False ``` @@ -68,7 +69,7 @@ That's because only one collection of meeting configuration settings can be appl -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsMeetingConfiguration -Identity site:Redmond -InMemory @@ -96,41 +97,39 @@ Instead, your virtual settings will disappear as soon as you end your Windows Po ## PARAMETERS -### -Identity - -Unique identifier for the new collection of meeting configuration settings. -Meeting configuration settings can only be created at the site or service scope. -To create new settings at the site scope, use syntax similar to this: `-Identity "site:Redmond".` -To create new settings at the service scope, use syntax like this: `-Identity "service:UserServer:atl-cs-001.litwareinc.com".` - -Note that the call to the New-CsMeetingConfiguration cmdlet will fail if the specified site or service already has a collection of meeting configuration settings. +### -AdmitAnonymousUsersByDefault +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Determines whether meetings will, by default, allow attendance by anonymous users (that is, unauthenticated users). +Set this value to True if you would like new meetings to allow for attendance by anonymous users by default. +Set this value to False if you would prefer that, by default, new meetings do not allow for attendance by anonymous users. +The default value is True. ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AdmitAnonymousUsersByDefault -Determines whether meetings will, by default, allow attendance by anonymous users (that is, unauthenticated users). -Set this value to True if you would like new meetings to allow for attendance by anonymous users by default. -Set this value to False if you would prefer that, by default, new meetings do not allow for attendance by anonymous users. +### -AssignedConferenceTypeByDefault + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Determines whether new meetings will be configured, by default, as public meetings. +Set this value to True to use public meetings by default; set this value to False to use private meetings by default. The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,16 +138,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AssignedConferenceTypeByDefault -Determines whether new meetings will be configured, by default, as public meetings. -Set this value to True to use public meetings by default; set this value to False to use private meetings by default. -The default value is True. +### -CustomFooterText + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Text to be used on custom meeting invitations. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,6 +157,9 @@ Accept wildcard characters: False ``` ### -DesignateAsPresenter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates which users (besides the meeting organizer) are automatically designated as presenters when they join a meeting. Valid choices are: None; Company; and Everyone. By default, DesignateAsPresenter is set to Company, meaning everyone in your organization has presenter rights the moment they join a meeting. @@ -165,8 +167,7 @@ By default, DesignateAsPresenter is set to Company, meaning everyone in your org ```yaml Type: DesignateAsPresenter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -176,6 +177,9 @@ Accept wildcard characters: False ``` ### -EnableAssignedConferenceType + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether users are allowed to schedule public meetings. With a public meeting, the conference ID and the meeting link remain consistent each time the meeting is held. With a private meeting, the conference ID and meeting link change from meeting to meeting. @@ -183,8 +187,7 @@ With a private meeting, the conference ID and meeting link change from meeting t ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -193,18 +196,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PstnCallersBypassLobby -Indicates whether users dialing in over a public switched telephone network (PSTN) phone line should automatically be admitted to a meeting. -If set to True PSTN callers will automatically be admitted to the meeting. -If set to False PSTN callers will initially be routed to the conference lobby. -At that point, they will be put on hold until a conference presenter grants them access to the meeting. -The default value is True. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -213,14 +214,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -HelpURL + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL to a website where users can obtain assistance on joining the meeting. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -229,44 +232,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -Identity -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the new collection of meeting configuration settings. +Meeting configuration settings can only be created at the site or service scope. +To create new settings at the site scope, use syntax similar to this: `-Identity "site:Redmond".` +To create new settings at the service scope, use syntax like this: `-Identity "service:UserServer:atl-cs-001.litwareinc.com".` + +Note that the call to the New-CsMeetingConfiguration cmdlet will fail if the specified site or service already has a collection of meeting configuration settings. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant - -Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new meeting configuration settings are being created. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -InMemory -You can return the tenant ID for each of your tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -275,14 +278,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -LegalURL + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL to a website containing legal information and meeting disclaimers. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -291,14 +296,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -LogoURL + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL for the image to be used on custom meeting invitations. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -307,14 +314,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomFooterText -Text to be used on custom meeting invitations. +### -PstnCallersBypassLobby + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether users dialing in over a public switched telephone network (PSTN) phone line should automatically be admitted to a meeting. +If set to True PSTN callers will automatically be admitted to the meeting. +If set to False PSTN callers will initially be routed to the conference lobby. +At that point, they will be put on hold until a conference presenter grants them access to the meeting. +The default value is True. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -323,14 +336,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HelpURL -URL to a website where users can obtain assistance on joining the meeting. +### -RequireRoomSystemsAuthorization + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True) all users must be authenticated before they can join a meeting using the Skype for Business Room System. +The default value is False ($False). + + ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -339,14 +357,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LegalURL -URL to a website containing legal information and meeting disclaimers. +### -Tenant + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new meeting configuration settings are being created. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` + + ```yaml -Type: String +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -355,14 +384,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LogoURL -URL for the image to be used on custom meeting invitations. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -371,18 +402,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequireRoomSystemsAuthorization - -When set to True ($True) all users must be authenticated before they can join a meeting using the Skype for Business Room System. -The default value is False ($False). +### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -396,13 +425,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsMeetingConfiguration cmdlet does not accept pipelined data. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.MeetingConfiguration The New-CsMeetingConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.MeetingConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsMobilityPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsMobilityPolicy.md similarity index 87% rename from skype/skype-ps/skype/New-CsMobilityPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsMobilityPolicy.md index 5e9016c50f..6193dba00c 100644 --- a/skype/skype-ps/skype/New-CsMobilityPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsMobilityPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csmobilitypolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsMobilityPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/new-csmobilitypolicy +schema: 2.0.0 +title: New-CsMobilityPolicy --- # New-CsMobilityPolicy @@ -62,7 +64,7 @@ To use Call via Work, users must be managed by a voice policy that allows simult ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ```powershell New-CsMobilityPolicy -Identity site:Redmond -EnableOutsideVoice $False @@ -71,7 +73,7 @@ New-CsMobilityPolicy -Identity site:Redmond -EnableOutsideVoice $False The command shown in Example 1 creates a new mobility policy for the Redmond site, and disables the use of Call via Work for any users affected by the policy. This is done by setting the EnableOutsideVoice parameter to False. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ```powershell $x = New-CsMobilityPolicy -Identity site:Redmond -InMemory @@ -91,45 +93,34 @@ If you do not call the Set-CsMobilityPolicy cmdlet, the policy will not be creat ## PARAMETERS -### -Identity - -Unique Identity to be assigned to the policy. -New mobility policies can be created at the site or per-user scope. -To create a new site policy, use the prefix "site:" and the name of the site as your Identity. -For example, use this syntax to create a new policy for the Redmond site: - -`-Identity site:Redmond` - -To create a new per-user policy, use an Identity similar to this: +### -AllowAutomaticPstnFallback -`-Identity SalesDepartmentPolicy` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that you cannot create a new global policy; if you want to make changes to the global policy, use the Set-CsMobilityPolicy cmdlet instead. -Likewise, you cannot create a new site or per-user policy if a policy with that Identity already exists. -If you need to make changes to an existing policy, use the Set-CsMobilityPolicy cmdlet. +This parameter is reserved for internal Microsoft use. ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -AllowCustomerExperienceImprovementProgram -Prompts you for confirmation before executing the command. +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) mobile users will be allowed to participate in the Microsoft Customer Experience Improvement Program. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,16 +129,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -AllowDeviceContactsSync -Enables administrators to provide explanatory text to accompany the policy. -For example, the Description might include information about the users that the policy should be assigned to. +> Applicable: Skype for Business Online + +When set to True (the default value) users will be allowed to sync device contacts on the mobile apps. + +More information: [How to disable CallKit integration for Skype for Business iOS](https://learn.microsoft.com/SkypeForBusiness/troubleshoot/server-phone-system/disable-callkit-integration). ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -156,18 +149,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableIPAudioVideo +### -AllowExchangeConnectivity -When set to False, prohibits the user from making voice over IP (VoIP) calls using the mobile device. -The default value is True, meaning that VoIP calls are allowed. +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -This parameter was introduced in Lync Server 2013. +When set to True (the default value) users will be allowed to connect to Exchange by using their mobile device. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -176,15 +167,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMobility +### -AllowSaveCallLogs -When set to True, users are allowed to use Skype for Business Mobile. +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) users will be allowed to save a call log of calls made from or received by their mobile device. + +Note that this setting does not apply to Android devices. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -193,18 +187,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOutsideVoice +### -AllowSaveCredentials -When set to True, enables users to take advantage of Call via Work. -When set to False, users cannot use Call via Work. +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -The default value is True. +When set to True (the default value) users will be allowed to save credentials information (such as passwords) on their mobile device. +This information can then be applied to auto-logon scenarios. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -213,15 +206,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -AllowSaveIMHistory -Suppresses the display of any non-fatal error message that might occur when running the command. +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) users will be allowed to save transcripts of IM and conferencing sessions on their mobile devices. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -230,16 +224,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -Description -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of a command called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to provide explanatory text to accompany the policy. +For example, the Description might include information about the users that the policy should be assigned to. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -248,11 +243,12 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequireWIFIForIPVideo +### -EnableIPAudioVideo -When set to True, the user can use IP video only in calls made when mobile device is connected to a Wi-Fi network. -If mobile device goes outside of Wi-Fi range, then video calls will be received as audio calls only. -If this property is set to False (the default value) then the user can make or receive IP video calls in using either a Wi-Fi or a cellular data connection. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to False, prohibits the user from making voice over IP (VoIP) calls using the mobile device. +The default value is True, meaning that VoIP calls are allowed. This parameter was introduced in Lync Server 2013. @@ -260,7 +256,6 @@ This parameter was introduced in Lync Server 2013. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -269,32 +264,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf - -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### -EnableMobility -### -AllowAutomaticPstnFallback +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -This parameter is reserved for internal Microsoft use. +When set to True, users are allowed to use Skype for Business Mobile. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -303,15 +282,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCustomerExperienceImprovementProgram +### -EnableOutsideVoice -When set to True (the default value) mobile users will be allowed to participate in the Microsoft Customer Experience Improvement Program. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, enables users to take advantage of Call via Work. +When set to False, users cannot use Call via Work. + +The default value is True. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -320,17 +303,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowDeviceContactsSync +### -EnablePushNotifications -When set to True (the default value) users will be allowed to sync device contacts on the mobile apps. +> Applicable: Skype for Business Online -More information: [How to disable CallKit integration for Skype for Business iOS](https://learn.microsoft.com/SkypeForBusiness/troubleshoot/server-phone-system/disable-callkit-integration). +When set to True (the default value) users will be allowed to receive push notifications on their mobile devices. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named @@ -339,15 +321,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowExchangeConnectivity +### -EncryptAppData -When set to True (the default value) users will be allowed to connect to Exchange by using their mobile device. +> Applicable: Skype for Business Online + +When set to True (the default value) users will be allowed to encrypt data on their mobile apps. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -356,17 +339,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSaveCallLogs +### -Force -When set to True (the default value) users will be allowed to save a call log of calls made from or received by their mobile device. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Note that this setting does not apply to Android devices. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -375,50 +357,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSaveCredentials +### -Identity -When set to True (the default value) users will be allowed to save credentials information (such as passwords) on their mobile device. -This information can then be applied to auto-logon scenarios. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Unique Identity to be assigned to the policy. +New mobility policies can be created at the site or per-user scope. +To create a new site policy, use the prefix "site:" and the name of the site as your Identity. +For example, use this syntax to create a new policy for the Redmond site: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +`-Identity site:Redmond` -### -AllowSaveIMHistory +To create a new per-user policy, use an Identity similar to this: -When set to True (the default value) users will be allowed to save transcripts of IM and conferencing sessions on their mobile devices. +`-Identity SalesDepartmentPolicy` + +Note that you cannot create a new global policy; if you want to make changes to the global policy, use the Set-CsMobilityPolicy cmdlet instead. +Likewise, you cannot create a new site or per-user policy if a policy with that Identity already exists. +If you need to make changes to an existing policy, use the Set-CsMobilityPolicy cmdlet. ```yaml -Type: Boolean +Type: XdsIdentity Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnablePushNotifications +### -InMemory -When set to True (the default value) users will be allowed to receive push notifications on their mobile devices. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of a command called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named @@ -427,15 +407,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EncryptAppData +### -RequireIntune -When set to True (the default value) users will be allowed to encrypt data on their mobile apps. +> Applicable: Skype for Business Online + +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named @@ -444,15 +425,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequireIntune +### -RequireWIFIForIPVideo -This parameter is reserved for internal Microsoft use. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, the user can use IP video only in calls made when mobile device is connected to a Wi-Fi network. +If mobile device goes outside of Wi-Fi range, then video calls will be received as audio calls only. +If this property is set to False (the default value) then the user can make or receive IP video calls in using either a Wi-Fi or a cellular data connection. + +This parameter was introduced in Lync Server 2013. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named @@ -463,6 +449,8 @@ Accept wildcard characters: False ### -RequireWiFiForSharing +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, mobile users must use a WiFi connection in order to participate in an application sharing session. When set to False (the default value) mobile users can participate in application sharing by using either a WiFi connection or a cellular (3G/4G) connection. @@ -473,7 +461,6 @@ If this value is set to False users can use the Options page to modify their sha Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -484,6 +471,8 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new mobility policy is being created. For example: @@ -497,7 +486,6 @@ You can return the tenant ID for each of your Skype for Business Online tenants Type: Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -508,6 +496,8 @@ Accept wildcard characters: False ### -VoiceSettings +> Applicable: Skype for Business Online + Controls how audio is connected by a mobile device joining a meeting or a peer-to-peer call. When the Skype for Business client is first run, and the user is enabled for Phone System with a Calling Plan, they are prompted to configure a call back phone number. This number is stored in settings under the **Calls and Meetings** section and will be used based on the value chosen for this parameter. Acceptable values are: **VoIPAlways:** WiFi will be used when available, otherwise a call back will be performed. @@ -520,7 +510,42 @@ Controls how audio is connected by a mobile device joining a meeting or a peer-t Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/New-CsNetworkBWAlternatePath.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkBWAlternatePath.md similarity index 91% rename from skype/skype-ps/skype/New-CsNetworkBWAlternatePath.md rename to skype/skype-ps/SkypeForBusiness/New-CsNetworkBWAlternatePath.md index cb3e77828a..e49bcbf84e 100644 --- a/skype/skype-ps/skype/New-CsNetworkBWAlternatePath.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkBWAlternatePath.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkbwalternatepath applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsNetworkBWAlternatePath -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkbwalternatepath +schema: 2.0.0 +title: New-CsNetworkBWAlternatePath --- # New-CsNetworkBWAlternatePath @@ -42,7 +43,7 @@ Note that you can apply these settings directly by using the AudioAlternatePath ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $a = New-CsNetworkBWAlternatePath -BWPolicyModality "audio" -AlternatePath $true @@ -63,13 +64,15 @@ We assign a value for the required parameter CentralSite (in this example the na ## PARAMETERS ### -AlternatePath + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Set the parameter to True to allow calls made in the media of the modality specified in the BWPolicyModality parameter (either audio or video) to be routed through an alternate path if adequate bandwidth does not exist in the primary path. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -BWPolicyModality + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The modality to which the alternate path setting applies. Valid values: audio, video @@ -88,8 +94,7 @@ Full data type: Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfigur ```yaml Type: BWPolicyModality Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -103,12 +108,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWAlternatePathType Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWAlternatePathType. ## NOTES diff --git a/skype/skype-ps/skype/New-CsNetworkBWPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkBWPolicy.md similarity index 89% rename from skype/skype-ps/skype/New-CsNetworkBWPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsNetworkBWPolicy.md index f6cd2973a3..92a3e8289e 100644 --- a/skype/skype-ps/skype/New-CsNetworkBWPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkBWPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkbwpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsNetworkBWPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkbwpolicy +schema: 2.0.0 +title: New-CsNetworkBWPolicy --- # New-CsNetworkBWPolicy @@ -40,7 +41,7 @@ Note that the recommended method of assigning audio and video policies is to ass ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $bwp = New-CsNetworkBWPolicy -BWLimit 200 -BWSessionLimit 3000 -BWPolicyModality video ``` @@ -50,7 +51,7 @@ All parameters for the New-CsNetworkBWPolicy cmdlet are required. In this example we specified a total bandwidth limit (BWLimit) of 2000 kbps and a bandwidth session limit (BWSessionLimit) of 300 kbps, and we applied these limits to video sessions (-BWPolicyModality video). -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $bwp = New-CsNetworkBWPolicy -BWLimit 200 -BWSessionLimit 3000 -BWPolicyModality video @@ -68,13 +69,15 @@ Then we use the BWPolicy parameter, giving it the value $bwp, which is the varia ## PARAMETERS ### -BWLimit + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum total bandwidth, in kbps, for all concurrent sessions of the type specified in the BWPolicyModality parameter. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -84,6 +87,9 @@ Accept wildcard characters: False ``` ### -BWPolicyModality + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines which type of bandwidth is limited. Valid values: Audio, Video @@ -91,8 +97,7 @@ Valid values: Audio, Video ```yaml Type: BWPolicyModality Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -102,13 +107,15 @@ Accept wildcard characters: False ``` ### -BWSessionLimit + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum bandwidth, in kbps, allowed for a single session of the type specified in the BWPolicyModality parameter. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -122,12 +129,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyType Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyType. ## NOTES diff --git a/skype/skype-ps/skype/New-CsNetworkBandwidthPolicyProfile.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkBandwidthPolicyProfile.md similarity index 84% rename from skype/skype-ps/skype/New-CsNetworkBandwidthPolicyProfile.md rename to skype/skype-ps/SkypeForBusiness/New-CsNetworkBandwidthPolicyProfile.md index 0c27af1dff..f714ee4e02 100644 --- a/skype/skype-ps/skype/New-CsNetworkBandwidthPolicyProfile.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkBandwidthPolicyProfile.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkbandwidthpolicyprofile applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsNetworkBandwidthPolicyProfile -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkbandwidthpolicyprofile +schema: 2.0.0 +title: New-CsNetworkBandwidthPolicyProfile --- # New-CsNetworkBandwidthPolicyProfile @@ -41,7 +42,7 @@ Bandwidth policy profiles are applied to network sites by calling the New-CsNetw ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsNetworkBandwidthPolicyProfile -Identity LowBWLimits -AudioBWLimit 2000 -AudioBWSessionLimit 200 -VideoBWLimit 1400 -VideoBWSessionLimit 500 @@ -55,26 +56,10 @@ The same is done to create video session limits, but using the VideoBWLimit and ## PARAMETERS -### -Identity -A string value that uniquely identifies the policy. -All bandwidth policy profiles are created at the global scope. -Therefore the scope is implied and only a unique name needs to be specified when creating a new bandwidth policy profile. -Note that this value also populates the BWPolicyProfileID property of the profile. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AudioBWLimit -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AudioBWLimit The maximum amount of bandwidth to allocate for all audio connections. If a single audio session will cause the audio bandwidth limit to be exceeded, that session will not be allowed to start. @@ -88,8 +73,7 @@ Default: If you supply a value to the AudioBWSessionLimit parameter but not to A ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -99,6 +83,9 @@ Accept wildcard characters: False ``` ### -AudioBWSessionLimit + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum amount of bandwidth to allocate per audio session. Expressed in kbps. Value must be 40 or higher. @@ -110,8 +97,7 @@ Default: If you supply a value to the AudioBWLimit parameter but not to AudioBWS ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -121,6 +107,9 @@ Accept wildcard characters: False ``` ### -BWPolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A list of objects containing bandwidth policy profiles. Each object in the list consists of a bandwidth modality (audio or video), a bandwidth limitation, and a bandwidth session limitation. @@ -131,8 +120,7 @@ Objects in the list can be created by calling the New-CsNetworkBWPolicy cmdlet. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -142,14 +130,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A description of the bandwidth policy profile. For example, you can use this parameter to clarify the expected use of the profile. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,22 +148,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VideoBWLimit -The maximum amount of bandwidth to allocate for all video connections. -If a single video session will cause the video bandwidth limit to be exceeded, that session will not be allowed to start. - -Expressed in kbps. -For example, a value of 1000 would signify 1000 kbps. +### -Force -If you supply a value to this parameter, you cannot supply a value to the BWPolicy parameter. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Default: If you supply a value to the VideoBWSessionLimit parameter but not to VideoBWLimit, VideoBWLimit will default to 0. +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,36 +166,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VideoBWSessionLimit -The maximum amount of bandwidth to allocate per video session. -Expressed in kbps. -Value must be 100 or higher. +### -Identity -If you supply a value to this parameter, you cannot supply a value to the BWPolicy parameter. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Default: If you supply a value to the VideoBWLimit parameter but not to VideoBWSessionLimit, VideoBWSessionLimit will default to 700. +A string value that uniquely identifies the policy. +All bandwidth policy profiles are created at the global scope. +Therefore the scope is implied and only a unique name needs to be specified when creating a new bandwidth policy profile. +Note that this value also populates the BWPolicyProfileID property of the profile. ```yaml -Type: String +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -220,18 +208,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -VideoBWLimit -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +The maximum amount of bandwidth to allocate for all video connections. +If a single video session will cause the video bandwidth limit to be exceeded, that session will not be allowed to start. + +Expressed in kbps. +For example, a value of 1000 would signify 1000 kbps. + +If you supply a value to this parameter, you cannot supply a value to the BWPolicy parameter. +Default: If you supply a value to the VideoBWSessionLimit parameter but not to VideoBWLimit, VideoBWLimit will default to 0. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -240,14 +234,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -VideoBWSessionLimit + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The maximum amount of bandwidth to allocate per video session. +Expressed in kbps. +Value must be 100 or higher. + +If you supply a value to this parameter, you cannot supply a value to the BWPolicy parameter. + +Default: If you supply a value to the VideoBWLimit parameter but not to VideoBWSessionLimit, VideoBWSessionLimit will default to 700. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -257,13 +259,33 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -277,12 +299,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType. ## NOTES diff --git a/skype/skype-ps/skype/New-CsNetworkInterRegionRoute.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkInterRegionRoute.md similarity index 84% rename from skype/skype-ps/skype/New-CsNetworkInterRegionRoute.md rename to skype/skype-ps/SkypeForBusiness/New-CsNetworkInterRegionRoute.md index 5a44fa962c..100dbfcc95 100644 --- a/skype/skype-ps/skype/New-CsNetworkInterRegionRoute.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkInterRegionRoute.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkinterregionroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsNetworkInterRegionRoute -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkinterregionroute +schema: 2.0.0 +title: New-CsNetworkInterRegionRoute --- # New-CsNetworkInterRegionRoute @@ -45,7 +46,7 @@ This cmdlet creates that route association. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsNetworkInterRegionRoute -Identity NA_APAC_Route -NetworkRegionID1 NorthAmerica -NetworkRegionID2 APAC -NetworkRegionLinkIDs "NA_EMEA,EMEA_APAC" @@ -62,7 +63,28 @@ This will route connections from NorthAmerica to APAC through EMEA and apply any ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier for the newly created network region route. Network region routes are created only at the global scope, so this identifier does not need to specify a scope. Instead, it contains a string that is a unique name that identifies that route. @@ -70,8 +92,7 @@ Instead, it contains a string that is a unique name that identifies that route. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -80,15 +101,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InterNetworkRegionRouteID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This value is the same as the Identity. You cannot specify both an Identity and an InterNetworkRegionRouteID; a value entered for one will be automatically used for both. ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -98,6 +142,9 @@ Accept wildcard characters: False ``` ### -NetworkRegionID1 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Identity (NetworkRegionID) of one of the two regions connected through this route. The value passed to this parameter must be a different region from the value of the NetworkRegionID2 parameter. (In other words, you can't route a region to itself.) In addition, the combination of NetworkRegionID1 and NetworkRegionID2 must be unique (for example, you can't have two routes defined that connect NorthAmerica and EMEA). @@ -105,8 +152,7 @@ The value passed to this parameter must be a different region from the value of ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -116,6 +162,9 @@ Accept wildcard characters: False ``` ### -NetworkRegionID2 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Identity (NetworkRegionID) of one of the two regions connected through this route. The value passed to this parameter must be a different region from the value of the NetworkRegionID1 parameter. (In other words, you can't route a region to itself.) In addition, the combination of NetworkRegionID1 and NetworkRegionID2 must be unique (for example, you can't have two routes defined that connect NorthAmerica and EMEA). @@ -123,8 +172,7 @@ The value passed to this parameter must be a different region from the value of ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -134,6 +182,9 @@ Accept wildcard characters: False ``` ### -NetworkRegionLinkIDs + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to specify all the links for this route as a string of comma-separated values. The values are the identities (NetworkRegionLinkIDs) of the region links. If you enter values for both NetworkRegionLinkIDs and NetworkRegionLinks, NetworkRegionLinkIDs will be ignored. @@ -142,8 +193,7 @@ This parameter provides a convenient way to specify the list of links without ha ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -153,6 +203,9 @@ Accept wildcard characters: False ``` ### -NetworkRegionLinks + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A list object containing the identities (NetworkRegionLinkIDs) of the region links that apply to this route. For this cmdlet, this parameter differs from the NetworkRegionLinkIDs parameter only in the format if you enter more than one link. The NetworkRegionLinkIDs parameter is the recommended method for defining the initial list with this cmdlet. @@ -160,24 +213,7 @@ The NetworkRegionLinkIDs parameter is the recommended method for defining the in ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -186,18 +222,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory - -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -207,29 +241,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -243,12 +263,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkRegionRouteType Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkRegionRouteType. ## NOTES diff --git a/skype/skype-ps/skype/New-CsNetworkInterSitePolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkInterSitePolicy.md similarity index 82% rename from skype/skype-ps/skype/New-CsNetworkInterSitePolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsNetworkInterSitePolicy.md index 445ced2da8..6778cfe687 100644 --- a/skype/skype-ps/skype/New-CsNetworkInterSitePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkInterSitePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkintersitepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsNetworkInterSitePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkintersitepolicy +schema: 2.0.0 +title: New-CsNetworkInterSitePolicy --- # New-CsNetworkInterSitePolicy @@ -44,7 +45,7 @@ This cmdlet creates a network site policy that associates a bandwidth limitation ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsNetworkInterSitePolicy -Identity Reno_Portland -NetworkSiteID1 Reno -NetworkSiteID2 Portland -BWPolicyProfileID LowBWLimits @@ -57,136 +58,151 @@ The bandwidth limitations for audio and video connections between these sites ar ## PARAMETERS -### -Identity -A unique identifier for the newly created network inter-site policy. -Network inter-site policies are created only at the global scope, so this identifier does not need to specify a scope. -Instead, it contains a string that is a unique name that identifies that site policy. +### -BWPolicyProfileID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity of the bandwidth policy profile that will define the limitations for this site policy. +You can retrieve a list of available profiles by calling the Get-CsNetworkBandwidthPolicyProfile cmdlet. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InterNetworkSitePolicyID -This value is the same as the Identity. -You cannot specify both an Identity and an InterNetworkSitePolicyID; a value entered for one will be automatically used for both. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkSiteID1 -The Identity (NetworkSiteID) of one of the two sites associated with this policy. -The combination of NetworkSiteID1 and NetworkSiteID2 must be unique (for example, you can't have two site policies defined that connect Reno and Portland). +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier for the newly created network inter-site policy. +Network inter-site policies are created only at the global scope, so this identifier does not need to specify a scope. +Instead, it contains a string that is a unique name that identifies that site policy. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: True -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkSiteID2 -The Identity (NetworkSiteID) of one of the two sites associated with this policy. -The combination of NetworkSiteID1 and NetworkSiteID2 must be unique (for example, you can't have two site policies defined that connect Reno and Portland). +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BWPolicyProfileID -The Identity of the bandwidth policy profile that will define the limitations for this site policy. -You can retrieve a list of available profiles by calling the Get-CsNetworkBandwidthPolicyProfile cmdlet. +### -InterNetworkSitePolicyID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This value is the same as the Identity. +You cannot specify both an Identity and an InterNetworkSitePolicyID; a value entered for one will be automatically used for both. ```yaml Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -NetworkSiteID1 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity (NetworkSiteID) of one of the two sites associated with this policy. +The combination of NetworkSiteID1 and NetworkSiteID2 must be unique (for example, you can't have two site policies defined that connect Reno and Portland). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory - -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -NetworkSiteID2 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +The Identity (NetworkSiteID) of one of the two sites associated with this policy. +The combination of NetworkSiteID1 and NetworkSiteID2 must be unique (for example, you can't have two site policies defined that connect Reno and Portland). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -195,14 +211,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -216,12 +234,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkSitePolicyType Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkSitePolicyType. ## NOTES diff --git a/skype/skype-ps/skype/New-CsNetworkMediaBypassConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkMediaBypassConfiguration.md similarity index 88% rename from skype/skype-ps/skype/New-CsNetworkMediaBypassConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsNetworkMediaBypassConfiguration.md index 37c19d474c..1c4f116ee6 100644 --- a/skype/skype-ps/skype/New-CsNetworkMediaBypassConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkMediaBypassConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkmediabypassconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsNetworkMediaBypassConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkmediabypassconfiguration +schema: 2.0.0 +title: New-CsNetworkMediaBypassConfiguration --- # New-CsNetworkMediaBypassConfiguration @@ -39,7 +41,7 @@ To retrieve these settings, run this command: (Get-CsNetworkConfiguration).Media ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $a = New-CsNetworkMediaBypassConfiguration -AlwaysBypass $true -Enabled $true @@ -59,7 +61,7 @@ Therefore, in line 2 of the example, we save the media bypass configuration chan The following parameters are not applicable to Skype for Business Online: BypassID, EnableDefaultBypassID, EnabledForAudioVideoConferences, ExternalBypassMode, InternalBypassMode, PipelineVariable, and Tenant -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $a = (Get-CsNetworkConfiguration).MediaBypassSettings @@ -85,6 +87,8 @@ Finally, in line 3 we call the Set-CsNetworkConfiguration cmdlet, passing the Me ### -AlwaysBypass +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Setting this parameter to True will attempt media bypass on all calls. Set this parameter value to True only if call admission control (CAC) is disabled. @@ -105,8 +109,7 @@ Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -117,6 +120,8 @@ Accept wildcard characters: False ### -BypassID +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + The media bypass ID. If the AlwaysBypass parameter is set to True and a value is supplied for this parameter, this BypassID will be associated with all subnets. If AlwaysBypass is False, the BypassID value is associated with all subnets that are not found in network configuration sites and regions. @@ -128,8 +133,7 @@ This value is automatically generated when Enabled is set to True and either: 1) ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -140,6 +144,8 @@ Accept wildcard characters: False ### -Enabled +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Set this parameter to True to enable media bypass. At that point bypass decisions will be based on the value of the AlwaysBypass setting as follows: @@ -151,8 +157,7 @@ Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -163,6 +168,8 @@ Accept wildcard characters: False ### -EnableDefaultBypassID +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + This value applies only when AlwaysBypass is set to False. Setting this value to True will automatically generate a default bypass ID. @@ -177,8 +184,7 @@ Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -187,18 +193,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExternalBypassMode +### -EnabledForAudioVideoConferences -Reserved for future use. -External media bypass is not supported in Skype for Business Server. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Default: Off +Indicates whether media bypass should be used for audio/video conferences. +The default value is False ($False). ```yaml -Type: BypassModeEnumType +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -207,19 +212,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InternalBypassMode +### -ExternalBypassMode -The value of this parameter controls when clients connecting from inside the organization's network can try to perform media bypass. -If Enabled is set to True, this value will automatically be changed to Any. -Other values for this parameter are reserved for future use. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Reserved for future use. +External media bypass is not supported in Skype for Business Server. Default: Off ```yaml Type: BypassModeEnumType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -228,16 +233,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnabledForAudioVideoConferences +### -InternalBypassMode -Indicates whether media bypass should be used for audio/video conferences. -The default value is False ($False). +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +The value of this parameter controls when clients connecting from inside the organization's network can try to perform media bypass. +If Enabled is set to True, this value will automatically be changed to Any. +Other values for this parameter are reserved for future use. + +Default: Off ```yaml -Type: Boolean +Type: BypassModeEnumType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -247,13 +256,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + {{Fill Tenant Description}} ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -267,12 +278,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.MediaBypassSettingsType Creates an object reference of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.MediaBypassSettingsType. ### System.Object diff --git a/skype/skype-ps/skype/New-CsNetworkRegion.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkRegion.md similarity index 87% rename from skype/skype-ps/skype/New-CsNetworkRegion.md rename to skype/skype-ps/SkypeForBusiness/New-CsNetworkRegion.md index eee2fe72cc..6018ec3e03 100644 --- a/skype/skype-ps/skype/New-CsNetworkRegion.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkRegion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkregion applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsNetworkRegion -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkregion +schema: 2.0.0 +title: New-CsNetworkRegion --- # New-CsNetworkRegion @@ -49,7 +50,7 @@ The parameters of this cmdlet allow you to provide settings that determine wheth ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsNetworkRegion -Identity NorthAmerica -Description "All North American Locations" -CentralSite Redmond-NA-MLS @@ -60,7 +61,7 @@ The region name is specified as the value for the Identity parameter. A value is also specified for the optional Description parameter, describing this region as being composed of "All North American Locations." Finally, the CentralSite parameter receives a value of the name of the central site for this region, Redmond-NA-MLS. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsNetworkRegion -Identity EMEA -CentralSite Dublin-EU-Site -AudioAlternatePath $False @@ -71,7 +72,7 @@ To do this we call the New-CsNetworkRegion cmdlet, passing an Identity of EMEA. We assign a value for the required parameter CentralSite (in this example the name of the central site for this region is Dublin-EU-Site), and then we specify the AudioAlternatePath parameter, passing it the value $False. Setting AudioAlternatePath to False indicates that if adequate bandwidth is not available, the audio calls will not be routed to an alternate path; instead, they will simply not be completed. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` $a = New-CsNetworkBWAlternatePath -BWPolicyModality "audio" -AlternatePath $False @@ -92,61 +93,10 @@ We assign a value for the required parameter CentralSite (in this example the na ## PARAMETERS -### -Identity -A unique identifier for the newly created network region. -Regions are created only at the global scope, so this identifier does not need to specify a scope. -Instead, it contains a string that is a unique name that identifies that region. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CentralSite -The central site running the bandwidth policy service. -This service must be enabled in order to use CAC. -This service runs on the Front End Server or the Standard Edition server. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkRegionID -This value is the same as the Identity. -You cannot specify both an Identity and a NetworkRegionID; a value entered for one will be automatically used for both. - -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AudioAlternatePath +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This parameter determines whether audio calls will be routed through an alternate path if adequate bandwidth does not exist in the primary path. This parameter populates the BWAlternatePaths property. @@ -163,8 +113,7 @@ If any of your calls will be Internet calls, this value must be True, regardless ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -174,6 +123,9 @@ Accept wildcard characters: False ``` ### -BWAlternatePaths + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A list of objects that contain information about whether alternate Internet connection paths are allowed if a media request is unable to complete along the preferred path (for example, if limits on that path have been exceeded). Alternate path objects must be created by calling the New-CsNetworkBWAlternatePath cmdlet. @@ -184,8 +136,7 @@ Alternate paths for audio and video are enabled (AlternatePath = True) by defaul ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -196,6 +147,8 @@ Accept wildcard characters: False ### -BypassID +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A globally unique identifier (GUID). This GUID is used to map network regions to media bypass settings within a CAC or Enhanced 9-1-1 (E9-1-1) network configuration. (Use this BypassID value in the call to the New-CsNetworkMediaBypassConfiguration cmdlet.) @@ -210,8 +163,7 @@ If you supply a value for this parameter, you'll receive a confirmation prompt a ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -220,43 +172,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -A string that describes the region. -This parameter can be used to provide a more descriptive explanation of what the region is for than can be expressed by the Identity alone. +### -CentralSite + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The central site running the bandwidth policy service. +This service must be enabled in order to use CAC. +This service runs on the Front End Server or the Standard Edition server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -VideoAlternatePath - -This parameter determines whether video calls will be routed through an alternate path if adequate bandwidth does not exist in the primary path. - -This parameter populates the BWAlternatePaths property. -The value supplied to this parameter is stored in the AlternatePath property for the alternate path element with a BWPolicyModality value of Video. - -If you supply a value for this parameter you cannot specify a value for the BWAlternatePaths parameter. - -Default: True. -Set this parameter to False only if you need to turn off the offload to the Internet. -If any of your calls will be Internet calls, this value must be True, regardless of bandwidth settings. +### -Description +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +A string that describes the region. +This parameter can be used to provide a more descriptive explanation of what the region is for than can be expressed by the Identity alone. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -266,14 +212,16 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses any confirmation prompts that would otherwise be displayed before making changes. For example, if you supply a value to the BypassID parameter, you will not be prompted for confirmation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -282,8 +230,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier for the newly created network region. +Regions are created only at the global scope, so this identifier does not need to specify a scope. +Instead, it contains a string that is a unique name that identifies that region. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. @@ -292,8 +262,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -302,14 +271,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -NetworkRegionID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This value is the same as the Identity. +You cannot specify both an Identity and a NetworkRegionID; a value entered for one will be automatically used for both. ```yaml -Type: SwitchParameter +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -VideoAlternatePath + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter determines whether video calls will be routed through an alternate path if adequate bandwidth does not exist in the primary path. + +This parameter populates the BWAlternatePaths property. +The value supplied to this parameter is stored in the AlternatePath property for the alternate path element with a BWPolicyModality value of Video. + +If you supply a value for this parameter you cannot specify a value for the BWAlternatePaths parameter. + +Default: True. +Set this parameter to False only if you need to turn off the offload to the Internet. +If any of your calls will be Internet calls, this value must be True, regardless of bandwidth settings. + + + +```yaml +Type: Boolean Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -319,13 +320,33 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -339,12 +360,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType. ## NOTES diff --git a/skype/skype-ps/skype/New-CsNetworkRegionLink.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkRegionLink.md similarity index 83% rename from skype/skype-ps/skype/New-CsNetworkRegionLink.md rename to skype/skype-ps/SkypeForBusiness/New-CsNetworkRegionLink.md index 20c21b9c30..a279a8e184 100644 --- a/skype/skype-ps/skype/New-CsNetworkRegionLink.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkRegionLink.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkregionlink applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsNetworkRegionLink -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworkregionlink +schema: 2.0.0 +title: New-CsNetworkRegionLink --- # New-CsNetworkRegionLink @@ -44,7 +45,7 @@ This cmdlet defines a link between two regions and sets the bandwidth limitation ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsNetworkRegionLink -Identity NA_EMEA -NetworkRegionID1 NorthAmerica -NetworkRegionID2 EMEA -BWPolicyProfileID LowBWLimits @@ -62,134 +63,149 @@ For details, see the New-CsNetworkSite cmdlet help topic.) ## PARAMETERS -### -Identity -A unique identifier for the newly created network region link. -Network region links are created only at the global scope, so this identifier does not need to specify a scope. -Instead, it contains a string that is a unique name that identifies that link. +### -BWPolicyProfileID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity of the bandwidth policy profile that will define the bandwidth limitations for this link. +You can retrieve a list of available profiles by calling the Get-CsNetworkBandwidthPolicyProfile cmdlet. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkRegionID1 -The Identity (NetworkRegionID) of the region that is linked to the region identified by the NetworkRegionID2 parameter. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkRegionID2 -The Identity (NetworkRegionID) of the region that is linked to the region identified by the NetworkRegionID1 parameter. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier for the newly created network region link. +Network region links are created only at the global scope, so this identifier does not need to specify a scope. +Instead, it contains a string that is a unique name that identifies that link. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: True -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkRegionLinkID -This value is the same as the Identity. -You cannot specify both an Identity and a NetworkRegionLinkID; a value entered for one will be automatically used for both. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + ```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BWPolicyProfileID -The Identity of the bandwidth policy profile that will define the bandwidth limitations for this link. -You can retrieve a list of available profiles by calling the Get-CsNetworkBandwidthPolicyProfile cmdlet. +### -NetworkRegionID1 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity (NetworkRegionID) of the region that is linked to the region identified by the NetworkRegionID2 parameter. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -NetworkRegionID2 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity (NetworkRegionID) of the region that is linked to the region identified by the NetworkRegionID1 parameter. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory - -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -NetworkRegionLinkID +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +This value is the same as the Identity. +You cannot specify both an Identity and a NetworkRegionLinkID; a value entered for one will be automatically used for both. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -198,14 +214,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -219,12 +237,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionLinkType This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionLinkType. ## NOTES diff --git a/skype/skype-ps/skype/New-CsNetworkSite.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkSite.md similarity index 85% rename from skype/skype-ps/skype/New-CsNetworkSite.md rename to skype/skype-ps/SkypeForBusiness/New-CsNetworkSite.md index 160f838625..d5b9f42425 100644 --- a/skype/skype-ps/skype/New-CsNetworkSite.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkSite.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworksite applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsNetworkSite -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworksite +schema: 2.0.0 +title: New-CsNetworkSite --- # New-CsNetworkSite @@ -47,7 +48,7 @@ A CAC network site must be created for every site within an organization, even i ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsNetworkSite -Identity Vancouver -NetworkRegionID NorthAmerica ``` @@ -63,7 +64,7 @@ Unless (or until) a value is added to this site later using the Set-CsNetworkSit -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsNetworkSite -Identity Paris -NetworkRegionID EMEA -BWPolicyProfileID LowBWLimits ``` @@ -79,45 +80,10 @@ The policies associated with that profile will be used for this site. ## PARAMETERS -### -Identity - -A unique identifier for the newly created network site. -Sites are created only at the global scope, so this identifier does not need to specify a scope. -Instead, it contains a string that is unique among all network sites within the Skype for Business Server 2015 deployment. - - - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -NetworkSiteID -This value is the same as the Identity. -You cannot specify both an Identity and a NetworkSiteID; a value entered for one will be automatically used for both. - -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -BWPolicyProfileID -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -BWPolicyProfileID The Identity of the bandwidth policy profile that will define the bandwidth limitations for this site. You can retrieve a list of available profiles by calling the Get-CsNetworkBandwidthPolicyProfile cmdlet. @@ -126,8 +92,7 @@ If you specify a value for this parameter, you must also specify a value for the ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,6 +103,8 @@ Accept wildcard characters: False ### -BypassID +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A globally unique identifier (GUID). This GUID is used to map network sites to media bypass settings within a CAC or E9-1-1 network configuration. (Use this BypassID value in the call to the New-CsNetworkMediaBypassConfiguration cmdlet.) @@ -155,8 +122,7 @@ If you manually enter a value, you will receive a confirmation prompt to verify ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -166,14 +132,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A string that describes the site. This parameter can be used to provide a more descriptive explanation of what the site is for or where it is than can be expressed by the Identity alone. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,16 +150,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocationPolicy -The name of the location policy associated with this site. -The location policy assigns specific E9-1-1 settings to the site. -You can retrieve a list of location policies by calling the Get-CsLocationPolicy cmdlet. +### -EnableLocationBasedRouting + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, voice routing will be managed by taking into account the location of both the user placing the call and the user receiving the call. +The default value is False. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -200,35 +169,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkRegionID -The Identity of the network region that this site is associated with. -This parameter must contain a value if you want to provide a BypassID (either through auto-generation or manually), or if the EnableBandwidthPolicyCheck property of the network configuration is True. -You can retrieve the network configuration settings by calling the Get-CsNetworkConfiguration cmdlet. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier for the newly created network site. +Sites are created only at the global scope, so this identifier does not need to specify a scope. +Instead, it contains a string that is unique among all network sites within the Skype for Business Server 2015 deployment. + + ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -236,6 +211,8 @@ Accept wildcard characters: False ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. @@ -244,8 +221,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -254,14 +230,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -LocationPolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The name of the location policy associated with this site. +The location policy assigns specific E9-1-1 settings to the site. +You can retrieve a list of location policies by calling the Get-CsLocationPolicy cmdlet. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -270,33 +250,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -NetworkRegionID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity of the network region that this site is associated with. +This parameter must contain a value if you want to provide a BypassID (either through auto-generation or manually), or if the EnableBandwidthPolicyCheck property of the network configuration is True. +You can retrieve the network configuration settings by calling the Get-CsNetworkConfiguration cmdlet. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableLocationBasedRouting -When set to True, voice routing will be managed by taking into account the location of both the user placing the call and the user receiving the call. -The default value is False. +### -NetworkSiteID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This value is the same as the Identity. +You cannot specify both an Identity and a NetworkSiteID; a value entered for one will be automatically used for both. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -304,6 +290,9 @@ Accept wildcard characters: False ``` ### -VoiceRoutingPolicy + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Per-user voice routing policy to be assigned to the site. For example: @@ -316,8 +305,43 @@ This parameter was introduced in the February, 2013 release of Lync Server 2013. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -331,12 +355,11 @@ This cmdlet supports the common parameters:` -Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType Create an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType. ## NOTES diff --git a/skype/skype-ps/skype/New-CsNetworkSubnet.md b/skype/skype-ps/SkypeForBusiness/New-CsNetworkSubnet.md similarity index 85% rename from skype/skype-ps/skype/New-CsNetworkSubnet.md rename to skype/skype-ps/SkypeForBusiness/New-CsNetworkSubnet.md index 38d0bfaf72..5729d09d6b 100644 --- a/skype/skype-ps/skype/New-CsNetworkSubnet.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsNetworkSubnet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworksubnet applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsNetworkSubnet -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csnetworksubnet +schema: 2.0.0 +title: New-CsNetworkSubnet --- # New-CsNetworkSubnet @@ -47,7 +48,7 @@ For more details, see the Examples section for this cmdlet. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsNetworkSubnet -Identity 172.11.15.0 -MaskBits 24 -NetworkSiteID Vancouver ``` @@ -60,7 +61,7 @@ That is done by supplying a value--in this case 24--to the MaskBits parameter. Finally, the site ID Vancouver is passed to the NetworkSiteID parameter to associate this subnet with that site. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Import-CSV C:\subnet.csv | foreach {New-CsNetworkSubnet -Identity $_.Identity -MaskBits $_.Mask -NetworkSiteID $_.SiteID} @@ -97,67 +98,74 @@ This process continues until all lines in the file have been read, and their val ## PARAMETERS -### -Identity -The unique subnet ID of the subnet being created. -This must be an IP address (such as 174.11.12.0), and it must be the first address in the IP address range defined by the subnet. +### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A description of the subnet being created. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MaskBits -The bitmask to be applied to the subnet being created. +### -Force -Valid values: 1 through 32 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SubnetID -This is the same value as the Identity. -You must specify either an Identity or a SubnetID, but you cannot specify both. -Whatever value you supply to one will automatically be applied to the other. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique subnet ID of the subnet being created. +This must be an IP address (such as 174.11.12.0), and it must be the first address in the IP address range defined by the subnet. ```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: True -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -A description of the subnet being created. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -166,31 +174,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkSiteID -The site ID of the site to which this subnet belongs. -You can retrieve site IDs for your deployment by calling the Get-CsNetworkSite cmdlet. +### -MaskBits + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The bitmask to be applied to the subnet being created. + +Valid values: 1 through 32 ```yaml -Type: String +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -NetworkSiteID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The site ID of the site to which this subnet belongs. +You can retrieve site IDs for your deployment by calling the Get-CsNetworkSite cmdlet. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -199,34 +213,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory - -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -SubnetID +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +This is the same value as the Identity. +You must specify either an Identity or a SubnetID, but you cannot specify both. +Whatever value you supply to one will automatically be applied to the other. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -235,14 +251,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -256,12 +274,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.SubnetType Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.SubnetType. ## NOTES diff --git a/skype/skype-ps/skype/New-CsOAuthServer.md b/skype/skype-ps/SkypeForBusiness/New-CsOAuthServer.md similarity index 85% rename from skype/skype-ps/skype/New-CsOAuthServer.md rename to skype/skype-ps/SkypeForBusiness/New-CsOAuthServer.md index 683832a330..b7ddae2b5b 100644 --- a/skype/skype-ps/skype/New-CsOAuthServer.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsOAuthServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csoauthserver applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsOAuthServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csoauthserver +schema: 2.0.0 +title: New-CsOAuthServer --- # New-CsOAuthServer @@ -44,7 +45,7 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsOAuthServer -Identity "Office 365" -MetadataUrl "https://sts.office365.microsoft.com/metadata/json/1" @@ -56,32 +57,36 @@ The new server uses the metadata URL `https://sts.office365.microsoft.com/metada ## PARAMETERS -### -MetadataUrl -URL where the WS-FederationMetadata for the server is published. -Servers use the metadata to agree on the types of tokens that will be exchanged as well the keys that will be used to sign these tokens. -Note that the specified URL must be available when you run the New-CsOAuthServer cmdlet or else the command will fail. +### -AcceptSecurityIdentifierInformation + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True), security identifiers (SIDs) can be used for authentication purposes. +The default value is False. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -AuthorizationUriOverride + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +URI used for OAuth authorization override. +The override prevents authenticated users from being reprompted for their credentials after they have logged on. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -91,13 +96,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -107,13 +114,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Friendly (and unique) name used to identify the OAuth server. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -123,14 +132,16 @@ Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,8 +150,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -MetadataUrl + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL where the WS-FederationMetadata for the server is published. +Servers use the metadata to agree on the types of tokens that will be exchanged as well the keys that will be used to sign these tokens. +Note that the specified URL must be available when you run the New-CsOAuthServer cmdlet or else the command will fail. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Realm +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Server-to-server security container. By default, Skype for Business Server uses your default SIP domain as its OAuth realm. @@ -149,8 +182,7 @@ By default, Skype for Business Server uses your default SIP domain as its OAuth ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -161,6 +193,8 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new OAuth server is being created. For example: @@ -175,8 +209,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -185,31 +218,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Type -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Type of authentication used by the server. +For example, this syntax configures the server to use Active Directory Federation Services authentication: -### -AcceptSecurityIdentifierInformation -When set to True ($True), security identifiers (SIDs) can be used for authentication purposes. -The default value is False. +-Type "ADFS" ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -218,15 +239,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AuthorizationUriOverride -URI used for OAuth authorization override. -The override prevents authenticated users from being reprompted for their credentials after they have logged on. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -235,17 +257,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -Type of authentication used by the server. -For example, this syntax configures the server to use Active Directory Federation Services authentication: +### -WhatIf --Type "ADFS" +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -259,13 +280,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsOAuthServer cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.OAuthServer#Decorated The New-CsOAuthServer cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.OAuthServer#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsOutboundCallingNumberTranslationRule.md b/skype/skype-ps/SkypeForBusiness/New-CsOutboundCallingNumberTranslationRule.md similarity index 87% rename from skype/skype-ps/skype/New-CsOutboundCallingNumberTranslationRule.md rename to skype/skype-ps/SkypeForBusiness/New-CsOutboundCallingNumberTranslationRule.md index db567dff75..ae11cd6aea 100644 --- a/skype/skype-ps/skype/New-CsOutboundCallingNumberTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsOutboundCallingNumberTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csoutboundcallingnumbertranslationrule applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsOutboundCallingNumberTranslationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csoutboundcallingnumbertranslationrule +schema: 2.0.0 +title: New-CsOutboundCallingNumberTranslationRule --- # New-CsOutboundCallingNumberTranslationRule @@ -53,7 +54,7 @@ In the Edit Trunk Configuration dialog box scroll down to the section labeled Ca ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsOutboundCallingNumberTranslationRule -Parent "site:Redmond" -Name SevenDigit -Description "Converts a dialed number to seven digits" -Pattern '^\+1206(\d{7})$' -Translation '$1' @@ -64,7 +65,47 @@ The command shown in Example 1 creates a new outbound calling number translation ## PARAMETERS +### -Description + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to provide additional text to accompany a translation rule. +This description can be used to help administrators clearly identify the purpose of the rule. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the new translation rule. Names are composed of the scope (parent), a "/" character, and a unique name within that scope. For example, a rule named RedmondDialing created for the Redmond site would have an Identity that looked like this: @@ -76,8 +117,7 @@ If you use the Identity parameter then your command cannot contain either the Pa ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -86,7 +126,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Name + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name for the new translation rule; names must be unique for the given scope. For example: @@ -98,8 +160,7 @@ The Name parameter cannot be used in the same command as the Identity parameter. ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -109,6 +170,9 @@ Accept wildcard characters: False ``` ### -Parent + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Scope at which the new translation rule will be configured. To configure a rule at the global scope, use this syntax: @@ -128,8 +192,7 @@ The Parent parameter cannot be used in the same command as the Identity paramete ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -138,31 +201,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Pattern -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Description -Enables administrators to provide additional text to accompany a translation rule. -This description can be used to help administrators clearly identify the purpose of the rule. +A regular expression representing the number pattern to which the Translation will be applied. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -171,31 +219,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Priority -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. +Priority assigned to the rule. +If a number matches the Pattern of more than one outbound translation rule, rules are applied in priority order. +Rules are processed in order of their assigned priority; the first rule to be processed has a priority of 0; the second rule to be processed has a priority of 1; and so on. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -204,14 +239,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Pattern -A regular expression representing the number pattern to which the Translation will be applied. +### -Translation + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A regular expression that will be applied to the number matching the Pattern to prepare that number for outbound calling. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -220,32 +257,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Priority -Priority assigned to the rule. -If a number matches the Pattern of more than one outbound translation rule, rules are applied in priority order. -Rules are processed in order of their assigned priority; the first rule to be processed has a priority of 0; the second rule to be processed has a priority of 1; and so on. - -```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Translation -A regular expression that will be applied to the number matching the Pattern to prepare that number for outbound calling. +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -255,13 +276,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -275,14 +298,13 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsOutboundCallingNumberTranslationRule cmdlet does not accept pipelined data. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.CallingNumberTranslationRule#Decorated The New-CsOutboundCallingNumberTranslationRule cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.CallingNumberTranslationRule#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsOutboundTranslationRule.md b/skype/skype-ps/SkypeForBusiness/New-CsOutboundTranslationRule.md similarity index 84% rename from skype/skype-ps/skype/New-CsOutboundTranslationRule.md rename to skype/skype-ps/SkypeForBusiness/New-CsOutboundTranslationRule.md index 73e18b5b4f..2acb8309e2 100644 --- a/skype/skype-ps/skype/New-CsOutboundTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsOutboundTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csoutboundtranslationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsOutboundTranslationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csoutboundtranslationrule +schema: 2.0.0 +title: New-CsOutboundTranslationRule --- # New-CsOutboundTranslationRule @@ -51,7 +52,7 @@ If you call the New-CsOutboundTranslationRule cmdlet and specify a scope at whic ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsOutboundTranslationRule -Identity "site:Redmond/Prefix Redmond" @@ -62,7 +63,7 @@ Because no other parameters are specified, the rule is created with the default Notice that the value passed to the Identity parameter is in double-quotes; this is because the name of the rule (Prefix Redmond) contains a space. If the rule name does not contain a space you don't need to enclose the Identity in double quotes. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsOutboundTranslationRule -Parent global -Name SeattleSevenDigit -Description "Convert to seven digits" -Pattern '^\+1425(\d{7})$' -Translation '$1' @@ -77,8 +78,47 @@ For example, the number +14255551212 would be translated to the number 5551212. ## PARAMETERS +### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A description of the outbound translation rule. +This description will help identify the purpose of the rule. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier for the outbound translation rule. The Identity includes the scope at which the rule is applied and the name of the rule, and must be at the global, site, or service (PSTNGateway only) scope. For example, site:Redmond/OutboundRule1 and PstnGateway:Redmond.litwareinc.com/OutboundRule2. @@ -90,8 +130,7 @@ If the Identity parameter is specified, you cannot specify values for the Name o ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -100,19 +139,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Parent -The scope of the outbound translation rule. -If a value is specified for this parameter, a value must also be specified for the Name parameter. -However, the Identity parameter cannot be specified. -If the Parent and Name parameters aren't specified, the Identity must be. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + ```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -120,6 +161,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name of the outbound translation rule. If no Name is supplied, an Identity consisting of a scope and name must be specified. If a Name is supplied, the Parent parameter is also required, but an Identity cannot be specified. @@ -127,8 +171,7 @@ If a Name is supplied, the Parent parameter is also required, but an Identity ca ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -137,17 +180,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -A description of the outbound translation rule. -This description will help identify the purpose of the rule. +### -Parent + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The scope of the outbound translation rule. +If a value is specified for this parameter, a value must also be specified for the Name parameter. +However, the Identity parameter cannot be specified. +If the Parent and Name parameters aren't specified, the Identity must be. ```yaml Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -155,6 +202,9 @@ Accept wildcard characters: False ``` ### -Pattern + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A regular expression representing the number pattern to which the Translation will be applied. Default: ^\+(\d*)$ @@ -162,8 +212,7 @@ Default: ^\+(\d*)$ ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -173,14 +222,16 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If a number matches the Pattern of more than one outbound translation rule, rules are applied in priority order. Use this parameter to assign a priority to the rule. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -190,6 +241,9 @@ Accept wildcard characters: False ``` ### -Translation + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A regular expression that will be applied to the number matching the Pattern to prepare that number for outbound routing. Default: $1 @@ -197,8 +251,7 @@ Default: $1 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -207,34 +260,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -InMemory - -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -244,29 +279,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -280,12 +301,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TranslationRule This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TranslationRule. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPartnerApplication.md b/skype/skype-ps/SkypeForBusiness/New-CsPartnerApplication.md similarity index 84% rename from skype/skype-ps/skype/New-CsPartnerApplication.md rename to skype/skype-ps/SkypeForBusiness/New-CsPartnerApplication.md index 60a75d1f84..b4e88264ae 100644 --- a/skype/skype-ps/skype/New-CsPartnerApplication.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPartnerApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cspartnerapplication applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsPartnerApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cspartnerapplication +schema: 2.0.0 +title: New-CsPartnerApplication --- # New-CsPartnerApplication @@ -70,7 +71,7 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsPartnerApplication -Identity "MicrosoftExchange" -ApplicationTrustLevel "Full" -MetadataUrl "https://autodiscover.litwareinc.com/metadata/json/1" @@ -80,7 +81,7 @@ The command shown in Example 1 creates a new partner application with the Identi In this example, the new partner application uses the metadata URL `https://autodiscover.litwareinc.com/metadata/json/1`. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsPartnerApplication -Identity "MicrosoftExchange" -ApplicationIdentifier "microsoft.exchange" -ApplicationTrustLevel "Full" -UseOAuthServer @@ -93,8 +94,29 @@ To do this, the command uses the UseOAuthServer parameter instead of the Metadat ## PARAMETERS +### -AcceptSecurityIdentifierInformation + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True), security identifiers (SIDs) can be used for authentication purposes. +The default value is False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ApplicationIdentifier +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the partner application. The ApplicationIdentifier is provided by the server application. You cannot use the ApplicationIdentifier parameter and the MetadataUrl parameter in the same command. @@ -104,8 +126,7 @@ You cannot use the ApplicationIdentifier parameter and the MetadataUrl parameter ```yaml Type: String Parameter Sets: UseOAuthServer, CertificateFileData, CertificateRawData -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -116,6 +137,8 @@ Accept wildcard characters: False ### -ApplicationTrustLevel +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the level of trust between Skype for Business Server and the partner application. Allowed values are: @@ -130,8 +153,7 @@ The default value is Full. ```yaml Type: ApplicationTrustLevel Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -141,6 +163,9 @@ Accept wildcard characters: False ``` ### -CertificateFileData + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Path to a certificate file that can be assigned to the partner application. For example: @@ -149,8 +174,7 @@ For example: ```yaml Type: String Parameter Sets: CertificateFileData -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -160,6 +184,9 @@ Accept wildcard characters: False ``` ### -CertificateRawData + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Certificate (in Base64 encoded format) that can be assigned to the partner application. To read raw data from a certificate and then convert that data to the required format, use commands similar to these: @@ -174,8 +201,7 @@ You can then use this syntax to assign the certificate data stored in the variab ```yaml Type: String Parameter Sets: CertificateRawData -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -184,81 +210,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MetadataUrl -URL where the WS-FederationMetadata for the partner application is published. -Partner applications use the metadata to agree on the types of tokens that will be exchanged as well the keys that will be used to sign these tokens. - -```yaml -Type: String -Parameter Sets: MetadataUrl -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UseOAuthServer -When present, indicates that the partner application will use one of the pre-authorized OAuth servers instead of a security token server built into the application itself. - -```yaml -Type: SwitchParameter -Parameter Sets: UseOAuthServer -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AcceptSecurityIdentifierInformation -When set to True ($True), security identifiers (SIDs) can be used for authentication purposes. -The default value is False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Enabled -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Enabled When set to True the partner application will be enabled and available for immediate use. The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -268,13 +230,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -284,13 +248,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the new partner application. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -300,14 +266,16 @@ Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -316,33 +284,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Realm - -Server-to-server security container. -By default, Skype for Business Server uses your default SIP domain as its OAuth realm. +### -MetadataUrl +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +URL where the WS-FederationMetadata for the partner application is published. +Partner applications use the metadata to agree on the types of tokens that will be exchanged as well the keys that will be used to sign these tokens. ```yaml Type: String -Parameter Sets: UseOAuthServer -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: MetadataUrl +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Realm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Server-to-server security container. +By default, Skype for Business Server uses your default SIP domain as its OAuth realm. + ```yaml Type: String -Parameter Sets: CertificateFileData, CertificateRawData -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: UseOAuthServer, CertificateFileData, CertificateRawData +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -351,6 +324,8 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new partner application is being created. For example: @@ -360,13 +335,46 @@ You can return the tenant ID for each of your tenants by running this command: `Get-CsTenant | Select-Object DisplayName, TenantID` +```yaml +Type: Guid +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UseOAuthServer + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, indicates that the partner application will use one of the pre-authorized OAuth servers instead of a security token server built into the application itself. ```yaml -Type: Guid +Type: SwitchParameter +Parameter Sets: UseOAuthServer +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -376,13 +384,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -396,13 +406,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPartnerApplication cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.PartnerApplication#Decorated The New-CsPartnerApplication cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.PartnerApplication#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPersistentChatAddin.md b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatAddin.md similarity index 92% rename from skype/skype-ps/skype/New-CsPersistentChatAddin.md rename to skype/skype-ps/SkypeForBusiness/New-CsPersistentChatAddin.md index 6b554367cb..e1a61e3991 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatAddin.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatAddin.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchataddin applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsPersistentChatAddin -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchataddin +schema: 2.0.0 +title: New-CsPersistentChatAddin --- # New-CsPersistentChatAddin @@ -40,7 +41,7 @@ Skype for Business Server Control Panel: To create a new Persistent Chat add-in ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsPersistentChatAddin -Name "ITPersistentChatAddin" -PersistentChatPoolFqdn "atl-cs-001.litwareinc.com" -Url "https://atl-cs-001.litwareinc.com/itchat" @@ -54,14 +55,15 @@ The URL parameter and the parameter value `https://atl-cs-001.litwareinc.com/itc ### -Name +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Friendly name to be given to the Persistent Chat add-in. Names must be unique per Persistent Chat Server pool. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: Named @@ -70,34 +72,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Url +### -PersistentChatPoolFqdn -URL of the webpage to be displayed by the Persistent Chat add-in. +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Fully qualified domain name of the Persistent Chat Server pool. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PersistentChatPoolFqdn +### -Url -Fully qualified domain name of the Persistent Chat Server pool. +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +URL of the webpage to be displayed by the Persistent Chat add-in. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -109,14 +113,13 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPersistentChatAddin cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.PersistentChat.Cmdlets.AddinObject The New-CsPersistentChatAddin cmdlet creates new instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.AddinObject object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPersistentChatCategory.md b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatCategory.md similarity index 91% rename from skype/skype-ps/skype/New-CsPersistentChatCategory.md rename to skype/skype-ps/SkypeForBusiness/New-CsPersistentChatCategory.md index 807ee1f92c..f7c5017c01 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatCategory.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatCategory.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchatcategory applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsPersistentChatCategory -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchatcategory +schema: 2.0.0 +title: New-CsPersistentChatCategory --- # New-CsPersistentChatCategory @@ -46,7 +47,7 @@ Skype for Business Server Control Panel: To create a new Persistent Chat categor ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsPersistentChatCategory -Name "HelpDesk" -PersistentChatPoolFqdn "atl-cs-001.litwareinc.com" -EnableFileUpload @@ -58,32 +59,17 @@ In this example, file upload is enabled (by including the parameter EnableFileUp ## PARAMETERS -### -Name -Name given to the Persistent Chat category. -Names must be unique per Persistent Chat pool. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -Description -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -Description Additional text accompanying the Persistent Chat category. For example, the Description might explain the purpose of the category and what type of rooms you can expect to find within the category. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -93,13 +79,15 @@ Accept wildcard characters: False ``` ### -EnableFileUpload + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When present, allows file uploads to the chat rooms in the category. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -109,14 +97,16 @@ Accept wildcard characters: False ``` ### -EnableInvitations + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When this parameter is included, Invitations will be enabled for the category. Among other things, this means that users on the AllowedMembers list will automatically receive an invitation to join a new chat room at the time that new room is created. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -125,14 +115,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Name + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Name given to the Persistent Chat category. +Names must be unique per Persistent Chat pool. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PersistentChatPoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Fully qualified domain name of the Persistent Chat pool where the category should be created. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -142,14 +153,16 @@ Accept wildcard characters: False ``` ### -RemoveChatHistory + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When this parameter is included, the chat history feature will be disabled for the new category. Typically, chat history is only disabled for chat rooms that are used for announcements that are posted once and then never need to be referred to again. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -163,13 +176,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPersistentChatCategory cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.PersistentChat.Cmdlets.CategoryObject The New-CsPersistentChatCategory cmdlet creates new instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.CategoryObject object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPersistentChatComplianceConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatComplianceConfiguration.md similarity index 89% rename from skype/skype-ps/skype/New-CsPersistentChatComplianceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsPersistentChatComplianceConfiguration.md index 98ea85b68d..ec29ab1949 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatComplianceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatComplianceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchatcomplianceconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsPersistentChatComplianceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchatcomplianceconfiguration +schema: 2.0.0 +title: New-CsPersistentChatComplianceConfiguration --- # New-CsPersistentChatComplianceConfiguration @@ -43,7 +44,7 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsPersistentChatComplianceConfiguration -Identity "site:Redmond" -AddUserDetails $True -AddChatRoomDetails $True @@ -53,7 +54,7 @@ The command shown in Example 1 creates a new collection of Persistent Chat compl In this example, both the AddUserDetails and the AddChatRoomDetails properties are set to True ($True). -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsPersistentChatComplianceConfiguration -Identity "site:Redmond" -RunInterval "00:30:00" @@ -65,39 +66,17 @@ In this example, the RunInterval property is set to 30 minutes; that is, 00 hour ## PARAMETERS -### -Identity -Unique identifier for the new Persistent Chat compliance settings being created. -New compliance settings can be created at either the site or the service scope (for the Persistent Chat Server service, only). -To create new settings at the site scope, use syntax similar to this: - -`-Identity "site:Redmond"` - -To create new settings at the service scope, use syntax like this: +### -AdapterName -`-Identity "service:PersistentChatServer:atl-gc-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AdapterName Name of the Persistent Chat adapters used by the compliance settings. Adapters are third-party products that convert the data in the compliance database to a specific format. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -107,14 +86,16 @@ Accept wildcard characters: False ``` ### -AdapterOutputDirectory + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Full path to the folder where adapter data is stored. You must have a separate folder for each adapter. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -125,6 +106,8 @@ Accept wildcard characters: False ### -AdapterType +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Specifies the fully qualified name of a .Net managed type that implements the Microsoft.Rtc.Internal.Chat.Server.Compliance.IComplianceAdapter interface. This adapter is supplied by a third-party or can be set to the internal XML adapter, "Microsoft.Rtc.Internal.Chat.Server.Compliance.XmlAdapter,compliance". @@ -133,8 +116,7 @@ If you do not specify an adapter type Persistent Chat will not save compliance d ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -145,6 +127,8 @@ Accept wildcard characters: False ### -AddChatRoomDetails +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When set to True, additional details about each chat room are provided to the adapter. This has the potential to greatly increase the size of the compliance data. @@ -153,8 +137,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -165,6 +148,8 @@ Accept wildcard characters: False ### -AddUserDetails +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When set to True, additional details about each chat room user are provided to the adapter. This has the potential to greatly increase the size of the compliance data. @@ -173,24 +158,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -201,14 +169,15 @@ Accept wildcard characters: False ### -CreateFileAttachmentsManifest +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When set to True, additional output files will be created to track file transfers within chat rooms. These files will have the file extension .ATTACH and are placed in the location specified by the AdapterOutputDirectory. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -219,13 +188,14 @@ Accept wildcard characters: False ### -CustomConfiguration +> Applicable: Lync Server 2013, Skype for Business Server 2015 + XSLT transform script that enables Persistent Chat to save compliance data in a custom format of your design. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -235,13 +205,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -250,15 +222,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Unique identifier for the new Persistent Chat compliance settings being created. +New compliance settings can be created at either the site or the service scope (for the Persistent Chat Server service, only). +To create new settings at the site scope, use syntax similar to this: + +`-Identity "site:Redmond"` + +To create new settings at the service scope, use syntax like this: + +`-Identity "service:PersistentChatServer:atl-gc-001.litwareinc.com"` + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -268,14 +268,16 @@ Accept wildcard characters: False ``` ### -OneChatRoomPerOutputFile + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When set to True, separate reports are created for each chat room. The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -285,6 +287,9 @@ Accept wildcard characters: False ``` ### -RunInterval + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Amount of time that the server waits before generating the next output file. The RunInterval must be specified using the format days.hours:minutes:seconds. For example, to specify a RunInterval of 30 minutes (the default value) use this syntax: @@ -297,8 +302,25 @@ The default value is 15 minutes (00:15:00). ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -308,13 +330,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -328,13 +352,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPersistentChatComplianceConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatComplianceConfiguration The New-CsPersistentChatComplianceConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatComplianceConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPersistentChatConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatConfiguration.md similarity index 89% rename from skype/skype-ps/skype/New-CsPersistentChatConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsPersistentChatConfiguration.md index ede3df5de1..2d97d2805e 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchatconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsPersistentChatConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchatconfiguration +schema: 2.0.0 +title: New-CsPersistentChatConfiguration --- # New-CsPersistentChatConfiguration @@ -40,7 +41,7 @@ Skype for Business Server Control Panel: To create a new collection of Persisten ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsPersistentChatConfiguration -Identity "site:Redmond" -ParticipantUpdateLimit 100 @@ -51,38 +52,38 @@ In this example, the ParticipantUpdateLimit property is set to 100. ## PARAMETERS -### -Identity -Unique identifier for the new Persistent Chat configuration settings being created. -New configuration settings can be created at either the site or the service scope (for the Persistent Chat Server service, only). -To create new settings at the site scope, use syntax similar to this: +### -DefaultChatHistory -`-Identity "site:Redmond"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -To create new settings at the service scope, use syntax like this: +Default number of chat messages instantly available in a chat room. +Note that this value represents only the number of messages immediately available; it does not place a limit on the total amount of messages that can be retrieved. -`-Identity "service:PersistentChatServer:atl-gc-001.litwarein.com"` +DefaultChatHistory can be set to any value between 1 and 500, inclusive. +The default value is 30. ```yaml -Type: XdsIdentity +Type: Int16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -91,51 +92,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DefaultChatHistory -Default number of chat messages instantly available in a chat room. -Note that this value represents only the number of messages immediately available; it does not place a limit on the total amount of messages that can be retrieved. +### -Identity -DefaultChatHistory can be set to any value between 1 and 500, inclusive. -The default value is 30. +> Applicable: Lync Server 2013, Skype for Business Server 2015 -```yaml -Type: Int16 -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Unique identifier for the new Persistent Chat configuration settings being created. +New configuration settings can be created at either the site or the service scope (for the Persistent Chat Server service, only). +To create new settings at the site scope, use syntax similar to this: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +`-Identity "site:Redmond"` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +To create new settings at the service scope, use syntax like this: + +`-Identity "service:PersistentChatServer:atl-gc-001.litwarein.com"` ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -145,14 +138,16 @@ Accept wildcard characters: False ``` ### -MaxFileSizeKB + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Maximum size of a file (in kilobytes) that can be uploaded or downloaded by the web service. The default value is 20000 KB. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -162,14 +157,16 @@ Accept wildcard characters: False ``` ### -ParticipantUpdateLimit + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Maximum number of users who can participate in a chat room before the active participant list updates are disabled. The default value is 75. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -179,13 +176,33 @@ Accept wildcard characters: False ``` ### -RoomManagementUrl + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + URL for the Web page that administrators can use to manage individual chat rooms. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -195,13 +212,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -215,13 +234,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPersistentChatConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatConfiguration The New-CsPersistentChatConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPersistentChatEndpoint.md b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatEndpoint.md similarity index 90% rename from skype/skype-ps/skype/New-CsPersistentChatEndpoint.md rename to skype/skype-ps/SkypeForBusiness/New-CsPersistentChatEndpoint.md index ea7227eca8..b612890b7c 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatEndpoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchatendpoint applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsPersistentChatEndpoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchatendpoint +schema: 2.0.0 +title: New-CsPersistentChatEndpoint --- # New-CsPersistentChatEndpoint @@ -42,7 +43,7 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsPersistentChatEndpoint -SipAddress "sip:pce@litwareinc.com" -PersistentChatPoolFqdn "atl-pcpool-001.litwareinc.com" -DisplayName "Persistent Chat Endpoint 1" ``` @@ -54,88 +55,97 @@ This new endpoint has the SIP address "sip:pce@litwareinc.com" and the display n ## PARAMETERS -### -PersistentChatPoolFqdn -Fully qualified domain name of the Persistent Chat pool that the new endpoint will be associated with. -For example: +### -DisplayName -`-PersistentChatPoolFqdn "atl-pc-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Active Directory display name for the new contact object. ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SipAddress - -Unique identifier that allows the endpoint to communicate with SIP devices such as Skype for Business. -The SIP address must use the sip: prefix as well as a valid SIP domain; for example: - -`-SipAddress "sip:pcEndpoint1@litwareinc.com"` +### -PassThru +> Applicable: Lync Server 2013, Skype for Business Server 2015 +Enables you to pass a contact object through the pipeline that represents the new Persistent Chat endpoint. +By default, the New-CsPersistentChatEndpoint cmdlet does not pass objects through the pipeline. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -PersistentChatPoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Fully qualified domain name of the Persistent Chat pool that the new endpoint will be associated with. +For example: + +`-PersistentChatPoolFqdn "atl-pc-001.litwareinc.com"` ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayName -Active Directory display name for the new contact object. +### -SipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Unique identifier that allows the endpoint to communicate with SIP devices such as Skype for Business. +The SIP address must use the sip: prefix as well as a valid SIP domain; for example: + +`-SipAddress "sip:pcEndpoint1@litwareinc.com"` + + ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a contact object through the pipeline that represents the new Persistent Chat endpoint. -By default, the New-CsPersistentChatEndpoint cmdlet does not pass objects through the pipeline. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: cf Required: False Position: Named @@ -145,13 +155,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -165,13 +177,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPersistentChatEndpoint cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSPersistentChatContact The New-CsPersistentChatEndpoint cmdlet creates new instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSPersistentChatContact class. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPersistentChatPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatPolicy.md similarity index 91% rename from skype/skype-ps/skype/New-CsPersistentChatPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsPersistentChatPolicy.md index 24a866881d..0376bb141b 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchatpolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsPersistentChatPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchatpolicy +schema: 2.0.0 +title: New-CsPersistentChatPolicy --- # New-CsPersistentChatPolicy @@ -44,7 +45,7 @@ Skype for Business Server Control Panel: To create a new Persistent Chat policy ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsPersistentChatPolicy -Identity "RedmondPersistentChatPolicy" -EnablePersistentChat $True @@ -54,7 +55,7 @@ The command shown in Example 1 creates a new per-user Persistent Chat policy wit In this example, Persistent Chat is enabled by using the parameter EnablePersistentChat and the parameter value $True. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsPersistentChatPolicy -Identity "site:Redmond" -EnablePersistentChat $True @@ -66,46 +67,36 @@ That's done by setting the Identity to the string value "site:" followed by the ## PARAMETERS -### -Identity - -Unique identifier to be assigned to the policy. -New Persistent Chat policies can be created at the site scope or the per-user scope. -To create a new site policy, use the prefix "site:" and the name of the site as your Identity. -For example, use this syntax to create a new policy for the Redmond site: - -`-Identity site:Redmond` - -To create a new per-user policy, use an Identity similar to this: - -`-Identity SalesPersistentChatPolicy` - -Note that you cannot create a new global policy; if you want to make changes to the global policy, use the Set-CsPersistentChatPolicy cmdlet instead. -Likewise, you cannot create a new site or per-user policy if a policy with that Identity already exists. -If you need to make changes to an existing policy, use the Set-CsPersistentChatPolicy cmdlet. +### -Description +> Applicable: Lync Server 2013, Skype for Business Server 2015 +Enables administrators to provide explanatory text to accompany the policy. +For example, the Description might include information about the users the policy should be assigned to. ```yaml -Type: XdsIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -EnablePersistentChat + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +When set to True, users affected by the policy will be allowed to use Persistent Chat. +When set to False (the default value) users affected by the policy will not be allowed to use Persistent Chat. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -114,15 +105,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide explanatory text to accompany the policy. -For example, the Description might include information about the users the policy should be assigned to. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -131,31 +123,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnablePersistentChat -When set to True, users affected by the policy will be allowed to use Persistent Chat. -When set to False (the default value) users affected by the policy will not be allowed to use Persistent Chat. +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Unique identifier to be assigned to the policy. +New Persistent Chat policies can be created at the site scope or the per-user scope. +To create a new site policy, use the prefix "site:" and the name of the site as your Identity. +For example, use this syntax to create a new policy for the Redmond site: + +`-Identity site:Redmond` + +To create a new per-user policy, use an Identity similar to this: + +`-Identity SalesPersistentChatPolicy` + +Note that you cannot create a new global policy; if you want to make changes to the global policy, use the Set-CsPersistentChatPolicy cmdlet instead. +Likewise, you cannot create a new site or per-user policy if a policy with that Identity already exists. +If you need to make changes to an existing policy, use the Set-CsPersistentChatPolicy cmdlet. + + ```yaml -Type: Boolean +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -164,15 +175,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. +### -Tenant + +> Applicable: Skype for Business Server 2015 + +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new Persistent Chat policy is being created. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -181,14 +200,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: cf Required: False Position: Named @@ -197,21 +218,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new Persistent Chat policy is being created. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2013, Skype for Business Server 2015 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015 +Aliases: wi Required: False Position: Named @@ -225,13 +241,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPersistentChatPolicy cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.PersistentChat.PersistentChatPolicy The New-CsPersistentChatPolicy cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Policy.PersistentChat.PersistentChatPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPersistentChatRoom.md b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatRoom.md similarity index 90% rename from skype/skype-ps/skype/New-CsPersistentChatRoom.md rename to skype/skype-ps/SkypeForBusiness/New-CsPersistentChatRoom.md index b387851687..510a6fdebc 100644 --- a/skype/skype-ps/skype/New-CsPersistentChatRoom.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPersistentChatRoom.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchatroom applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsPersistentChatRoom -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cspersistentchatroom +schema: 2.0.0 +title: New-CsPersistentChatRoom --- # New-CsPersistentChatRoom @@ -47,7 +48,7 @@ Skype for Business Server Control Panel: To create a new Persistent Chat chat ro ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsPersistentChatRoom -Name "ITChatRoom" -PersistentChatPoolFqdn "atl-cs-001.litwareinc.com" -Category "IT" @@ -59,56 +60,43 @@ In this example, the chat room is added to the IT category. ## PARAMETERS -### -Category -Category under which the room is to be created; for example: +### -Addin -`-Category "IT"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -Note that the specified category must already exist or the command will fail. -Categories, which are collections of Persistent Chat chat rooms, can be created by using the New-CsPersistentChatCategory cmdlet. +Name of the Persistent Chat add-in, if any, associated with the chat room. +A Persistent Chat add-in is a customized web page that can be embedded within a Persistent Chat client. +Add-ins can be created by using the New-CsPersistentChatAddin cmdlet. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -Name of the new Persistent Chat chat room. -Names must be unique per Persistent Chat pool. +### -Category -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +> Applicable: Lync Server 2013, Skype for Business Server 2015 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Category under which the room is to be created; for example: -### -Addin -Name of the Persistent Chat add-in, if any, associated with the chat room. -A Persistent Chat add-in is a customized web page that can be embedded within a Persistent Chat client. -Add-ins can be created by using the New-CsPersistentChatAddin cmdlet. +`-Category "IT"` + +Note that the specified category must already exist or the command will fail. +Categories, which are collections of Persistent Chat chat rooms, can be created by using the New-CsPersistentChatCategory cmdlet. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -116,13 +104,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables administrators to provide additional information about the new chat room ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -132,14 +122,16 @@ Accept wildcard characters: False ``` ### -Disabled + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When present, the new chat room will be disabled and unavailable for use when it is first created. If this parameter is not used then the new chat room will be enabled and available for immediate use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -149,14 +141,16 @@ Accept wildcard characters: False ``` ### -Invitations + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Specifies whether or not Invitations for the new chat room will be inherited from the category. Among other things, this means that users on the AllowedMembers list will automatically receive an invitation to join a new chat room at the time that new room is created. ```yaml Type: ChatRoomInvitations Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -165,7 +159,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Name + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Name of the new Persistent Chat chat room. +Names must be unique per Persistent Chat pool. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -PersistentChatPoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Fully qualified domain name of the Persistent Chat pool where the new chat room will be located. For example: @@ -174,8 +190,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -185,6 +200,9 @@ Accept wildcard characters: False ``` ### -Privacy + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Privacy settings for the new chat room. Allowed values are: @@ -195,8 +213,7 @@ Allowed values are: ```yaml Type: ChatRoomPrivacy Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -206,6 +223,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Specifies whether the new chat room should be configured as a Normal chat room (where all members can post messages) or an Auditorium (where only presenters can post messages). For example: @@ -216,8 +236,7 @@ The default value is Normal. ```yaml Type: ChatRoomType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -231,13 +250,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPersistentChatRoom cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.PersistentChat.Cmdlets.ChatRoomObject The New-CsPersistentChatRoom cmdlet creates new instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.ChatRoomObject object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPinPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsPinPolicy.md similarity index 89% rename from skype/skype-ps/skype/New-CsPinPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsPinPolicy.md index 36afdd1b3c..c9309c51ab 100644 --- a/skype/skype-ps/skype/New-CsPinPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPinPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cspinpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsPinPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cspinpolicy +schema: 2.0.0 +title: New-CsPinPolicy --- # New-CsPinPolicy @@ -43,7 +44,7 @@ However, you cannot create a second global PIN policy; all you can do is modify ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsPinPolicy -Identity "site:Redmond" -MinPasswordLength 10 @@ -54,7 +55,7 @@ This command includes just one optional parameter, MinPasswordLength, which is u All the remaining policy properties will be configured using the default values. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsPinPolicy -Identity "site:Redmond" -MinPasswordLength 10 -PINHistoryCount 10 -PINLifetime 30 @@ -64,7 +65,7 @@ The command shown in Example 2 creates a new policy with the Identity site:Redmo This command uses the parameters MinPasswordLength, PINHistoryCount, and PINLifetime to explicitly configure three different property values for the new policy. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` $x = New-CsPinPolicy -Identity "site:Redmond" -InMemory @@ -87,7 +88,7 @@ After all the properties have been configured, the Set-CsPinPolicy cmdlet is use After the Set-CsPinPolicy cmdlet has been called, you will be able to view the policy and its property values by using the Get-CsPinPolicy cmdlet. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` $x = Get-CsPinPolicy -Identity "site:Redmond" @@ -106,8 +107,70 @@ The net result is that the value of the MinPasswordLength property will be copie ## PARAMETERS +### -AllowCommonPatterns + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not "common patterns" are allowed in PINs. +Common patterns include repeating digits (222222); four or more consecutive digits (123456); and PINs that match a user's phone number or extension number. +If set to True common patterns (such as the PIN 456789, which includes consecutive digits) are allowed; if set to False common patterns are not allowed. +The default value is False. + + + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to provide explanatory text to accompany a PIN policy. +For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the unique Identity to be assigned to the policy. PIN policies can be created at the site or per-user scope. To create a policy at the site scope, use syntax similar to this: @@ -123,8 +186,7 @@ To create a policy at the per-user scope, use syntax similar to this: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -133,15 +195,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide explanatory text to accompany a PIN policy. -For example, the Description might include information about the users the policy should be assigned to. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -152,6 +218,8 @@ Accept wildcard characters: False ### -MaximumLogonAttempts +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the number of sequential logon failures that are allowed before a user's PIN is automatically locked. Logon failures are counted in two different ways: local logon failures and global logon failures. When a user first tries to logon, a new 30 minute observation window starts; each failed logon during that 30 minute window is recorded as both a local logon failure and a global logon failure. @@ -180,8 +248,7 @@ This typically provides the most security. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -191,6 +258,9 @@ Accept wildcard characters: False ``` ### -MinPasswordLength + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The minimum allowed length (that is, the minimum number of digits) in a PIN. For example, if MinPasswordLength is set to 8 then a PIN of 1259 will be rejected because that PIN only has 4 digits. PIN lengths must have at least 4 digits but no more than 24 digits; the default value is 5. @@ -198,8 +268,7 @@ PIN lengths must have at least 4 digits but no more than 24 digits; the default ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -209,6 +278,9 @@ Accept wildcard characters: False ``` ### -PINHistoryCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates how often users are allowed to reuse the same PIN. For example, if the PINHistoryCount is set to 3, then the first three times a user resets his or her PIN they must use a new PIN; on the fourth reset, they can reuse their first PIN. (And, on the fifth reset, they can reuse their second PIN, and so on.) The PIN history count can be any whole number between 0 and 20, inclusive; 0 means that users can use the same PIN number over and over again. @@ -220,8 +292,7 @@ For example, you cannot set PINLifetime to 30 and leave PINHistoryCount at 0. ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -231,6 +302,9 @@ Accept wildcard characters: False ``` ### -PINLifetime + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the length of time (in days) that a PIN remains valid; after the PIN lifetime expires users must select a new PIN number before they will be allowed to use PIN authentication to gain access to the system. PINLifetime can be set to any whole number between 0 and 999, inclusive; 0 indicates that PIN numbers never expire. By default, the PIN lifetime is set to 0 days. @@ -240,8 +314,7 @@ If you set the PINLifetime to a value greater than 0 then you must also set the ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -250,34 +323,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Tenant -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -InMemory +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new PIN policy is being created. +For example: -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +Get-CsTenant | Select-Object DisplayName, TenantID ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -286,52 +348,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowCommonPatterns - -Indicates whether or not "common patterns" are allowed in PINs. -Common patterns include repeating digits (222222); four or more consecutive digits (123456); and PINs that match a user's phone number or extension number. -If set to True common patterns (such as the PIN 456789, which includes consecutive digits) are allowed; if set to False common patterns are not allowed. -The default value is False. - - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -340,21 +366,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new PIN policy is being created. -For example: +### -WhatIf -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: - -Get-CsTenant | Select-Object DisplayName, TenantID +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -368,13 +389,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPinPolicy cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.UserPin.UserPolicy Creates a new instance of the Microsoft.Rtc.Management.WritableConfig.Policy.UserPin.UserPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPlatformServiceSettings.md b/skype/skype-ps/SkypeForBusiness/New-CsPlatformServiceSettings.md similarity index 85% rename from skype/skype-ps/skype/New-CsPlatformServiceSettings.md rename to skype/skype-ps/SkypeForBusiness/New-CsPlatformServiceSettings.md index a469445901..23511ac752 100644 --- a/skype/skype-ps/skype/New-CsPlatformServiceSettings.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPlatformServiceSettings.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csplatformservicesettings applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsPlatformServiceSettings -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csplatformservicesettings +schema: 2.0.0 +title: New-CsPlatformServiceSettings --- # New-CsPlatformServiceSettings @@ -32,7 +33,7 @@ The `New-CsPlatformServiceSettings` cmdlet gives you the ability to create a new ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` PS C:\> New-CsPlatformServiceSettings -Identity NewPSS -EnableDelegateManagement $True -EnableExternalAccessCheck $True ``` @@ -41,30 +42,16 @@ This example creates a new Platform Service Settings configuration and enables d ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableCORS -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableCORS This parameter is reserved for Microsoft internal use only. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -74,13 +61,15 @@ Accept wildcard characters: False ``` ### -EnableDelegateManagement + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables the ability to manage delegates from the Skype for Business on Mac client. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -90,13 +79,15 @@ Accept wildcard characters: False ``` ### -EnableE911 + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Allows Skype for Business on Mac users to call 911. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -106,13 +97,15 @@ Accept wildcard characters: False ``` ### -EnableExternalAccessCheck + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to use external access policies to block external access to Skype for Business on Mac users. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -122,13 +115,15 @@ Accept wildcard characters: False ``` ### -EnableFileTransfer + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables Skype for Business on Mac users send files in peer-to-peer chats. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -138,13 +133,15 @@ Accept wildcard characters: False ``` ### -EnablePushNotifications + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables Skype for Business on Mac clients to use push notifications. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -154,13 +151,15 @@ Accept wildcard characters: False ``` ### -EnableUcwaScopeCheck + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for Microsoft internal use only. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -170,13 +169,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses any confirmation prompts that would otherwise be displayed before testing. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -186,6 +187,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the Platform Service Settings to be created. To create a new collection of settings at the site scope, use syntax similar to this: @@ -196,7 +200,7 @@ To create new settings at the service scope, use syntax like this: `-Identity service:WebServer:atl-cs-001.litwareinc.com` -Privacy settings can only be created for the WebServer service. +Privacy settings can only be created for the WebServer service. An error will occur if you try to apply these settings to any other service. Note that your command will fail if Platform Service Settings already exist for the specified site or service. @@ -206,7 +210,6 @@ Likewise, your command will fail if you attempt to create a new collection of gl Type: XdsIdentity Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 1 @@ -216,6 +219,9 @@ Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-CsPlatformServiceSettings. @@ -223,7 +229,6 @@ If you assign the output of this cmdlet called with this parameter to a variable Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -233,13 +238,15 @@ Accept wildcard characters: False ``` ### -MaxRegistrationsPerPublicApplication + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for Microsoft internal use only. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -249,13 +256,33 @@ Accept wildcard characters: False ``` ### -UseLegacyPushNotifications + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for Microsoft internal use only. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -265,6 +292,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -272,7 +302,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/New-CsPresencePolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsPresencePolicy.md similarity index 89% rename from skype/skype-ps/skype/New-CsPresencePolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsPresencePolicy.md index 3fbe18e8f8..198bd818ca 100644 --- a/skype/skype-ps/skype/New-CsPresencePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPresencePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cspresencepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsPresencePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cspresencepolicy +schema: 2.0.0 +title: New-CsPresencePolicy --- # New-CsPresencePolicy @@ -55,7 +56,7 @@ Note that you cannot create a new presence policy at the global scope, nor can y ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsPresencePolicy -Identity "RedmondPresencePolicy" -MaxPromptedSubscriber 400 -MaxCategorySubscription 500 @@ -65,7 +66,7 @@ The command shown in Example 1 creates a new per-user presence policy with the I In this example, the value of the MaxPromptedSubscriber property is set to 400 and the value of the MaxCategorySubscription property is set to 500. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsPresencePolicy -Identity "RedmondPresencePolicy" -InMemory @@ -88,46 +89,37 @@ This final step is crucial: if you do not call the Set-CsPresencePolicy cmdlet t ## PARAMETERS -### -Identity - -Unique identifier for the new presence policy. -To create a new per-user policy, use syntax similar to this: - -`-Identity "RedmondPresencePolicy"` - -To create a new policy at the site scope, use syntax similar to this: +### -Description -`-Identity "site:Redmond"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that you cannot create a new presence policy at the global scope. -In addition, your command will fail if the site in question already hosts a presence policy, or if you try to use the Identity of a per-user policy that already exists. +Enables administrators to provide additional text to accompany a presence policy. +For example, the Description might include information about the users the policy should be assigned to. ```yaml -Type: XdsIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxCategorySubscription -The maximum number of category subscriptions allowed at any one time. -A category subscription represents a request for a specific category of information; for example, an application that requests calendar data. +### -Force -MaxCategorySubscription can be set to any integer value between 0 and 3000; the default value is 1000. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: UInt16 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -136,35 +128,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxPromptedSubscriber -The maximum number of promoted subscribers a user can have at any one time. -By default, any time you are added to another user's Contacts list a notification dialog appears on screen informing you of this fact, and giving you the chance to do such things as add the person to your own Contacts list or block the person from viewing your presence. -Until you take action and dismiss the dialog box, each notification counts as a prompted subscriber. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the new presence policy. +To create a new per-user policy, use syntax similar to this: + +`-Identity "RedmondPresencePolicy"` + +To create a new policy at the site scope, use syntax similar to this: + +`-Identity "site:Redmond"` + +Note that you cannot create a new presence policy at the global scope. +In addition, your command will fail if the site in question already hosts a presence policy, or if you try to use the Identity of a per-user policy that already exists. + -MaxPromptedSubscriber can be set to any integer value between 0 and 600, inclusive; the default value is 200. -If you set this value to 0, users will not receive any notifications when they are added to another user's Contacts list. ```yaml -Type: UInt16 +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -173,18 +179,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -MaxCategorySubscription -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +The maximum number of category subscriptions allowed at any one time. +A category subscription represents a request for a specific category of information; for example, an application that requests calendar data. +MaxCategorySubscription can be set to any integer value between 0 and 3000; the default value is 1000. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -193,14 +200,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MaxPromptedSubscriber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The maximum number of promoted subscribers a user can have at any one time. +By default, any time you are added to another user's Contacts list a notification dialog appears on screen informing you of this fact, and giving you the chance to do such things as add the person to your own Contacts list or block the person from viewing your presence. +Until you take action and dismiss the dialog box, each notification counts as a prompted subscriber. + +MaxPromptedSubscriber can be set to any integer value between 0 and 600, inclusive; the default value is 200. +If you set this value to 0, users will not receive any notifications when they are added to another user's Contacts list. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -209,14 +223,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new presence policy is being created. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,18 +248,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description - -Enables administrators to provide additional text to accompany a presence policy. -For example, the Description might include information about the users the policy should be assigned to. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -245,21 +266,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the new presence policy is being created. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -273,13 +289,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPresencePolicy cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Presence.PresencePolicy The New-CsPresencePolicy cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Presence.PresencePolicy object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPresenceProvider.md b/skype/skype-ps/SkypeForBusiness/New-CsPresenceProvider.md similarity index 88% rename from skype/skype-ps/skype/New-CsPresenceProvider.md rename to skype/skype-ps/SkypeForBusiness/New-CsPresenceProvider.md index a7723a9ad6..3efdea4348 100644 --- a/skype/skype-ps/skype/New-CsPresenceProvider.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPresenceProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cspresenceprovider applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsPresenceProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cspresenceprovider +schema: 2.0.0 +title: New-CsPresenceProvider --- # New-CsPresenceProvider @@ -46,7 +47,7 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsPresenceProvider -Parent "global" -Fqdn "fabrikam.com" @@ -55,7 +56,7 @@ New-CsPresenceProvider -Parent "global" -Fqdn "fabrikam.com" The command shown in Example 1 creates a new presence provider (with the fully qualified domain name "fabrikam.com") that will be added to the global collection of user services configuration settings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUserServicesConfiguration | ForEach-Object {New-CsPresenceProvider -Parent $_.Identity -Fqdn "fabrikam.com"} @@ -68,7 +69,28 @@ Those settings are then piped to the ForEach-Object, which takes each item in th ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Fqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name for the presence provider. For example: @@ -82,8 +104,7 @@ Note that FQDNs must be unique at a given scope. ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -93,6 +114,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the new presence provider. The Identity of a presence provider is composed of two parts: the scope (Parent) where the rule has been applied (for example, service:UserServer:atl-cs-001.litwareinc.com) and the provider's fully qualified domain name. To create a new provider at the global scope use syntax similar to this: @@ -112,8 +136,7 @@ You cannot use the Identity parameter in the same command as the Fqdn or the Par ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -122,7 +145,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Parent + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Scope where the new presence provider will be created. To create a new presence provider at the global scope, use syntax similar to this: @@ -142,8 +187,7 @@ However, the Parent parameter cannot be used in conjunction with the Identity pa ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -153,29 +197,15 @@ Accept wildcard characters: False ``` ### -Confirm -Prompts you for confirmation before executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -184,31 +214,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -222,13 +237,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPresenceProvider cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PresenceProvider#Decorated The New-CsPresenceProvider cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PresenceProvider#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPrivacyConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsPrivacyConfiguration.md similarity index 88% rename from skype/skype-ps/skype/New-CsPrivacyConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsPrivacyConfiguration.md index 73c2badb7b..6728dfded2 100644 --- a/skype/skype-ps/skype/New-CsPrivacyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPrivacyConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csprivacyconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsPrivacyConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csprivacyconfiguration +schema: 2.0.0 +title: New-CsPrivacyConfiguration --- # New-CsPrivacyConfiguration @@ -50,7 +51,7 @@ The New-CsPrivacyConfiguration cmdlet enables you to create new privacy configur ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsPrivacyConfiguration -Identity site:Redmond -EnablePrivacyMode $True @@ -61,7 +62,7 @@ The new settings enable privacy mode; this is done by adding the EnablePrivacyMo Note that this command will fail if the Redmond site already has a collection of privacy settings. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsPrivacyConfiguration -Identity site:Redmond -InMemory @@ -82,40 +83,10 @@ Calling the Set-CsPrivacyConfiguration cmdlet is critical: if you fail to call t ## PARAMETERS -### -Identity - -Unique identifier for the privacy configuration settings to be created. -To create a new collection of settings at the site scope, use syntax similar to this: - -`-Identity site:Redmond` - -To create new settings at the service scope, use syntax like this: - -`-Identity service:UserServer:atl-cs-001.litwareinc.com` - -Privacy settings can only be created for the User Server service. -An error will occur if you try to apply these settings to any other service. - -Note that your command will fail if privacy configuration settings already exist for the specified site or service. -Likewise, your command will fail if you attempt to create a new collection of global settings. - - - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AutoInitiateContacts +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If True, Skype for Business will automatically add your manager and your direct reports to your Contacts list. The default value is True. @@ -124,8 +95,7 @@ The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -136,6 +106,8 @@ Accept wildcard characters: False ### -DisplayPublishedPhotoDefault +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If True, the user's photo will automatically be published in Skype for Business. If False, the user's photo will not be available unless he or she explicitly selects the option Let others see my photo. The default value is True. @@ -145,8 +117,7 @@ The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -156,6 +127,9 @@ Accept wildcard characters: False ``` ### -EnablePrivacyMode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If True, gives users the opportunity to enable the advanced privacy mode. In advanced privacy mode, only people on your Contacts list will be allowed to view your presence information. If False, your presence information will be available to anyone in your organization. @@ -164,8 +138,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -174,19 +147,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PublishLocationDataDefault - -If True, location data will automatically be published in Skype for Business. -If False, location data will not be available unless the user explicitly selects the option Show Contacts My Location. -The default value is True. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -195,17 +165,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the privacy configuration settings to be created. +To create a new collection of settings at the site scope, use syntax similar to this: + +`-Identity site:Redmond` + +To create new settings at the service scope, use syntax like this: + +`-Identity service:UserServer:atl-cs-001.litwareinc.com` + +Privacy settings can only be created for the User Server service. +An error will occur if you try to apply these settings to any other service. + +Note that your command will fail if privacy configuration settings already exist for the specified site or service. +Likewise, your command will fail if you attempt to create a new collection of global settings. + + ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -213,6 +200,8 @@ Accept wildcard characters: False ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. @@ -221,8 +210,29 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PublishLocationDataDefault + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, location data will automatically be published in Skype for Business. +If False, location data will not be available unless the user explicitly selects the option Show Contacts My Location. +The default value is True. + + + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -233,6 +243,8 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new privacy configuration settings are being created. For example: @@ -247,8 +259,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -257,14 +268,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -273,14 +286,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -294,13 +309,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPrivacyConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PrivacyConfiguration The New-CsPrivacyConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PrivacyConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsProxyConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsProxyConfiguration.md similarity index 82% rename from skype/skype-ps/skype/New-CsProxyConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsProxyConfiguration.md index 2d9e20f244..48fb0e66fb 100644 --- a/skype/skype-ps/skype/New-CsProxyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsProxyConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csproxyconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsProxyConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csproxyconfiguration +schema: 2.0.0 +title: New-CsProxyConfiguration --- # New-CsProxyConfiguration @@ -48,7 +49,7 @@ These new collections are created by using the New-CsProxyConfiguration cmdlet. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsProxyConfiguration -Identity "service:EdgeServer:atl-edge-001.litwareinc.com" -RequestServerCompression $True -MaxClientMessageBodySizeKb 256 @@ -59,7 +60,7 @@ These new settings use all the default proxy server property values except for t Note that this command will fail if proxy server settings have already been configured for the service EdgeServer:atl-edge-001.litwareinc.com. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsProxyConfiguration -Identity "service:EdgeServer:atl-edge-001.litwareinc.com" -InMemory @@ -83,38 +84,34 @@ If you do not call the Set-CsProxyConfiguration cmdlet, no settings will be appl ## PARAMETERS -### -Identity - -Unique identifier for the proxy server configuration settings to be created. -Proxy server configuration settings can only be created at the service scope, and only for the Edge Server and Registrar services. -You cannot create settings at the global scope; likewise, you cannot create settings at the service scope if the service in question already hosts a collection of proxy server settings. -For example, if the service Registrar:atl-cs-001.litwareinc.com already hosts proxy server settings, then any command that attempts to create new settings for that service will fail. +### -AcceptClientCompression -To specify the Identity for your new proxy server settings, use syntax similar to this: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-Identity "service:Registrar:atl-cs-001.litwareinc.com"` +When set to True (the default value), the proxy server will accept all incoming compression requests from client endpoints. ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AcceptClientCompression -When set to True (the default value), the proxy server will accept all incoming compression requests from client endpoints. +### -AcceptServerCompression + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), the proxy server will accept all incoming compression requests from other servers. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -123,14 +120,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AcceptServerCompression -When set to True (the default value), the proxy server will accept all incoming compression requests from other servers. +### -AllowPartnerPollingSubscribes + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set the True, partner applications are allowed to periodically poll the service for state changes. +The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,14 +139,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableWhiteSpaceKeepAlive -When set to True (the default value), the proxy server expects clients to periodically send a "whitespace message" (an empty message with no content) to indicate that the connection is still active. +### -DisableNtlmFor2010AndLaterClients + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, users logging on from Skype for Business must use the Kerberos protocol for authentication. +The default value is False. + + ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -155,16 +160,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxClientCompressionCount -Indicates the maximum number of client-to-server connections that can be compressed at any given time; additional connections beyond this limit will not be compressed. -The compression count can be set to any integer value between 0 and 65535, inclusive. -The default value is 15000. +### -DnsCacheRecordCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Maximum number of records that can be maintained in the DNS record cache. +The default value is 3000. + + ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -173,16 +181,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxServerCompressionCount -Indicates the maximum number of server-to-server connections that can be compressed at any given time; additional connections beyond this limit will not be compressed. -The server compression count can be set to any integer value between 0 and 65535, inclusive. -The default value is 1024. +### -EnableLoggingAllMessageBodies + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, Microsoft Lync Server will log the actual content of all instant messages. +For privacy reasons, message content is typically deleted and only information about the communicating endpoints is included in the log files. + +The default value is False. ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -191,15 +202,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Realm -Indicates whether or not security credentials are processed by the default proxy server realm (SIP Communications Service) or by a custom realm. -Custom realms must be specified (and created) by using the New-CsSipProxyCustom cmdlet. +### -EnableWhiteSpaceKeepAlive + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), the proxy server expects clients to periodically send a "whitespace message" (an empty message with no content) to indicate that the connection is still active. ```yaml -Type: IRealmChoice +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -208,14 +220,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequestServerCompression -When set to True (the default value) the proxy server requests that compression be used on all outgoing connections to other servers. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -224,31 +238,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TreatAllClientsAsRemote -When set to True, the proxy server functions as if all client connections are external connections that pass through the Edge Server running the Access Edge service. -The default value is False. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the proxy server configuration settings to be created. +Proxy server configuration settings can only be created at the service scope, and only for the Edge Server and Registrar services. +You cannot create settings at the global scope; likewise, you cannot create settings at the service scope if the service in question already hosts a collection of proxy server settings. +For example, if the service Registrar:atl-cs-001.litwareinc.com already hosts proxy server settings, then any command that attempts to create new settings for that service will fail. + +To specify the Identity for your new proxy server settings, use syntax similar to this: + +`-Identity "service:Registrar:atl-cs-001.litwareinc.com"` ```yaml -Type: Boolean +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UseCertificateForClientToProxyAuth -When set to True (the default value), client endpoints will be allowed to use certificates for authentication. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -257,18 +284,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseKerberosForClientToProxyAuth - -When set to True (the default value), client endpoints will be allowed to use the Kerberos protocol for authentication. -Although Kerberos is a more secure protocol than NTLM, it cannot be used if the client belongs to a different realm than the server. +### -LoadBalanceEdgeServers +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +When True, software load balancing is employed for requests to Edge Servers. +The default value is True ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -277,16 +303,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseNtlmForClientToProxyAuth -When set to True (the default value), client endpoints will be allowed to use the NTLM protocol for authentication. -Although NTLM is a less secure protocol than Kerberos, NTLM can be used if the client belongs to a different domain than the server. -That is not true for Kerberos authentication. +### -LoadBalanceInternalServers + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When True, software load balancing is employed for requests to Registrars and other internal servers. +The default value is true ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -295,14 +322,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -MaxClientCompressionCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum number of client-to-server connections that can be compressed at any given time; additional connections beyond this limit will not be compressed. +The compression count can be set to any integer value between 0 and 65535, inclusive. +The default value is 15000. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -311,18 +342,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory - -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -MaxClientMessageBodySizeKb +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +The maximum-allowed size (in kilobytes) for the body of a message sent from a client endpoint. +The default value is 128, meaning that messages with a body size larger than 128 KB will be rejected. +The client message body size can be set to any integer value between 64 and 256, inclusive. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -331,14 +362,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MaxKeepAliveInterval + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the amount of time (in minutes) that can elapse before the server verifies that the connection with the client is still valid. +The default value is 20 minutes. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -347,14 +381,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -MaxServerCompressionCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum number of server-to-server connections that can be compressed at any given time; additional connections beyond this limit will not be compressed. +The server compression count can be set to any integer value between 0 and 65535, inclusive. +The default value is 1024. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -363,18 +401,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableNtlmFor2010AndLaterClients - -When set to True, users logging on from Skype for Business must use the Kerberos protocol for authentication. -The default value is False. +### -MaxServerMessageBodySizeKb +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +The maximum-allowed size (in kilobytes) for the body of a message sent from another server. +The default value is 5000, meaning that messages with a body size larger than 5000 KB will be rejected. +The server message body size can be set to any integer value between 1000 and 20000, inclusive. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -383,18 +421,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DnsCacheRecordCount - -Maximum number of records that can be maintained in the DNS record cache. -The default value is 3000. +### -OutgoingTlsCount +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Specifies the maximum number of Transport Layer Security (TLS) connections that can be used for each internal server. +The minimum number of TLS connections is 1, and the maximum number is 4. +By default, OutgoingTlsCount is set to 4. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -403,16 +441,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxClientMessageBodySizeKb -The maximum-allowed size (in kilobytes) for the body of a message sent from a client endpoint. -The default value is 128, meaning that messages with a body size larger than 128 KB will be rejected. -The client message body size can be set to any integer value between 64 and 256, inclusive. +### -Realm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not security credentials are processed by the default proxy server realm (SIP Communications Service) or by a custom realm. +Custom realms must be specified (and created) by using the New-CsSipProxyCustom cmdlet. ```yaml -Type: UInt32 +Type: IRealmChoice Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -421,16 +460,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxServerMessageBodySizeKb -The maximum-allowed size (in kilobytes) for the body of a message sent from another server. -The default value is 5000, meaning that messages with a body size larger than 5000 KB will be rejected. -The server message body size can be set to any integer value between 1000 and 20000, inclusive. +### -RequestServerCompression + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) the proxy server requests that compression be used on all outgoing connections to other servers. ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -439,16 +478,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutgoingTlsCount -Specifies the maximum number of Transport Layer Security (TLS) connections that can be used for each internal server. -The minimum number of TLS connections is 1, and the maximum number is 4. -By default, OutgoingTlsCount is set to 4. +### -SpecialConfigurationList + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: String ```yaml -Type: UInt32 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -457,15 +496,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPartnerPollingSubscribes -When set the True, partner applications are allowed to periodically poll the service for state changes. -The default value is False ($False). +### -TestFeatureList + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not currently used by Skype for Business Server. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -474,17 +514,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableLoggingAllMessageBodies -When set to True, Microsoft Lync Server will log the actual content of all instant messages. -For privacy reasons, message content is typically deleted and only information about the communicating endpoints is included in the log files. +### -TestParameterList -The default value is False. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not currently used by Skype for Business Server. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -493,15 +532,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LoadBalanceEdgeServers -When True, software load balancing is employed for requests to Edge Servers. -The default value is True ($True). +### -TreatAllClientsAsRemote + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, the proxy server functions as if all client connections are external connections that pass through the Edge Server running the Access Edge service. +The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -510,15 +551,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LoadBalanceInternalServers -When True, software load balancing is employed for requests to Registrars and other internal servers. -The default value is true ($True). +### -UseCertificateForClientToProxyAuth + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), client endpoints will be allowed to use certificates for authentication. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -527,15 +569,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxKeepAliveInterval -Specifies the amount of time (in minutes) that can elapse before the server verifies that the connection with the client is still valid. -The default value is 20 minutes. +### -UseKerberosForClientToProxyAuth + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), client endpoints will be allowed to use the Kerberos protocol for authentication. +Although Kerberos is a more secure protocol than NTLM, it cannot be used if the client belongs to a different realm than the server. + + ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -544,14 +590,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SpecialConfigurationList -PARAMVALUE: String +### -UseNtlmForClientToProxyAuth + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), client endpoints will be allowed to use the NTLM protocol for authentication. +Although NTLM is a less secure protocol than Kerberos, NTLM can be used if the client belongs to a different domain than the server. +That is not true for Kerberos authentication. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -560,14 +610,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TestFeatureList -This parameter is not currently used by Skype for Business Server. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -576,14 +628,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TestParameterList -This parameter is not currently used by Skype for Business Server. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -597,13 +651,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsProxyConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.ProxySettings The New-CsProxyConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.ProxySettings object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPublicProvider.md b/skype/skype-ps/SkypeForBusiness/New-CsPublicProvider.md similarity index 86% rename from skype/skype-ps/skype/New-CsPublicProvider.md rename to skype/skype-ps/SkypeForBusiness/New-CsPublicProvider.md index 3350062fcf..25d0cc553c 100644 --- a/skype/skype-ps/skype/New-CsPublicProvider.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPublicProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cspublicprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsPublicProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cspublicprovider +schema: 2.0.0 +title: New-CsPublicProvider --- # New-CsPublicProvider @@ -48,7 +49,7 @@ Note that you cannot federate with a public provider if your Edge servers are co ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsPublicProvider -Identity "Fabrikam" -ProxyFqdn "proxyserver.fabrikam.com" -Enabled $True @@ -58,7 +59,7 @@ The command shown in Example 1 creates a new federation relationship with a publ In addition to specifying the Identity, two other property values (and their corresponding parameters) must be set: ProxyFqdn (set to proxyserver.fabrikam.com) and Enabled (which, in this case, is set to True). -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsPublicProvider -Identity "Fabrikam" -ProxyFqdn "proxyserver.fabrikam.com" -Enabled $True -InMemory @@ -80,101 +81,75 @@ In turn, the virtual provider will disappear the moment you end your Windows Pow ## PARAMETERS -### -Identity +### -Enabled -Unique identifier for the public provider to be created. -The Identity typically the name of the website providing the services. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Identities must be unique not only among public providers, but also among hosting providers. -Suppose you try to create a new public provider with the Identity Fabrikam. -Your command will fail if a public provider or a hosting provider with that Identity already exists. +Indicates whether or not the federation relationship between your organization and the public provider is active. +If set to True, users in your organization will be able to exchange instant messages and presence information with users who have accounts hosted on the public provider. +If set to False, users in your organization will not be able to exchange instant messages and presence information with users who have accounts hosted on the public provider. +You can enable and disable federation relationships at any time by using the Enable-CsPublicProvider cmdlet and the Disable-CsPublicProvider cmdlet, respectively. ```yaml -Type: XdsGlobalRelativeIdentity +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyFqdn -Specifies the fully qualified domain name (FQDN) (for example, proxyserver.fabrikam.com) of the proxy server used by the public provider. +### -EnableSkypeDirectorySearch -Proxy FQDNs must be unique not only among public providers, but also among hosting providers. -For example, suppose you try to create a new public provider with the proxy FQDN proxyserver.fabrikam.com. -This command will fail if a public provider or a hosting provider with that proxy FQDN already exists. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: $true | $false ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Enabled - -Indicates whether or not the federation relationship between your organization and the public provider is active. -If set to True, users in your organization will be able to exchange instant messages and presence information with users who have accounts hosted on the public provider. -If set to False, users in your organization will not be able to exchange instant messages and presence information with users who have accounts hosted on the public provider. -You can enable and disable federation relationships at any time by using the Enable-CsPublicProvider cmdlet and the Disable-CsPublicProvider cmdlet, respectively. +### -EnableSkypeIdRouting +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +PARAMVALUE: $true | $false ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -VerificationLevel - -Indicates how (or if) messages sent from a public provider are verified to ensure that they were sent from that provider. -The VerificationLevel must be set to one of the following values: - -AlwaysVerifiable. -All messages purportedly sent from this provider will be accepted. -If a verification header is not found in the message it will be added by Skype for Business Server. -This is the default value. - -AlwaysUnverifiable. -All messages purportedly sent from a public provider are considered unverified. -They will be delivered only if they were sent from a person who is on the recipient's Contacts list. -For example, if Ken Myer is on your Contacts list you will be able to receive messages from him. -If Pilar Ackerman is not on your Contacts list then you will not be able to receive messages from her. -Note that Skype for Business users can manually override this setting, thereby allowing themselves to receive messages people not on their Contacts list. - -UseSourceVerification. -Uses the verification header added to the message by the public provider. -If the verification information is missing the message will be rejected. -This value has been deprecated for use in Skype for Business Server. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: VerificationLevelType +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -183,14 +158,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -IconUrl + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL for the icon used to indicate a Microsoft Skype contact. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -199,34 +176,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -Identity -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the public provider to be created. +The Identity typically the name of the website providing the services. + +Identities must be unique not only among public providers, but also among hosting providers. +Suppose you try to create a new public provider with the Identity Fabrikam. +Your command will fail if a public provider or a hosting provider with that Identity already exists. ```yaml -Type: SwitchParameter +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -235,14 +222,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -NameDecorationDomain + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: String + + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -251,14 +242,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IconUrl -URL for the icon used to indicate a Microsoft Skype contact. +### -NameDecorationExcludedDomainList + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: String ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -267,17 +260,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NameDecorationDomain - -PARAMVALUE: String +### -NameDecorationRoutingDomain +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +PARAMVALUE: String ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -286,30 +278,58 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSkypeDirectorySearch -PARAMVALUE: $true | $false +### -ProxyFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the fully qualified domain name (FQDN) (for example, proxyserver.fabrikam.com) of the proxy server used by the public provider. + +Proxy FQDNs must be unique not only among public providers, but also among hosting providers. +For example, suppose you try to create a new public provider with the proxy FQDN proxyserver.fabrikam.com. +This command will fail if a public provider or a hosting provider with that proxy FQDN already exists. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSkypeIdRouting -PARAMVALUE: $true | $false +### -VerificationLevel + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates how (or if) messages sent from a public provider are verified to ensure that they were sent from that provider. +The VerificationLevel must be set to one of the following values: + +AlwaysVerifiable. +All messages purportedly sent from this provider will be accepted. +If a verification header is not found in the message it will be added by Skype for Business Server. +This is the default value. + +AlwaysUnverifiable. +All messages purportedly sent from a public provider are considered unverified. +They will be delivered only if they were sent from a person who is on the recipient's Contacts list. +For example, if Ken Myer is on your Contacts list you will be able to receive messages from him. +If Pilar Ackerman is not on your Contacts list then you will not be able to receive messages from her. +Note that Skype for Business users can manually override this setting, thereby allowing themselves to receive messages people not on their Contacts list. + +UseSourceVerification. +Uses the verification header added to the message by the public provider. +If the verification information is missing the message will be rejected. +This value has been deprecated for use in Skype for Business Server. + + ```yaml -Type: Boolean +Type: VerificationLevelType Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -318,14 +338,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NameDecorationExcludedDomainList -PARAMVALUE: String +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -334,14 +356,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NameDecorationRoutingDomain -PARAMVALUE: String +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -355,13 +379,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPublicProvider cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayPublicProvider Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayPublicProvider object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsPushNotificationConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsPushNotificationConfiguration.md similarity index 90% rename from skype/skype-ps/skype/New-CsPushNotificationConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsPushNotificationConfiguration.md index 614ff79df4..cbb9d2a236 100644 --- a/skype/skype-ps/skype/New-CsPushNotificationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsPushNotificationConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cspushnotificationconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsPushNotificationConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cspushnotificationconfiguration +schema: 2.0.0 +title: New-CsPushNotificationConfiguration --- # New-CsPushNotificationConfiguration @@ -48,7 +49,7 @@ That gives Administrators the ability to provide push notifications to users in ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsPushNotificationConfiguration -Identity "site:Redmond" -EnableApplePushNotificationService $True -EnableMicrosoftPushNotificationService -$True @@ -58,7 +59,7 @@ The command shown in Example 1 creates a new collection of push notification set The latter is done by setting both the EnableApplePushNotificationService and the EnableMicrosoftPushNotificationService properties to True. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Get-CsSite | ForEach-Object {New-CsPushNotificationConfiguration -Identity $_.Identity} @@ -70,7 +71,7 @@ That collection is then piped to the ForEach-Object cmdlet, which takes each sit Note that this command will fail for any site that already hosts a collection of push notification configuration settings. -### -------------------------- EXAMPLE 3 -------------------------- +### EXAMPLE 3 ``` $x = New-CsPushNotificationConfiguration -Identity "site:Redmond" -InMemory @@ -93,44 +94,10 @@ If you do not call the Set-CsPushNotificationConfiguration cmdlet, these setting ## PARAMETERS -### -Identity -Push notification settings can only be created at the site scope. -To specify a new collection of settings for a site, use syntax similar to this: - -`-Identity "site:Redmond"` - -Note that this command will fail if the Redmond site already hosts a collection of push notification settings. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableApplePushNotificationService -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableApplePushNotificationService When set to True, iPhone users will receive push notifications from the Apple Push Notification Service. When set to False, iPhone users will not receive these notifications. @@ -139,8 +106,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,6 +116,9 @@ Accept wildcard characters: False ``` ### -EnableMicrosoftPushNotificationService + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, Windows Phone users will receive push notifications from the Microsoft Push Notification Service. When set to False, Windows Phone users will not receive these notifications. @@ -158,8 +127,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -169,13 +137,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,15 +154,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Push notification settings can only be created at the site scope. +To specify a new collection of settings for a site, use syntax similar to this: + +`-Identity "site:Redmond"` + +Note that this command will fail if the Redmond site already hosts a collection of push notification settings. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of a command called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -203,6 +198,8 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new push notification configuration settings are being created. For example: @@ -217,8 +214,25 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -228,13 +242,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -248,13 +264,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsPushNotificationConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WriteableConfig.Settings.PushNotificationConfiguration.PushNotificationConfiguration The New-CsPushNotificationConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.PushNotificationConfiguration.PushNotificationConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsQoEConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsQoEConfiguration.md similarity index 81% rename from skype/skype-ps/skype/New-CsQoEConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsQoEConfiguration.md index 936e584b5d..b5f3af49d3 100644 --- a/skype/skype-ps/skype/New-CsQoEConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsQoEConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csqoeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsQoEConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csqoeconfiguration +schema: 2.0.0 +title: New-CsQoEConfiguration --- # New-CsQoEConfiguration @@ -41,7 +42,7 @@ QoE is part of the Monitoring Server role; therefore Monitoring Server must be d ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsQoEConfiguration -Identity site:Redmond -EnableQoE $False @@ -52,7 +53,7 @@ In addition to the Identity site:Redmond, the new settings also have the EnableQ Because site settings take precedence over global settings, this means that QoE will be disabled for the Redmond site, regardless of whether or not QoE has been enabled at the global scope. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsQoEConfiguration -Identity site:Dublin -KeepQoEDataForDays 30 -PurgeHourOfDay 4 @@ -67,27 +68,10 @@ Note: If you have enabled QoE and call detail recording (CDR), for performance r ## PARAMETERS -### -Identity - -The site to which the new settings apply. -This must be entered in the format site:\, where \ is the name of the site in your Skype for Business Server deployment. - - - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableExternalConsumer -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableExternalConsumer Specifies whether an external consumer is able to receive QoE reports. Default: False @@ -95,8 +79,7 @@ Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -106,6 +89,9 @@ Accept wildcard characters: False ``` ### -EnablePurging + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies whether records will be purged after the duration defined in the KeepQoEDataForDays property has elapsed. Default: True @@ -113,8 +99,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -124,6 +109,9 @@ Accept wildcard characters: False ``` ### -EnableQoE + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies whether QoE records will be collected and saved to the monitoring database. Note that even if EnableQoE is set to True, QoE data will not be collected unless a Monitoring Server has been deployed and associated with a Registrar pool. @@ -133,8 +121,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -144,13 +131,15 @@ Accept wildcard characters: False ``` ### -ExternalConsumerIssuedCertId + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The certificate ID of the certificate that allows access to the external consumer web service. ```yaml Type: IssuedCertId Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -160,13 +149,15 @@ Accept wildcard characters: False ``` ### -ExternalConsumerName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The friendly name of the external consumer of the QoE report. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -176,13 +167,15 @@ Accept wildcard characters: False ``` ### -ExternalConsumerURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The URL of the external consumer to which the QoE reports will be posted. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -191,19 +184,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -KeepQoEDataForDays -The number of days QoE data will be stored before being purged from the database. -This value is ignored if EnablePurging is set to False. +### -Force -Must be a value from 1 through 2562. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Default: 60 +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: UInt32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -212,34 +202,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PurgeHourOfDay -The hour of day that QoE records that have exceeded the number of days specified in the KeepQoEDataForDays property will be purged. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The site to which the new settings apply. +This must be entered in the format site:\, where \ is the name of the site in your Skype for Business Server deployment. + -Must be a value 0 through 23, representing the hour of the day. -For example, 0 would be midnight, 13 would be 1:00 PM. -Default: 1 ```yaml -Type: UInt32 +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -248,18 +244,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -KeepQoEDataForDays -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The number of days QoE data will be stored before being purged from the database. +This value is ignored if EnablePurging is set to False. +Must be a value from 1 through 2562. +Default: 60 ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -268,14 +267,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -PurgeHourOfDay + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The hour of day that QoE records that have exceeded the number of days specified in the KeepQoEDataForDays property will be purged. + +Must be a value 0 through 23, representing the hour of the day. +For example, 0 would be midnight, 13 would be 1:00 PM. +Default: 1 ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -285,13 +290,33 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -305,12 +330,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.QoE.QoESettings Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.QoE.QoESettings. ## NOTES diff --git a/skype/skype-ps/skype/New-CsRegistrarConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsRegistrarConfiguration.md similarity index 87% rename from skype/skype-ps/skype/New-CsRegistrarConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsRegistrarConfiguration.md index cb6eea8e9f..2db1b34936 100644 --- a/skype/skype-ps/skype/New-CsRegistrarConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRegistrarConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csregistrarconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsRegistrarConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csregistrarconfiguration +schema: 2.0.0 +title: New-CsRegistrarConfiguration --- # New-CsRegistrarConfiguration @@ -50,7 +51,7 @@ Your command will also fail if you try to create new settings at the global scop ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsRegistrarConfiguration -Identity site:Redmond -MaxEndpointsPerUser 4 -EnableDHCPServer $True @@ -61,7 +62,7 @@ In addition to specifying the Identity for the new settings, the command also se Note that this command will fail if the Redmond site has already been assigned a collection of Registrar configuration settings. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsRegistrarConfiguration -Identity site:Redmond -InMemory @@ -86,39 +87,29 @@ If you do not call the Set-CsRegistrarConfiguration cmdlet, no new settings will ## PARAMETERS -### -Identity - -Unique identifier for the Registrar configuration settings to be created. -To create settings configured at the site scope, use syntax similar to this: - -`-Identity site:Redmond` - -To create settings at the service level, use syntax like this: - -`-Identity service:Registrar:atl-cs-001.litwareinc.com` - -Note that a given site or service can only have, at most, a single collection of Registrar settings. -If you try to create a new collection with the Identity site:Redmond and the Redmond site already hosts a collection of Registrar settings, then your command will fail. - -In addition, you cannot create new Registrar settings at the global scope. -If you want to change values at the global scope, use the Set-CsRegistrarConfiguration cmdlet. +### -BackupStoreUnavailableThreshold +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Specifies the amount of time the system will wait before determining that the backup store is unavailable; at that point, users will be placed in survivability mode. +The default value is 30 minutes (00:30:00). ```yaml -Type: XdsIdentity +Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -DefaultEndpointExpiration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When endpoints log on they have the option of requesting an expiration timeout; this specifies the time interval that an endpoint can remain logged onto the system before it must contact the server and request an extension. The DefaultEndpointExpiration property represents the expiration timeout interval for clients that do not request a specific timeout value. @@ -128,8 +119,7 @@ The default value is 600 (10 minutes). ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,14 +129,16 @@ Accept wildcard characters: False ``` ### -EnableDHCPServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether endpoints can use DHCP servers to locate a Registrar. If True, clients will send a DHCP Inform message when they first start; the DHCP server will respond by sending the fully qualified domain name (FQDN) of a Registrar that can be used to log on the user. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -155,19 +147,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxEndpointExpiration -When endpoints log on, they have the option of requesting an expiration timeout; this specifies the time interval that an endpoint can remain logged onto the system before it must contact the server and request an extension. -The MaxEndpointExpiration property represents the maximum amount of time that clients can be granted. -For example, if the maximum time is set to 600 seconds and a client requests a timeout interval of 800 seconds, the client will be given the maximum allowed expiration period: 600 seconds. +### -EnableWinFabLogUpload -The MaxEndpointExpiration must be between 300 (5 minutes) and 900 (15 minutes). -The default value is 900. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: $true | $false ```yaml -Type: Int32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -176,19 +165,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MinEndpointExpiration -When endpoints log on, they have the option of requesting an expiration timeout; this specifies the time interval that an endpoint can remain logged onto the system before it must contact the server and request an extension. -The MinEndpointExpiration property represents the minimum amount of time that clients can be granted. -For example, if the minimum time is set to 600 seconds and a client requests a timeout interval of 200 seconds, the client will be given the minimum allowed expiration period: 600 seconds. +### -Force -The MinEndpointExpiration must be between 300 (5 minutes) and 900 (15 minutes). -The default value is 300. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -197,45 +183,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxEndpointsPerUser +### -Identity -Indicates the maximum number of endpoints a user can simultaneously have connected to the system. -(For example, a user who is logged on to Skype for Business Server with both a computer and a mobile phone would be using two endpoints.) MaxEndpointsPerUser must be set to a value between 1 and 64, inclusive. -The default value is 8. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Although it is possible to allow a user as many as 64 endpoints, it is recommended that the maximum number of endpoints not exceed 8. -Values of 9 or more are used for backwards compatibility and, in rare cases, when suggested by Microsoft support personnel. -For new deployments, the maximum number of endpoints should be no more than 8. +Unique identifier for the Registrar configuration settings to be created. +To create settings configured at the site scope, use syntax similar to this: -Note, too, that the maximum number of endpoints is intended to give individual users multiple points of presence. -As such, this setting is designed for individual users and not for groups of users (such as an entire department.) +`-Identity site:Redmond` + +To create settings at the service level, use syntax like this: +`-Identity service:Registrar:atl-cs-001.litwareinc.com` +Note that a given site or service can only have, at most, a single collection of Registrar settings. +If you try to create a new collection with the Identity site:Redmond and the Redmond site already hosts a collection of Registrar settings, then your command will fail. -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +In addition, you cannot create new Registrar settings at the global scope. +If you want to change values at the global scope, use the Set-CsRegistrarConfiguration cmdlet. -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -243,6 +218,8 @@ Accept wildcard characters: False ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. @@ -251,8 +228,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -261,14 +237,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MaxEndpointExpiration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When endpoints log on, they have the option of requesting an expiration timeout; this specifies the time interval that an endpoint can remain logged onto the system before it must contact the server and request an extension. +The MaxEndpointExpiration property represents the maximum amount of time that clients can be granted. +For example, if the maximum time is set to 600 seconds and a client requests a timeout interval of 800 seconds, the client will be given the maximum allowed expiration period: 600 seconds. + +The MaxEndpointExpiration must be between 300 (5 minutes) and 900 (15 minutes). +The default value is 900. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -277,14 +260,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -MaxEndpointsPerUser + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum number of endpoints a user can simultaneously have connected to the system. +(For example, a user who is logged on to Skype for Business Server with both a computer and a mobile phone would be using two endpoints.) MaxEndpointsPerUser must be set to a value between 1 and 64, inclusive. +The default value is 8. + +Although it is possible to allow a user as many as 64 endpoints, it is recommended that the maximum number of endpoints not exceed 8. +Values of 9 or more are used for backwards compatibility and, in rare cases, when suggested by Microsoft support personnel. +For new deployments, the maximum number of endpoints should be no more than 8. + +Note, too, that the maximum number of endpoints is intended to give individual users multiple points of presence. +As such, this setting is designed for individual users and not for groups of users (such as an entire department.) + + ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -293,15 +289,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BackupStoreUnavailableThreshold -Specifies the amount of time the system will wait before determining that the backup store is unavailable; at that point, users will be placed in survivability mode. -The default value is 30 minutes (00:30:00). +### -MaxUserCount + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum number of users that can simultaneously be logged on to a Registrar. +MaxUserCount can be set to any integer value between 2000 and 100000, inclusive. +The default value is 12000. + + ```yaml -Type: TimeSpan +Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -310,19 +311,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxUserCount +### -MinEndpointExpiration -Indicates the maximum number of users that can simultaneously be logged on to a Registrar. -MaxUserCount can be set to any integer value between 2000 and 100000, inclusive. -The default value is 12000. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +When endpoints log on, they have the option of requesting an expiration timeout; this specifies the time interval that an endpoint can remain logged onto the system before it must contact the server and request an extension. +The MinEndpointExpiration property represents the minimum amount of time that clients can be granted. +For example, if the minimum time is set to 600 seconds and a client requests a timeout interval of 200 seconds, the client will be given the minimum allowed expiration period: 600 seconds. +The MinEndpointExpiration must be between 300 (5 minutes) and 900 (15 minutes). +The default value is 300. ```yaml -Type: UInt64 +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -333,6 +336,8 @@ Accept wildcard characters: False ### -PoolState +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Current state for the Registrar pool. Allowed values are: @@ -351,8 +356,7 @@ The default value is Active. ```yaml Type: PoolState Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -361,14 +365,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableWinFabLogUpload -PARAMVALUE: $true | $false +### -UserCertificateReplicationThreshold + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Minimum interval in minutes for user certificate to be replicated. ```yaml -Type: Boolean +Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -377,14 +383,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserCertificateReplicationThreshold -Minimum interval in minutes for user certificate to be replicated. +### -WinFabMaxLogsSizeMb + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Limits the maximum disk space used by Fabric traces. Only applies to deployments using Windows Fabric 3.0 or newer ```yaml -Type: UInt64 +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -393,14 +401,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WinFabMaxLogsSizeMb -Limits the maximum disk space used by Fabric traces. Only applies to deployments using Windows Fabric 3.0 or newer +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -414,13 +442,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsRegistrarConfiguration cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Registrar.RegistrarSettings The New-CsRegistrarConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Registrar.RegistrarSettings object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsReportingConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsReportingConfiguration.md similarity index 87% rename from skype/skype-ps/skype/New-CsReportingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsReportingConfiguration.md index 5b76d057c5..1e7a0e79f4 100644 --- a/skype/skype-ps/skype/New-CsReportingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsReportingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csreportingconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsReportingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csreportingconfiguration +schema: 2.0.0 +title: New-CsReportingConfiguration --- # New-CsReportingConfiguration @@ -50,7 +51,7 @@ Skype for Business Server Control Panel: The functions carried out by the New-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsReportingConfiguration -Identity "service:MonitoringDatabase:atl-sql-001.litwareinc.com" -ReportingUrl "https://atl-sql-001.litwareinc.com/lync_reports" @@ -62,7 +63,28 @@ In this example, the value of the ReportingUrl property is set to `https://atl-s ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service Identity of the monitoring database to be associated with the new reporting configuration settings. For example: @@ -71,8 +93,7 @@ For example: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -81,14 +102,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -97,31 +121,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -ReportingUrl -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL for the Skype for Business Server Monitoring Reports. -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -130,17 +141,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReportingUrl - -URL for the Skype for Business Server Monitoring Reports. +### -Confirm +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -150,13 +160,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -170,14 +182,13 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsReportingConfiguration cmdlet does not accept pipelined data. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Reporting.ReportingConfiguration The New-CsReportingConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Reporting.ReportingConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsRgsAgentGroup.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsAgentGroup.md similarity index 86% rename from skype/skype-ps/skype/New-CsRgsAgentGroup.md rename to skype/skype-ps/SkypeForBusiness/New-CsRgsAgentGroup.md index ce81c7775c..45358287a0 100644 --- a/skype/skype-ps/skype/New-CsRgsAgentGroup.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsAgentGroup.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsagentgroup applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsRgsAgentGroup -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsagentgroup +schema: 2.0.0 +title: New-CsRgsAgentGroup --- # New-CsRgsAgentGroup @@ -47,7 +48,7 @@ New agent groups are created by using the New-CsRgsAgentGroup cmdlet. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsRgsAgentGroup -Parent service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk Group" @@ -59,7 +60,7 @@ In this example, no other group parameters are specified, meaning the group will Because no agents have been assigned to this group any calls routed to the new agent group will automatically be disconnected. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsRgsAgentGroup -Parent service: ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk Group" -AgentsByUri "sip:kenmyer@litwareinc.com","sip:pilarackerman@litwareinc.com" @@ -73,42 +74,10 @@ This value is a comma-separated list of the SIP addresses to be added to the age ## PARAMETERS -### -Name -Unique name to be assigned to the agent group. -The combination of the Parent property and the Name property enables you to uniquely identify agent groups without having to refer to the group's globally unique identifier (GUID). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parent -Service where the new agent group will be hosted. -For example: `-Parent "service:ApplicationServer:atl-cs-001.litwareinc.com".` - -```yaml -Type: RgsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -AgentAlertTime +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the amount of time (in seconds) that a call can remain unanswered before it is automatically routed to the next agent. The AgentAlertTime can be set to any integer value between 10 and 600 seconds (10 minutes), inclusive. The default value is 20 seconds. @@ -121,8 +90,7 @@ To avoid this, set the Alert Time value to less than 180 seconds. ```yaml Type: Int16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,6 +100,9 @@ Accept wildcard characters: False ``` ### -AgentsByUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + **Below Content Applies To:** Lync Server 2010 Enables you to individually add agents to an agent group. @@ -151,8 +122,7 @@ Note that you can only select users who have been enabled for Enterprise Voice. ```yaml Type: System.Collections.ObjectModel.Collection`1[System.Uri] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,14 +132,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to provide additional, explanatory information about the agent group. For example, the Description might contain information about who to contact if the group does not receive the expected phone calls. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,13 +151,15 @@ Accept wildcard characters: False ``` ### -DistributionGroupAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to add all the members of a distribution group to an agent group. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -194,16 +168,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ParticipationPolicy -Indicates whether or not agents are required to formally sign on to the system in order to receive phone calls intended for the group. -If ParticipationPolicy is set to Informal (the default value) sign-in is not required. -If ParticipationPolicy is set to Formal then sign-in is required. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: ParticipationPolicy +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -212,47 +186,77 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RoutingMethod +### -InMemory -Specifies the method used to route new calls to agents. -The RoutingMethod must be set to one of the following values: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -LongestIdle - Calls are routed to the agent who has been idle (that is, not involved in a Skype for Business activity) for the longest period of time. +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. -RoundRobin - Calls are routed to the next agent on the list. -Serial - Calls are always routed to the first agent on the list, and are only routed to other agents if this person is not available or does not answer within the allotted time. -Parallel - Calls are routed to all agents at the same time, except for agents whose presence status indicates that they are in a call or otherwise unavailable. +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Attendant - Calls are routed to all agents at the same time, even if the agent's presence status indicates that he or she is in a call or otherwise unavailable. -The only exception occurs when an agent has set his or her presence to Do Not Disturb. +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -The default routing method is Parallel. +### -Name +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Unique name to be assigned to the agent group. +The combination of the Parent property and the Name property enables you to uniquely identify agent groups without having to refer to the group's globally unique identifier (GUID). ```yaml -Type: RoutingMethod +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Parent + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service where the new agent group will be hosted. +For example: `-Parent "service:ApplicationServer:atl-cs-001.litwareinc.com".` ```yaml -Type: SwitchParameter +Type: RgsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ParticipationPolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not agents are required to formally sign on to the system in order to receive phone calls intended for the group. +If ParticipationPolicy is set to Informal (the default value) sign-in is not required. +If ParticipationPolicy is set to Formal then sign-in is required. + +```yaml +Type: ParticipationPolicy Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -261,18 +265,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -RoutingMethod -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the method used to route new calls to agents. +The RoutingMethod must be set to one of the following values: + +LongestIdle - Calls are routed to the agent who has been idle (that is, not involved in a Skype for Business activity) for the longest period of time. + +RoundRobin - Calls are routed to the next agent on the list. + +Serial - Calls are always routed to the first agent on the list, and are only routed to other agents if this person is not available or does not answer within the allotted time. + +Parallel - Calls are routed to all agents at the same time, except for agents whose presence status indicates that they are in a call or otherwise unavailable. + +Attendant - Calls are routed to all agents at the same time, even if the agent's presence status indicates that he or she is in a call or otherwise unavailable. +The only exception occurs when an agent has set his or her presence to Do Not Disturb. + +The default routing method is Parallel. ```yaml -Type: SwitchParameter +Type: RoutingMethod Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -283,6 +301,8 @@ Accept wildcard characters: False ### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. @@ -291,7 +311,6 @@ Prompts you for confirmation before executing the command. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -302,6 +321,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. @@ -310,7 +331,6 @@ Describes what would happen if you executed the command without actually executi Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -324,13 +344,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None New-CsRgsAgentGroup does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Rgs.Management.WritableSettings.AgentGroup New-CsRgsAgentGroup creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.AgentGroup object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsRgsAnswer.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsAnswer.md similarity index 91% rename from skype/skype-ps/skype/New-CsRgsAnswer.md rename to skype/skype-ps/SkypeForBusiness/New-CsRgsAnswer.md index 446e74549c..292a521822 100644 --- a/skype/skype-ps/skype/New-CsRgsAnswer.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsAnswer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsanswer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsRgsAnswer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsanswer +schema: 2.0.0 +title: New-CsRgsAnswer --- # New-CsRgsAnswer @@ -51,7 +52,7 @@ In that case, you will need to create a new instance of the Response Group answe ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $w = New-CsRgsPrompt -TextToSpeechPrompt "Please hold while we transfer your call." @@ -79,6 +80,9 @@ For details, see the New-CsRgsQuestion help topic. ## PARAMETERS ### -Action + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the action to be taken any time a caller provides this answer. The Action parameter must be specified using an object reference created by using the New-CsRgsCallAction cmdlet. For details, see the Examples section in this topic. @@ -86,8 +90,7 @@ For details, see the Examples section in this topic. ```yaml Type: CallAction Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -97,6 +100,9 @@ Accept wildcard characters: False ``` ### -DtmfResponse + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the key on the telephone keypad to be pressed in order to match the answer. For example, if callers are told to press 1 for hardware, then DtmfResponse would be configured like this: `-DtmfResponse 1.` @@ -106,8 +112,7 @@ Each answer must have at least one of these two response types. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -117,14 +122,16 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name given to the Response Group answer. Names do not have to be unique. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,6 +141,9 @@ Accept wildcard characters: False ``` ### -VoiceResponseList + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Array of keywords callers can say that will match the answer. For example, if one option available to callers is "Hardware" then the VoiceResponseList property might be set to this: `-VoiceResponseList "Hardware".` Multiple keywords can be specified by using comma-separated values. @@ -143,8 +153,7 @@ Voice responses should not contain double quote marks, because that character is ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,13 +167,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None New-CsRgsAnswer does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Rgs.Management.WritableSettings.Answer Creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Answer object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsRgsCallAction.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsCallAction.md similarity index 92% rename from skype/skype-ps/skype/New-CsRgsCallAction.md rename to skype/skype-ps/SkypeForBusiness/New-CsRgsCallAction.md index 5e38c17538..0f9a7498a6 100644 --- a/skype/skype-ps/skype/New-CsRgsCallAction.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsCallAction.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgscallaction applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsRgsCallAction -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csrgscallaction +schema: 2.0.0 +title: New-CsRgsCallAction --- # New-CsRgsCallAction @@ -52,7 +53,7 @@ In addition, all the call actions except for TransferToQuestion can be used for ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $x = Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk Overflow" @@ -83,7 +84,7 @@ If the Help Desk queue "overflows" (that is, if it reaches the maximum number of Finally, the last command in the example calls Set-CsRgsQueue to write the changes to the actual instance of Help Desk Overflow queue on ApplicationServer:atl-cs-001.litwareinc.com. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $w = New-CsRgsPrompt -TextToSpeechPrompt "Please hold while we transfer your call." @@ -105,6 +106,9 @@ To do this, the new call action's Action property is set to TransferToPSTN and t ## PARAMETERS ### -Action + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the call action to be taken. The Action must be set to one of the following values: @@ -125,8 +129,7 @@ The Action must be specified each time you create a new call action; there is no ```yaml Type: Action Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -136,14 +139,16 @@ Accept wildcard characters: False ``` ### -Prompt + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompt to be played before the call action takes place. (For example, "Please hold while your call is transferred.") Prompts must be created by using the New-CsRgsPrompt cmdlet. ```yaml Type: Prompt Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -153,6 +158,9 @@ Accept wildcard characters: False ``` ### -Question + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Question to be asked if the Action has been set to TransferToQuestion. The question must be created by using the New-CsRgsQuestion cmdlet. @@ -161,8 +169,7 @@ This parameter is required if the Action has been set to TransferToQuestion. ```yaml Type: Question Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -172,6 +179,9 @@ Accept wildcard characters: False ``` ### -QueueID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Identity of the Response Group queue the call should be transferred to (assuming that the Action has been set to TransferToQueue). The QueueID is best specified by using Get-CsRgsQueue to retrieve the Identity of the relevant queue. @@ -180,8 +190,7 @@ This parameter is required if the Action is set to TransferToQueue. ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -191,6 +200,9 @@ Accept wildcard characters: False ``` ### -Uri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address, voice mail URI, or PSTN telephone number that the call should be transferred to. This parameter is required if the Action has been set to TransferToUri; TransferToVoiceMailUri; or TransferToPSTN. @@ -198,8 +210,7 @@ This parameter is required if the Action has been set to TransferToUri; Transfer ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -213,13 +224,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None New-CsRgsCallAction does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Rgs.Management.WritableSettings.CallAction New-CsRgsCallAction creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.CallAction object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsRgsHoliday.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsHoliday.md similarity index 92% rename from skype/skype-ps/skype/New-CsRgsHoliday.md rename to skype/skype-ps/SkypeForBusiness/New-CsRgsHoliday.md index 18b0630657..85172cdc34 100644 --- a/skype/skype-ps/skype/New-CsRgsHoliday.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsHoliday.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsholiday applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsRgsHoliday -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsholiday +schema: 2.0.0 +title: New-CsRgsHoliday --- # New-CsRgsHoliday @@ -56,7 +57,7 @@ Although a holiday set can (and typically does) hold multiple holidays, these ho ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $christmasDay = New-CsRgsHoliday -StartDate "12/25/2013 12:00 AM" -EndDate "12/26/2013 12:00 AM" -Name "Christmas Day" @@ -81,39 +82,42 @@ The final command then calls Set-CsRgsHolidaySet to write the changes (that is, ## PARAMETERS -### -Name -Unique name used to differentiate the holiday from other holidays. +### -EndDate + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Ending date for the holiday. +The format for the ending date depends on your Regional and Language Options. +For example, in the U.S. +an ending date of July 4, 2013 would be formatted like this: `-EndDate "7/5/2013 12:00 AM"`, meaning that the holiday ends at 12:00 A.M. +on July 5, 2013. + + ```yaml -Type: String +Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EndDate - -Ending date for the holiday. -The format for the ending date depends on your Regional and Language Options. -For example, in the U.S. -an ending date of July 4, 2013 would be formatted like this: `-EndDate "7/5/2013 12:00 AM"`, meaning that the holiday ends at 12:00 A.M. -on July 5, 2013. +### -Name +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Unique name used to differentiate the holiday from other holidays. ```yaml -Type: DateTime +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -122,6 +126,8 @@ Accept wildcard characters: False ### -StartDate +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Starting date for the holiday. The format for the starting date depends on your Regional and Language Options. For example, in the U.S. @@ -133,8 +139,7 @@ on July 4, 2013. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -148,13 +153,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None New-CsRgsHoliday does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Rgs.Management.WritableSettings.Holiday New-CsRgsHoliday creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Holiday object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsRgsHolidaySet.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsHolidaySet.md similarity index 89% rename from skype/skype-ps/skype/New-CsRgsHolidaySet.md rename to skype/skype-ps/SkypeForBusiness/New-CsRgsHolidaySet.md index d86a40c358..6f3f900ca4 100644 --- a/skype/skype-ps/skype/New-CsRgsHolidaySet.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsHolidaySet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsholidayset applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsRgsHolidaySet -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsholidayset +schema: 2.0.0 +title: New-CsRgsHolidaySet --- # New-CsRgsHolidaySet @@ -56,7 +57,7 @@ Note that, when you create a new holiday set, you must include at least one holi ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` -HolidayList($x, $y, $z) @@ -79,8 +80,28 @@ You can then include all those variable names as the parameter value passed to H ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -HolidayList +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + One or more holidays to be added to the holiday set. Holidays must be created by using the New-CsRgsHoliday cmdlet and then stored in an object reference. These object references are then passed to the Holidays parameter in order to add the holidays to the holiday set. @@ -97,8 +118,7 @@ English. ```yaml Type: System.Collections.ObjectModel.Collection`1[Microsoft.Rtc.Rgs.Management.WritableSettings.Holiday] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -107,77 +127,69 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -Unique name to be assigned to the holiday set. -The combination of the Parent property and the Name property enables you to uniquely identify holiday sets without having to refer to the set's globally unique identifier (GUID). +### -InMemory -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -Parent -Service where the new holiday set will be hosted. -For example: `-Parent "service:ApplicationServer:atl-cs-001.litwareinc.com".` ```yaml -Type: RgsIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory - -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -Name +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Unique name to be assigned to the holiday set. +The combination of the Parent property and the Name property enables you to uniquely identify holiday sets without having to refer to the set's globally unique identifier (GUID). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Parent + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service where the new holiday set will be hosted. +For example: `-Parent "service:ApplicationServer:atl-cs-001.litwareinc.com".` ```yaml -Type: SwitchParameter +Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + **Below Content Applies To:** Lync Server 2010 Prompts you for confirmation before running the cmdlet. @@ -194,7 +206,6 @@ Prompts you for confirmation before executing the command. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -205,6 +216,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. @@ -213,7 +226,6 @@ Describes what would happen if you executed the command without actually executi Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -227,13 +239,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None New-CsRgsHolidaySet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Rgs.Management.WritableSettings.HolidaySet New-CsRgsHolidaySet creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.HolidaySet object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsRgsHoursOfBusiness.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsHoursOfBusiness.md similarity index 85% rename from skype/skype-ps/skype/New-CsRgsHoursOfBusiness.md rename to skype/skype-ps/SkypeForBusiness/New-CsRgsHoursOfBusiness.md index 137037c180..84d623be97 100644 --- a/skype/skype-ps/skype/New-CsRgsHoursOfBusiness.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsHoursOfBusiness.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgshoursofbusiness applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsRgsHoursOfBusiness -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csrgshoursofbusiness +schema: 2.0.0 +title: New-CsRgsHoursOfBusiness --- # New-CsRgsHoursOfBusiness @@ -59,7 +60,7 @@ to Hours2. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsRgsHoursOfBusiness -Parent "service:ApplicationServer:atl-cs-001.litwareinc.com" -Name "Help Desk Business Hours" @@ -69,7 +70,7 @@ The command shown in Example 1 creates a new business hours set named Help Desk In this example, no business hours are configured for the set. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $weekday = New-CsRgsTimeRange -Name "Weekday Hours" -OpenTime "8:00" -CloseTime "18:00" @@ -90,49 +91,35 @@ to 6:00 P.M., and by using the time range variable $weekday. ## PARAMETERS -### -Name -Unique name to be assigned to the business hours set. -The combination of the Parent property and the Name property enables you to uniquely identify business hour sets without having to refer to the collection's globally unique identifier (GUID). +### -Custom + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True, the business hours can only be used by the specified workflow. +If set to False (the default value) the business hours can be shared among multiple workflows. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Parent -Service where the new business hours set will be hosted. -For example: `-Parent "service:ApplicationServer:atl-cs-001.litwareinc.com".` +### -Force -```yaml -Type: RgsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Custom -If set to True, the business hours can only be used by the specified workflow. -If set to False (the default value) the business hours can be shared among multiple workflows. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,22 +128,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MondayHours1 -First set of opening and closing times for Monday. +### -FridayHours1 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +First set of opening and closing times for Friday. If your organization is open from, say, 9:00 A.M. to 5:00 P.M. -every Monday then you will only need to configure a single time range. +every Friday then you will only need to configure a single time range. However, if your organization is open from 8:00 A.M. to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M., you will need to create two time ranges for Monday. +to 5:00 P.M., you will need to create two time ranges for Friday. -If your organization is closed on Mondays, then do not configure a value for either MondayHours1 or MondayHours2. +If your organization is closed on Fridays, then do not configure a value for either FridayHours1 or FridayHours2. ```yaml Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -165,21 +154,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MondayHours2 -Second set of opening and closing times for Monday. +### -FridayHours2 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Second set of opening and closing times for Friday. If your organization is open from, say, 9:00 A.M. to 5:00 P.M. -every Monday then you will only need to configure a single time range. +every Friday then you will only need to configure a single time range. However, if your organization is open from 8:00 A.M. to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M. -you will need to create two time ranges for Monday. +to 5:00 P.M., you will need to create two time ranges for Friday. ```yaml Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -188,22 +178,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TuesdayHours1 -First set of opening and closing times for Tuesday. -If your organization is open from, say, 9:00 A.M. -to 5:00 P.M. -every Tuesday then you will only need to configure a single time range. -However, if your organization is open from 8:00 A.M. -to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M., you will need to create two time ranges for Tuesday. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + -If your organization is closed on Tuesdays, then do not configure a value for either TuesdayHours1 or TuesdayHours2. ```yaml -Type: TimeRange +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -212,20 +199,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TuesdayHours2 -Second set of opening and closing times for Tuesday. +### -MondayHours1 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +First set of opening and closing times for Monday. If your organization is open from, say, 9:00 A.M. to 5:00 P.M. -every Tuesday then you will only need to configure a single time range. +every Monday then you will only need to configure a single time range. However, if your organization is open from 8:00 A.M. to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M., you will need to create two time ranges for Tuesday. +to 5:00 P.M., you will need to create two time ranges for Monday. + +If your organization is closed on Mondays, then do not configure a value for either MondayHours1 or MondayHours2. ```yaml Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -234,22 +225,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WednesdayHours1 -First set of opening and closing times for Wednesday. +### -MondayHours2 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Second set of opening and closing times for Monday. If your organization is open from, say, 9:00 A.M. to 5:00 P.M. -every Wednesday then you will only need to configure a single time range. +every Monday then you will only need to configure a single time range. However, if your organization is open from 8:00 A.M. to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M., you will need to create two time ranges for Wednesday. - -If your organization is closed on Wednesday, then do not configure a value for either WednesdayHours1 or WednesdayHours2. +to 5:00 P.M. +you will need to create two time ranges for Monday. ```yaml Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -258,44 +250,62 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WednesdayHours2 -Second set of opening and closing times for Wednesday. -If your organization is open from, say, 9:00 A.M. -to 5:00 P.M. -every Wednesday then you will only need to configure a single time range. -However, if your organization is open from 8:00 A.M. -to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M., you will need to create two time ranges for Wednesday. +### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique name to be assigned to the business hours set. +The combination of the Parent property and the Name property enables you to uniquely identify business hour sets without having to refer to the collection's globally unique identifier (GUID). ```yaml -Type: TimeRange +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ThursdayHours1 -First set of opening and closing times for Thursday. +### -Parent + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service where the new business hours set will be hosted. +For example: `-Parent "service:ApplicationServer:atl-cs-001.litwareinc.com".` + +```yaml +Type: RgsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SaturdayHours1 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +First set of opening and closing times for Saturday. If your organization is open from, say, 9:00 A.M. to 5:00 P.M. -every Thursday then you will only need to configure a single time range. +every Saturday then you will only need to configure a single time range. However, if your organization is open from 8:00 A.M. to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M., you will need to create two time ranges for Thursday. +to 5:00 P.M., you will need to create two time ranges for Saturday. -If your organization is closed on Thursdays, then do not configure a value for either ThursdayHours1 or ThursdayHours2. +If your organization is closed on Saturdays, then do not configure a value for either SaturdayHours1 or SaturdayHours2. ```yaml Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -304,20 +314,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ThursdayHours2 -Second set of opening and closing times for Thursday. +### -SaturdayHours2 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Second set of opening and closing times for Saturday. If your organization is open from, say, 9:00 A.M. to 5:00 P.M. -every Thursday then you will only need to configure a single time range. +every Saturday then you will only need to configure a single time range. However, if your organization is open from 8:00 A.M. to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M., you will need to create two time ranges for Thursday. +to 5:00 P.M., you will need to create two time ranges for Saturday. ```yaml Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -326,22 +338,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FridayHours1 -First set of opening and closing times for Friday. +### -SundayHours1 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +First set of opening and closing times for Sunday. If your organization is open from, say, 9:00 A.M. to 5:00 P.M. -every Friday then you will only need to configure a single time range. -However, if your organization is open from 8:00 A.M. -to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M., you will need to create two time ranges for Friday. +every Sunday then you will only need to configure a single time range. +However, if your organization is open from 8:00 AM to noon, closes for an hour lunch, then is open again from 1:00 P.M. +to 5:00 P.M., you will need to create two time ranges for Sunday. -If your organization is closed on Fridays, then do not configure a value for either FridayHours1 or FridayHours2. +If your organization is closed on Sundays, then do not configure a value for either SundayHours1 or SundayHours2. ```yaml Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -350,20 +363,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FridayHours2 -Second set of opening and closing times for Friday. +### -SundayHours2 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Second set of opening and closing times for Sunday. If your organization is open from, say, 9:00 A.M. to 5:00 P.M. -every Friday then you will only need to configure a single time range. +every Sunday then you will only need to configure a single time range. However, if your organization is open from 8:00 A.M. to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M., you will need to create two time ranges for Friday. +to 5:00 P.M. +you will need to create two time ranges for Sunday. ```yaml Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -372,22 +388,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SaturdayHours1 -First set of opening and closing times for Saturday. +### -ThursdayHours1 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +First set of opening and closing times for Thursday. If your organization is open from, say, 9:00 A.M. to 5:00 P.M. -every Saturday then you will only need to configure a single time range. +every Thursday then you will only need to configure a single time range. However, if your organization is open from 8:00 A.M. to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M., you will need to create two time ranges for Saturday. +to 5:00 P.M., you will need to create two time ranges for Thursday. -If your organization is closed on Saturdays, then do not configure a value for either SaturdayHours1 or SaturdayHours2. +If your organization is closed on Thursdays, then do not configure a value for either ThursdayHours1 or ThursdayHours2. ```yaml Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -396,20 +414,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SaturdayHours2 -Second set of opening and closing times for Saturday. +### -ThursdayHours2 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Second set of opening and closing times for Thursday. If your organization is open from, say, 9:00 A.M. to 5:00 P.M. -every Saturday then you will only need to configure a single time range. +every Thursday then you will only need to configure a single time range. However, if your organization is open from 8:00 A.M. to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M., you will need to create two time ranges for Saturday. +to 5:00 P.M., you will need to create two time ranges for Thursday. ```yaml Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -418,21 +438,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SundayHours1 -First set of opening and closing times for Sunday. +### -TuesdayHours1 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +First set of opening and closing times for Tuesday. If your organization is open from, say, 9:00 A.M. to 5:00 P.M. -every Sunday then you will only need to configure a single time range. -However, if your organization is open from 8:00 AM to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M., you will need to create two time ranges for Sunday. +every Tuesday then you will only need to configure a single time range. +However, if your organization is open from 8:00 A.M. +to noon, closes for an hour lunch, then is open again from 1:00 P.M. +to 5:00 P.M., you will need to create two time ranges for Tuesday. -If your organization is closed on Sundays, then do not configure a value for either SundayHours1 or SundayHours2. +If your organization is closed on Tuesdays, then do not configure a value for either TuesdayHours1 or TuesdayHours2. ```yaml Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -441,21 +464,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SundayHours2 -Second set of opening and closing times for Sunday. +### -TuesdayHours2 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Second set of opening and closing times for Tuesday. If your organization is open from, say, 9:00 A.M. to 5:00 P.M. -every Sunday then you will only need to configure a single time range. +every Tuesday then you will only need to configure a single time range. However, if your organization is open from 8:00 A.M. to noon, closes for an hour lunch, then is open again from 1:00 P.M. -to 5:00 P.M. -you will need to create two time ranges for Sunday. +to 5:00 P.M., you will need to create two time ranges for Tuesday. ```yaml Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -464,18 +488,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -WednesdayHours1 -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +First set of opening and closing times for Wednesday. +If your organization is open from, say, 9:00 A.M. +to 5:00 P.M. +every Wednesday then you will only need to configure a single time range. +However, if your organization is open from 8:00 A.M. +to noon, closes for an hour lunch, then is open again from 1:00 P.M. +to 5:00 P.M., you will need to create two time ranges for Wednesday. +If your organization is closed on Wednesday, then do not configure a value for either WednesdayHours1 or WednesdayHours2. ```yaml -Type: SwitchParameter +Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -484,14 +514,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -WednesdayHours2 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Second set of opening and closing times for Wednesday. +If your organization is open from, say, 9:00 A.M. +to 5:00 P.M. +every Wednesday then you will only need to configure a single time range. +However, if your organization is open from 8:00 A.M. +to noon, closes for an hour lunch, then is open again from 1:00 P.M. +to 5:00 P.M., you will need to create two time ranges for Wednesday. ```yaml -Type: SwitchParameter +Type: TimeRange Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -502,6 +540,8 @@ Accept wildcard characters: False ### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. @@ -510,7 +550,6 @@ Prompts you for confirmation before executing the command. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -521,6 +560,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. @@ -529,7 +570,6 @@ Describes what would happen if you executed the command without actually executi Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -543,13 +583,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None New-CsRgsHoursOfBusiness does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Rgs.Management.WritableSettings.BusinessHours Creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.BusinessHours object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsRgsPrompt.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsPrompt.md similarity index 94% rename from skype/skype-ps/skype/New-CsRgsPrompt.md rename to skype/skype-ps/SkypeForBusiness/New-CsRgsPrompt.md index 663c604f09..8b26c8a938 100644 --- a/skype/skype-ps/skype/New-CsRgsPrompt.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsPrompt.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsprompt applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsRgsPrompt -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsprompt +schema: 2.0.0 +title: New-CsRgsPrompt --- # New-CsRgsPrompt @@ -49,7 +50,7 @@ After new prompts are created in memory, the corresponding object reference is t ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $queue = Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" @@ -69,7 +70,7 @@ The final command in the example uses New-CsRgsCallAction to create a new Respon When creating the call action, the object reference $prompt (which contains the newly-created workflow prompt) is used as the value for the Prompt parameter; the object reference $queue is likewise used in conjunction with the QueueID parameter. After running this command, the new call action and its new workflow prompt are ready to be added to a Response Group workflow. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $queue = Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk Queue" @@ -92,15 +93,17 @@ Please hold." ## PARAMETERS -### -TextToSpeechPrompt -Text-to-speech (TTS) prompt to be read when the workflow is activated. -The TTS prompt, which is used only if an audio file is not specified, can contain a maximum of 4096 characters. +### -AudioFilePrompt + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Audio file to be played when the workflow is activated. +The audio file must be imported by using the Import-CsRgsAudioFile cmdlet. ```yaml -Type: String +Type: AudioFile Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -109,15 +112,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AudioFilePrompt -Audio file to be played when the workflow is activated. -The audio file must be imported by using the Import-CsRgsAudioFile cmdlet. +### -TextToSpeechPrompt + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Text-to-speech (TTS) prompt to be read when the workflow is activated. +The TTS prompt, which is used only if an audio file is not specified, can contain a maximum of 4096 characters. ```yaml -Type: AudioFile +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,13 +136,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None New-CsRgsPrompt does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableSettings.Prompt New-CsRgsPrompt creates instances of the Microsoft.Rtc.Management.WritableSettings.Prompt object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsRgsQuestion.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsQuestion.md similarity index 90% rename from skype/skype-ps/skype/New-CsRgsQuestion.md rename to skype/skype-ps/SkypeForBusiness/New-CsRgsQuestion.md index 9a30312ad9..7a7e26c6e4 100644 --- a/skype/skype-ps/skype/New-CsRgsQuestion.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsQuestion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsquestion applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsRgsQuestion -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsquestion +schema: 2.0.0 +title: New-CsRgsQuestion --- # New-CsRgsQuestion @@ -46,7 +47,7 @@ For example, if the caller in the original scenario presses 3, the prompt might ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $new = Get-CsRgsQueue -Identity service:ApplicationServer:pool0.litwareinc.com -Name "New Service Request" @@ -87,24 +88,10 @@ In addition to the Prompt parameter, the AnswerList parameter is used to indicat ## PARAMETERS -### -Prompt -Question to be asked of the caller. -Prompts must be created by using the New-CsRgsPrompt cmdlet. - -```yaml -Type: Prompt -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AnswerList -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AnswerList Array of valid answers to the question. For example, a help desk question might have answers such as Hardware Support, Software Installation, and Network Connections. Answers must be created by using the New-CsRgsAnswer cmdlet. @@ -112,8 +99,7 @@ Answers must be created by using the New-CsRgsAnswer cmdlet. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -123,6 +109,9 @@ Accept wildcard characters: False ``` ### -InvalidAnswerPrompt + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Response to be issued in case the caller selects an invalid answer. The InvalidAnswerPrompt must be created by using the New-CsRgsPrompt cmdlet. Note that after the playing the InvalidAnswerPrompt the application will then repeat the original prompt. @@ -130,8 +119,7 @@ Note that after the playing the InvalidAnswerPrompt the application will then re ```yaml Type: Prompt Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,14 +129,16 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Identifier for the question. Question names, which do not have to be unique, are limited to a maximum of 128 characters. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,14 +148,16 @@ Accept wildcard characters: False ``` ### -NoAnswerPrompt + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Response to be issued in case the caller does not respond to the initial prompt. The NoAnswerPrompt must be created by using the New-CsRgsPrompt cmdlet. ```yaml Type: Prompt Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -174,18 +166,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Prompt + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Question to be asked of the caller. +Prompts must be created by using the New-CsRgsPrompt cmdlet. + +```yaml +Type: Prompt +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 (https://go.microsoft.com/fwlink/?LinkID=113216).` ## INPUTS -### -None. +### None New-CsRgsQuestion does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WriteableSettings.Question New-CsRgsQuestion creates instances of the Microsoft.Rtc.Management.WriteableSettings.Question object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsRgsQueue.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsQueue.md similarity index 83% rename from skype/skype-ps/skype/New-CsRgsQueue.md rename to skype/skype-ps/SkypeForBusiness/New-CsRgsQueue.md index 119cd58947..35c593b182 100644 --- a/skype/skype-ps/skype/New-CsRgsQueue.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsQueue.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsqueue applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsRgsQueue -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsqueue +schema: 2.0.0 +title: New-CsRgsQueue --- # New-CsRgsQueue @@ -43,7 +44,7 @@ The New-CsRgsQueue cmdlet provides an easy way for administrators to create new ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $x = New-CsRgsCallAction -Action TransferToVoicemailUri -Uri "sip:+14255551298@litwareinc.com" @@ -61,34 +62,22 @@ In addition to specifying the OverflowAction, this command also configures value ## PARAMETERS -### -Parent -Service where the new queue will be hosted. -For example: `-Parent "service:ApplicationServer:atl-cs-001.litwareinc.com".` +### -AgentGroupIDList -```yaml -Type: RgsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Identity of the Response Group agent groups to be added to the queue. +The agent group Identities can be retrieved using the Get-CsRgsAgentGroup cmdlet. +For details, see the Examples section in this topic. -### -Name -Unique name to be assigned to the queue. -The combination of the Parent property and the Name property enables you to uniquely identify Response Group queues without having to refer to the queue's globally unique identifier (GUID). +If a call is routed to a queue that has no agent groups assigned to it (or has only been assigned agent groups that do not have any agents) then that call will automatically be disconnected. ```yaml -Type: String +Type: System.Collections.ObjectModel.Collection`1[Microsoft.Rtc.Rgs.Management.RgsIdentity] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -96,13 +85,15 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to provide additional information about the Response Group queue. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -111,15 +102,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowAction -Action to be taken if the overflow threshold is reached. -The OverflowAction must be created using the New-CsRgsCallAction cmdlet. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: CallAction +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,21 +120,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowCandidate -Indicates which call will be acted upon should the overflow threshold be reached. -The OverflowCandidate property must be set to one of the following two values: +### -InMemory -NewestCall +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. -OldestCall -The default value is NewestCall. ```yaml -Type: OverflowCandidate +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -151,33 +141,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverflowThreshold -Number of simultaneous calls that can be in the queue at any one time before the overflow action is triggered. -The OverflowThreshold can be any integer value between 0 and 1000, inclusive. -The default value is Null, meaning that an unlimited number of calls can be in the queue at any given time. +### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique name to be assigned to the queue. +The combination of the Parent property and the Name property enables you to uniquely identify Response Group queues without having to refer to the queue's globally unique identifier (GUID). ```yaml -Type: Int16 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutAction -Action to be taken if the timeout threshold is reached. -The TimeoutAction must be created using the New-CsRgsCallAction cmdlet. +### -OverflowAction + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Action to be taken if the overflow threshold is reached. +The OverflowAction must be created using the New-CsRgsCallAction cmdlet. ```yaml Type: CallAction Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -186,17 +179,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeoutThreshold -Amount of time (in seconds) that a call can be in the queue before that call times out. -At that point, the system will take the action specified by the TimeoutAction parameter. +### -OverflowCandidate -The timeout threshold can be any integer value between 10 and 65535 seconds (approximately 18 hours), inclusive; the default value is null, meaning that the queue never times out. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates which call will be acted upon should the overflow threshold be reached. +The OverflowCandidate property must be set to one of the following two values: + +NewestCall + +OldestCall + +The default value is NewestCall. ```yaml -Type: Int32 +Type: OverflowCandidate Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -205,14 +204,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -OverflowThreshold + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Number of simultaneous calls that can be in the queue at any one time before the overflow action is triggered. +The OverflowThreshold can be any integer value between 0 and 1000, inclusive. +The default value is Null, meaning that an unlimited number of calls can be in the queue at any given time. ```yaml -Type: SwitchParameter +Type: Int16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -221,18 +224,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -Parent -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Service where the new queue will be hosted. +For example: `-Parent "service:ApplicationServer:atl-cs-001.litwareinc.com".` + +```yaml +Type: RgsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -TimeoutAction + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Action to be taken if the timeout threshold is reached. +The TimeoutAction must be created using the New-CsRgsCallAction cmdlet. ```yaml -Type: SwitchParameter +Type: CallAction Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -241,18 +262,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AgentGroupIDList -Identity of the Response Group agent groups to be added to the queue. -The agent group Identities can be retrieved using the Get-CsRgsAgentGroup cmdlet. -For details, see the Examples section in this topic. +### -TimeoutThreshold -If a call is routed to a queue that has no agent groups assigned to it (or has only been assigned agent groups that do not have any agents) then that call will automatically be disconnected. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Amount of time (in seconds) that a call can be in the queue before that call times out. +At that point, the system will take the action specified by the TimeoutAction parameter. + +The timeout threshold can be any integer value between 10 and 65535 seconds (approximately 18 hours), inclusive; the default value is null, meaning that the queue never times out. ```yaml -Type: System.Collections.ObjectModel.Collection`1[Microsoft.Rtc.Rgs.Management.RgsIdentity] +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -263,6 +285,8 @@ Accept wildcard characters: False ### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. @@ -271,7 +295,6 @@ Prompts you for confirmation before executing the command. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -282,6 +305,8 @@ Accept wildcard characters: False ### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. @@ -290,7 +315,6 @@ Describes what would happen if you executed the command without actually executi Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -304,13 +328,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None New-CsRgsQueue does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Rgs.Management.WritableSettings.Queue New-CsRgsQueue creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Queue object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsRgsTimeRange.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsTimeRange.md similarity index 92% rename from skype/skype-ps/skype/New-CsRgsTimeRange.md rename to skype/skype-ps/SkypeForBusiness/New-CsRgsTimeRange.md index 7d567a2ff5..39efc7ea13 100644 --- a/skype/skype-ps/skype/New-CsRgsTimeRange.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsTimeRange.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgstimerange applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsRgsTimeRange -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csrgstimerange +schema: 2.0.0 +title: New-CsRgsTimeRange --- # New-CsRgsTimeRange @@ -53,7 +54,7 @@ You must also use New-CsRgsTimeRange to specify opening and closing hours any ti ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $sundayHours = New-CsRgsTimeRange -Name "Sunday hours" -OpenTime "08:30" -CloseTime "13:30" @@ -80,7 +81,7 @@ Note that if you fail to call Set-CsRgsHoursOfBusiness, the newly created time r If that happens, then the Help Desk Hours business hours collection will not be updated. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $sundayHours = New-CsRgsTimeRange -Name "Sunday hours" -OpenTime "08:30" -CloseTime "13:30" @@ -102,6 +103,9 @@ In this command, the variable $sundayHours specifies the time range for the prop ## PARAMETERS ### -CloseTime + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Time of day when business hours end. CloseTime should be formatted using a 24-hour clock; for example, to indicate that business hours end at 9:00 P.M. use this format: `-CloseTime "21:00".` @@ -109,8 +113,7 @@ use this format: `-CloseTime "21:00".` ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -119,35 +122,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OpenTime -Time of day when business hours begin. -OpenTime should be formatted using a 24-hour clock; for example, to indicate that business hours begin at 1:30 P.M. -use this format: `-OpenTime "13:30".` +### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the time range being created. +The Name is limited to a maximum of 128 characters. ```yaml -Type: TimeSpan +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -Unique identifier for the time range being created. -The Name is limited to a maximum of 128 characters. +### -OpenTime + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Time of day when business hours begin. +OpenTime should be formatted using a 24-hour clock; for example, to indicate that business hours begin at 1:30 P.M. +use this format: `-OpenTime "13:30".` ```yaml -Type: String +Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -159,13 +166,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None New-CsRgsTimeRange does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Rgs.Management.WritableSettings.TimeRange New-CsRgsTimeRange creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.TimeRange object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsRgsWorkflow.md b/skype/skype-ps/SkypeForBusiness/New-CsRgsWorkflow.md similarity index 84% rename from skype/skype-ps/skype/New-CsRgsWorkflow.md rename to skype/skype-ps/SkypeForBusiness/New-CsRgsWorkflow.md index dd48bcbd80..f0f8f17943 100644 --- a/skype/skype-ps/skype/New-CsRgsWorkflow.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRgsWorkflow.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsworkflow applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsRgsWorkflow -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csrgsworkflow +schema: 2.0.0 +title: New-CsRgsWorkflow --- # New-CsRgsWorkflow @@ -47,7 +48,7 @@ New workflows are created by using the New-CsRgsWorkflow cmdlet. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsRgsWorkflow -Parent service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" -PrimaryUri "sip:helpdesk@litwareinc.com" @@ -57,7 +58,7 @@ Example 1 creates a new workflow on the service ApplicationServer:atl-cs-001.lit This workflow is given the Name Help Desk and is assigned a primary URI of sip:helpdesk@litwareinc.com. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $prompt = New-CsRgsPrompt -TextToSpeechPrompt "Welcome to the help desk." @@ -81,59 +82,10 @@ This command sets the PrimaryUri to sip:helpdesk@litwareinc.com and sets the val ## PARAMETERS -### -Name -Unique name to be assigned to the workflow. -The combination of the Parent property and the Name property enables you to uniquely identify workflows without having to refer to the workflow's globally unique identifier (GUID). - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Parent -Service where the new workflow will be hosted. -For example: `-Parent "service:ApplicationServer:atl-cs-001.litwareinc.com".` - -```yaml -Type: RgsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PrimaryUri -SIP address for the workflow. -For example: `-PrimaryUri "sip:helpdesk@litwareinc.com".` -The PrimaryUri must begin with the "sip:" prefix. - -```yaml -Type: Uri -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Active -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Active If set to True, this means that the workflow is active and available to take phone calls. If set to False (the default value), the workflow is not available to take phone calls. @@ -144,8 +96,7 @@ If Active is set to False (or not configured) then no validation will take place ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -155,14 +106,16 @@ Accept wildcard characters: False ``` ### -Anonymous + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If set to True, the identities of individual Response Group agents will be masked any time these agents answer a call. If set to False (the default value), agent identities will be available to callers. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -172,14 +125,16 @@ Accept wildcard characters: False ``` ### -BusinessHoursID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Days of the week and times of the day that workflow agents are available to answer calls. The business hour Identities can be retrieved by using the Get-CsRgsHoursOfBusiness cmdlet. ```yaml Type: RgsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -189,14 +144,16 @@ Accept wildcard characters: False ``` ### -CustomMusicOnHoldFile + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents custom music to be played when callers are placed on hold. (If not defined, callers will hear the default music when placed on hold.) Custom music must be imported by using the Import-CsRgsAudioFile cmdlet. ```yaml Type: AudioFile Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -206,6 +163,9 @@ Accept wildcard characters: False ``` ### -DefaultAction + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the action to be taken when a workflow is opened during business hours. DefaultAction must be defined by using the New-CsRgsCallAction cmdlet, and must either direct the call to a queue or to a question. The DefaultAction parameter is mandatory if the workflow is active, but can be omitted if the workflow is inactive. @@ -213,8 +173,7 @@ The DefaultAction parameter is mandatory if the workflow is active, but can be o ```yaml Type: CallAction Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,6 +184,8 @@ Accept wildcard characters: False ### -Description +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to add additional information about a Response Group workflow. For example, the Description might include contact information for the owner of the workflow. This description appears in the Skype for Business contact card for the workflow. @@ -234,8 +195,7 @@ This description appears in the Skype for Business contact card for the workflow ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -246,6 +206,8 @@ Accept wildcard characters: False ### -DisplayNumber +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Phone number for the workflow as displayed in Skype for Business. The DisplayNumber can be formatted any way you want; for example: @@ -260,8 +222,7 @@ The DisplayNumber can be formatted any way you want; for example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -271,14 +232,34 @@ Accept wildcard characters: False ``` ### -EnabledForFederation + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the workflow is available to users from a federated domain. If set to False, only users within your organization will have access to the workflow. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -288,14 +269,56 @@ Accept wildcard characters: False ``` ### -HolidayAction + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Action to be taken if a call is received on a holiday. The HolidayAction must be defined by using the New-CsRgsCallAction cmdlet. ```yaml Type: CallAction Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -HolidaySetIDList + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Represents days when workflow agents are not available to answer calls. +The holiday set Identities can be retrieved by using the Get-CsRgsHolidaySet cmdlet. + +```yaml +Type: System.Collections.ObjectModel.Collection`1[Microsoft.Rtc.Rgs.Management.RgsIdentity] +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -306,6 +329,8 @@ Accept wildcard characters: False ### -Language +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Language that is used to read workflow text-to-speech prompts. The language parameter is optional as long as the operating system is using one of the supported languages shown in the list below. (Note that supported speech languages represent a subset of the languages that can be used on the operating system.) @@ -381,8 +406,7 @@ For example: `-Language "nl-NL".` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -392,6 +416,9 @@ Accept wildcard characters: False ``` ### -LineUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Phone number for the workflow. The line Uniform Resource Identifier (URI) must be specified by using the following format: the TEL: prefix followed by a plus sign, followed by the country/region calling code, area code, and phone number (using only digits: no blank spaces, periods, or hyphens). For example: `-LineUri "TEL:+14255551219"` @@ -399,8 +426,7 @@ For example: `-LineUri "TEL:+14255551219"` ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -409,15 +435,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NonBusinessHoursAction -Action to be taken if a call is received outside the workflow's business hours. -The NonBusinessHoursAction must be defined by using the New-CsRgsCallAction cmdlet. +### -Managed + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True indicates that the workflow will be managed by one or more users. +Those users can be specified by using the ManagedByUri parameter. ```yaml -Type: CallAction +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -426,15 +454,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TimeZone -Time zone information used when determining holidays and business hours. -For example: `-TimeZone "Pacific Standard Time"` +### -ManagersByUri + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP addresses of the user (or users) who will manage the workflow. +For example: + +`-ManagedByUri "sip:kenmyer@litwareinc.com"` + +To specify multiple managers separate the manager SIP addresses by using commas: + +`-ManagedByUri "sip:kenmyer@litwareinc.com", "sip:pilar@litwareinc.com"` ```yaml -Type: String +Type: System.Collections.ObjectModel.Collection`1[System.Uri] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -443,34 +479,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique name to be assigned to the workflow. +The combination of the Parent property and the Name property enables you to uniquely identify workflows without having to refer to the workflow's globally unique identifier (GUID). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory - -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -NonBusinessHoursAction +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Action to be taken if a call is received outside the workflow's business hours. +The NonBusinessHoursAction must be defined by using the New-CsRgsCallAction cmdlet. ```yaml -Type: SwitchParameter +Type: CallAction Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -479,53 +517,56 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm - -Prompts you for confirmation before executing the command. +### -Parent +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Service where the new workflow will be hosted. +For example: `-Parent "service:ApplicationServer:atl-cs-001.litwareinc.com".` ```yaml -Type: SwitchParameter +Type: RgsIdentity Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -HolidaySetIDList -Represents days when workflow agents are not available to answer calls. -The holiday set Identities can be retrieved by using the Get-CsRgsHolidaySet cmdlet. +### -PrimaryUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the workflow. +For example: `-PrimaryUri "sip:helpdesk@litwareinc.com".` +The PrimaryUri must begin with the "sip:" prefix. ```yaml -Type: System.Collections.ObjectModel.Collection`1[Microsoft.Rtc.Rgs.Management.RgsIdentity] +Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf - -Describes what would happen if you executed the command without actually executing the command. +### -TimeZone +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Time zone information used when determining holidays and business hours. +For example: `-TimeZone "Pacific Standard Time"` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -534,15 +575,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Managed -When set to True indicates that the workflow will be managed by one or more users. -Those users can be specified by using the ManagedByUri parameter. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + + ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -551,21 +595,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ManagersByUri -SIP addresses of the user (or users) who will manage the workflow. -For example: +### -WhatIf -`-ManagedByUri "sip:kenmyer@litwareinc.com"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. -To specify multiple managers separate the manager SIP addresses by using commas: -`-ManagedByUri "sip:kenmyer@litwareinc.com", "sip:pilar@litwareinc.com"` ```yaml -Type: System.Collections.ObjectModel.Collection`1[System.Uri] +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -579,13 +620,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsRgsWorkflow cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Rgs.Management.WritableSettings.Workflow The New-CsRgsWorkflow cmdlet creates new instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Workflow object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsRoutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsRoutingConfiguration.md similarity index 85% rename from skype/skype-ps/skype/New-CsRoutingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsRoutingConfiguration.md index b71bf8d54b..cd236c07f6 100644 --- a/skype/skype-ps/skype/New-CsRoutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsRoutingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsRoutingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csroutingconfiguration +schema: 2.0.0 +title: New-CsRoutingConfiguration --- # New-CsRoutingConfiguration @@ -45,7 +46,7 @@ This command will create an object only in memory that contains a default list o ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $x = New-CsRoutingConfiguration -Identity global -InMemory @@ -57,37 +58,38 @@ Any other use of this cmdlet will return an error. ## PARAMETERS -### -Identity -The scope of the routing configuration. -This value must be Global. +### -CallViaWorkCallerId + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +The number the system will display for the callback portion of an external call. +External calls first connect the user making the call by calling a specified number (typically the user's desk phone), once connected to the user, the system dials the outside number. +The CallViaWorkCallerId parameter specifies the number that will be displayed during the first leg, or callback segment, of the call via work external call. +For more information, see New-CsCallViaWorkPolicy. ```yaml -Type: XdsIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Route - -A list of all voice routes (Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route objects) defined for the Skype for Business Server deployment. - -You can create voice route objects by using the New-CsVoiceRoute cmdlet. -That is the recommended way of adding voice routes to this list. +### -EnableLocationBasedRouting +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +When set to True, voice routing will be managed by taking into account the location of both the user placing the call and the user receiving the call. +The default value is False. ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -97,13 +99,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -112,8 +116,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The scope of the routing configuration. +This value must be Global. + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. @@ -122,8 +147,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,14 +156,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Route + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A list of all voice routes (Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route objects) defined for the Skype for Business Server deployment. + +You can create voice route objects by using the New-CsVoiceRoute cmdlet. +That is the recommended way of adding voice routes to this list. + + ```yaml -Type: SwitchParameter +Type: PSListModifier Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -149,13 +180,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -164,34 +197,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallViaWorkCallerId -The number the system will display for the callback portion of an external call. -External calls first connect the user making the call by calling a specified number (typically the user's desk phone), once connected to the user, the system dials the outside number. -The CallViaWorkCallerId parameter specifies the number that will be displayed during the first leg, or callback segment, of the call via work external call. -For more information, see New-CsCallViaWorkPolicy. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableLocationBasedRouting -When set to True, voice routing will be managed by taking into account the location of both the user placing the call and the user receiving the call. -The default value is False. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -205,12 +220,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.PstnRoutingSettings Can create an in-memory object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.PstnRoutingSettings. ## NOTES diff --git a/skype/skype-ps/skype/New-CsServerApplication.md b/skype/skype-ps/SkypeForBusiness/New-CsServerApplication.md similarity index 85% rename from skype/skype-ps/skype/New-CsServerApplication.md rename to skype/skype-ps/SkypeForBusiness/New-CsServerApplication.md index 00a0588174..8ff4b30f9d 100644 --- a/skype/skype-ps/skype/New-CsServerApplication.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsServerApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csserverapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsServerApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csserverapplication +schema: 2.0.0 +title: New-CsServerApplication --- # New-CsServerApplication @@ -45,7 +46,7 @@ The New-CsServerApplication cmdlet provides a way for administrators to configur ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsServerApplication -Identity "EdgeServer:atl-edge-001.litwareinc.com/EdgeMonitor" -Uri http://www.litwareinc.com/edgemonitor -Critical $False @@ -54,7 +55,7 @@ New-CsServerApplication -Identity "EdgeServer:atl-edge-001.litwareinc.com/EdgeMo Example 1 creates a new server application with the Identity EdgeServer:atl-edge-001.litwareinc.com/EdgeMonitor. In addition to specifying the Identity, the parameters Uri and Critical are included; these parameters are used to specify the application URI and to indicate the application is not considered critical. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsServerApplication -Identity "EdgeServer:atl-edge-001.litwareinc.com/EdgeMonitor" -InMemory @@ -78,94 +79,99 @@ If you do not call the Set-CsServerApplication cmdlet, no application will be co ## PARAMETERS -### -Identity -Unique identifier for the server application to be created. -Server application Identities are composed of the service where the application is hosted plus the application name. -For example, the server application named QoEAgent might have an Identity similar to this: service:Registrar:atl-cs-001.litwareinc.com/QoEAgent. +### -Critical + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True, then Skype for Business Server will not start unless the application in question can be started. +If False, then Skype for Business Server will start regardless of whether or not the application can be started. +If this parameter is not specified the Critical property will be set to True. + + ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Parent - -Specifies the service that will host the new server application. -If you use the Identity parameter, then you do not need to use either the Parent or the Name parameters; that's because the application Identity combines the values of the Parent and Name properties. -However, you can omit the Identity parameter by using the Parent and Name parameters instead. -In that case, the Parent parameter would need to look something like this: - -`-Parent "Registrar:atl-cs-001.litwareinc.com"` +### -Enabled +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Set this value to True to enable the application. +Set the value to False to disable the application. +If this parameter is not specified the Enabled property will be set to False and the new application will be disabled. ```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -Friendly name for the service. -If you use the Identity parameter you do not need to include the Name parameter when creating a new service; instead, the Name property will be populated using the name portion of the application Identity. -For example, if you create a new application with the Identity service:Registrar:atl-cs-001.litwareinc.com/TestService the application will automatically be named TestService. -The Name parameter is required only if you use the Parent parameter. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Uri -Unique Uniform Resource Identifier (URI) for the application. -For example, the QoEAgent application has the URI `http://www.microsoft.com/LCS/QoEAgent`. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the server application to be created. +Server application Identities are composed of the service where the application is hosted plus the application name. +For example, the server application named QoEAgent might have an Identity similar to this: service:Registrar:atl-cs-001.litwareinc.com/QoEAgent. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: True -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Enabled -Set this value to True to enable the application. -Set the value to False to disable the application. -If this parameter is not specified the Enabled property will be set to False and the new application will be disabled. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -174,38 +180,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Critical - -If set to True, then Skype for Business Server will not start unless the application in question can be started. -If False, then Skype for Business Server will start regardless of whether or not the application can be started. -If this parameter is not specified the Critical property will be set to True. +### -Name +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Friendly name for the service. +If you use the Identity parameter you do not need to include the Name parameter when creating a new service; instead, the Name property will be populated using the name portion of the application Identity. +For example, if you create a new application with the Identity service:Registrar:atl-cs-001.litwareinc.com/TestService the application will automatically be named TestService. +The Name parameter is required only if you use the Parent parameter. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ScriptName -Path to the Microsoft SIP Processing Language (MSPL) script used by the application (if applicable). -MSPL is a scripting language used for filtering and routing SIP messages. +### -Parent + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the service that will host the new server application. +If you use the Identity parameter, then you do not need to use either the Parent or the Name parameters; that's because the application Identity combines the values of the Parent and Name properties. +However, you can omit the Identity parameter by using the Parent and Name parameters instead. +In that case, the Parent parameter would need to look something like this: + +`-Parent "Registrar:atl-cs-001.litwareinc.com"` + + ```yaml Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -213,6 +227,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the order of execution for server applications. The application with priority 0 is started first; the application with priority 1 is started second; and so on. Note that each service that hosts a server application has its own unique set of priorities. @@ -226,8 +243,7 @@ For example, if you delete an application that has a priority of 0 then the appl ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -236,18 +252,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory +### -Script -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Enables you to associate the server application with a script. +To add a script to a server application, use syntax similar to this: +`-Script "Update.ps1"` + +To remove a script, simply set the Script property to a null value: + +`-Script $Null` + +Each server application can only be associated with one script. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -256,14 +279,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -ScriptName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Path to the Microsoft SIP Processing Language (MSPL) script used by the application (if applicable). +MSPL is a scripting language used for filtering and routing SIP messages. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -272,16 +298,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Uri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique Uniform Resource Identifier (URI) for the application. +For example, the QoEAgent application has the URI `http://www.microsoft.com/LCS/QoEAgent`. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -289,13 +318,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -304,23 +335,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Script -Enables you to associate the server application with a script. -To add a script to a server application, use syntax similar to this: - -`-Script "Update.ps1"` - -To remove a script, simply set the Script property to a null value: +### -WhatIf -`-Script $Null` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Each server application can only be associated with one script. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -334,13 +358,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsServerApplication cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.ServerApplication.Application The New-CsServerApplication cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ServerApplication.Application object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsSimpleUrl.md b/skype/skype-ps/SkypeForBusiness/New-CsSimpleUrl.md similarity index 92% rename from skype/skype-ps/skype/New-CsSimpleUrl.md rename to skype/skype-ps/SkypeForBusiness/New-CsSimpleUrl.md index 93d388cd74..0b50babf82 100644 --- a/skype/skype-ps/skype/New-CsSimpleUrl.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSimpleUrl.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cssimpleurl applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsSimpleUrl -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cssimpleurl +schema: 2.0.0 +title: New-CsSimpleUrl --- # New-CsSimpleUrl @@ -65,7 +66,7 @@ After updating a simple URL collection, you must then run the Enable-CsComputer ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $urlEntry = New-CsSimpleUrlEntry -Url "https://meet.fabrikam.com" @@ -86,7 +87,37 @@ This syntax causes the URL stored in the object reference $simpleUrl to be added ## PARAMETERS +### -ActiveUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the URL that is actually to be accessed by users. +The SimpleUrlEntry property can contain multiple URLs, but only one of those URLs can be active at a given time. +An error will occur if you try to set the ActiveUrl to a value not found in the SimpleUrlEntry property. + +To assign an active URL, simply use the URL itself as the parameter value. +For example: + +`-ActiveUrl "https://meet.litwareinc.com"` + + + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Component + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the type of simple URL being created. Valid values are: @@ -105,8 +136,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -117,6 +147,8 @@ Accept wildcard characters: False ### -Domain +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP domain for the simple URL. For example: @@ -127,8 +159,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -138,6 +169,9 @@ Accept wildcard characters: False ``` ### -SimpleUrlEntry + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Collection of URLs for the specified component. For example, both `https://meet.litwareinc.com` and `https://litwareinc.com/meet` might be configured as URL entries for the Meet component. However, only one of those URLs can be (and must be) configured as the active URL. @@ -147,34 +181,7 @@ Simple URL entries must be created by using the New-CsSimpleUrlEntry cmdlet. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ActiveUrl - -Indicates the URL that is actually to be accessed by users. -The SimpleUrlEntry property can contain multiple URLs, but only one of those URLs can be active at a given time. -An error will occur if you try to set the ActiveUrl to a value not found in the SimpleUrlEntry property. - -To assign an active URL, simply use the URL itself as the parameter value. -For example: - -`-ActiveUrl "https://meet.litwareinc.com"` - - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -188,13 +195,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsSimpleUrl cmdlet does not accept pipelined data. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.SimpleUtl.SimpleUrl The New-CsSimpleUrl cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.SimpleUtl.SimpleUrl object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsSimpleUrlConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsSimpleUrlConfiguration.md similarity index 89% rename from skype/skype-ps/skype/New-CsSimpleUrlConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsSimpleUrlConfiguration.md index 4bcbbf4b6a..abd78d3016 100644 --- a/skype/skype-ps/skype/New-CsSimpleUrlConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSimpleUrlConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cssimpleurlconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsSimpleUrlConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cssimpleurlconfiguration +schema: 2.0.0 +title: New-CsSimpleUrlConfiguration --- # New-CsSimpleUrlConfiguration @@ -63,7 +64,7 @@ After updating a simple URL collection you must then run the Enable-CsComputer c ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsSimpleUrlConfiguration -Identity "site:Redmond" @@ -74,7 +75,7 @@ Because no parameters other than Identity are included with this command, the ne This command will fail if the Redmond site already hosts a simple URL collection. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $urlEntry = New-CsSimpleUrlEntry -Url "https://dialin.fabrikam.com" @@ -103,45 +104,44 @@ That syntax causes the URLs stored in the object references $simpleUrl and $simp ## PARAMETERS -### -Identity - -Unique identifier for the new simple URL configuration collection. -If there isn't a simple URL Configuration at Global level at the time the cmdlet is run, and if this parameter isn't specified, it will default to Global level, thus making this parameter optional in that case. -Because new collections after Global level can only be created at the site scope, the Identity must be the prefix "site:" followed by the name of the site, thus making this parameter mandatory. -For example, this syntax creates a new collection for the Redmond site: - -`-Identity "site:Redmond"` +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SimpleUrl +### -Identity -Simple URLs that have been configured for this collection. -These URLs must be created by using the New-SimpleUrl cmdlet and the New-SimpleUrlEntry cmdlet. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the new simple URL configuration collection. +If there isn't a simple URL Configuration at Global level at the time the cmdlet is run, and if this parameter isn't specified, it will default to Global level, thus making this parameter optional in that case. +Because new collections after Global level can only be created at the site scope, the Identity must be the prefix "site:" followed by the name of the site, thus making this parameter mandatory. +For example, this syntax creates a new collection for the Redmond site: + +`-Identity "site:Redmond"` ```yaml -Type: PSListModifier +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -149,6 +149,8 @@ Accept wildcard characters: False ### -InMemory +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. @@ -157,8 +159,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,14 +168,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -SimpleUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Simple URLs that have been configured for this collection. +These URLs must be created by using the New-SimpleUrl cmdlet and the New-SimpleUrlEntry cmdlet. + + ```yaml -Type: SwitchParameter +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -185,6 +191,8 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new Simple URL configuration settings are being created. For example: @@ -199,8 +207,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -209,14 +216,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -225,14 +234,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -246,12 +257,11 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SimpleUrl.SimpleUrlConfiguration The New-CsSimpleUrlConfiguration cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SimpleUrl.SimpleUrlConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsSimpleUrlEntry.md b/skype/skype-ps/SkypeForBusiness/New-CsSimpleUrlEntry.md similarity index 95% rename from skype/skype-ps/skype/New-CsSimpleUrlEntry.md rename to skype/skype-ps/SkypeForBusiness/New-CsSimpleUrlEntry.md index f748308d5a..7a6ff50a2c 100644 --- a/skype/skype-ps/skype/New-CsSimpleUrlEntry.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSimpleUrlEntry.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cssimpleurlentry applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsSimpleUrlEntry -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cssimpleurlentry +schema: 2.0.0 +title: New-CsSimpleUrlEntry --- # New-CsSimpleUrlEntry @@ -69,7 +70,7 @@ After updating a simple URL collection, you must then run the Enable-CsComputer ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $urlEntry = New-CsSimpleUrlEntry -Url "https://meet.fabrikam.com" @@ -90,7 +91,7 @@ This is done by using the Set-CsSimpleUrlConfiguration cmdlet, the SimpleUrl par This syntax causes the URL stored in the object reference $simpleUrl to be added to the SimpleUrl property. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $urlEntry = New-CsSimpleUrlEntry -Url "https://meet.fabrikam.com" @@ -121,6 +122,8 @@ This syntax causes the URLs stored in the object references $simpleUrl and $simp ### -Url +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URL to be added to the SimpleUrlEntry property of a simple URL. For example: @@ -133,8 +136,7 @@ URLs must start with the "https:" prefix. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -148,13 +150,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None ## OUTPUTS -### -The New-CsSimpleUrlEntry cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.SimpleUtl.SimpleUrlEntry object. +### Microsoft.Rtc.Management.WritableConfig.SimpleUrl.SimpleUrlEntry +The New-CsSimpleUrlEntry cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.SimpleUrl.SimpleUrlEntry object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsSipDomain.md b/skype/skype-ps/SkypeForBusiness/New-CsSipDomain.md similarity index 85% rename from skype/skype-ps/skype/New-CsSipDomain.md rename to skype/skype-ps/SkypeForBusiness/New-CsSipDomain.md index e3f6128773..12c75c512e 100644 --- a/skype/skype-ps/skype/New-CsSipDomain.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipdomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsSipDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cssipdomain +schema: 2.0.0 +title: New-CsSipDomain --- # New-CsSipDomain @@ -39,7 +40,7 @@ That is something you can do by running the New-CsSipDomain cmdlet. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` New-CsSipDomain -Identity fabrikam.com @@ -48,7 +49,7 @@ New-CsSipDomain -Identity fabrikam.com The command shown in Example 1 creates a new SIP domain, one that has the Identity fabrikam.com. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` New-CsSipDomain -Identity fabrikam.com -IsDefault $True @@ -61,8 +62,28 @@ That's because you can have only one default SIP domain. ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) for the new SIP domain. For example: @@ -73,8 +94,7 @@ For example: ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -85,6 +105,8 @@ Accept wildcard characters: False ### -IsDefault +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the domain is the default SIP domain, the domain used by Skype for Business Server any time a domain name is not explicitly stated. If set to True, the new domain will also become the new default domain @@ -98,8 +120,7 @@ If you change the default SIP domain you will need to restart the RTCCAA and RTC ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -108,14 +129,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -125,29 +148,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -161,14 +170,13 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsSipDomain cmdlet does not accept pipelined data. ## OUTPUTS -### +### Microsoft.Rtc.Management.Xds.SipDomain The New-CsSipDomain cmdlet creates new instances of the Microsoft.Rtc.Management.Xds.SipDomain object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsSipProxyCustom.md b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyCustom.md similarity index 90% rename from skype/skype-ps/skype/New-CsSipProxyCustom.md rename to skype/skype-ps/SkypeForBusiness/New-CsSipProxyCustom.md index 1e9b87ddfd..b2601410ed 100644 --- a/skype/skype-ps/skype/New-CsSipProxyCustom.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyCustom.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxycustom applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsSipProxyCustom -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxycustom +schema: 2.0.0 +title: New-CsSipProxyCustom --- # New-CsSipProxyCustom @@ -37,7 +38,7 @@ You can create a custom realm by using the New-CsSipProxyCustom cmdlet. ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $x = New-CsSipProxyCustom -CustomValue "Litwareinc Communications Service" @@ -49,13 +50,15 @@ The command shown in Example 1 assigns a custom realm (Litwareinc Communications ## PARAMETERS ### -CustomValue + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the realm to be used for authentication purposes. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -69,13 +72,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsSipProxyCustom cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.Custom The New-CsSipProxyCustom cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.Custom object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsSipProxyRealm.md b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyRealm.md similarity index 92% rename from skype/skype-ps/skype/New-CsSipProxyRealm.md rename to skype/skype-ps/SkypeForBusiness/New-CsSipProxyRealm.md index 28a9713563..90e2622da5 100644 --- a/skype/skype-ps/skype/New-CsSipProxyRealm.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyRealm.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxyrealm applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsSipProxyRealm -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxyrealm +schema: 2.0.0 +title: New-CsSipProxyRealm --- # New-CsSipProxyRealm @@ -39,7 +40,7 @@ However, because this cmdlet requires an additional step you might want to use t ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $x = New-CsSipProxyUseDefault @@ -53,7 +54,7 @@ To do this, the first command calls the New-CsSipProxyUseDefault cmdlet in order In the second command, $x is used as the parameter value for the New-CsSipProxyRealm cmdlet and the RealmChoice parameter. In turn, this creates a new proxy realm object that is stored in a variable named $y. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` $x = New-CsSipProxyCustom -CustomValue "Litwareinc Communications Service" @@ -70,14 +71,16 @@ In the second command, $x is used, along with the New-CsSipProxyRealm cmdlet and ## PARAMETERS ### -RealmChoice + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Object representing the realm to be used by a proxy server. The RealmChoice must be created by using either the New-CsSipProxyUseDefault or the New-CsSipProxyCustom cmdlet. ```yaml Type: IRealmChoice Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -91,13 +94,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsSipProxyRealm cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.Realm The New-CsSipProxyRealm cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.Realm object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsSipProxyTCP.md b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyTCP.md similarity index 94% rename from skype/skype-ps/skype/New-CsSipProxyTCP.md rename to skype/skype-ps/SkypeForBusiness/New-CsSipProxyTCP.md index 60a6fa4a29..4948b44f86 100644 --- a/skype/skype-ps/skype/New-CsSipProxyTCP.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyTCP.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxytcp applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsSipProxyTCP -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxytcp +schema: 2.0.0 +title: New-CsSipProxyTCP --- # New-CsSipProxyTCP @@ -49,7 +50,7 @@ You do not need to use the New-CsSipProxyTCP cmdlet if you use the New-CsStaticR ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` After the SipProxy.TCP object has been created, the New-CsSipProxyTransport cmdlet creates a TCP transport object. @@ -66,14 +67,16 @@ To do this, the first command in the example uses the New-CsSipProxyTCP cmdlet t ## PARAMETERS ### -IPAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + IP address of the next hop router. For example: -IPAddress 192.168.0.240. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -87,13 +90,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsSipProxyTCP cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.TCP The New-CsSipProxyTCP cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.TCP object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsSipProxyTLS.md b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyTLS.md similarity index 92% rename from skype/skype-ps/skype/New-CsSipProxyTLS.md rename to skype/skype-ps/SkypeForBusiness/New-CsSipProxyTLS.md index 8083398419..5554fd0e24 100644 --- a/skype/skype-ps/skype/New-CsSipProxyTLS.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyTLS.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxytls applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsSipProxyTLS -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxytls +schema: 2.0.0 +title: New-CsSipProxyTLS --- # New-CsSipProxyTLS @@ -51,7 +52,7 @@ The New-CsSipProxyTLS cmdlet is not required if you use the New-CsStaticRoute cm ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` $cert = New-CsSipProxyUseDefaultCert @@ -72,13 +73,15 @@ As soon as the TLS object exists, that object (and the TLS protocol) can be adde ## PARAMETERS ### -Certificate + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Certificate to be used for TLS authentication. ```yaml Type: ITLSTLSChoice Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -89,6 +92,8 @@ Accept wildcard characters: False ### -Fqdn +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the next hop server. For example: @@ -99,8 +104,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -114,13 +118,12 @@ This cmdlet supports the common parameters: `-Debug, -ErrorAction, -ErrorVariabl ## INPUTS -### -None. +### None The New-CsSipProxyTLS cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.TLS The New-CsSipProxyTLS cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.TLS object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsSipProxyTransport.md b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyTransport.md similarity index 93% rename from skype/skype-ps/skype/New-CsSipProxyTransport.md rename to skype/skype-ps/SkypeForBusiness/New-CsSipProxyTransport.md index 3986103a26..60488ac653 100644 --- a/skype/skype-ps/skype/New-CsSipProxyTransport.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyTransport.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxytransport applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsSipProxyTransport -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxytransport +schema: 2.0.0 +title: New-CsSipProxyTransport --- # New-CsSipProxyTransport @@ -48,7 +49,7 @@ You do not need to use the `New-CsSipProxyTransport` cmdlet if you are using the ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` $cert = New-CsSipProxyUseDefaultCert @@ -63,7 +64,7 @@ This object, stored in a variable named $cert, instructs Skype for Business Serv After the UseDefaultCert object has been created, the `New-CsSipProxyTLS` cmdlet can be called to create a new SipProxy.TLS object, one that uses the default certificate and points to atl-proxy-001.litwareinc.com as the fully qualified domain name (FQDN) of the next hop server. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $tcp = New-CsSipProxyTCP -IPAddress 192.168.1.100 @@ -79,14 +80,16 @@ After the SipProxy.TCP object has been created, the `New-CsSipProxyTransport` cm ## PARAMETERS ### -Port + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port number used for SIP routing. For example: `-Port 7742`. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -96,6 +99,9 @@ Accept wildcard characters: False ``` ### -TransportChoice + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the transmission protocol (TCP or TLS) to be used on the static route. To use the TCP protocol, create a transport object by using the `New-CsSipProxyTCP` cmdlet. To use the TLS protocol, create a transport object by using the `New-CsSipProxyTLS` cmdlet. @@ -103,8 +109,7 @@ To use the TLS protocol, create a transport object by using the `New-CsSipProxyT ```yaml Type: ITransportChoice Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -118,13 +123,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsSipProxyTransport` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.Transport The `New-CsSipProxyTransport` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.Transport object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsSipProxyUseDefault.md b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyUseDefault.md similarity index 85% rename from skype/skype-ps/skype/New-CsSipProxyUseDefault.md rename to skype/skype-ps/SkypeForBusiness/New-CsSipProxyUseDefault.md index c4b0c49aba..392556b6ed 100644 --- a/skype/skype-ps/skype/New-CsSipProxyUseDefault.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyUseDefault.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxyusedefault applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsSipProxyUseDefault -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxyusedefault +schema: 2.0.0 +title: New-CsSipProxyUseDefault --- # New-CsSipProxyUseDefault @@ -33,7 +34,7 @@ If you change the realm and then want to revert back to using the default realm, ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` $x = New-CsSipProxyUseDefault ``` @@ -43,34 +44,17 @@ The command shown in Example 1 assigns the default realm (SIP Communications Ser ## PARAMETERS -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 - -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. +### None The `New-CsSipProxyUseDefault` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.UseDefault The `New-CsSipProxyUseDefault` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.UseDefault object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsSipProxyUseDefaultCert.md b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyUseDefaultCert.md similarity index 91% rename from skype/skype-ps/skype/New-CsSipProxyUseDefaultCert.md rename to skype/skype-ps/SkypeForBusiness/New-CsSipProxyUseDefaultCert.md index c3e2de765f..13a2d68315 100644 --- a/skype/skype-ps/skype/New-CsSipProxyUseDefaultCert.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipProxyUseDefaultCert.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxyusedefaultcert applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsSipProxyUseDefaultCert -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cssipproxyusedefaultcert +schema: 2.0.0 +title: New-CsSipProxyUseDefaultCert --- # New-CsSipProxyUseDefaultCert @@ -43,7 +44,7 @@ Note that the New-CsSipProxyUseDefaultCert cmdlet is not required if you use the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $cert = New-CsSipProxyUseDefaultCert @@ -62,34 +63,17 @@ As soon as the TLS object exists, that object (and the TLS protocol) can be adde ## PARAMETERS -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 - -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. +### None The `New-CsSipProxyUseDefaultCert` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.UseDefaultCert The `New-CsSipProxyUseDefaultCert` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.UseDefaultCert object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsSipResponseCodeTranslationRule.md b/skype/skype-ps/SkypeForBusiness/New-CsSipResponseCodeTranslationRule.md similarity index 86% rename from skype/skype-ps/skype/New-CsSipResponseCodeTranslationRule.md rename to skype/skype-ps/SkypeForBusiness/New-CsSipResponseCodeTranslationRule.md index 79e5457a51..3697822a34 100644 --- a/skype/skype-ps/skype/New-CsSipResponseCodeTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsSipResponseCodeTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cssipresponsecodetranslationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsSipResponseCodeTranslationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cssipresponsecodetranslationrule +schema: 2.0.0 +title: New-CsSipResponseCodeTranslationRule --- # New-CsSipResponseCodeTranslationRule @@ -57,7 +58,7 @@ Translation rules can be assigned to the global scope, the site scope, or to the ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` New-CsSipResponseCodeTranslationRule -Identity "PstnGateway:192.168.0.240/Rule404" -ReceivedResponseCode 434 -TranslatedResponseCode 404 ``` @@ -66,7 +67,7 @@ The command shown in Example 1 creates a new SIP response code translation rule This rule translates a received response code of 434 to the standard SIP response code 404 (Not Found). -### -------------------------- Example 2 ------------------------ +### Example 2 ``` New-CsSipResponseCodeTranslationRule -Parent "PstnGateway:192.168.0.240" -Name "Rule404" -ReceivedResponseCode 434 -TranslatedResponseCode 404 ``` @@ -78,7 +79,28 @@ This simply shows an alternate way of creating a new SIP response code translati ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the translation rule to be created. The identity for a translation rule consists of two parts: the scope where the rule is to be assigned and the name to be given to the rule. For example, a translation rule named Rule404 to be created at the global scope would have an Identity that looks like this: global/Rule404. @@ -88,8 +110,7 @@ Instead of using the Identity parameter, you can use the Parent and Name paramet ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -98,18 +119,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TranslatedResponseCode -Value of the Skype for Business Server SIP response code that the ReceivedResponseCode and/or the ReceivedISUPCauseCode should be translated to. -Translated response codes can be any integer value between 400 and 699, inclusive. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -117,6 +140,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name used to differentiate one translation rule from another. Names must be unique within a given scope; for example, the Redmond site can only have one translation rule named Rule404. However, you can have a translation rule named Rule404 at the Redmond site and another rule named Rule404 at the Dublin site. @@ -126,8 +152,7 @@ The Name parameter must always be used in conjunction with the Parent parameter. ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -137,6 +162,9 @@ Accept wildcard characters: False ``` ### -Parent + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Scope where the new translation rule is to be assigned. To assign a rule to the global scope, use this syntax: @@ -156,8 +184,7 @@ The Parent parameter must always be used in conjunction with the Name parameter. ```yaml Type: String Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -167,6 +194,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Relative priority of the translation rule. Rules are processed in order of their assigned priority; the first rule to be processed has a priority of 0; the second rule to be processed has a priority of 1 and so on. If not specified the new rule will be given the lowest priority in its scope. @@ -174,8 +204,7 @@ If not specified the new rule will be given the lowest priority in its scope. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,18 +213,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceivedResponseCode -Value of the SIP response code used by a gateway when responding to an INVITE message. -A response code can be any integer value between 400 and 699, inclusive. -Although the cmdlet will accept integer values less than 400, these are not recognized as final responses. -As a result, the translation rule will never be used. -A value of 0 means that only the ISUP cause code will be used when executing the translation rule; the SIP response code will be ignored. +### -ReceivedISUPCauseValue + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Value of the ISDN User Part (ISUP) code that must be present in the SIP response message used by a gateway when responding to an INVITE message. +A value of -1 indicates that only the SIP response code will be used when executing the translation rule; the ISUP cause code will be ignored. + ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -204,16 +233,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -ReceivedResponseCode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Value of the SIP response code used by a gateway when responding to an INVITE message. +A response code can be any integer value between 400 and 699, inclusive. +Although the cmdlet will accept integer values less than 400, these are not recognized as final responses. +As a result, the translation rule will never be used. +A value of 0 means that only the ISUP cause code will be used when executing the translation rule; the SIP response code will be ignored. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -222,32 +255,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -TranslatedResponseCode -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Value of the Skype for Business Server SIP response code that the ReceivedResponseCode and/or the ReceivedISUPCauseCode should be translated to. +Translated response codes can be any integer value between 400 and 699, inclusive. -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -255,13 +276,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -270,16 +293,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceivedISUPCauseValue -Value of the ISDN User Part (ISUP) code that must be present in the SIP response message used by a gateway when responding to an INVITE message. -A value of -1 indicates that only the SIP response code will be used when executing the translation rule; the ISUP cause code will be ignored. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -293,14 +316,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsSipResponseCodeTranslationRule` cmdlet does not accept pipelined input. ## OUTPUTS -### -The `New-CsSipResponseCodeTranslationRule` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.SipResponseCodeTRanslationRule#Decorated object. +### Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.SipResponseCodeTranslationRule +The `New-CsSipResponseCodeTranslationRule` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.SipResponseCodeTTranslationRule object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsStaticRoute.md b/skype/skype-ps/SkypeForBusiness/New-CsStaticRoute.md similarity index 87% rename from skype/skype-ps/skype/New-CsStaticRoute.md rename to skype/skype-ps/SkypeForBusiness/New-CsStaticRoute.md index f7208b4025..18f98af6b5 100644 --- a/skype/skype-ps/skype/New-CsStaticRoute.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsStaticRoute.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csstaticroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsStaticRoute -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csstaticroute +schema: 2.0.0 +title: New-CsStaticRoute --- # New-CsStaticRoute @@ -47,7 +48,7 @@ After a route has been created by using the `New-CsStaticRoute` cmdlet, you must ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` $x = New-CsStaticRoute -TCPRoute -Destination "192.168.0.100" -Port 8025 -MatchUri "litwareinc.com" @@ -64,7 +65,7 @@ This is done by calling the `Set-CsStaticRoutingConfiguration` cmdlet along with The parameter value @{Add=$x} adds the route object stored in $x to the existing set of routes already in the global collection. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $x = New-CsStaticRoute -TLSRoute -Destination "atl-proxy-001.litwareinc.com" -Port 8025 -MatchUri "*.litwareinc.com" -UseDefaultCertificate $True @@ -79,7 +80,7 @@ In addition, the new route object, which is stored in a variable named $x, uses After the route object has been created, the second command in the example then adds the new route to the global static routing configuration collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $x = New-CsStaticRoute -TLSRoute -Destination "atl-proxy.litwareinc.com" -Port 5061 -MatchUri "litwareinc.com" -UseDefaultCertificate $False -TLSCertIssuer "CN=CertificateAuthority, DC=litwareinc, DC=com" -TLSCertSerialNumber 0x8f,0x33,0x70,0x93,0x70,0x05,0x33,0x00,0x02,0x33 @@ -94,6 +95,9 @@ After the route object has been created, the second command in the example then ## PARAMETERS ### -Destination + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If the route uses Transport Layer Security (TLS) as the transport protocol, then the Destination is the fully qualified domain name (FQDN) of the next hop server. For example: `-Destination "atl-proxy-001.litwareinc.com"` @@ -104,8 +108,7 @@ For example: `-Destination "192.168.0.240"`. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -114,39 +117,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MatchUri -FQDN or domain suffix used to determine if the message is being sent to a user handled by this route. -For example, you might use the FQDN "litwareinc.com". -This pattern matches any user who has a SIP address that ends with the domain name "litwareinc.com". +### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True, then the route is enabled and any messages matching the MatchURI pattern will be routed to the next hop server. +If set to False, the route is disabled and will not be used in routing messages. +The default value is True. -To match child domains of a domain, you can use a wildcard value like "*.litwareinc.com". -That value matches any domain that ends with the suffix "litwareinc.com". -For example: northamerica.litwareinc.com; asia.litwareinc.com and europe.litwareinc.com. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Enabled -If set to True, then the route is enabled and any messages matching the MatchURI pattern will be routed to the next hop server. -If set to False, the route is disabled and will not be used in routing messages. -The default value is True. +### -MatchOnlyPhoneUri +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True, only messages addressed to phone Uniform Resource identifiers (URIs) (for example, sip:kenmmyer@litwareinc.com;user=phone) will be matched and potentially, routed. +If set to False (the default value) then all messages will be matched. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -155,17 +157,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MatchOnlyPhoneUri -If set to True, only messages addressed to phone Uniform Resource identifiers (URIs) (for example, sip:kenmmyer@litwareinc.com;user=phone) will be matched and potentially, routed. -If set to False (the default value) then all messages will be matched. +### -MatchUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN or domain suffix used to determine if the message is being sent to a user handled by this route. +For example, you might use the FQDN "litwareinc.com". +This pattern matches any user who has a SIP address that ends with the domain name "litwareinc.com". + +To match child domains of a domain, you can use a wildcard value like "*.litwareinc.com". +That value matches any domain that ends with the suffix "litwareinc.com". +For example: northamerica.litwareinc.com; asia.litwareinc.com and europe.litwareinc.com. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -173,6 +182,9 @@ Accept wildcard characters: False ``` ### -Port + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port number used for SIP routing. For example: `-Port 7742` @@ -180,8 +192,7 @@ For example: `-Port 7742` ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -191,6 +202,9 @@ Accept wildcard characters: False ``` ### -ReplaceHostInRequestUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If set to True ($True) then the host portion of a Request-URI will be replaced by the address of the next hop server. If set the False then the Request-URI will be used as-is. The Request-URI represents the URI of the user or service that the request (message) is addressed to. @@ -199,8 +213,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -210,13 +223,15 @@ Accept wildcard characters: False ``` ### -TCPRoute + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Configures TCP as the transport protocol for the new route. ```yaml Type: SwitchParameter Parameter Sets: TCP -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -226,6 +241,9 @@ Accept wildcard characters: False ``` ### -TLSCertIssuer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the certification authority (CA) that issued the certificate to be used in the static route. This parameter is not used if you have configured TCP as the transport protocol. @@ -234,8 +252,7 @@ If you include the TLSCertIssuer parameter then you must also use the TLSCertSer ```yaml Type: String Parameter Sets: TLS -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -245,6 +262,9 @@ Accept wildcard characters: False ``` ### -TLSCertSerialNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Serial number of the TLS certificate to be used in the static route. Serial numbers must be passed as a byte array; this means you must pass the serial number as an array of two-character values. For example: `-TLSCertSerialNumber 0x01, 0xA4, 0xD5, 0x67, 0x89` @@ -257,8 +277,7 @@ If you include the TLSCertSerialNumber parameter then you must also use the TLSC ```yaml Type: Byte[] Parameter Sets: TLS -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -268,13 +287,15 @@ Accept wildcard characters: False ``` ### -TLSRoute + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Configures TLS as the transport protocol for the new route. ```yaml Type: SwitchParameter Parameter Sets: TLS -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -284,6 +305,9 @@ Accept wildcard characters: False ``` ### -UseDefaultCertificate + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Configures the route to use your default Skype for Business Server certificate as its authentication certificate. If you do not want to use the default certificate then you must specify a different certificate by using the TLSCertIssuer and TLSCertSerialNumber parameters. @@ -295,8 +319,7 @@ To view the default certificate, use the following command: ```yaml Type: Boolean Parameter Sets: TLS -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -310,13 +333,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsStaticRoute` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.Route The `New-CsStaticRoute` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.Route object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsStaticRoutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsStaticRoutingConfiguration.md similarity index 87% rename from skype/skype-ps/skype/New-CsStaticRoutingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsStaticRoutingConfiguration.md index f59880c6ef..b1b42b1db2 100644 --- a/skype/skype-ps/skype/New-CsStaticRoutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsStaticRoutingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csstaticroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsStaticRoutingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csstaticroutingconfiguration +schema: 2.0.0 +title: New-CsStaticRoutingConfiguration --- # New-CsStaticRoutingConfiguration @@ -39,7 +40,7 @@ In addition to that, you can use the `New-CsStaticRoutingConfiguration` cmdlet t ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` New-CsStaticRoutingConfiguration -Identity "service:Registrar:atl-cs-001.litwareinc.com" ``` @@ -48,7 +49,7 @@ Example 1 creates a new static routing configuration collection with the Identit Because the Route parameter is not included in the command, the new collection will not have any static routes assigned to it. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $x = New-CsStaticRoute -TCPRoute -Destination "192.168.0.100" -Port 8025 -MatchUri "*.litwareinc.com" @@ -64,7 +65,28 @@ After that, the `New-CsStaticRoutingConfiguration` cmdlet is called to create a ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the new static routing collection to be created. New collections can only be created at the service scope and can only be assigned to the Registrar service. Because of that, the Identity for a new collection must look similar to this: @@ -75,8 +97,7 @@ Because of that, the Identity for a new collection must look similar to this: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -85,32 +106,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Route -Individual static routes maintained within the collection. -Routes to be added to a collection must either by copied from another collection or created using the `New-CsStaticRoute` cmdlet. -For details, see the Examples section in this topic. +### -InMemory -```yaml -Type: PSListModifier -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,16 +126,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -Route +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Individual static routes maintained within the collection. +Routes to be added to a collection must either by copied from another collection or created using the `New-CsStaticRoute` cmdlet. +For details, see the Examples section in this topic. ```yaml -Type: SwitchParameter +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -137,14 +146,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -153,14 +164,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -174,13 +187,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsStaticRoutingConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.RoutingSettings The `New-CsStaticRoutingConfiguration` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.RoutingSettings object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsStorageServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsStorageServiceConfiguration.md similarity index 87% rename from skype/skype-ps/skype/New-CsStorageServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsStorageServiceConfiguration.md index b9fb8758da..c9a4bf4389 100644 --- a/skype/skype-ps/skype/New-CsStorageServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsStorageServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csstorageserviceconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsStorageServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csstorageserviceconfiguration +schema: 2.0.0 +title: New-CsStorageServiceConfiguration --- # New-CsStorageServiceConfiguration @@ -38,7 +39,7 @@ Skype for Business Server Control Panel: The functions carried out by the `New-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsStorageServiceConfiguration -Identity "site:Redmond" ``` @@ -48,40 +49,34 @@ The command shown in Example 1 creates a new collection of storage service confi ## PARAMETERS -### -Identity -Unique identifier for the new collection of storage service configuration settings to be created. -Storage service settings can be created at the site scope or the service scope (but only for the Registrar service). -To create a new collections of settings at the site scope, use syntax similar to this: - -`-Identity "site:Redmond"` - -To create settings at the service scope, use syntax similar to this: +### -EnableAsyncAdaptorTaskAbort -`-Identity "service:Registrar:atl-cs-001.litwareinc.com"` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Note that your command will fail if the specified site or service already hosts a collection of storage service configuration settings. +PARAMVALUE: $true | $false ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -EnableAutoImportFlushedData + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: $true | $false ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -90,14 +85,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAsyncAdaptorTaskAbort +### -EnableFabricReplicationSetReduction + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: $true | $false ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -106,14 +103,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAutoImportFlushedData -PARAMVALUE: $true | $false +### -FabricInvalidStateTimeoutDuration + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: UInt64 ```yaml -Type: Boolean +Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,14 +121,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableFabricReplicationSetReduction -PARAMVALUE: $true | $false +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any nonfatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,30 +139,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FabricInvalidStateTimeoutDuration -PARAMVALUE: UInt64 +### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the new collection of storage service configuration settings to be created. +Storage service settings can be created at the site scope or the service scope (but only for the Registrar service). +To create a new collections of settings at the site scope, use syntax similar to this: + +`-Identity "site:Redmond"` + +To create settings at the service scope, use syntax similar to this: + +`-Identity "service:Registrar:atl-cs-001.litwareinc.com"` + +Note that your command will fail if the specified site or service already hosts a collection of storage service configuration settings. ```yaml -Type: UInt64 +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any nonfatal error message that might occur when running the command. +### -InMemory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -170,15 +186,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -188,13 +205,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -208,13 +227,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsStorageServiceConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.StorageService.StorageServiceSettings The `New-CsStorageServiceConfiguration` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.StorageService.StorageServiceSettings object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsTeamsUpgradePolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsTeamsUpgradePolicy.md similarity index 96% rename from skype/skype-ps/skype/New-CsTeamsUpgradePolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsTeamsUpgradePolicy.md index e0076883f9..28a08eb08c 100644 --- a/skype/skype-ps/skype/New-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTeamsUpgradePolicy.md @@ -1,14 +1,14 @@ --- +applicable: Skype for Business Server 2015, Skype for Business Server 2019 +author: hirenshah1 external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: rogupta Module Name: SkypeForBusiness +ms.author: hirshah online version: https://learn.microsoft.com/powershell/module/skype/new-csteamsupgradepolicy -applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsTeamsUpgradePolicy schema: 2.0.0 -manager: rogupta -author: hirenshah1 -ms.author: hirshah -ms.reviewer: +title: New-CsTeamsUpgradePolicy --- # New-CsTeamsUpgradePolicy @@ -53,15 +53,16 @@ This creates a policy for users that can be granted as desired to individual use ## PARAMETERS -### -NotifySfbUsers +### -Description -Determines whether users who are assigned this policy will see a notification in their Skype for Business client about a pending upgrade to Teams. In addition, if NotifySfBUsers=true and TeamsUpgradeConfiguration has DownloadTeams=true, Win32 versions of Skype for Business will silently download the Teams client. +> Applicable: Skype for Business Server 2019 + +Free form text that can be used as needed by administrators. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -69,33 +70,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description +### -Identity -Free form text that can be used as needed by administrators. +> Applicable: Skype for Business Server 2019 + +The identity of the policy. To specify the global policy for the organization, use "global". To specify a specific site, use "site:\" where \ is the name of the site. To specify a policy that can be assigned as needed to any users, simply specify a name of your choosing. ```yaml -Type: String +Type: XdsIdentity Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity +### -NotifySfbUsers -The identity of the policy. To specify the global policy for the organization, use "global". To specify a specific site, use "site:\" where \ is the name of the site. To specify a policy that can be assigned as needed to any users, simply specify a name of your choosing. +> Applicable: Skype for Business Server 2019 + +Determines whether users who are assigned this policy will see a notification in their Skype for Business client about a pending upgrade to Teams. In addition, if NotifySfBUsers=true and TeamsUpgradeConfiguration has DownloadTeams=true, Win32 versions of Skype for Business will silently download the Teams client. ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 -Required: True -Position: 1 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False diff --git a/skype/skype-ps/skype/New-CsTelemetryConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsTelemetryConfiguration.md similarity index 86% rename from skype/skype-ps/skype/New-CsTelemetryConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsTelemetryConfiguration.md index 8cff3d883a..d42a99a67f 100644 --- a/skype/skype-ps/skype/New-CsTelemetryConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTelemetryConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cstelemetryconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsTelemetryConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cstelemetryconfiguration +schema: 2.0.0 +title: New-CsTelemetryConfiguration --- # New-CsTelemetryConfiguration @@ -28,7 +29,7 @@ For privacy information, see the Skype for Business Privacy Statement (https://g ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsTelemetryConfiguration -Identity Site:Redmond -EnableClientTelemetry $True ``` @@ -38,42 +39,35 @@ This example creates a new telemetry configuration with telemetry enabled and sc ## PARAMETERS -### -Identity -A unique identifier that includes the scope of the telemetry configuration. -Telemetry configurations can be scoped at the Global, Site, or Service level. -For example, "site:Redmond" (for site). -The format of the service scope is "Service:\", where identity is derived from the topology. -You can use the following commands to identify the relevant services. - -`Get-CsService -WebServer | fl Identity` +### -EnableClientTelemetry -`Get-CsService -PoolFqdn \ | fl Identity` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -The first command will give you all of the WebServices in the topology, regardless of the pool. -The second will give you all of the services on the pool, regardless of their role. -You can combine the two commands to zero in on a single role in a single pool. +When set to true, client telemetry will be enabled. +The default is false. ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -82,31 +76,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableClientTelemetry -When set to true, client telemetry will be enabled. -The default is false. +### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier that includes the scope of the telemetry configuration. +Telemetry configurations can be scoped at the Global, Site, or Service level. +For example, "site:Redmond" (for site). +The format of the service scope is "Service:\", where identity is derived from the topology. +You can use the following commands to identify the relevant services. + +`Get-CsService -WebServer | fl Identity` + +`Get-CsService -PoolFqdn \ | fl Identity` + +The first command will give you all of the WebServices in the topology, regardless of the pool. +The second will give you all of the services on the pool, regardless of their role. +You can combine the two commands to zero in on a single role in a single pool. ```yaml -Type: Boolean +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. +### -InMemory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -115,15 +125,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -133,13 +144,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -153,13 +166,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/New-CsTenantUpdateTimeWindow.md b/skype/skype-ps/SkypeForBusiness/New-CsTenantUpdateTimeWindow.md similarity index 88% rename from skype/skype-ps/skype/New-CsTenantUpdateTimeWindow.md rename to skype/skype-ps/SkypeForBusiness/New-CsTenantUpdateTimeWindow.md index 11a5b21e8e..40e0dad5e0 100644 --- a/skype/skype-ps/skype/New-CsTenantUpdateTimeWindow.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTenantUpdateTimeWindow.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cstenantupdatetimewindow applicable: Skype for Business Online -title: New-CsTenantUpdateTimeWindow -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/new-cstenantupdatetimewindow +schema: 2.0.0 +title: New-CsTenantUpdateTimeWindow --- # New-CsTenantUpdateTimeWindow @@ -62,7 +64,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsTenantUpdateTimeWindow -Identity FirstAndLastWeekend -Monthly -WeeksOfMonth First,Last -DaysOfWeek Sunday,Saturday -StartTime 1:00 -Duration 5:00 ``` @@ -70,7 +72,7 @@ New-CsTenantUpdateTimeWindow -Identity FirstAndLastWeekend -Monthly -WeeksOfMont This example creates a new tenant update time window in the tenant in Monthly type. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsTenantUpdateTimeWindow -Identity MidDay -Monthly -DayOfMonth 15 -StartTime 5:00 -Duration 6:00 ``` @@ -78,7 +80,7 @@ New-CsTenantUpdateTimeWindow -Identity MidDay -Monthly -DayOfMonth 15 -StartTime This example creates a new tenant update time window in the tenant in Monthly type. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` New-CsTenantUpdateTimeWindow -Identity Weekday -Weekly -DaysOfWeek Monday,Tuesday,Wednesday,Thursday,Friday -StartTime 3:00 -Duration 10:00 ``` @@ -86,7 +88,7 @@ New-CsTenantUpdateTimeWindow -Identity Weekday -Weekly -DaysOfWeek Monday,Tuesda This example creates a new tenant update time window in the tenant in Weekly type. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` New-CsTenantUpdateTimeWindow -Identity Night -Daily ``` @@ -97,13 +99,15 @@ This example creates a new tenant update time window in the tenant in Daily type ## PARAMETERS ### -Daily + +> Applicable: Skype for Business Online + Type of Time window is daily. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -113,14 +117,16 @@ Accept wildcard characters: False ``` ### -DayOfMonth + +> Applicable: Skype for Business Online + Day of month. It must be defined when Type is Monthly. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -130,6 +136,9 @@ Accept wildcard characters: False ``` ### -DaysOfWeek + +> Applicable: Skype for Business Online + Days of week. It can be multiple days separated by a comma. It must be defined when Type is Weekly or Monthly. @@ -137,8 +146,7 @@ It must be defined when Type is Weekly or Monthly. ```yaml Type: TenantUpdateTimeWindowDayOfWeek Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -147,30 +155,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specifies the identity of the tenant update time window. +### -Duration + +> Applicable: Skype for Business Online + +Duration of the update time window. ```yaml -Type: XdsGlobalRelativeIdentity +Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Monthly -Type of Time window is monthly. +### -Force + +> Applicable: Skype for Business Online + +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -179,32 +193,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Weekly -Type of Time window is weekly. +### -Identity + +> Applicable: Skype for Business Online + +Specifies the identity of the tenant update time window. ```yaml -Type: SwitchParameter +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WeeksOfMonth -Weeks of month. -It can be multiple weeks separated by a comma. -It must be defined when Type is Monthly. +### -InMemory + +> Applicable: Skype for Business Online + +PARAMVALUE: SwitchParameter ```yaml -Type: TenantUpdateTimeWindowWeekOfMonth +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -213,14 +229,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -PARAMVALUE: SwitchParameter +### -Monthly + +> Applicable: Skype for Business Online + +Type of Time window is monthly. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -229,14 +247,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Duration -Duration of the update time window. +### -StartTime + +> Applicable: Skype for Business Online + +Time of day when the update time window starts. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -245,16 +265,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Tenant + +> Applicable: Skype for Business Online + +PARAMVALUE: Guid ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -263,14 +283,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -PARAMVALUE: SwitchParameter +### -Weekly + +> Applicable: Skype for Business Online + +Type of Time window is weekly. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -279,14 +301,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StartTime -Time of day when the update time window starts. +### -WeeksOfMonth + +> Applicable: Skype for Business Online + +Weeks of month. +It can be multiple weeks separated by a comma. +It must be defined when Type is Monthly. ```yaml -Type: TimeSpan +Type: TenantUpdateTimeWindowWeekOfMonth Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -295,14 +321,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -PARAMVALUE: Guid +### -Confirm + +> Applicable: Skype for Business Online + +PARAMVALUE: SwitchParameter ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -312,13 +340,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/New-CsTestDevice.md b/skype/skype-ps/SkypeForBusiness/New-CsTestDevice.md similarity index 86% rename from skype/skype-ps/skype/New-CsTestDevice.md rename to skype/skype-ps/SkypeForBusiness/New-CsTestDevice.md index 74d4439948..59e2c77180 100644 --- a/skype/skype-ps/skype/New-CsTestDevice.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTestDevice.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cstestdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsTestDevice -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cstestdevice +schema: 2.0.0 +title: New-CsTestDevice --- # New-CsTestDevice @@ -46,7 +47,7 @@ These devices can be configured at either the global scope or the site scope. ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` New-CsTestDevice -Identity site:Redmond/UCPhone -IdentifierType SerialNumber -Identifier "07823-A345" ``` @@ -56,7 +57,7 @@ Note the syntax used to specify the device Identity: the device scope (site:Redm This device uses the serial number as the IdentifierType and has a serial number of 07823-A345. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` New-CsTestDevice -Parent "site:Redmond" -Name UCPhone -IdentifierType SerialNumber -Identifier "07823-A345" ``` @@ -69,28 +70,28 @@ The `New-CsTestDevice` cmdlet will take those two parameter values and construct ## PARAMETERS -### -Identity -Indicates the Identity for the new test device. -An Identity consists of both the scope where the test device is to be assigned (for example, site:Redmond) and the name for the new device (for example, UCPhone). -To assign a test device named UCPhone to the Redmond site, your Identity parameter must look like this: +### -Force -`-Identity "site:Redmond/UCPhone"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Identifier + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Based on the IdentifierType, indicates the Media Access Control (MAC) address or serial number of the new test device. Serial numbers can be specified using numbers, letters, hyphens and underscores; for example: @@ -110,8 +111,7 @@ A MAC address such as 01-02-03-04-05 will not be accepted because it does not ha ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -121,6 +121,9 @@ Accept wildcard characters: False ``` ### -IdentifierType + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the test device will be uniquely identified by its MAC address or by its serial number. To identify a device by its MAC address, set the IdentifierType to MACAddress. To identify a device by its serial number, set the IdentifierType to SerialNumber. @@ -129,8 +132,7 @@ MACAddress and SerialNumber are the only allowed values. ```yaml Type: IdentifierType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -139,87 +141,102 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -Name for the new test device (names must be unique within a given scope). -The Name parameter should be used only when using the Parent parameter. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity for the new test device. +An Identity consists of both the scope where the test device is to be assigned (for example, site:Redmond) and the name for the new device (for example, UCPhone). +To assign a test device named UCPhone to the Redmond site, your Identity parameter must look like this: + +`-Identity "site:Redmond/UCPhone"` + ```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: True -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Parent -Name of the scope (for example, site:Redmond) where the new test device is to be assigned. -If you use the Parent parameter then you must also use the Name parameter; for example: +### -InMemory -`-Parent site:Redmond -Name UCPhone` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -If you use the Parent parameter then you should not use the Identity parameter and vice-versa. +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. ```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name for the new test device (names must be unique within a given scope). +The Name parameter should be used only when using the Parent parameter. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -Parent + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the scope (for example, site:Redmond) where the new test device is to be assigned. +If you use the Parent parameter then you must also use the Name parameter; for example: + +`-Parent site:Redmond -Name UCPhone` + +If you use the Parent parameter then you should not use the Identity parameter and vice-versa. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -228,14 +245,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -249,13 +268,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsTestDevice` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.TestDevice Creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.TestDevice object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsThirdPartyVideoSystem.md b/skype/skype-ps/SkypeForBusiness/New-CsThirdPartyVideoSystem.md similarity index 88% rename from skype/skype-ps/skype/New-CsThirdPartyVideoSystem.md rename to skype/skype-ps/SkypeForBusiness/New-CsThirdPartyVideoSystem.md index b99a3a2d81..cc69b51b22 100644 --- a/skype/skype-ps/skype/New-CsThirdPartyVideoSystem.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsThirdPartyVideoSystem.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csthirdpartyvideosystem applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsThirdPartyVideoSystem -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csthirdpartyvideosystem +schema: 2.0.0 +title: New-CsThirdPartyVideoSystem --- # New-CsThirdPartyVideoSystem @@ -38,7 +39,7 @@ VTC contact objects can be created by using the `New-CsThirdPartyVideoSystem` cm ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsThirdPartyVideoSystem -RegistrarPool "redmond-cs-001.litwareinc.com" -OU "ou=Telecommunications,dc=litwareinc,dc=com" -DisplayName "Redmond Video System" -SipAddress "sip:redmondvideo@litwareinc.com" ``` @@ -47,7 +48,7 @@ In Example 1, a new third-party video system contact object is created in the Te This new contact object will be homed on the Registrar pool Redmond-cs-001.litwareinc.com; will have the display name Redmond Video System and will use the SIP address sip:redmondvideo@litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsThirdPartyVideoSystem -RegistrarPool "redmond-cs-001.litwareinc.com" -DN "cn=RedmondVideoSystem,ou=Telecommunications,dc=litwareinc,dc=com" -SipAddress "sip:redmondvideo@litwareinc.com" ``` @@ -58,43 +59,41 @@ To carry out that task you need to include three parameters: RegistrarPool, whic ## PARAMETERS -### -DN -Enables you to associate an existing Active Directory contact object with a third-party video system. -If you have a contact object you want to associate with video system, use the DN parameter followed by the distinguished name of that contact. -For example: +### -DisplayName -`-DN "cn=Building 14 Lobby,dc=litwareinc,dc=com"` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Note that the command will fail if the specified contact does not exist. -Note, too that you cannot use the OU and the DN parameters in the same command. +Configures the Active Directory display name of the video system. ```yaml -Type: ADObjectId -Parameter Sets: DN -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OU -Distinguished name of the Active Directory organizational unit (OU) where the contact object should be located. +### -DN + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to associate an existing Active Directory contact object with a third-party video system. +If you have a contact object you want to associate with video system, use the DN parameter followed by the distinguished name of that contact. For example: -`-OU "ou=Redmond,dc=litwareinc,dc=com"` +`-DN "cn=Building 14 Lobby,dc=litwareinc,dc=com"` -If you include the OU parameter, a new contact will be created in the specified OU and the contact will automatically be assigned a GUID (globally unique identifier) as its common name. -As a result, the contact object will have a name similar to this: {ce84964a-c4da-4622-ad34-c54ff3ed361f}. +Note that the command will fail if the specified contact does not exist. +Note, too that you cannot use the OU and the DN parameters in the same command. ```yaml -Type: OUIdParameter -Parameter Sets: OU -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: ADObjectId +Parameter Sets: DN +Aliases: Required: True Position: Named @@ -103,37 +102,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RegistrarPool -Fully qualified domain name (FQDN) of the Registrar pool where the contact object should be homed. +### -LineUri + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Phone number for the VTC device. +The line URI should be specified by using the E.164 format and be prefixed by the "TEL:" prefix. For example: -`-RegistrarPool "atl-cs-001.litwareinc.com"` +`-LineURI "TEL:+14255551297"` + +Any extension number should be added to the end of the line URI; for example: + +`-LineURI "TEL:+14255551297;ext=51297"` ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SipAddress -Unique identifier that allows the video system to communicate with SIP devices such as Skype for Business. -The SIP address must be prefaced by the prefix "sip:". +### -OU + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Distinguished name of the Active Directory organizational unit (OU) where the contact object should be located. For example: -`sip:contoso_video@litwareinc.com` +`-OU "ou=Redmond,dc=litwareinc,dc=com"` + +If you include the OU parameter, a new contact will be created in the specified OU and the contact will automatically be assigned a GUID (globally unique identifier) as its common name. +As a result, the contact object will have a name similar to this: {ce84964a-c4da-4622-ad34-c54ff3ed361f}. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: OUIdParameter +Parameter Sets: OU +Aliases: Required: True Position: Named @@ -142,14 +152,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -PassThru + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to pass a contact object through the pipeline that represents the third-party video system being modified. +By default, the `New-CsThirdPartyVideoSystem` cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,55 +171,59 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayName -Configures the Active Directory display name of the video system. +### -RegistrarPool + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the Registrar pool where the contact object should be homed. +For example: + +`-RegistrarPool "atl-cs-001.litwareinc.com"` ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -LineUri -Phone number for the VTC device. -The line URI should be specified by using the E.164 format and be prefixed by the "TEL:" prefix. -For example: +### -SipAddress -`-LineURI "TEL:+14255551297"` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Any extension number should be added to the end of the line URI; for example: +Unique identifier that allows the video system to communicate with SIP devices such as Skype for Business. +The SIP address must be prefaced by the prefix "sip:". +For example: -`-LineURI "TEL:+14255551297;ext=51297"` +`sip:contoso_video@litwareinc.com` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a contact object through the pipeline that represents the third-party video system being modified. -By default, the `New-CsThirdPartyVideoSystem` cmdlet does not pass objects through the pipeline. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -216,13 +233,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -236,13 +255,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsThirdPartyVideoSystem` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADThirdPartyVideoSystemContact The `New-CsThirdPartyVideoSystem` cmdlet creates new instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADThirdPartyVideoSystemContact object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsThirdPartyVideoSystemPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsThirdPartyVideoSystemPolicy.md similarity index 88% rename from skype/skype-ps/skype/New-CsThirdPartyVideoSystemPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsThirdPartyVideoSystemPolicy.md index 4043433c11..24533bdf4e 100644 --- a/skype/skype-ps/skype/New-CsThirdPartyVideoSystemPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsThirdPartyVideoSystemPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csthirdpartyvideosystempolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsThirdPartyVideoSystemPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csthirdpartyvideosystempolicy +schema: 2.0.0 +title: New-CsThirdPartyVideoSystemPolicy --- # New-CsThirdPartyVideoSystemPolicy @@ -36,7 +37,7 @@ The `New-CsThirdPartyVideoSystem` cmdlet provides a way for administrators to cr ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsThirdPartyVideoSystemPolicy -Identity "site:Redmond" -SupportsSendingLowResolution $False ``` @@ -47,33 +48,16 @@ With this policy, VTCs will not be allowed to send low resolution video; that's ## PARAMETERS -### -Identity -Indicates the unique Identity to be assigned to the policy. -Third party video system policies can be created at the site or per-user scope. -To create a policy at the site scope, use syntax similar to this: `-Identity "site:Redmond"`. -To create a policy at the per-user scope, use syntax similar to this: `-Identity "RedmondVideoSystemPolicy"`. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -82,31 +66,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the unique Identity to be assigned to the policy. +Third party video system policies can be created at the site or per-user scope. +To create a policy at the site scope, use syntax similar to this: `-Identity "site:Redmond"`. +To create a policy at the per-user scope, use syntax similar to this: `-Identity "RedmondVideoSystemPolicy"`. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,14 +107,16 @@ Accept wildcard characters: False ``` ### -SupportsSendingLowResolution + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether or not low-resolution video can be sent by a VTC device. The default value is True ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -133,6 +126,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for the third-party video system policy being created. For example: @@ -145,8 +141,25 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -156,13 +169,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -176,13 +191,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsThirdPartyVideoSystemPolicy` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.ThirdPartyVideoSystem.ThirdPartyVideoSystemPolicy The `New-CsThirdPartyVideoSystemPolicy` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ThirdPartyVideoSystem.ThirdPartyVideoSystemPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsTrunkConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsTrunkConfiguration.md similarity index 85% rename from skype/skype-ps/skype/New-CsTrunkConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsTrunkConfiguration.md index f7e31d7df2..2ec916c89a 100644 --- a/skype/skype-ps/skype/New-CsTrunkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTrunkConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cstrunkconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsTrunkConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cstrunkconfiguration +schema: 2.0.0 +title: New-CsTrunkConfiguration --- # New-CsTrunkConfiguration @@ -27,7 +28,7 @@ New-CsTrunkConfiguration [-Identity] [-ConcentratedTopology ] [-RTCPCallsOnHold ] [-SipResponseCodeTranslationRulesList ] [-SRTPMode ] [-Force] [-InMemory] [-WhatIf] [-Confirm] [-Enable3pccRefer ] [-EnableFastFailoverTimer ] [-EnableOnlineVoice ] - [-EnableRTPLatching ] [-ForwardCallHistory ] [-ForwardPAI ] [-ForwardAnonymousCallGatewayPAI ] + [-EnableRTPLatching ] [-ForwardCallHistory ] [-ForwardPAI ] [-ForwardAnonymousCallGatewayPAI ] [-OutboundCallingNumberTranslationRulesList ] [-PstnUsages ] [-EnableLocationRestriction ] [-NetworkSiteID ] [] ``` @@ -40,7 +41,7 @@ These settings configure such things as whether media bypass is enabled on this ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` New-CsTrunkConfiguration -Identity site:Redmond ``` @@ -49,7 +50,7 @@ This example creates a new trunk configuration with the Identity site:Redmond. The remaining properties for this new configuration will be populated with default values. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` New-CsTrunkConfiguration -Identity site:Redmond -EnableBypass $True ``` @@ -59,7 +60,7 @@ Media bypass is enabled by assigning the value $True to the EnableBypass paramet The remaining properties for this new configuration will be populated with default values. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` New-CsTrunkConfiguration -Identity site:Redmond @@ -78,25 +79,10 @@ After that we pass values to the Pattern and Translation parameters to define th ## PARAMETERS -### -Identity -A unique identifier that includes the scope of the trunk configuration. -Trunk configurations can be created at the Site scope, or at the Service scope for a PSTN Gateway service. -(A global configuration exists by default and cannot be removed or re-created.) For example, site:Redmond (for site) or PstnGateway:Redmond.litwareinc.com (for service). - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -ConcentratedTopology -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -ConcentratedTopology The value of this parameter determines whether there is a well-known media termination point. (An example of a well-known media termination point would be a PSTN gateway where the media termination has the same IP as the signaling termination.) Set this value to False if the trunk does not have a well-known media termination point. @@ -105,8 +91,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,13 +101,36 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A string describing the purpose of the trunk configuration. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable3pccRefer + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether the 3pcc protocol can be used to allow transferred calls to bypass the hosted site. +3pcc is also known as "third party control," and occurs when a third-party is used to connect a pair of callers (for example, an operator placing a call from person A to person B). +The REFER method is a standard SIP method which indicates that the recipient should contact a third-party by using information supplied by the sender. +The default value is False ($False). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -132,6 +140,9 @@ Accept wildcard characters: False ``` ### -EnableBypass + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The value of this parameter determines whether media bypass is enabled for this trunk. Set this value to True to enable bypass. Note that in order for the media bypass to work successfully, certain capabilities must be supported by PSTN gateways, SBCs and PBXs, including: @@ -156,8 +167,7 @@ Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -166,16 +176,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMobileTrunkSupport -Defines whether the service provider is a mobile carrier. +### -EnableFastFailoverTimer -Default: False +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, outbound calls that are not answered by the gateway within 10 seconds will be routed to the next available trunk; if there are no additional trunks then the call will automatically be dropped. +In an organization with slow networks and gateway responses, that could potentially result in calls being dropped unnecessarily. + +The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,18 +197,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnablePIDFLOSupport -Defines whether to route emergency calls with Presence Information Data Format Location Object (PIDF-LO) through the defined gateway. -Set this parameter to True if emergency calls are to be routed to a certified emergency services provider. -(The location will be transmitted with the call.) +### -EnableLocationRestriction -Default: False +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, location-based voice routing will be enabled for calls passing through the SIP trunks managed by the specified collection of SIP trunk configuration settings. +With location-based voice routing, the locations of both the user making the call and the user receiving the call are taken into account when calls are routed. +If this property is set to True (the default value is False) then you should also set the NetworkSiteId property. + +This parameter was introduced in the February, 2013 version of Lync Server 2013. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -204,23 +219,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableReferSupport -Defines whether this trunk supports receiving Refer requests from the Mediation Server. - -Media bypass can be enabled only under the following circumstances: +### -EnableMobileTrunkSupport -- The ConcentratedTopology parameter is set to True -- The EnableReferSupport parameter is set to False and RTCPActiveCalls and RTCPCallsOnHold are set to False, or EnableReferSupport is set to True +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that if EnableBypass is True and EnableReferSupport is False, bypass calls that are subsequently transferred will become non-bypass. +Defines whether the service provider is a mobile carrier. -Default: True +Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -229,20 +239,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSessionTimer -Specifies whether the session timer is enabled. -Session timers are used to determine whether a particular session is still active. +### -EnableOnlineVoice -Note that even if this parameter is set to False, session timers can be applicable if the remote connection has session timer enabled. -In such a case, the Mediation Server will reply to session timer probes from the remote entity. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Default: False +Indicates whether the SIP trunks support online voice. +With online voice, users have an on-premises Lync Server account but have their voicemail hosted by Office 365. +The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -251,18 +259,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSignalBoost -When this parameter is set to True the PSTN gateway, IP-PBX, or SBC at the service provider will boost the audio volume in voice streams that are sent to the Mediation Server or Skype for Business Server clients. -If this value is set to False, audio will be boosted either at the Mediation Server (for non-bypass calls) or in Skype for Business Server clients (for bypass calls). +### -EnablePIDFLOSupport -Default: False +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Defines whether to route emergency calls with Presence Information Data Format Location Object (PIDF-LO) through the defined gateway. +Set this parameter to True if emergency calls are to be routed to a certified emergency services provider. +(The location will be transmitted with the call.) +Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -271,16 +281,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxEarlyDialogs -The maximum number of forked responses a PSTN gateway, IP-PBX, or SBC at the service provider can receive to an Invite that it sent to the Mediation Server. +### -EnableReferSupport -Default: 20 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Defines whether this trunk supports receiving Refer requests from the Mediation Server. + +Media bypass can be enabled only under the following circumstances: + +- The ConcentratedTopology parameter is set to True +- The EnableReferSupport parameter is set to False and RTCPActiveCalls and RTCPCallsOnHold are set to False, or EnableReferSupport is set to True + +Note that if EnableBypass is True and EnableReferSupport is False, bypass calls that are subsequently transferred will become non-bypass. + +Default: True ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -289,16 +308,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutboundTranslationRulesList -A collection of phone number translation rules that apply to calls handled by Outbound Routing (calls routed to PBX or PSTN destinations). +### -EnableRTPLatching -While this list and these rules can be created directly with this cmdlet, it is recommended that you create the outbound translation rules with the `New-CsOutboundTranslationRule` cmdlet, which will create the rule and assign it to the trunk configuration with the matching scope. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not the SIP trunks support RTP latching. +RTP latching is a technology that enables RTP/RTCP connectivity through a NAT (network address translator) device or firewall. +The default value is False ($False). ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -307,16 +328,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RemovePlusFromUri -Setting this parameter to True will cause the Mediation Server to remove leading plus signs (+) from Uniform Resource Identifiers (URIs) before sending them on to the service provider. +### -EnableSessionTimer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies whether the session timer is enabled. +Session timers are used to determine whether a particular session is still active. + +Note that even if this parameter is set to False, session timers can be applicable if the remote connection has session timer enabled. +In such a case, the Mediation Server will reply to session timer probes from the remote entity. Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -325,21 +352,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RTCPActiveCalls -This parameter determines whether RTCP packets are sent from the PSTN gateway, IP-PBX, or SBC at the service provider for active calls. -An active call in this context is a call where media is allowed to flow in at least one direction. -If RTCPActiveCalls is set to True, the Mediation Server or Skype for Business Server client can terminate a call if it does not receive RTCP packets for a period exceeding 30 seconds. +### -EnableSignalBoost -Note that disabling the checks for received RTCP media for active calls in Skype for Business Server elements removes an important safeguard for detecting a dropped peer and should be done only if necessary. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Default: True +When this parameter is set to True the PSTN gateway, IP-PBX, or SBC at the service provider will boost the audio volume in voice streams that are sent to the Mediation Server or Skype for Business Server clients. +If this value is set to False, audio will be boosted either at the Mediation Server (for non-bypass calls) or in Skype for Business Server clients (for bypass calls). + +Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -348,21 +374,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RTCPCallsOnHold -This parameter determines whether RTCP packets continue to be sent across the trunk for calls that have been placed on hold and no media packets are expected to flow in either direction. -If Music on Hold is enabled at either the Skype for Business Server client or the trunk, the call will be considered to be active and this property will be ignored. -In these circumstances use the RTCPActiveCalls parameter. - -Note that disabling the checks for received RTCP media for active calls in Skype for Business Server elements removes an important safeguard for detecting a dropped peer and should be done only if necessary. +### -Force -Default: True +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -371,20 +392,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipResponseCodeTranslationRulesList -A list of SIP response code translation rules that apply to response codes received from a PSTN gateway, IP-PBX, or SBC at the service provider. -These rules allow the administrator to map SIP response codes with values between 400 and 699 received over a trunk to new values more consistent with Skype for Business Server. +### -ForwardAnonymousCallGatewayPAI -You can create this list and corresponding rules directly with this cmdlet. -However, it is recommended that you create the SIP response code translation rules by calling the `New-CsSipResponseCodeTranslationRule` cmdlet. -That cmdlet will create the rule and assign it to the trunk configuration with the matching scope. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +If an anonymous call is forwarded to an outgoing PSTN call, this parameter indicates whether the incoming P-Asserted-Identity (PAI) header at the Gateway call will be preserved in the PSTN call. The default value is **False** ($False). + +**Notes:** +- `EnablePAIPAssthrough` is deprecated in favor of `ForwardAnonymousCallGatewayPAI`. This change is made by installing KB5016483. +- When `ForwardAnonymousCallGatewayPAI` is used, `ForwardPAI` must be set to **True**. ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -393,28 +414,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SRTPMode -The value of this parameter determines the level of support for SRTP to protect media traffic between the Mediation Server and the PSTN Gateway, IP-PBX, or SBC at the service provider. -For media bypass cases, this value must be compatible with the EncryptionLevel setting in the media configuration. -Media configuration is set by using the `New-CsMediaConfiguration` cmdlet and the `Set-CsMediaConfiguration` cmdlet. - -Valid values: - -- Required: SRTP encryption must be used. -- Optional: SRTP will be used if the gateway supports it. -- NotSupported: SRTP encryption is not supported and therefore will not be used. - -Note: SRTPMode is used only if the gateway is configured to use Transport Layer Security (TLS). -If the gateway is configured with Transmission Control Protocol (TCP) as the transport, SRTPMode is internally set to NotSupported. +### -ForwardCallHistory -Default: Required +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Indicates whether call history information will be forwarded through the trunk. +The default value is False ($False). ```yaml -Type: SRTPMode +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -423,14 +433,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -ForwardPAI + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether the P-Asserted-Identity (PAI) header will be forwarded along with the call. +The PAI header provides a way to verify the identity of the caller. +The default value is False ($False). ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -439,32 +453,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -Identity +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier that includes the scope of the trunk configuration. +Trunk configurations can be created at the Site scope, or at the Service scope for a PSTN Gateway service. +(A global configuration exists by default and cannot be removed or re-created.) For example, site:Redmond (for site) or PstnGateway:Redmond.litwareinc.com (for service). ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -473,14 +493,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -MaxEarlyDialogs + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The maximum number of forked responses a PSTN gateway, IP-PBX, or SBC at the service provider can receive to an Invite that it sent to the Mediation Server. + +Default: 20 ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -489,17 +513,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Enable3pccRefer -Indicates whether the 3pcc protocol can be used to allow transferred calls to bypass the hosted site. -3pcc is also known as "third party control," and occurs when a third-party is used to connect a pair of callers (for example, an operator placing a call from person A to person B). -The REFER method is a standard SIP method which indicates that the recipient should contact a third-party by using information supplied by the sender. -The default value is False ($False). +### -NetworkSiteID + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Site ID of the network site associated with the new collection of trunk configuration settings. +If the EnableLocationRestriction property is set to True then location-based voice routing through this trunk will be managed by using the settings configured for the specified site. +Network site IDs can be retrieved by using this command: + +`Get-CsNetworkSite | Select NetworkSiteID` + +This parameter was introduced in the February, 2013 release of Lync Server 2013. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -508,17 +537,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableFastFailoverTimer -When set to True, outbound calls that are not answered by the gateway within 10 seconds will be routed to the next available trunk; if there are no additional trunks then the call will automatically be dropped. -In an organization with slow networks and gateway responses, that could potentially result in calls being dropped unnecessarily. +### -OutboundCallingNumberTranslationRulesList -The default value is True. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Collection of outbound calling number translation rules assigned to the trunk. +You can retrieve information about the available rules by running this command: + +`Get-CsOutboundCallingNumberTranslationRule` ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -527,16 +558,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOnlineVoice -Indicates whether the SIP trunks support online voice. -With online voice, users have an on-premises Lync Server account but have their voicemail hosted by Office 365. -The default value is False ($False). +### -OutboundTranslationRulesList + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A collection of phone number translation rules that apply to calls handled by Outbound Routing (calls routed to PBX or PSTN destinations). + +While this list and these rules can be created directly with this cmdlet, it is recommended that you create the outbound translation rules with the `New-CsOutboundTranslationRule` cmdlet, which will create the rule and assign it to the trunk configuration with the matching scope. ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -545,16 +578,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableRTPLatching -Indicates whether or not the SIP trunks support RTP latching. -RTP latching is a technology that enables RTP/RTCP connectivity through a NAT (network address translator) device or firewall. -The default value is False ($False). +### -PstnUsages + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Collection of PSTN usages assigned to the trunk. +You can retrieve information about the available usages by running this command: + +`Get-CsPstnUsage` ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -563,15 +599,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ForwardCallHistory -Indicates whether call history information will be forwarded through the trunk. -The default value is False ($False). +### -RemovePlusFromUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Setting this parameter to True will cause the Mediation Server to remove leading plus signs (+) from Uniform Resource Identifiers (URIs) before sending them on to the service provider. + +Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -580,16 +619,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ForwardPAI -Indicates whether the P-Asserted-Identity (PAI) header will be forwarded along with the call. -The PAI header provides a way to verify the identity of the caller. -The default value is False ($False). +### -RTCPActiveCalls + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter determines whether RTCP packets are sent from the PSTN gateway, IP-PBX, or SBC at the service provider for active calls. +An active call in this context is a call where media is allowed to flow in at least one direction. +If RTCPActiveCalls is set to True, the Mediation Server or Skype for Business Server client can terminate a call if it does not receive RTCP packets for a period exceeding 30 seconds. + +Note that disabling the checks for received RTCP media for active calls in Skype for Business Server elements removes an important safeguard for detecting a dropped peer and should be done only if necessary. + +Default: True + ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -598,18 +644,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ForwardAnonymousCallGatewayPAI -If an anonymous call is forwarded to an outgoing PSTN call, this parameter indicates whether the incoming P-Asserted-Identity (PAI) header at the Gateway call will be preserved in the PSTN call. The default value is **False** ($False). +### -RTCPCallsOnHold + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter determines whether RTCP packets continue to be sent across the trunk for calls that have been placed on hold and no media packets are expected to flow in either direction. +If Music on Hold is enabled at either the Skype for Business Server client or the trunk, the call will be considered to be active and this property will be ignored. +In these circumstances use the RTCPActiveCalls parameter. + +Note that disabling the checks for received RTCP media for active calls in Skype for Business Server elements removes an important safeguard for detecting a dropped peer and should be done only if necessary. + +Default: True -**Notes:** -- `EnablePAIPAssthrough` is deprecated in favor of `ForwardAnonymousCallGatewayPAI`. This change is made by installing KB5016483. -- When `ForwardAnonymousCallGatewayPAI` is used, `ForwardPAI` must be set to **True**. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -618,17 +669,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutboundCallingNumberTranslationRulesList -Collection of outbound calling number translation rules assigned to the trunk. -You can retrieve information about the available rules by running this command: +### -SipResponseCodeTranslationRulesList + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A list of SIP response code translation rules that apply to response codes received from a PSTN gateway, IP-PBX, or SBC at the service provider. +These rules allow the administrator to map SIP response codes with values between 400 and 699 received over a trunk to new values more consistent with Skype for Business Server. + +You can create this list and corresponding rules directly with this cmdlet. +However, it is recommended that you create the SIP response code translation rules by calling the `New-CsSipResponseCodeTranslationRule` cmdlet. +That cmdlet will create the rule and assign it to the trunk configuration with the matching scope. -`Get-CsOutboundCallingNumberTranslationRule` ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -637,17 +693,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PstnUsages -Collection of PSTN usages assigned to the trunk. -You can retrieve information about the available usages by running this command: +### -SRTPMode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The value of this parameter determines the level of support for SRTP to protect media traffic between the Mediation Server and the PSTN Gateway, IP-PBX, or SBC at the service provider. +For media bypass cases, this value must be compatible with the EncryptionLevel setting in the media configuration. +Media configuration is set by using the `New-CsMediaConfiguration` cmdlet and the `Set-CsMediaConfiguration` cmdlet. + +Valid values: + +- Required: SRTP encryption must be used. +- Optional: SRTP will be used if the gateway supports it. +- NotSupported: SRTP encryption is not supported and therefore will not be used. + +Note: SRTPMode is used only if the gateway is configured to use Transport Layer Security (TLS). +If the gateway is configured with Transmission Control Protocol (TCP) as the transport, SRTPMode is internally set to NotSupported. + +Default: Required -`Get-CsPstnUsage` ```yaml -Type: PSListModifier +Type: SRTPMode Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -656,18 +725,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableLocationRestriction -When set to True, location-based voice routing will be enabled for calls passing through the SIP trunks managed by the specified collection of SIP trunk configuration settings. -With location-based voice routing, the locations of both the user making the call and the user receiving the call are taken into account when calls are routed. -If this property is set to True (the default value is False) then you should also set the NetworkSiteId property. +### -Confirm -This parameter was introduced in the February, 2013 version of Lync Server 2013. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -676,20 +743,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkSiteID -Site ID of the network site associated with the new collection of trunk configuration settings. -If the EnableLocationRestriction property is set to True then location-based voice routing through this trunk will be managed by using the settings configured for the specified site. -Network site IDs can be retrieved by using this command: +### -WhatIf -`Get-CsNetworkSite | Select NetworkSiteID` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -This parameter was introduced in the February, 2013 release of Lync Server 2013. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -703,12 +766,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TrunkConfiguration Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TrunkConfiguration. ## NOTES diff --git a/skype/skype-ps/skype/New-CsTrustedApplication.md b/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplication.md similarity index 87% rename from skype/skype-ps/skype/New-CsTrustedApplication.md rename to skype/skype-ps/SkypeForBusiness/New-CsTrustedApplication.md index a46ee864c0..35164616ee 100644 --- a/skype/skype-ps/skype/New-CsTrustedApplication.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cstrustedapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsTrustedApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cstrustedapplication +schema: 2.0.0 +title: New-CsTrustedApplication --- # New-CsTrustedApplication @@ -53,7 +54,7 @@ You must open the port in the Windows firewall and any corporate firewalls in or ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` New-CsTrustedApplication -ApplicationId tapp1 -TrustedApplicationPoolFqdn TrustPool.litwareinc.com -Port 6000 ``` @@ -64,7 +65,7 @@ We also must specify a port for the application; in this example we used port 60 Note that running this cmdlet by specifying an ApplicationId and a TrustedApplicationPoolFqdn will automatically generate an Identity that can later be used to retrieve, modify, or remove this application. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` New-CsTrustedApplication -Identity TrustPool.litwareinc.com/tapp2 -Port 6100 ``` @@ -76,27 +77,10 @@ This value must be in the format \/\. ## PARAMETERS -### -Identity -A unique identifier for the trusted application on the pool. -Identity values must be entered in the format \/\, where pool FQDN is the fully qualified domain name (FQDN) of the pool on which the application resides and application ID is the name of the application. -The application ID must be unique for a given pool. - -If you enter an Identity, you cannot specify values for the ApplicationId or TrustedApplicationPoolFqdn parameters. +### -ApplicationId -```yaml -Type: ExternalApplicationIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ApplicationId The name of the application. This must be a string that is unique within the pool that is specified in the TrustedApplicationPoolFqdn parameter. The string cannot contain spaces. @@ -107,8 +91,7 @@ You cannot specify an ApplicationId and an Identity. ```yaml Type: String Parameter Sets: AppIdAndPoolFqdn -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -117,61 +100,71 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Port -The port number on which the application will run. -The port must be unique within a given pool. -In other words, no other applications that use this same port can be defined on the specified pool. +### -EnableTcp + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies that the trusted application will use Transmission Control Protocol (TCP). +Use this parameter only if the trusted application is not a Microsoft Unified Communications Managed API (UCMA) application. +This is because UCMA applications support only the mutual Transport Layer Security (MTLS) protocol. +If you do not specify the Force parameter with the EnableTcp parameter, you'll receive a confirmation prompt before the new trusted application will be created. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TrustedApplicationPoolFqdn -The FQDN of the trusted application pool on which the application will reside. -If you supply a value for TrustedApplicationPoolFqdn you must also supply a value for ApplicationId, but you cannot supply a value for the Identity parameter. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String -Parameter Sets: AppIdAndPoolFqdn -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableTcp -Specifies that the trusted application will use Transmission Control Protocol (TCP). -Use this parameter only if the trusted application is not a Microsoft Unified Communications Managed API (UCMA) application. -This is because UCMA applications support only the mutual Transport Layer Security (MTLS) protocol. -If you do not specify the Force parameter with the EnableTcp parameter, you'll receive a confirmation prompt before the new trusted application will be created. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier for the trusted application on the pool. +Identity values must be entered in the format \/\, where pool FQDN is the fully qualified domain name (FQDN) of the pool on which the application resides and application ID is the name of the application. +The application ID must be unique for a given pool. + +If you enter an Identity, you cannot specify values for the ApplicationId or TrustedApplicationPoolFqdn parameters. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: ExternalApplicationIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -LegacyApplicationName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Use this parameter only if the application is being migrated from a Microsoft Office Communications Server 2007 R2 deployment. This value must be the same as the GRUU type of the Office Communications Server 2007 R2 version of the application in order for the two to work together. @@ -183,8 +176,7 @@ If you don't specify a value for this parameter, the value of the Application ID ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -193,32 +185,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Port + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The port number on which the application will run. +The port must be unique within a given pool. +In other words, no other applications that use this same port can be defined on the specified pool. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -TrustedApplicationPoolFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The FQDN of the trusted application pool on which the application will reside. +If you supply a value for TrustedApplicationPoolFqdn you must also supply a value for ApplicationId, but you cannot supply a value for the Identity parameter. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: AppIdAndPoolFqdn +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -226,13 +225,33 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -246,12 +265,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.Xds.DisplayTrustedApplication Creates an object of type Microsoft.Rtc.Management.Xds.DisplayTrustedApplication. ## NOTES diff --git a/skype/skype-ps/skype/New-CsTrustedApplicationComputer.md b/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationComputer.md similarity index 86% rename from skype/skype-ps/skype/New-CsTrustedApplicationComputer.md rename to skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationComputer.md index 1f2dd613a9..e40f9aee2e 100644 --- a/skype/skype-ps/skype/New-CsTrustedApplicationComputer.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationComputer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cstrustedapplicationcomputer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsTrustedApplicationComputer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cstrustedapplicationcomputer +schema: 2.0.0 +title: New-CsTrustedApplicationComputer --- # New-CsTrustedApplicationComputer @@ -38,7 +39,7 @@ In addition, if you did not specify a computer FQDN for the default computer whe ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` New-CsTrustedApplicationComputer -Identity Trust1.litwareinc.com -Pool TrustPool.litwareinc.com ``` @@ -51,14 +52,34 @@ The pool must exist and must be a trusted application pool. ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The FQDN of the computer that hosts the trusted application. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -68,14 +89,16 @@ Accept wildcard characters: False ``` ### -Pool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The FQDN of the pool hosting the trusted application computer. You can find available pools by running the `Get-CsTrustedApplicationPool` cmdlet. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -84,14 +107,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -101,29 +126,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -137,12 +148,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.Xds.DisplayComputer Creates an object of type Microsoft.Rtc.Management.Xds.DisplayComputer. ## NOTES diff --git a/skype/skype-ps/skype/New-CsTrustedApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationEndpoint.md similarity index 82% rename from skype/skype-ps/skype/New-CsTrustedApplicationEndpoint.md rename to skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationEndpoint.md index 9013c9e9a4..0aab130d2d 100644 --- a/skype/skype-ps/skype/New-CsTrustedApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationEndpoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cstrustedapplicationendpoint applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsTrustedApplicationEndpoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cstrustedapplicationendpoint +schema: 2.0.0 +title: New-CsTrustedApplicationEndpoint --- # New-CsTrustedApplicationEndpoint @@ -34,7 +35,7 @@ This cmdlet creates a new endpoint contact object in Active Directory Domain Ser ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` New-CsTrustedApplicationEndpoint -ApplicationId tapp1 -TrustedApplicationPoolFqdn TrustPool.litwareinc.com ``` @@ -46,7 +47,7 @@ In order to ensure the SIP address is unique, the auto-generated address will in If you'd like a more readable SIP address, see Example 2. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` New-CsTrustedApplicationEndpoint -ApplicationId tapp1 -TrustedApplicationPoolFqdn TrustPool.litwareinc.com -SipAddress sip:endpoint1@litwareinc.com ``` @@ -59,6 +60,9 @@ Rather than allowing the system to generate a SIP address, we've specified an ad ## PARAMETERS ### -ApplicationId + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The application ID of the trusted application for which the endpoint contact is being created. An application with this ID must already exist. Note that you may include only the name part of the application ID, you don't need to (but you can) include the prefix information. @@ -67,8 +71,7 @@ For example, if the application ID is urn:application:TrustedApp1 you only need ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -77,33 +80,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TrustedApplicationPoolFqdn -The fully qualified domain name (FQDN) of the trusted application pool associated with the application. -The application must already be associated with this pool for the endpoint to be created. +### -DisplayName -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SipAddress -A SIP address for the new contact object. -If you do not include a value for this parameter a SIP address will be auto-generated in the format sip:RtcApplication-\.\, for example sip:RtcApplication-fbf9e2d1-c6aa-45a3-a045-b92d4ef961b2@litwareinc.com. -The domain will be the default SIP domain. +The display name of the endpoint contact object. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -112,14 +98,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayName -The display name of the endpoint contact object. +### -DisplayNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The telephone number of the contact as it will appear in the Address Book. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,14 +116,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayNumber -The telephone number of the contact as it will appear in the Address Book. +### -LineURI + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The phone number of the contact. +Must be in the format TEL:\, for example TEL:+14255551212. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -144,15 +135,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LineURI -The phone number of the contact. -Must be in the format TEL:\, for example TEL:+14255551212. +### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns the results of this command. +Running this cmdlet will display the newly created object; including this parameter will simply repeat that output, making the use of this parameter redundant. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,6 +155,9 @@ Accept wildcard characters: False ``` ### -PrimaryLanguage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The primary language used for the trusted application. The language must be configured using a valid language code, such as en-US (U.S. English), fr-FR (French), etc. @@ -169,8 +165,7 @@ English), fr-FR (French), etc. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -180,6 +175,9 @@ Accept wildcard characters: False ``` ### -SecondaryLanguages + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A collection of languages that can also be used for trusted applications. Values must be configured as a comma-separated values list of language codes. For example, the following syntax sets French Canadian and French as secondary languages: `-SecondaryLanguages "fr-CA","fr-FR"`. @@ -187,8 +185,27 @@ For example, the following syntax sets French Canadian and French as secondary l ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.String] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A SIP address for the new contact object. +If you do not include a value for this parameter a SIP address will be auto-generated in the format sip:RtcApplication-\.\, for example sip:RtcApplication-fbf9e2d1-c6aa-45a3-a045-b92d4ef961b2@litwareinc.com. +The domain will be the default SIP domain. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -198,6 +215,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new trusted application pool endpoint is being created. For example: @@ -211,8 +231,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -221,31 +240,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Returns the results of this command. -Running this cmdlet will display the newly created object; including this parameter will simply repeat that output, making the use of this parameter redundant. +### -TrustedApplicationPoolFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The fully qualified domain name (FQDN) of the trusted application pool associated with the application. +The application must already be associated with this pool for the endpoint to be created. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -254,14 +277,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -275,12 +300,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact Creates an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact. ## NOTES diff --git a/skype/skype-ps/skype/New-CsTrustedApplicationPool.md b/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationPool.md similarity index 84% rename from skype/skype-ps/skype/New-CsTrustedApplicationPool.md rename to skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationPool.md index cd945137d5..89a6004802 100644 --- a/skype/skype-ps/skype/New-CsTrustedApplicationPool.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsTrustedApplicationPool.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cstrustedapplicationpool applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsTrustedApplicationPool -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cstrustedapplicationpool +schema: 2.0.0 +title: New-CsTrustedApplicationPool --- # New-CsTrustedApplicationPool @@ -43,7 +44,7 @@ To add more computers to the pool, call the `New-CsTrustedApplicationComputer` c ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` New-CsTrustedApplicationPool -Identity TrustPool.litwareinc.com -Registrar pool0.litwareinc.com -Site Redmond ``` @@ -61,7 +62,7 @@ However, if you want to later find all trusted application pools for the NA site `Get-CsTrustedApplicationPool | Where-Object {$_.SiteId -eq "site:Redmond1"}` -### -------------------------- Example 2 ------------------------ +### Example 2 ``` New-CsTrustedApplicationPool -Identity TrustPool.litwareinc.com -Registrar Registrar:redmond.litwareinc.com -Site Redmond -ComputerFqdn AppServer.litwareinc.com ``` @@ -75,25 +76,10 @@ We've specified a different FQDN, AppServer.litwareinc.com, for the computer tha ## PARAMETERS -### -Identity -The FQDN of the new pool. -Note that while the Identity value for creating a pool is the pool FQDN, the value that will be stored as the Identity with the new pool is actually an automatically generated service ID of the pool. -The Identity entered here will be saved as the PoolFqdn. +### -AppSharingPortCount -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AppSharingPortCount The number of ports available in the port range for application sharing connections. Default: 0 @@ -101,8 +87,7 @@ Default: 0 ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -112,13 +97,15 @@ Accept wildcard characters: False ``` ### -AppSharingPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number of the first port in the port range available for application sharing connections. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,6 +115,9 @@ Accept wildcard characters: False ``` ### -AudioPortCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number of ports available in the port range for audio connections. Default: 0 @@ -135,8 +125,7 @@ Default: 0 ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -146,13 +135,15 @@ Accept wildcard characters: False ``` ### -AudioPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number of the first port in the port range available for audio connections. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,6 +153,9 @@ Accept wildcard characters: False ``` ### -ComputerFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creating a trusted application pool will automatically create a trusted application computer that is part of that pool. By default the computer will receive the same FQDN as the pool. Enter a value in this parameter to specify an FQDN for the computer that is different from the pool FQDN. @@ -170,8 +164,7 @@ If you plan to add more computers to the pool, you must enter a value for this p ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -180,7 +173,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The FQDN of the new pool. +Note that while the Identity value for creating a pool is the pool FQDN, the value that will be stored as the Identity with the new pool is actually an automatically generated service ID of the pool. +The Identity entered here will be saved as the PoolFqdn. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OutboundOnly + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies whether a trusted application can initiate a connection to a server within the pool. Set this value to True if you want all connections to be initiated by the server rather than the application. @@ -189,8 +223,7 @@ Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -200,6 +233,9 @@ Accept wildcard characters: False ``` ### -Registrar + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The service ID or FQDN of the Registrar service for the pool. Note that even though this parameter is optional, if you attempt to create a new trusted application endpoint (by using the `New-CsTrustedApplicationEndpoint` cmdlet) and assign the endpoint to a pool that does not have a Registrar dependency, you'll receive an error and the endpoint will not be created. @@ -208,8 +244,7 @@ In addition, you cannot remove a trusted application pool that is not associated ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -219,6 +254,9 @@ Accept wildcard characters: False ``` ### -RequiresReplication + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether replication is required for this pool. Set this value to False if replication is not required. You would usually set this parameter to False for Microsoft Outlook Web Access and manually-provisioned applications. @@ -229,8 +267,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -240,6 +277,9 @@ Accept wildcard characters: False ``` ### -Site + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Site ID of the site on which this pool is homed. Call the `Get-CsSite` cmdlet to retrieve the SiteId property of a site. Keep in mind that you must use the SiteId property rather than the Identity of the site. @@ -254,8 +294,7 @@ If the pool doesn't exist, this parameter is required. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -265,6 +304,9 @@ Accept wildcard characters: False ``` ### -ThrottleAsServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Set this parameter to false to throttle connections between the servers within the pool and trusted applications as clients. This places greater restrictions on the connections than the default True, which throttles connections as servers. Throttling a connection places restrictions on the number of transactions that can occur at once. @@ -274,8 +316,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -285,6 +326,9 @@ Accept wildcard characters: False ``` ### -TreatAsAuthenticated + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether authentication is required for trusted applications connecting to servers within the pool. Set this parameter to False if you want to require trusted applications to be authenticated. The default value of True allows the trusted applications to connect under the assumption they've already been authenticated. @@ -294,8 +338,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -305,6 +348,9 @@ Accept wildcard characters: False ``` ### -VideoPortCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number of ports available in the port range for video connections. Default: 0 @@ -312,8 +358,7 @@ Default: 0 ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -323,13 +368,15 @@ Accept wildcard characters: False ``` ### -VideoPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number of the first port in the port range available for video connections. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -338,14 +385,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -355,29 +404,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -391,12 +426,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.Xds.DisplayExternalServer Creates an object of type Microsoft.Rtc.Management.Xds.DisplayExternalServer. ## NOTES diff --git a/skype/skype-ps/skype/New-CsUCPhoneConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsUCPhoneConfiguration.md similarity index 86% rename from skype/skype-ps/skype/New-CsUCPhoneConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsUCPhoneConfiguration.md index 30a0ec713e..1ddbc403d8 100644 --- a/skype/skype-ps/skype/New-CsUCPhoneConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsUCPhoneConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csucphoneconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsUCPhoneConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csucphoneconfiguration +schema: 2.0.0 +title: New-CsUCPhoneConfiguration --- # New-CsUCPhoneConfiguration @@ -51,7 +52,7 @@ The only thing you can do at the global scope is use the `Set-CsUCPhoneConfigura ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` New-CsUCPhoneConfiguration -Identity site:Redmond -CalendarPollInterval "00:10:00" -LoggingLevel "Medium" ``` @@ -62,7 +63,7 @@ As soon as this command completes, the new settings will be applied to the Redmo Note that this command will fail if the Redmond site already has a collection of UC phone settings. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $x = New-CsUCPhoneConfiguration -Identity site:Redmond -InMemory @@ -83,24 +84,10 @@ If you do not call this cmdlet, your virtual settings will disappear when you en ## PARAMETERS -### -Identity -Represents the unique identifier to be assigned to the new collection of UC phone configuration settings. -Because you can only create new collections at the site scope, the Identity will always be the prefix "site:" followed by the site name; for example "site:Redmond". - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -CalendarPollInterval -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -CalendarPollInterval Indicates how often the UC device retrieves information from your Outlook calendar. The value must be specified using the format hours:minutes:seconds; for example, to set the time interval to 1 hour (the maximum allowed interval) use this syntax: @@ -112,8 +99,7 @@ The default value is 3 minutes (00:03:00). ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -123,14 +109,73 @@ Accept wildcard characters: False ``` ### -EnforcePhoneLock + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether or not UC phones are automatically locked after the number of minutes specified by PhoneLockTimeout. The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Represents the unique identifier to be assigned to the new collection of UC phone configuration settings. +Because you can only create new collections at the site scope, the Identity will always be the prefix "site:" followed by the site name; for example "site:Redmond". + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -140,6 +185,9 @@ Accept wildcard characters: False ``` ### -LoggingLevel + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables logging on the UC device. Valid values are Off; Low; Medium; and High. The default value is Off. @@ -147,8 +195,7 @@ The default value is Off. ```yaml Type: LoggingLevel Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,6 +205,9 @@ Accept wildcard characters: False ``` ### -MinPhonePinLength + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the minimum number of digits required for personal identification numbers (PINs). Minimum value: 4 @@ -169,8 +219,7 @@ Default: 6 ```yaml Type: Byte Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -180,6 +229,9 @@ Accept wildcard characters: False ``` ### -PhoneLockTimeout + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the length of time, in minutes, that a UC phone will remain idle before automatically locking. This value must be less than 01:00:00 (1 hour). @@ -188,8 +240,7 @@ The default value is 00:10:00 (10 minutes). ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -199,6 +250,9 @@ Accept wildcard characters: False ``` ### -SIPSecurityMode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the level of security that the server applies to SIP sessions initiated by a UC phone. Valid values are: @@ -214,8 +268,7 @@ The default value is High. ```yaml Type: SIPSecurityMode Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,6 +278,9 @@ Accept wildcard characters: False ``` ### -Voice8021p + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the user priority value (the 802.1p value) for voice traffic within the Skype for Business Server deployment. This setting is effective only for networks in which switches and bridges are 802.1p-capable. @@ -235,8 +291,7 @@ The default value is 0. ```yaml Type: Byte Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -246,6 +301,9 @@ Accept wildcard characters: False ``` ### -VoiceDiffServTag + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the decimal representation of the 6-bit DiffServ Code Point (DSCP) priority marking. This marking defines the Per Hop Behavior (PHB) for IP packets passed by the UC phones that are managed by this server. @@ -255,8 +313,7 @@ The default value is 40. ```yaml Type: Byte Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -265,32 +322,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### -Confirm -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -300,29 +341,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -336,13 +363,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsUCPhoneConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.UcPhoneSettings Creates instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.UcPhoneSettings object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsUnassignedNumber.md b/skype/skype-ps/SkypeForBusiness/New-CsUnassignedNumber.md similarity index 86% rename from skype/skype-ps/skype/New-CsUnassignedNumber.md rename to skype/skype-ps/SkypeForBusiness/New-CsUnassignedNumber.md index 963f52646a..dc36abb242 100644 --- a/skype/skype-ps/skype/New-CsUnassignedNumber.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsUnassignedNumber.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csunassignednumber applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsUnassignedNumber -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csunassignednumber +schema: 2.0.0 +title: New-CsUnassignedNumber --- # New-CsUnassignedNumber @@ -47,7 +48,7 @@ To check on Exchange Auto Attendant settings, run the `Get-CsExUmContact` cmdlet ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsUnassignedNumber -Identity UNSet1 -NumberRangeStart "+14255551000" -NumberRangeEnd "+14255551100" -AnnouncementService ApplicationServer:redmond.litwareinc.com -AnnouncementName "Welcome Announcement" ``` @@ -58,7 +59,7 @@ Finally, we specify the Announcement by first supplying the AnnouncementService Keep in mind that an Announcement with that name must already exist in the system. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsUnassignedNumber -Identity UNSet2 -NumberRangeStart "+14255552100" -NumberRangeEnd "+14255552200" -ExUmAutoAttendantPhoneNumber "+12065551234" ``` @@ -71,7 +72,7 @@ Note that Exchange must be set up and this number must be an existing contact ob The contact must be an Auto Attendant contact (the AutoAttendant property for the contact must be True). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` New-CsUnassignedNumber -Identity UNSet2 -NumberRangeStart "+14255552100" -NumberRangeEnd "+14255552200" -ExUmAutoAttendantPhoneNumber "+12065551234" -Priority 2 ``` @@ -83,32 +84,16 @@ This means that if an unassigned number range has been defined that overlaps thi ## PARAMETERS -### -Identity -A unique name for the range of unassigned numbers being created. -All unassigned number ranges have a global scope, so the name specified here must be unique throughout the Skype for Business Server deployment. - - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AnnouncementName -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AnnouncementName The name of the Announcement that will be used to handle calls to this range of numbers. ```yaml Type: String Parameter Sets: AnnouncementService -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 6 @@ -118,6 +103,9 @@ Accept wildcard characters: False ``` ### -AnnouncementService + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The fully qualified domain name (FQDN) or service ID of the Announcement service. This parameter is required only if you have not specified a value for the ExUmAutoAttendantPhoneNumber parameter. @@ -125,7 +113,6 @@ This parameter is required only if you have not specified a value for the ExUmAu Type: String Parameter Sets: AnnouncementService Aliases: AnnouncementServerFqdn -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 5 @@ -135,6 +122,9 @@ Accept wildcard characters: False ``` ### -ExUmAutoAttendantPhoneNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The phone number of the Exchange Auto Attendant to route calls in this range to. This field is required only if you are not using an Announcement Service (in which case you do not supply values for the AnnouncementService or AnnouncementName parameters). The Exchange Auto Attendant contact must already be set up in order to assign a value to this parameter. @@ -143,8 +133,7 @@ The Exchange Auto Attendant contact must already be set up in order to assign a ```yaml Type: String Parameter Sets: AutoAttendant -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 5 @@ -153,28 +142,68 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NumberRangeStart -The first number in the range of unassigned numbers. -Must be less than or equal to the value supplied for NumberRangeEnd. +### -Force -The number must match the regular expression (tel:)?(\+)?\[1-9\]\d{0,17}(;ext=\[1-9\]\d{0,9})?. -This means the number may begin with the string tel: (if you don't specify that string it will be automatically added for you), a plus sign (+) and a digit 1 through 9. -The phone number can be up to 17 digits and may be followed by an extension in the format ;ext= followed by the extension number. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique name for the range of unassigned numbers being created. +All unassigned number ranges have a global scope, so the name specified here must be unique throughout the Skype for Business Server deployment. + + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: (All) +Aliases: Required: True -Position: 3 +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -NumberRangeEnd + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The last number in the range of unassigned numbers. Must be greater than or equal to the number supplied for NumberRangeStart. To specify a range of one number, use the same number for the NumberRangeStart and NumberRangeEnd. @@ -186,8 +215,7 @@ The phone number can be up to 17 digits and may be followed by an extension in t ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 4 @@ -196,32 +224,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Priority -It is possible for unassigned number ranges to overlap. -If a number falls within more than one range, the range with the highest priority will take effect. +### -NumberRangeStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The first number in the range of unassigned numbers. +Must be less than or equal to the value supplied for NumberRangeEnd. +The number must match the regular expression (tel:)?(\+)?\[1-9\]\d{0,17}(;ext=\[1-9\]\d{0,9})?. +This means the number may begin with the string tel: (if you don't specify that string it will be automatically added for you), a plus sign (+) and a digit 1 through 9. +The phone number can be up to 17 digits and may be followed by an extension in the format ;ext= followed by the extension number. ```yaml -Type: Int32 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +It is possible for unassigned number ranges to overlap. +If a number falls within more than one range, the range with the highest priority will take effect. + ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -230,16 +267,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -249,29 +286,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -285,12 +308,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange Creates an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange. ## NOTES diff --git a/skype/skype-ps/skype/New-CsUserReplicatorConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsUserReplicatorConfiguration.md similarity index 89% rename from skype/skype-ps/skype/New-CsUserReplicatorConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsUserReplicatorConfiguration.md index 285f45e328..ba185645bd 100644 --- a/skype/skype-ps/skype/New-CsUserReplicatorConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsUserReplicatorConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csuserreplicatorconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsUserReplicatorConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csuserreplicatorconfiguration +schema: 2.0.0 +title: New-CsUserReplicatorConfiguration --- # New-CsUserReplicatorConfiguration @@ -49,7 +50,7 @@ You cannot create new User Replicator settings for the on-premises version of Sk ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` New-CsUserReplicatorConfiguration -Identity "service:Registrar:atl-cs-001.litwareinc.com" ``` @@ -58,7 +59,7 @@ The command shown in Example 1 creates a new collection of User Replicator confi Because no additional parameters are specified, the new collection will use the default user replicator values. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` New-CsUserReplicatorConfiguration -Identity "service:Registrar:atl-cs-001.litwareinc.com" -ADDomainNamingContextList @{Add="dc=fabrikam,dc=com","dc=contoso.com"} ``` @@ -70,30 +71,10 @@ This new collection of user replicator configuration settings will only configur ## PARAMETERS -### -Identity -Unique identifier of the User Replicator configuration settings to be created. -Settings can only be created at the service scope and only for the Registrar service. -That means that new settings must have an Identity similar to this: - -`-Identity "service:Registrar:atl-cs-001.litwareinc.com"` - -Note that this applies only to Skype for Business Online. +### -ADDomainNamingContextList +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ADDomainNamingContextList Distinguished names of the Active Directory domains that the User Replicator must synchronize with. For example, to add a domain to the list use syntax similar to this: @@ -111,8 +92,7 @@ If this property is not null then the replicator will only synchronize with the ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -121,20 +101,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReplicationCycleInterval -Represents the amount of time that the User Replicator waits before checking for user account updates in Active Directory. -The replication cycle interval can be any time value between 1 second and 23 hours, 59 minutes and 59 seconds; the default value is 1 minute. -The interval must be expressed using the format hours:minutes:seconds. -For example, this syntax sets to time interval to one hour and 15 minutes: +### -Force -`-ReplicationCycleInterval 01:15:00` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: TimeSpan +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -143,23 +119,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier of the User Replicator configuration settings to be created. +Settings can only be created at the service scope and only for the Registrar service. +That means that new settings must have an Identity similar to this: + +`-Identity "service:Registrar:atl-cs-001.litwareinc.com"` + +Note that this applies only to Skype for Business Online. + ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. @@ -167,8 +155,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -177,14 +164,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -ReplicationCycleInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Represents the amount of time that the User Replicator waits before checking for user account updates in Active Directory. +The replication cycle interval can be any time value between 1 second and 23 hours, 59 minutes and 59 seconds; the default value is 1 minute. +The interval must be expressed using the format hours:minutes:seconds. +For example, this syntax sets to time interval to one hour and 15 minutes: + +`-ReplicationCycleInterval 01:15:00` + ```yaml -Type: SwitchParameter +Type: TimeSpan Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SkipFirstSyncAllowedDowntime + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates how long Skype for Business Server should wait for user data to synchronize before marking the service as started. +The default value is 2 hours (02:00:00), meaning that, after 2 hours, the status of the replication service will changed from Pending to Started. + +```yaml +Type: TimeSpan +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -194,13 +208,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -209,15 +225,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipFirstSyncAllowedDowntime -Indicates how long Skype for Business Server should wait for user data to synchronize before marking the service as started. -The default value is 2 hours (02:00:00), meaning that, after 2 hours, the status of the replication service will changed from Pending to Started. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: TimeSpan +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -231,13 +248,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsUserReplicatorConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.UserReplicator.UserReplicatorConfiguration The `New-CsUserReplicatorConfiguration` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserReplicator.UserReplicatorConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsUserServicesConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsUserServicesConfiguration.md similarity index 86% rename from skype/skype-ps/skype/New-CsUserServicesConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsUserServicesConfiguration.md index 6a6f17e252..20d36c66d9 100644 --- a/skype/skype-ps/skype/New-CsUserServicesConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsUserServicesConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csuserservicesconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsUserServicesConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csuserservicesconfiguration +schema: 2.0.0 +title: New-CsUserServicesConfiguration --- # New-CsUserServicesConfiguration @@ -42,7 +43,7 @@ Your command will fail if you try to create settings for, say, the Redmond site ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` New-CsUserServicesConfiguration -Identity site:Redmond -MaxContacts 500 -MaintenanceTimeOfDay "11:00 PM" ``` @@ -53,7 +54,7 @@ Note that this command will fail if User Services settings have already been con That is because you are limited to one collection of settings per site. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $x = New-CsUserServicesConfiguration -Identity site:Redmond -InMemory @@ -77,31 +78,28 @@ This final step is crucial: if you do not call the `Set-CsUserServicesConfigurat ## PARAMETERS -### -Identity -Unique identifier for the User Services configuration settings to be created. -To create settings at the site scope, use syntax similar to this: - -`-Identity site:Redmond` - -To create settings at the service level, use syntax like this: +### -AllowNonRoomSystemNotification -`-Identity service:UserServer:atl-cs-001.litwareinc.com` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +PARAMVALUE: $true | $false ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -AnonymousUserGracePeriod + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the amount of time an anonymous (unauthenticated) user can remain in a meeting without an authenticated user being present in that same meeting. For example, if this value is set to 15 minutes an anonymous user can stay in the meeting for, at most, 15 minutes before an authenticated user must join. If an authenticated user does not join before the grace period expires then the anonymous user will be removed from the meeting. @@ -114,8 +112,7 @@ The grace period can be set to any value between 0 second and 1 day; the default ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -125,6 +122,9 @@ Accept wildcard characters: False ``` ### -DeactivationGracePeriod + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum amount of time that a meeting can remain active. This value must be specified using the following format: days.hours:minutes:seconds. For example, to enable a meeting to last for 60 hours you would use this format: 2.12:00:00 (2 days. @@ -136,8 +136,7 @@ The default value is 1 day (1.00:00:00). ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -147,6 +146,9 @@ Accept wildcard characters: False ``` ### -DefaultSubscriptionExpiration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Subscriptions are created any time a user makes a request for data such as presence information. When the request is made, the user (or, more correctly, the user's client application) can request the length of time that the subscription remains valid before it must be renewed. If no such request is issued, then the subscription is set to the value specified by the DefaultSubscriptionExpiration property. @@ -157,8 +159,71 @@ The default value is 28800 seconds (8 hours). ```yaml Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the User Services configuration settings to be created. +To create settings at the site scope, use syntax similar to this: + +`-Identity site:Redmond` + +To create settings at the service level, use syntax like this: + +`-Identity service:UserServer:atl-cs-001.litwareinc.com` + + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -168,6 +233,9 @@ Accept wildcard characters: False ``` ### -MaintenanceTimeOfDay + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the time of day when regularly-scheduled database maintenance (such as the purging of outdated records) takes place. This value must be specified as a date-time value. You can use either the 24-hour format (for example, "14:00") or the 12-hour format (for example, "2:00 PM"). @@ -177,8 +245,7 @@ The default value for MaintenanceTimeOfDay is 1:00 AM (01:00:00). ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -188,6 +255,9 @@ Accept wildcard characters: False ``` ### -MaxContacts + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum number of contacts a user can have; the default value is 250. The MaxContacts property represents the absolute maximum number of contacts a user can have. However, you can use the CsClientPolicy cmdlets to limit certain users to a maximum number of contacts lower than the value of MaxContacts. @@ -195,8 +265,7 @@ However, you can use the CsClientPolicy cmdlets to limit certain users to a maxi ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -206,6 +275,9 @@ Accept wildcard characters: False ``` ### -MaxPersonalNotes + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the maximum number of personal notes that are stored in the user's note history. By default, the last 3 personal notes are maintained in the note history. The maximum number of notes that can be maintained in the history is 10. @@ -213,8 +285,7 @@ The maximum number of notes that can be maintained in the history is 10. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -224,6 +295,9 @@ Accept wildcard characters: False ``` ### -MaxScheduledMeetingsPerOrganizer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum number of meetings that a single user can serve as organizer for at a given time. The default value is 1000. This means that, if a user is already the organizer for 1000 meetings, his or her attempt to schedule a new meeting (meeting number 1001) will fail. @@ -231,8 +305,7 @@ This means that, if a user is already the organizer for 1000 meetings, his or he ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -242,6 +315,9 @@ Accept wildcard characters: False ``` ### -MaxSubscriptionExpiration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Subscriptions are created any time a user makes a request for data such as presence information. When the request is made, the user (or, more correctly, the user's client application) can request the length of time that the subscription remains valid before it must be renewed. The MaxSubscriptionExpiration property represents the maximum amount of time that clients can be granted. @@ -253,8 +329,7 @@ The default value is 43200 seconds (12 hours). ```yaml Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -264,6 +339,9 @@ Accept wildcard characters: False ``` ### -MaxSubscriptions + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum number of SIP subscribe dialogs that a user can have open at any one time. A subscribe dialog represents a request for SIP resources. The default value is 200. @@ -272,8 +350,7 @@ The default value is 200. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -282,32 +359,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SubscribeToCollapsedDG -If set to True (the default value), client applications will be allowed to subscribe to distribution groups that are not currently expanded in the Contacts list. -This enables the client to maintain up-to-minute presence information for each member of the group. -If set to False, client applications will not be allowed to subscribe to "collapsed" groups. +### -MinSubscriptionExpiration -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Subscriptions are created any time a user makes a request for data such as presence information. +When the request is made, the user (or, more correctly, the user's client application) can request the length of time that the subscription remains valid before it must be renewed. +The MinSubscriptionExpiration property represents the minimum amount of time that clients can be granted. +For example, if the minimum time is set to 1200 seconds and a client requests a timeout interval of 200 seconds, the client will be given the minimum allowed expiration period: 1200 seconds. + +The minimum subscription time must be expressed as an integer value between 300 seconds (5 minutes) and 86400 seconds (24 hours), inclusive. +The default value is 1200 seconds (20 minutes). -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: SwitchParameter +Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -316,16 +384,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -PresenceProviders +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Collection of presence providers for the new User Service configuration settings. +Presence providers are best added to a collection of User Service configuration settings by using the `New-CsPresenceProvider` cmdlet. ```yaml -Type: SwitchParameter +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -334,30 +403,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -SubscribeToCollapsedDG -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +If set to True (the default value), client applications will be allowed to subscribe to distribution groups that are not currently expanded in the Contacts list. +This enables the client to maintain up-to-minute presence information for each member of the group. +If set to False, client applications will not be allowed to subscribe to "collapsed" groups. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -366,21 +423,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MinSubscriptionExpiration -Subscriptions are created any time a user makes a request for data such as presence information. -When the request is made, the user (or, more correctly, the user's client application) can request the length of time that the subscription remains valid before it must be renewed. -The MinSubscriptionExpiration property represents the minimum amount of time that clients can be granted. -For example, if the minimum time is set to 1200 seconds and a client requests a timeout interval of 200 seconds, the client will be given the minimum allowed expiration period: 1200 seconds. +### -Confirm -The minimum subscription time must be expressed as an integer value between 300 seconds (5 minutes) and 86400 seconds (24 hours), inclusive. -The default value is 1200 seconds (20 minutes). +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml -Type: Int64 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -389,31 +441,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PresenceProviders -Collection of presence providers for the new User Service configuration settings. -Presence providers are best added to a collection of User Service configuration settings by using the `New-CsPresenceProvider` cmdlet. +### -WhatIf -```yaml -Type: PSListModifier -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -AllowNonRoomSystemNotification -PARAMVALUE: $true | $false +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -427,13 +464,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsUserServicesConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.UserServicesSettings The `New-CsUserServicesConfiguration` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.UserServicesSettings object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsUserServicesPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsUserServicesPolicy.md similarity index 88% rename from skype/skype-ps/skype/New-CsUserServicesPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsUserServicesPolicy.md index d9608afa86..7309f4bfea 100644 --- a/skype/skype-ps/skype/New-CsUserServicesPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsUserServicesPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csuserservicespolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsUserServicesPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csuserservicespolicy +schema: 2.0.0 +title: New-CsUserServicesPolicy --- # New-CsUserServicesPolicy @@ -46,7 +47,7 @@ Skype for Business Server Control Panel: The functions carried out by the `New-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsUserServicesPolicy -Identity "site:Redmond" -UcsAllowed $False ``` @@ -57,7 +58,46 @@ Users managed by this policy will not have their contacts moved to the Unified C ## PARAMETERS +### -EnableAwaySinceIndication + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: $true | $false + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the policy to be created. To create a policy at the site scope, use syntax similar to this: @@ -78,8 +118,7 @@ To create a per-user policy, use syntax similar to this: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -88,30 +127,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -InMemory -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -120,15 +146,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. +### -MigrationDelayInDays + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the number of days the system will wait before beginning a migration to or from the unified contact store. +MigrationDelayInDays can be set to any value between 0 and 180, inclusive. +The default value is 0. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,6 +167,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new user services policy is being created. For example: @@ -151,8 +183,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,6 +193,9 @@ Accept wildcard characters: False ``` ### -UcsAllowed + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True (the default value) users affected by the policy will automatically be migrated to the unified contact store (assuming that they have an account on Exchange and that they log on using Skype for Business). When set to False, users can be removed from the unified contact store, but only if they are "manually" removed by the `Invoke-CsUcsRollback` cmdlet. @@ -169,8 +203,7 @@ When set to False, users can be removed from the unified contact store, but only ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,14 +212,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -195,32 +230,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAwaySinceIndication -PARAMVALUE: $true | $false - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -MigrationDelayInDays -Specifies the number of days the system will wait before beginning a migration to or from the unified contact store. -MigrationDelayInDays can be set to any value between 0 and 180, inclusive. -The default value is 0. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -234,13 +253,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsUserServicesPolicy` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.UserServices.UserServicesPolicy The `New-CsUserServicesPolicy` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Policy.UserServices.UserServicesPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsVideoInteropServerConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsVideoInteropServerConfiguration.md similarity index 90% rename from skype/skype-ps/skype/New-CsVideoInteropServerConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsVideoInteropServerConfiguration.md index 3c55431495..135c85f2dc 100644 --- a/skype/skype-ps/skype/New-CsVideoInteropServerConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVideoInteropServerConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csvideointeropserverconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsVideoInteropServerConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csvideointeropserverconfiguration +schema: 2.0.0 +title: New-CsVideoInteropServerConfiguration --- # New-CsVideoInteropServerConfiguration @@ -45,7 +46,7 @@ However, administrators can use the `New-CsVideoInteropServerConfiguration` cmdl ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsVideoInteropServerConfiguration -Identity "site:Redmond" -EnableEnhancedVideoExperience $False ``` @@ -56,38 +57,35 @@ The enhanced video experience is disabled by setting the EnableEnhancedVideoExpe ## PARAMETERS -### -Identity -Unique identifier for the new collection of VIS configuration settings. -New collections can be created at either the site scope or the service scope (for the video interop service only). -For example, this syntax creates a new collection of settings assigned to the Redmond site: - -`-Identity "site:Redmond"` +### -EnableEnhancedVideoExperience -And this syntax creates a new collection assigned to the VIS for the pool atl-cs-001.litwareinc.com: +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -`-Identity "service:VideoInteropServer:atl-edge-001.litwareinc.com"` +When set to True ($True) the single video stream coming from a third party video teleconferencing system (VTC) will be converted to multiple streams in order to meet the needs of devices using different video resolutions or frame rates. +The default value is True ($True). ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,31 +94,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableEnhancedVideoExperience -When set to True ($True) the single video stream coming from a third party video teleconferencing system (VTC) will be converted to multiple streams in order to meet the needs of devices using different video resolutions or frame rates. -The default value is True ($True). +### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the new collection of VIS configuration settings. +New collections can be created at either the site scope or the service scope (for the video interop service only). +For example, this syntax creates a new collection of settings assigned to the Redmond site: + +`-Identity "site:Redmond"` + +And this syntax creates a new collection assigned to the VIS for the pool atl-cs-001.litwareinc.com: + +`-Identity "service:VideoInteropServer:atl-edge-001.litwareinc.com"` ```yaml -Type: Boolean +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. +### -InMemory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -129,15 +139,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -147,13 +158,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -167,13 +180,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsVideoInteropServerConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.VideoInteropServer.VideoInteropServerConfiguration The `New-CsVideoInteropServerConfiguration` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.VideoInteropServer.VideoInteropServerConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsVideoInteropServerSyntheticTransactionConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsVideoInteropServerSyntheticTransactionConfiguration.md similarity index 89% rename from skype/skype-ps/skype/New-CsVideoInteropServerSyntheticTransactionConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsVideoInteropServerSyntheticTransactionConfiguration.md index 090e344050..bc031afd71 100644 --- a/skype/skype-ps/skype/New-CsVideoInteropServerSyntheticTransactionConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVideoInteropServerSyntheticTransactionConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csvideointeropserversynthetictransactionconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsVideoInteropServerSyntheticTransactionConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csvideointeropserversynthetictransactionconfiguration +schema: 2.0.0 +title: New-CsVideoInteropServerSyntheticTransactionConfiguration --- # New-CsVideoInteropServerSyntheticTransactionConfiguration @@ -30,7 +31,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsVideoInteropServerSyntheticTransactionConfiguration -Identity "site:Redmond" -WatcherNodeFqdns "atl-cs-001.contoso.com", "atl-cs-002.contoso.com" ``` @@ -40,7 +41,28 @@ This example creates a new Video Interop Server synthetic transaction configurat ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The Identity parameter specifies the Video Interop Server synthetic transaction configuration to create. Video Interop Server synthetic transaction configuration settings can be configured at the global, site, or service scope. To refer to the global instance, use this syntax: @@ -56,8 +78,7 @@ Wildcard characters such as the asterisk (*) cannot be used with the Identity pa ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -66,14 +87,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -InMemory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -82,31 +106,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. +### -WatcherNodeFqdns -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Specifies the FQDN of the watcher node relevant to the synthetic transaction. +For example: `-WatcherNodeFqdns "atl-cs-001.contoso.com"`. +Watcher nodes are computers that periodically use System Center Operations Manager and Skype for Business Server synthetic transactions to verify that Skype for Business Server components are working as expected. +For more information, see `New-CsWatcherNodeConfiguration`. -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. +To enter multiple values and overwrite any existing entries, use the following syntax: `\,\....` +If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: `"\","\"....` + +To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="\","\"...; Remove="\","\"...}`. ```yaml -Type: SwitchParameter +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -115,22 +132,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WatcherNodeFqdns -Specifies the FQDN of the watcher node relevant to the synthetic transaction. -For example: `-WatcherNodeFqdns "atl-cs-001.contoso.com"`. -Watcher nodes are computers that periodically use System Center Operations Manager and Skype for Business Server synthetic transactions to verify that Skype for Business Server components are working as expected. -For more information, see `New-CsWatcherNodeConfiguration`. +### -Confirm -To enter multiple values and overwrite any existing entries, use the following syntax: `\,\....` -If the values contain spaces or otherwise require quotation marks, you need to use the following syntax: `"\","\"....` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -To add or remove one or more values without affecting any existing entries, use the following syntax: `@{Add="\","\"...; Remove="\","\"...}`. +Prompts you for confirmation before executing the command. ```yaml -Type: PSListModifier +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -140,13 +151,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -160,12 +173,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None +### None ## OUTPUTS -### +### VideoInteropServerSyntheticTransactionConfiguration Returns a VideoInteropServerSyntheticTransactionConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsVideoTrunkConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsVideoTrunkConfiguration.md similarity index 89% rename from skype/skype-ps/skype/New-CsVideoTrunkConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsVideoTrunkConfiguration.md index 554d14112c..a48739df63 100644 --- a/skype/skype-ps/skype/New-CsVideoTrunkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVideoTrunkConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csvideotrunkconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsVideoTrunkConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csvideotrunkconfiguration +schema: 2.0.0 +title: New-CsVideoTrunkConfiguration --- # New-CsVideoTrunkConfiguration @@ -52,7 +53,7 @@ However, administrators can use the `New-CsVideoTrunkConfiguration` cmdlet to cr ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsVideoTrunkConfiguration -Identity "site:Redmond" -EnableSessionTimer $True ``` @@ -63,51 +64,17 @@ Session timers are enabled on the new configuration by setting the EnableSession ## PARAMETERS -### -Identity -The Identity parameter specifies the unique identifier for the new collection of video trunk configuration settings. -New collections can be created at either the site scope or the service scope (for the Video Gateway service only). - -For example, this syntax creates a new collection of settings assigned to the Redmond site: `-Identity "site:Redmond"`. -And this syntax creates a new collection assigned to the Video Gateway "video-pbx-001.litwareinc.com": `-Identity "service:VideoGateway:video-pbx-001.litwareinc.com"` - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +### -EnableMediaEncryptionForSipOverTls -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableMediaEncryptionForSipOverTls When set to True ($True) it is expected that the Video Gateway or third party video teleconferencing system (VTC) uses TLS to protect SIP signaling and uses SRTP to protect the media traffic. The default value is True ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -117,6 +84,9 @@ Accept wildcard characters: False ``` ### -EnableSessionTimer + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies whether the session timer is enabled. Session timers are used to determine whether a particular session is still active. The default is false ($False). @@ -127,8 +97,7 @@ In such a case, the Video Interop Server will reply to session timer probes from ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,13 +107,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error messages and completes the cmdlet operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -154,6 +125,9 @@ Accept wildcard characters: False ``` ### -ForwardErrorCorrectionType + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the type of Forward Error Correction (FEC) to be used between the Video Interop Server (VIS) and a Video Gateway. The valid settings are: @@ -164,8 +138,7 @@ Cisco: Enables FEC compatible with Cisco Video Gateways, such as Cisco Unified C ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,14 +148,16 @@ Accept wildcard characters: False ``` ### -GatewaySendsRtcpForActiveCalls + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + When set to True ($True) it is expected that the Video Gateway or third party video teleconferencing system (VTC) sends RTCP for calls that are enabled for media sending from the Video Gateway or VTC. The default value is True ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -192,14 +167,16 @@ Accept wildcard characters: False ``` ### -GatewaySendsRtcpForCallsOnHold + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + When set to True ($True) it is expected that the Video Gateway or third party video teleconferencing system (VTC) sends RTCP for calls that are disabled for media sending from the Video Gateway or VTC. The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -208,15 +185,57 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity parameter specifies the unique identifier for the new collection of video trunk configuration settings. +New collections can be created at either the site scope or the service scope (for the Video Gateway service only). + +For example, this syntax creates a new collection of settings assigned to the Redmond site: `-Identity "site:Redmond"`. +And this syntax creates a new collection assigned to the Video Gateway "video-pbx-001.litwareinc.com": `-Identity "service:VideoGateway:video-pbx-001.litwareinc.com"` + +```yaml +Type: XdsIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InMemory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by passing that object reference to the `Set-CsVideoTrunkConfiguration` cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -226,13 +245,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -246,13 +267,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsVideoTrunkConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.VideoTrunkConfiguration The `New-CsVideoTrunkConfiguration` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.VideoTrunkConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsVoiceNormalizationRule.md b/skype/skype-ps/SkypeForBusiness/New-CsVoiceNormalizationRule.md similarity index 83% rename from skype/skype-ps/skype/New-CsVoiceNormalizationRule.md rename to skype/skype-ps/SkypeForBusiness/New-CsVoiceNormalizationRule.md index 9404a4f7ca..160efe931c 100644 --- a/skype/skype-ps/skype/New-CsVoiceNormalizationRule.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVoiceNormalizationRule.md @@ -1,12 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csvoicenormalizationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsVoiceNormalizationRule -schema: 2.0.0 -manager: bulenteg author: jenstrier +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/skype/new-csvoicenormalizationrule +schema: 2.0.0 +title: New-CsVoiceNormalizationRule --- # New-CsVoiceNormalizationRule @@ -42,18 +44,18 @@ These rules are a required part of phone authorization and call routing. They define the requirements for converting (or translating) numbers from an internal format to a standard (E.164) format. An understanding of regular expressions is helpful in order to define number patterns that will be translated. -For Lync or Skype for Business Server, rules that are created by using this cmdlet are part of the dial plan and in addition to being accessible through the +For Lync or Skype for Business Server, rules that are created by using this cmdlet are part of the dial plan and in addition to being accessible through the The `Get-CsVoiceNormalizationRule` cmdlet can also be accessed through the NormalizationRules property returned by a call to the `Get-CsDialPlan` cmdlet. You cannot create a normalization rule unless a dial plan with an Identity matching the scope specified in the normalization rule Identity already exists. For example, you can't create a normalization rule with the Identity site:Redmond/RedmondNormalizationRule unless a dial plan for site:Redmond already exists. -For Microsoft Teams, rules that are created by using this cmdlet can only be created with the InMemory switch and should be added to a tenant dial plan using +For Microsoft Teams, rules that are created by using this cmdlet can only be created with the InMemory switch and should be added to a tenant dial plan using the `New-CsTenantDialPlan` or `Set-CsTenantDialPlan` cmdlets. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsVoiceNormalizationRule -Identity "site:Redmond/Prefix Redmond" ``` @@ -67,7 +69,7 @@ Keep in mind that a dial plan for the Redmond site must exist for this command t You can create a new dial plan by calling the `New-CsDialPlan` cmdlet. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsVoiceNormalizationRule -Parent SeattleUser -Name SeattleFourDigit -Description "Dialing with internal four-digit extension" -Pattern '^(\d{4})$' -Translation '+1206555$1' ``` @@ -84,7 +86,7 @@ Single quotes are required for these values; double quotes (or no quotes) will n As in Example 1, a dial plan with the given scope must exist. In this case, that means a dial plan with the Identity SeattleUser must already exist. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $nr1=New-CsVoiceNormalizationRule -Identity dp1/nr1 -Description "Dialing with internal four-digit extension" -Pattern '^(\d{4})$' -Translation '+1206555$1' -InMemory New-CsTenantDialPlan -Identity DP1 -NormalizationRules @{Add=$nr1} @@ -94,88 +96,88 @@ This example creates a new in-memory voice normalization rule and then adds it t ## PARAMETERS -### -Identity -A unique identifier for the rule. -The Identity specified must include the scope followed by a slash and then the name; for example: site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name. -The name portion will automatically be stored in the Name property. -You cannot specify values for Identity and Name in the same command. - -For Lync and Skype for Business Server, voice normalization rules can be created at the following scopes: global, site, service (Registrar and PSTNGateway only) and per user. -A dial plan with an Identity matching the scope of the normalization rule must already exist before a new rule can be created. -(To retrieve a list of dial plans, call the `Get-CsDialPlan` cmdlet.) +### -Description -For Microsoft Teams, voice normalization rules can be created at the following scopes: global and tag. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams -The Identity parameter is required unless the Parent parameter is specified. -You cannot include the Identity parameter and the Parent parameter in the same command. +A friendly description of the normalization rule. +Maximum string length: 512 characters. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams +Type: String +Parameter Sets: (All) +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The name of the rule. -This parameter is required if a value has been specified for the Parent parameter. -If no value has been specified for the Parent parameter, Name defaults to the name specified in the Identity parameter. -For example, if a rule is created with the Identity site:Redmond/RedmondRule, the Name will default to RedmondRule. -The Name parameter and the Identity parameter cannot be used in the same command. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Parent -The scope at which the new normalization rule will be created. -This value must be global; site:\, where \ is the name of the Skype for Business Server site; PSTN gateway or Registrar service, such as -PSTNGateway:redmond.litwareinc.com; or a string designating a per user rule. -A dial plan with the specified scope must already exist or the command will fail. +### -Identity -The Parent parameter is required unless the Identity parameter is specified. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +A unique identifier for the rule. +The Identity specified must include the scope followed by a slash and then the name; for example: site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name. +The name portion will automatically be stored in the Name property. +You cannot specify values for Identity and Name in the same command. + +For Lync and Skype for Business Server, voice normalization rules can be created at the following scopes: global, site, service (Registrar and PSTNGateway only) and per user. +A dial plan with an Identity matching the scope of the normalization rule must already exist before a new rule can be created. +(To retrieve a list of dial plans, call the `Get-CsDialPlan` cmdlet.) + +For Microsoft Teams, voice normalization rules can be created at the following scopes: global and tag. + +The Identity parameter is required unless the Parent parameter is specified. You cannot include the Identity parameter and the Parent parameter in the same command. -If you include the Parent parameter, the Name parameter is also required. + ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams +Type: XdsIdentity +Parameter Sets: Identity +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -A friendly description of the normalization rule. +### -InMemory -Maximum string length: 512 characters. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Creates an object reference without actually committing the object as a permanent change. + +For Lync or Skype for Business Server, if you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the +object reference and then commit those changes by calling this cmdlet's matching Set-\. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams +Aliases: Required: False Position: Named @@ -185,6 +187,9 @@ Accept wildcard characters: False ``` ### -IsInternalExtension + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + If True, the result of applying this rule will be a number internal to the organization. If False, applying the rule results in an external number. This value is ignored if the value of the OptimizeDeviceDialing property of the associated dial plan/tenant dial plan is set to False. @@ -194,8 +199,7 @@ Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams +Aliases: Required: False Position: Named @@ -204,34 +208,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Pattern -A regular expression that the dialed number must match in order for this rule to be applied. +### -Name -Default: ^(\d{11})$ (The default represents any set of numbers up to 11 digits.) +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +The name of the rule. +This parameter is required if a value has been specified for the Parent parameter. +If no value has been specified for the Parent parameter, Name defaults to the name specified in the Identity parameter. +For example, if a rule is created with the Identity site:Redmond/RedmondRule, the Name will default to RedmondRule. +The Name parameter and the Identity parameter cannot be used in the same command. ```yaml Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Priority -The order in which rules are applied. -A phone number might match more than one rule. -This parameter sets the order in which the rules are tested against the number. +### -Parent + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +The scope at which the new normalization rule will be created. +This value must be global; site:\, where \ is the name of the Skype for Business Server site; PSTN gateway or Registrar service, such as +PSTNGateway:redmond.litwareinc.com; or a string designating a per user rule. +A dial plan with the specified scope must already exist or the command will fail. + +The Parent parameter is required unless the Identity parameter is specified. +You cannot include the Identity parameter and the Parent parameter in the same command. +If you include the Parent parameter, the Name parameter is also required. ```yaml -Type: Int32 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams +Aliases: Required: False Position: Named @@ -240,16 +255,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Translation -The regular expression pattern that will be applied to the number to convert it to E.164 format. +### -Pattern -Default: +$1 (The default prefixes the number with a plus sign \[+\].) +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +A regular expression that the dialed number must match in order for this rule to be applied. + +Default: ^(\d{11})$ (The default represents any set of numbers up to 11 digits.) ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams +Aliases: Required: False Position: Named @@ -258,14 +275,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +The order in which rules are applied. +A phone number might match more than one rule. +This parameter sets the order in which the rules are tested against the number. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams +Aliases: Required: False Position: Named @@ -274,17 +295,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. +### -Tenant -For Lync or Skype for Business Server, if you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the -object reference and then commit those changes by calling this cmdlet's matching Set-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +For internal Microsoft usage. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -293,27 +313,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Microsoft Teams +### -Translation -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +The regular expression pattern that will be applied to the number to convert it to E.164 format. + +Default: +$1 (The default prefixes the number with a plus sign \[+\].) ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams +Aliases: Required: False Position: Named @@ -323,13 +334,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams Required: False Position: Named @@ -338,14 +351,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -For internal Microsoft usage. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -359,12 +374,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule. ## NOTES diff --git a/skype/skype-ps/skype/New-CsVoicePolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsVoicePolicy.md similarity index 83% rename from skype/skype-ps/skype/New-CsVoicePolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsVoicePolicy.md index 1f0e3f4982..f328cba6f1 100644 --- a/skype/skype-ps/skype/New-CsVoicePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVoicePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csvoicepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsVoicePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csvoicepolicy +schema: 2.0.0 +title: New-CsVoicePolicy --- # New-CsVoicePolicy @@ -39,7 +40,7 @@ The policy created by this cmdlet determines whether many of these features are ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsVoicePolicy -Identity UserVoicePolicy1 ``` @@ -47,7 +48,7 @@ New-CsVoicePolicy -Identity UserVoicePolicy1 This example creates a new per-user voice policy (with default settings) that has an Identity of UserVoicePolicy1. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsVoicePolicy UserVoicePolicy2 -AllowSimulRing $false -PstnUsages @{add = "Local"} ``` @@ -58,7 +59,7 @@ This command also adds "Local" to the list of PSTN usages, which associates this The Identity parameter is a positional parameter and therefore if you put the identity value first in the list of parameters you don't need to explicitly state that it's the Identity.) -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $a = Get-CsPstnUsage @@ -75,26 +76,10 @@ This refers to the Usage property of the PSTN usage settings, which contains the ## PARAMETERS -### -Identity -A unique identifier specifying the scope or the name of the policy. -Valid values for this cmdlet are site:\ (where \ is the name of the Skype for Business Server site to which this policy applies, such as site:Redmond) and a string designating a per-user policy, such as RedmondVoicePolicy. -A global policy exists by default. - - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AllowCallForwarding -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AllowCallForwarding If this parameter is set to True, calls can be forwarded. If this parameter is set to False, calls cannot be forwarded. @@ -103,8 +88,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -114,6 +98,9 @@ Accept wildcard characters: False ``` ### -AllowPSTNReRouting + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When this parameter is set to True, calls made to internal numbers homed on another pool will be routed through the public switched telephone network (PSTN) when the pool or WAN is unavailable. Default: True @@ -121,8 +108,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,6 +118,9 @@ Accept wildcard characters: False ``` ### -AllowSimulRing + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Simultaneous ring is a feature that allows multiple phones to ring when a single number is dialed. Setting this parameter to True enables this feature. If this parameter is set to False, simultaneous ring cannot be configured for any user to which this policy is assigned. @@ -141,8 +130,63 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CallForwardingSimulRingUsageType + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Provides a way for administrators to manage call forwarding and simultaneous ringing. +Allowed values are: + +VoicePolicyUsage - The default voice policy usage is used to manage call forwarding and simultaneous ringing on all calls. +This is the default value. + +InternalOnly - Call forwarding and simultaneous ringing are limited to calls made from one Lync user to another. + +CustomUsage. +A custom PSTN usage will be used to manage call forwarding and simultaneous ringing. +This usage must be specified using the CustomCallForwardingSimulRingUsages parameter. + + +```yaml +Type: CallForwardingSimulRingUsageType +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomCallForwardingSimulRingUsages + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Custom PSTN usage used to manage call forwarding and simultaneous ringing. +To add a custom usage to voice policy use syntax similar to this: + +`-CustomCallForwardingSimulRingUsages @{Add="RedmondPstnUsage"}` + +To remove a custom usage, use this syntax: + +`-CustomCallForwardingSimulRingUsages @{Remove="RedmondPstnUsage"}` + +Note that the usage must exist before it can be used with the CustomCallForwardingSimulRingUsages parameter. + +```yaml +Type: PSListModifier +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -152,6 +196,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A description of the voice policy. Maximum length: 1040 characters. @@ -159,8 +206,25 @@ Maximum length: 1040 characters. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableBusyOptions + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +{{Fill EnableBusyOptions Description}} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -170,6 +234,9 @@ Accept wildcard characters: False ``` ### -EnableBWPolicyOverride + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Policies can be set to manage network configuration, including limiting bandwidth. Setting this parameter to True will allow override of these policies. In other words, if this parameter is set to True, no bandwidth checks will be made and calls will go through regardless of the call admission control (CAC) settings. @@ -179,8 +246,7 @@ Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -190,6 +256,9 @@ Accept wildcard characters: False ``` ### -EnableCallPark + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Call Park application allows a call to be held, or parked, at a certain number within a range of numbers for later retrieval. Setting this parameter to True enables the application. If this parameter is set to False, users assigned to this policy cannot park calls that have been dialed to their phone number. @@ -199,8 +268,7 @@ Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -210,6 +278,9 @@ Accept wildcard characters: False ``` ### -EnableCallTransfer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether calls can be transferred to another number. If this parameter is set to True, calls can be transferred; if the parameter is set to False, calls cannot be transferred. @@ -218,8 +289,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -229,6 +299,9 @@ Accept wildcard characters: False ``` ### -EnableDelegation + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Call delegation allows a user to answer calls for another user or make calls on the other user's behalf. For example, a manager can set up call delegation so that all incoming calls ring both the manager's phone and the phone of an administrator. Setting this parameter to True allows users with this policy to set up call delegation. @@ -239,8 +312,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -250,6 +322,9 @@ Accept wildcard characters: False ``` ### -EnableMaliciousCallTracing + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Malicious call tracing is a standard that is in place to trace calls that a user designates as malicious. These calls can be traced even if caller ID is blocked. The trace is available only to the proper authorities, not the user. @@ -260,8 +335,7 @@ Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -271,6 +345,9 @@ Accept wildcard characters: False ``` ### -EnableTeamCall + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Team Call allows a user to designate a group of other users whose phones will ring when that user's number is called. This feature is useful in teams where, for example, anyone from a team can answer incoming calls from customers. Setting this parameter to True enables this feature. @@ -280,8 +357,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -290,18 +366,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -A displayable name describing this policy. +### -EnableVoicemailEscapeTimer -Default: DefaultPolicy +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True, calls to an unanswered mobile device will be routed to the organization voicemail instead of the mobile device provider's voicemail. +If a call is answered "too soon" (that is, before the value configured for the PSTNVoicemailEscapeTimer property has elapsed) it will be assumed that the mobile device is not available and the call will be routed to the organization voicemail. +The default value is False. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -310,19 +387,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PreventPSTNTollBypass -PSTN tolls are more commonly known as long-distance charges. -Organizations can sometimes bypass these tolls by implementing a Voice over Internet Protocol (VoIP) solution that enables branch offices to connect by using network calls. -Setting this parameter to True will send calls through the PSTN and incur charges rather than going through the network and bypassing the tolls. +### -Force -Default: False +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -331,46 +405,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PstnUsages -A list of PSTN usages available to this policy. -The PSTN usage ties a voice policy to a phone route. - -Any string value can be placed into this list, as long as the value exists in the current global list of PSTN usages. -(Duplicate strings are not allowed; all strings must be unique.) The list of PSTN usages can be retrieved by calling the `Get-CsPstnUsage` cmdlet. - -By default this list is empty. -If you don't supply a value for this parameter, you'll receive a warning message stating that users granted this policy will not be able to make outbound PSTN calls. +### -Identity -```yaml -Type: PSListModifier -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +A unique identifier specifying the scope or the name of the policy. +Valid values for this cmdlet are site:\ (where \ is the name of the Skype for Business Server site to which this policy applies, such as site:Redmond) and a string designating a per-user policy, such as RedmondVoicePolicy. +A global policy exists by default. -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. @@ -378,8 +437,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -388,30 +446,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Name -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A displayable name describing this policy. + +Default: DefaultPolicy -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -Confirm -Prompts you for confirmation before executing the command. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -420,25 +468,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallForwardingSimulRingUsageType -Provides a way for administrators to manage call forwarding and simultaneous ringing. -Allowed values are: +### -PreventPSTNTollBypass -VoicePolicyUsage - The default voice policy usage is used to manage call forwarding and simultaneous ringing on all calls. -This is the default value. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -InternalOnly - Call forwarding and simultaneous ringing are limited to calls made from one Lync user to another. +PSTN tolls are more commonly known as long-distance charges. +Organizations can sometimes bypass these tolls by implementing a Voice over Internet Protocol (VoIP) solution that enables branch offices to connect by using network calls. +Setting this parameter to True will send calls through the PSTN and incur charges rather than going through the network and bypassing the tolls. -CustomUsage. -A custom PSTN usage will be used to manage call forwarding and simultaneous ringing. -This usage must be specified using the CustomCallForwardingSimulRingUsages parameter. +Default: False ```yaml -Type: CallForwardingSimulRingUsageType +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -447,23 +491,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomCallForwardingSimulRingUsages -Custom PSTN usage used to manage call forwarding and simultaneous ringing. -To add a custom usage to voice policy use syntax similar to this: +### -PstnUsages -`-CustomCallForwardingSimulRingUsages @{Add="RedmondPstnUsage"}` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -To remove a custom usage, use this syntax: +A list of PSTN usages available to this policy. +The PSTN usage ties a voice policy to a phone route. -`-CustomCallForwardingSimulRingUsages @{Remove="RedmondPstnUsage"}` +Any string value can be placed into this list, as long as the value exists in the current global list of PSTN usages. +(Duplicate strings are not allowed; all strings must be unique.) The list of PSTN usages can be retrieved by calling the `Get-CsPstnUsage` cmdlet. -Note that the usage must exist before it can be used with the CustomCallForwardingSimulRingUsages parameter. +By default this list is empty. +If you don't supply a value for this parameter, you'll receive a warning message stating that users granted this policy will not be able to make outbound PSTN calls. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -472,26 +516,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableVoicemailEscapeTimer -When set to True, calls to an unanswered mobile device will be routed to the organization voicemail instead of the mobile device provider's voicemail. -If a call is answered "too soon" (that is, before the value configured for the PSTNVoicemailEscapeTimer property has elapsed) it will be assumed that the mobile device is not available and the call will be routed to the organization voicemail. - -The default value is False. +### -PSTNVoicemailEscapeTimer -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PSTNVoicemailEscapeTimer Amount of time (in milliseconds) used to determine whether or not a call has been answered "too soon". If a response is received within this time interval Skype for Business Server will assume that the mobile device is not available and automatically switch the call to the organization's voicemail. If no response is received before the time interval is reached then the call will be allowed to proceed. The default value is 1500 milliseconds. @@ -500,8 +528,7 @@ The default value is 1500 milliseconds. ```yaml Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -511,6 +538,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the new voice policy is being created. For example: @@ -524,8 +554,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -535,6 +564,9 @@ Accept wildcard characters: False ``` ### -VoiceDeploymentMode + +> Applicable: Lync Server 2013 + Allowed values are: * OnPrem @@ -547,8 +579,7 @@ The default value is OnPrem. ```yaml Type: VoiceDeploymentMode Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013 +Aliases: Required: False Position: Named @@ -557,14 +588,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableBusyOptions -{{Fill EnableBusyOptions Description}} +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Boolean +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -578,12 +629,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Voice.VoicePolicy This cmdlet creates an instance of the Microsoft.Rtc.Management.WritableConfig.Voice.VoicePolicy object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsVoiceRegex.md b/skype/skype-ps/SkypeForBusiness/New-CsVoiceRegex.md similarity index 88% rename from skype/skype-ps/skype/New-CsVoiceRegex.md rename to skype/skype-ps/SkypeForBusiness/New-CsVoiceRegex.md index dfa493a3db..5a3ea6561b 100644 --- a/skype/skype-ps/skype/New-CsVoiceRegex.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVoiceRegex.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csvoiceregex applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsVoiceRegex -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/new-csvoiceregex +schema: 2.0.0 +title: New-CsVoiceRegex --- # New-CsVoiceRegex @@ -42,7 +44,7 @@ Use this cmdlet to help you generate regular expressions to be used as Pattern a ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $regex = New-CsVoiceRegex -ExactLength 7 -DigitsToStrip 3 ``` @@ -53,7 +55,7 @@ The Pattern created by this regular expression will be ^\d{3}(\d{4})$ while the For example, the number 5551212 would match this pattern and the resulting translation would be 1212: the 7-digit number with the first 3 digits stripped. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $regex = New-CsVoiceRegex -AtLeastLength 7 -StartsWith "1" @@ -77,6 +79,9 @@ This adds up to a number of at least 7 digits (1 plus 5 plus 1 or more) that sta ## PARAMETERS ### -AtLeastLength + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + The minimum length required for the string (phone number) to match the expression. For example, if you're defining a normalization rule that affects only numbers that must be at least 7 digits (or characters) in length, specify a value of 7 for this parameter. @@ -86,8 +91,7 @@ You cannot enter values for both. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,18 +100,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExactLength -The length the string (phone number) must be to match the regular expression. -For example, if you want a normalization rule to affect only 10-digit numbers, specify a value of 10 for this parameter. +### -DigitsToPrepend -You must enter a value for this parameter or for the AtLeastLength parameter. -You cannot enter values for both. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +A string specifying the characters or numbers to add to the beginning of the phone number. +The value entered for this parameter will impact the Translation value, prepending characters to the number matching the regular expression Pattern. +For example, if the number matching the pattern is 5551212 and the DigitsToPrepend value is 425, the translated number will be 4255551212 (assuming no other translations have been applied). ```yaml -Type: Int32 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,16 +120,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DigitsToPrepend -A string specifying the characters or numbers to add to the beginning of the phone number. -The value entered for this parameter will impact the Translation value, prepending characters to the number matching the regular expression Pattern. -For example, if the number matching the pattern is 5551212 and the DigitsToPrepend value is 425, the translated number will be 4255551212 (assuming no other translations have been applied). +### -DigitsToStrip + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +The number of characters to strip from the beginning of the string (phone number). +For example, if the number 2065551212 is entered and the DigitsToStrip is 3, the number will be translated to 5551212 ```yaml -Type: String +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,15 +139,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DigitsToStrip -The number of characters to strip from the beginning of the string (phone number). -For example, if the number 2065551212 is entered and the DigitsToStrip is 3, the number will be translated to 5551212 +### -ExactLength + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +The length the string (phone number) must be to match the regular expression. +For example, if you want a normalization rule to affect only 10-digit numbers, specify a value of 10 for this parameter. + +You must enter a value for this parameter or for the AtLeastLength parameter. +You cannot enter values for both. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -152,6 +162,9 @@ Accept wildcard characters: False ``` ### -StartsWith + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + The first character of the string (phone number). The string will not match the regular expression unless it begins with the string specified in the StartsWith parameter. For example, if a value of "+1" is specified for StartsWith, only numbers that begin with +1 will match this pattern and be translated. @@ -161,8 +174,7 @@ For example, if you've specified an ExactLength of 10 and a StartsWith string of ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -176,12 +188,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.OcsVoiceRegex Creates on object of type Microsoft.Rtc.Management.Voice.OcsVoiceRegex. ## NOTES diff --git a/skype/skype-ps/skype/New-CsVoiceRoute.md b/skype/skype-ps/SkypeForBusiness/New-CsVoiceRoute.md similarity index 85% rename from skype/skype-ps/skype/New-CsVoiceRoute.md rename to skype/skype-ps/SkypeForBusiness/New-CsVoiceRoute.md index f6633618bd..5c260353cd 100644 --- a/skype/skype-ps/skype/New-CsVoiceRoute.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVoiceRoute.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csvoiceroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsVoiceRoute -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csvoiceroute +schema: 2.0.0 +title: New-CsVoiceRoute --- # New-CsVoiceRoute @@ -48,7 +49,7 @@ A voice route includes a regular expression that identifies which phone numbers ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsVoiceRoute -Identity Route1 ``` @@ -57,7 +58,7 @@ The command in this example creates a new voice route with an Identity of Route1 All other properties will be set to the default values. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsVoiceRoute -Identity Route1 -PstnUsages @{add="Long Distance"} -PstnGatewayList @{add="PstnGateway:redmondpool.litwareinc.com"} ``` @@ -66,7 +67,7 @@ The command in this example creates a new voice route with an Identity of Route1 It also adds the PSTN usage Long Distance to the list of usages and the service ID PstnGateway:redmondpool.litwareinc.com to the list of PSTN gateways. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $x = (Get-CsPstnUsage).Usage @@ -86,61 +87,59 @@ This value says to add the contents of $x, which contain the phone usages list r ## PARAMETERS -### -Identity -A name that uniquely identifies the voice route. -Voice routes can be defined only at the global scope, so the identity is simply the name you want to give the route. -(You can have spaces in the route name, for instance Test Route, but you must enclose the full string in double quotes in the call to the `New-CsVoiceRoute` cmdlet.) +### -AlternateCallerId -If Identity is specified, the Name must be left blank. -The value of the Identity will be assigned to the Name. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If the SuppressCallerId parameter is set to True, the value of the AlternateCallerId parameter will be displayed to receiving parties rather than the caller's actual number. +This number should be a valid number and could be used to represent a division within an organization, such as Support or Human Resources. + +If the SuppressCallerId parameter is set to False, the AlternateCallerId parameter is ignored. +This value must match the regular expression (\+)?\[1-9\]\d*(;ext=\[1-9\]\d*)?. +In other words, the value can begin with a plus sign (+) but doesn't need to; must consist of any number of digits and may be followed by an extension that begins with ;ext= followed by any number of digits. +(Note that if you include an extension the string must be placed within double quotes.) ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -The unique name of the voice route. -If this parameter is set, the value will be automatically applied to the voice route Identity. -You cannot specify both an Identity and a Name. +### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A description of what this voice route is for. ```yaml Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AlternateCallerId -If the SuppressCallerId parameter is set to True, the value of the AlternateCallerId parameter will be displayed to receiving parties rather than the caller's actual number. -This number should be a valid number and could be used to represent a division within an organization, such as Support or Human Resources. +### -Force -If the SuppressCallerId parameter is set to False, the AlternateCallerId parameter is ignored. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -This value must match the regular expression (\+)?\[1-9\]\d*(;ext=\[1-9\]\d*)?. -In other words, the value can begin with a plus sign (+) but doesn't need to; must consist of any number of digits and may be followed by an extension that begins with ;ext= followed by any number of digits. -(Note that if you include an extension the string must be placed within double quotes.) +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -149,14 +148,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -A description of what this voice route is for. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A name that uniquely identifies the voice route. +Voice routes can be defined only at the global scope, so the identity is simply the name you want to give the route. +(You can have spaces in the route name, for instance Test Route, but you must enclose the full string in double quotes in the call to the `New-CsVoiceRoute` cmdlet.) + +If Identity is specified, the Name must be left blank. +The value of the Identity will be assigned to the Name. + ```yaml -Type: String +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. + + +```yaml +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -165,7 +192,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique name of the voice route. +If this parameter is set, the value will be automatically applied to the voice route Identity. +You cannot specify both an Identity and a Name. + +```yaml +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -NumberPattern + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A regular expression that specifies the phone numbers to which this route applies. Numbers matching this pattern will be routed according to the rest of the routing settings. @@ -174,8 +224,7 @@ Default: \[0-9\]{10} ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -185,14 +234,16 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A number could resolve to multiple voice routes. The priority determines the order in which the routes will be applied if more than one route is possible. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -202,6 +253,9 @@ Accept wildcard characters: False ``` ### -PstnGatewayList + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + In Skype for Business Server a Mediation Server can be associated with multiple gateways. This parameter contains a list of gateways associated with this voice route. Each member of this list must be the service Identity of the PSTN gateway or Mediation Server. @@ -218,8 +272,7 @@ However, if you leave this parameter blank when creating a new voice route, you' ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -229,6 +282,9 @@ Accept wildcard characters: False ``` ### -PstnUsages + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A list of PSTN usages (such as Local, Long Distance, etc.) that can be applied to this voice route. The PSTN usage must be an existing usage. (PSTN usages can be retrieved by calling the `Get-CsPstnUsage` cmdlet.) @@ -239,8 +295,7 @@ However, if you leave this parameter blank when creating a new voice route, you' ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -250,6 +305,9 @@ Accept wildcard characters: False ``` ### -SuppressCallerId + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether a caller's ID will be revealed on outbound calls. If this parameter is set to True, caller ID will be suppressed. In place of the actual ID, the value of the AlternateCallerId will be displayed. @@ -258,8 +316,7 @@ When SuppressCallerId is set to True, a value for AlternateCallerId must be supp ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -268,32 +325,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### -Confirm -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -303,29 +344,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -339,12 +366,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route Creates an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route. ## NOTES diff --git a/skype/skype-ps/skype/New-CsVoiceRoutingPolicy.md b/skype/skype-ps/SkypeForBusiness/New-CsVoiceRoutingPolicy.md similarity index 86% rename from skype/skype-ps/skype/New-CsVoiceRoutingPolicy.md rename to skype/skype-ps/SkypeForBusiness/New-CsVoiceRoutingPolicy.md index f6a0bd7f8b..8d47d8111d 100644 --- a/skype/skype-ps/skype/New-CsVoiceRoutingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVoiceRoutingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csvoiceroutingpolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsVoiceRoutingPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csvoiceroutingpolicy +schema: 2.0.0 +title: New-CsVoiceRoutingPolicy --- # New-CsVoiceRoutingPolicy @@ -38,7 +39,7 @@ Skype for Business Server Control Panel: The functions carried out by the `New-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsVoiceRoutingPolicy -Identity "RedmondVoiceRoutingPolicy" -Name "RedmondVoiceRoutingPolicy" -PstnUsages "Long Distance" ``` @@ -47,7 +48,7 @@ The command shown in Example 1 creates a new per-user voice routing policy with This policy is assigned a single PSTN usage: Long Distance. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsVoiceRoutingPolicy -Identity "RedmondVoiceRoutingPolicy" -Name "RedmondVoiceRoutingPolicy" -PstnUsages "Long Distance", "Local", "Internal" ``` @@ -58,34 +59,35 @@ Multiple usages can be assigned simply by separating each usage using a comma. ## PARAMETERS -### -Identity -Unique identifier to be assigned to the new voice routing policy. -Because you can only create new policies at the per-user scope, the Identity will always be the "name" being assigned to the policy. -For example: +### -Description -`-Identity "RedmondVoiceRoutingPolicy"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to provide explanatory text to accompany a voice routing policy. +For example, the Description might include information about the users the policy should be assigned to. ```yaml -Type: XdsIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -94,48 +96,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide explanatory text to accompany a voice routing policy. -For example, the Description might include information about the users the policy should be assigned to. +### -Identity -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Unique identifier to be assigned to the new voice routing policy. +Because you can only create new policies at the per-user scope, the Identity will always be the "name" being assigned to the policy. +For example: -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +`-Identity "RedmondVoiceRoutingPolicy"` ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -145,13 +138,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A friendly name describing this policy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -161,6 +156,9 @@ Accept wildcard characters: False ``` ### -PstnUsages + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A list of PSTN usages (such as Local or Long Distance) that can be applied to this voice routing policy. The PSTN usage must be an existing usage. (PSTN usages can be retrieved by calling the `Get-CsPstnUsage` cmdlet.) @@ -168,8 +166,25 @@ The PSTN usage must be an existing usage. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -179,13 +194,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -199,13 +216,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsVoiceRoutingPolicy` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceRoutingPolicy The `New-CsVoiceRoutingPolicy` cmdlet creates new instances of Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceRoutingPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsVoiceTestConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsVoiceTestConfiguration.md similarity index 84% rename from skype/skype-ps/skype/New-CsVoiceTestConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsVoiceTestConfiguration.md index bff35169f4..9698676445 100644 --- a/skype/skype-ps/skype/New-CsVoiceTestConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVoiceTestConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csvoicetestconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsVoiceTestConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csvoicetestconfiguration +schema: 2.0.0 +title: New-CsVoiceTestConfiguration --- # New-CsVoiceTestConfiguration @@ -46,7 +47,7 @@ The configurations created with this cmdlet are tested using the `Test-CsVoiceTe ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsVoiceTestConfiguration -Identity TestConfig1 ``` @@ -54,7 +55,7 @@ New-CsVoiceTestConfiguration -Identity TestConfig1 This example creates a new voice test configuration with default values that has the Identity TestConfig1. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsVoiceTestConfiguration TestConfig1 -TargetDialplan site:Redmond1 ``` @@ -66,7 +67,7 @@ In this example we declared TestConfig1 without specifying the Identity paramete Identity is a positional parameter, so the first value in the command following the cmdlet name is recognized by the cmdlet as the Identity. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` New-CsVoiceTestConfiguration -Identity TestConfig1 -DialedNumber 5551212 -ExpectedTranslatedNumber +5551212 ``` @@ -79,46 +80,10 @@ That test must be run using the `Test-CsVoiceTestConfiguration` cmdlet. ## PARAMETERS -### -Identity -A string uniquely identifying this test scenario. - -This string can be up to 32 characters in length and may contain any alphanumeric characters plus the backslash (\\), period (.) or underscore (_). - -The value of this parameter does not include scope because this object can be created only at the global scope. -Therefore only a unique name is required. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Name -This parameter contains the same value as the Identity. -If the Identity parameter is specified, you cannot include the Name parameter in your command. -Likewise, if the Name parameter is specified, you cannot specify an Identity. +### -DialedNumber -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DialedNumber The phone number you want to use to test the policies, usages, etc. Must be 512 characters or fewer. @@ -128,8 +93,7 @@ Default: 1234 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,6 +103,9 @@ Accept wildcard characters: False ``` ### -ExpectedRoute + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name of the voice route expected to be used during the configuration test. If a different route is used, based on the target dial plan and voice policy, the test will fail. You can retrieve available voice routes by calling the `Get-CsVoiceRoute` cmdlet. @@ -148,8 +115,7 @@ Must be 256 characters or fewer. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -159,6 +125,9 @@ Accept wildcard characters: False ``` ### -ExpectedTranslatedNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The phone number in the format you expect to see it after translation. This is the value of the DialedNumber parameter after normalization. If you run the `Test-CsVoiceTestConfiguration` cmdlet and the DialedNumber does not result in the value in ExpectedTranslatedNumber, the test will report as Fail. @@ -171,8 +140,7 @@ Default: +1234 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,6 +150,9 @@ Accept wildcard characters: False ``` ### -ExpectedUsage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name of the PSTN usage expected to be used during the configuration test. If a different PSTN usage is used, based on the target dial plan and voice policy, the test will fail. You can retrieve available usages by calling the `Get-CsPstnUsage` cmdlet. @@ -192,8 +163,7 @@ Must be 256 characters or fewer. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -202,20 +172,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetVoicePolicy -The Identity of the voice policy against which to run this test. -Voice policies can be retrieved by calling the `Get-CsVoicePolicy` cmdlet. +### -Force -Must be 40 characters or fewer. - -Default: Global +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -224,23 +190,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A string uniquely identifying this test scenario. + +This string can be up to 32 characters in length and may contain any alphanumeric characters plus the backslash (\\), period (.) or underscore (_). + +The value of this parameter does not include scope because this object can be created only at the global scope. +Therefore only a unique name is required. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. @@ -248,8 +224,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -258,14 +233,66 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter contains the same value as the Identity. +If the Identity parameter is specified, you cannot include the Name parameter in your command. +Likewise, if the Name parameter is specified, you cannot specify an Identity. ```yaml -Type: SwitchParameter +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetDialplan + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity of the dial plan to be used for this test. +Dial plans can be retrieved by called the `Get-CsDialPlan` cmdlet. + +Must be 40 characters or fewer. + +Default: Global + + +```yaml +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetVoicePolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity of the voice policy against which to run this test. +Voice policies can be retrieved by calling the `Get-CsVoicePolicy` cmdlet. + +Must be 40 characters or fewer. + +Default: Global + + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -275,13 +302,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -290,20 +319,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetDialplan -The Identity of the dial plan to be used for this test. -Dial plans can be retrieved by called the `Get-CsDialPlan` cmdlet. - -Must be 40 characters or fewer. +### -WhatIf -Default: Global +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -317,12 +342,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration This cmdlet creates an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration ## NOTES diff --git a/skype/skype-ps/skype/New-CsVoicemailReroutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsVoicemailReroutingConfiguration.md similarity index 86% rename from skype/skype-ps/skype/New-CsVoicemailReroutingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsVoicemailReroutingConfiguration.md index 58bcb680ea..e3cedde889 100644 --- a/skype/skype-ps/skype/New-CsVoicemailReroutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsVoicemailReroutingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csvoicemailreroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsVoicemailReroutingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csvoicemailreroutingconfiguration +schema: 2.0.0 +title: New-CsVoicemailReroutingConfiguration --- # New-CsVoicemailReroutingConfiguration @@ -38,7 +39,7 @@ Note that these settings are not available unless the Enabled property has been ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsVoicemailReroutingConfiguration -Identity site:Redmond1 -Enabled $True -AutoAttendantNumber "+14255551212" ``` @@ -47,7 +48,7 @@ This example creates new voice mail rerouting settings that apply to the site Re The Enabled parameter is set to True to turn on this configuration and a phone number (+14255551212) is supplied to specify the Auto-Attendant to which calls will be rerouted. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsVoicemailReroutingConfiguration -Identity site:Redmond1 -SubscriberAccessNumber "+14255551213" ``` @@ -60,25 +61,10 @@ Enabled is set to False by default, so Subscriber Access calls will not be rerou ## PARAMETERS -### -Identity -This parameter contains a unique identifier specifying the scope at which this configuration is applied. -New voice mail rerouting configurations can be created only at the site level, so the Identity would be in the format Site:\, where \ is the name of the site to which the settings are applied. -A global voice mail rerouting configuration exists by default and cannot be re-created by calling the `New-CsVoicemailReroutingConfiguration` cmdlet. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AutoAttendantNumber -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AutoAttendantNumber Phone number of the Auto-Attendant to which the voice mail deposit attempts should be re-routed. The number supplied to this parameter must be a LineUri of an existing contact object. @@ -88,8 +74,7 @@ Value must be a number beginning with a digit 1 through 9, optionally preceded b ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -99,6 +84,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether attempts to access voice mail should be re-routed through PSTN when IP connectivity is down. Default: False @@ -106,8 +94,7 @@ Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,18 +103,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SubscriberAccessNumber -Subscriber Access number to which the voice mail retrieval attempts should be re-routed. +### -Force -The number supplied to this parameter must be a LineUri of an existing contact object. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Value must be a number beginning with a digit 1 through 9, optionally preceded by a plus (+), followed by any number of digits. +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -136,23 +121,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter contains a unique identifier specifying the scope at which this configuration is applied. +New voice mail rerouting configurations can be created only at the site level, so the Identity would be in the format Site:\, where \ is the name of the site to which the settings are applied. +A global voice mail rerouting configuration exists by default and cannot be re-created by calling the `New-CsVoicemailReroutingConfiguration` cmdlet. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. @@ -160,8 +152,7 @@ If you assign the output of this cmdlet called with this parameter to a variable ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -170,14 +161,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SubscriberAccessNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Subscriber Access number to which the voice mail retrieval attempts should be re-routed. + +The number supplied to this parameter must be a LineUri of an existing contact object. + +Value must be a number beginning with a digit 1 through 9, optionally preceded by a plus (+), followed by any number of digits. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -187,13 +184,33 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -207,12 +224,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.ExumRouting.VoicemailReroutingConfiguration Creates an object of type Microsoft.Rtc.Management.WritableConfig.Settings.ExumRouting.VoicemailReroutingConfiguration. ## NOTES diff --git a/skype/skype-ps/skype/New-CsWatcherNodeConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsWatcherNodeConfiguration.md similarity index 86% rename from skype/skype-ps/skype/New-CsWatcherNodeConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsWatcherNodeConfiguration.md index 7127cbf0ec..6981271010 100644 --- a/skype/skype-ps/skype/New-CsWatcherNodeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsWatcherNodeConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cswatchernodeconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsWatcherNodeConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cswatchernodeconfiguration +schema: 2.0.0 +title: New-CsWatcherNodeConfiguration --- # New-CsWatcherNodeConfiguration @@ -47,7 +48,7 @@ Skype for Business Server Control Panel: The functions carried out by the `New-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsTestUserCredential -SipAddress "sip:kenmyer@litwareinc.com" -UserName "litwareinc\kenmyer" -Password "07Apples" @@ -69,64 +70,57 @@ These new settings use port 5061; the two new test users and the extended test s ## PARAMETERS -### -Identity -Fully qualified domain name of the pool being associated with the watcher node configuration settings. -You can use either the Identity parameter or the TargetFqdn parameter to specify the pool; however, you cannot use both these parameters in the same command. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Enabled -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PortNumber -SIP port used by the Registrar service. +Enables or disables the watcher node. +The default value is True ($True). ```yaml -Type: UInt16 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetFqdn -Fully qualified domain name of the pool being associated with the watcher node configuration settings. -You can use either the TargetFqdn parameter or the Identity parameter to specify the pool; however, you cannot use both these parameters in the same command. +### -ExtendedTests + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +PSTN or Audio Conferencing Provider tests that can be assigned to a watcher node configuration. +These tests must be created using the `New-CsExtendedTest` cmdlet and stored in a variable (for example, $x). +The test can then be assigned to a watcher node by using syntax similar to this: + +`-ExtendedTests @{Add=$x}` ```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSListModifier +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,35 +129,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Enabled -Enables or disables the watcher node. -The default value is True ($True). +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool being associated with the watcher node configuration settings. +You can use either the Identity parameter or the TargetFqdn parameter to specify the pool; however, you cannot use both these parameters in the same command. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ExtendedTests -PSTN or Audio Conferencing Provider tests that can be assigned to a watcher node configuration. -These tests must be created using the `New-CsExtendedTest` cmdlet and stored in a variable (for example, $x). -The test can then be assigned to a watcher node by using syntax similar to this: +### -InMemory -`-ExtendedTests @{Add=$x}` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. ```yaml -Type: PSListModifier +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -172,33 +167,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -PortNumber + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP port used by the Registrar service. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. +### -TargetFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool being associated with the watcher node configuration settings. +You can use either the TargetFqdn parameter or the Identity parameter to specify the pool; however, you cannot use both these parameters in the same command. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -206,6 +205,9 @@ Accept wildcard characters: False ``` ### -Tests + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Synthetic transactions to be run by the watcher node. Allowed values are: @@ -249,8 +251,7 @@ To configure tests at the time you create a new watcher node, use the following ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -260,6 +261,9 @@ Accept wildcard characters: False ``` ### -TestUsers + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP addresses of the test users to be assigned to the watcher node; these user accounts must have previously been configured by using the `Set-CsTestUserCredential` cmdlet. To add test users, use syntax similar to this, separating user addresses by using commas: @@ -268,8 +272,7 @@ To add test users, use syntax similar to this, separating user addresses by usin ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -278,15 +281,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseInternalWebUrls -When set to True ($True), instructs the watcher node to use the internal Web URLs rather than the external Web URLs. -This provides a way to way to verify URL validity for users located behind the organization's firewall. +### -UseAutoDiscovery + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True), Skype for Business Online watcher nodes will use the Autodiscover service to locate the target pool. +When set to False (the default value) watcher nodes will use SRV records to locate the pool. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -295,14 +300,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -UseInternalWebUrls + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True), instructs the watcher node to use the internal Web URLs rather than the external Web URLs. +This provides a way to way to verify URL validity for users located behind the organization's firewall. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -312,13 +320,15 @@ Accept wildcard characters: False ``` ### -XmppTestReceiverMailAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + XMPP email address to be used when testing the XMPP gateway. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -327,15 +337,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseAutoDiscovery -When set to True ($True), Skype for Business Online watcher nodes will use the Autodiscover service to locate the target pool. -When set to False (the default value) watcher nodes will use SRV records to locate the pool. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -349,13 +378,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsWatcherNodeConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.TargetPool#Decorated The `New-CsWatcherNodeConfiguration` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.TargetPool#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsWebLink.md b/skype/skype-ps/SkypeForBusiness/New-CsWebLink.md similarity index 94% rename from skype/skype-ps/skype/New-CsWebLink.md rename to skype/skype-ps/SkypeForBusiness/New-CsWebLink.md index 56cf68d55b..604d29e32f 100644 --- a/skype/skype-ps/skype/New-CsWebLink.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsWebLink.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csweblink applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsWebLink -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csweblink +schema: 2.0.0 +title: New-CsWebLink --- # New-CsWebLink @@ -52,7 +53,7 @@ Autodiscover URLs are based on the SIP domains used in your organization; admini ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $Link1 = New-CsWebLink -Token "Fabrikam" -Href "https://LyncDiscover.fabrikam.com" @@ -65,7 +66,7 @@ After that, the `Set-CsAutoDiscoverConfiguration` cmdlet is used to add the new This is done by using the WebLinks parameter and the parameter value @{Add=$Link1}. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $Link1 = New-CsWebLink -Token "Fabrikam" -Href "https://LyncDiscover.fabrikam.com" @@ -84,6 +85,9 @@ That syntax causes the values stored in the variables $Link1 and $Link2 to be ad ## PARAMETERS ### -Href + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URL for the Autodiscover service, For example: `-Href "https://LyncDiscover.fabrikam.com"` @@ -91,8 +95,7 @@ URL for the Autodiscover service, For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -102,6 +105,9 @@ Accept wildcard characters: False ``` ### -Token + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique name to be given to the URL. For example: @@ -110,8 +116,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -125,13 +130,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsWebLink` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WriteableConfig.Settings.WebLink.WebLink Creates new instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.WebLink.WebLink object ## NOTES diff --git a/skype/skype-ps/skype/New-CsWebOrigin.md b/skype/skype-ps/SkypeForBusiness/New-CsWebOrigin.md similarity index 94% rename from skype/skype-ps/skype/New-CsWebOrigin.md rename to skype/skype-ps/SkypeForBusiness/New-CsWebOrigin.md index f4c97376ec..60d4ca406e 100644 --- a/skype/skype-ps/skype/New-CsWebOrigin.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsWebOrigin.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csweborigin applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsWebOrigin -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csweborigin +schema: 2.0.0 +title: New-CsWebOrigin --- # New-CsWebOrigin @@ -33,7 +34,7 @@ Skype for Business Server Control Panel: The functions carried out by the `New-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $x = New-CsWebOrigin -Url "http://fabrikam.com" @@ -48,7 +49,7 @@ The second command in the example uses the `New-CsWebServiceConfiguration` cmdle The syntax "`- CrossDomainAuthorizationList $x`" adds http://fabrikam.com to the collection of domains authorized for cross-domain scripting. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $x = New-CsWebOrigin -Url "http://fabrikam.com" @@ -67,6 +68,9 @@ To replace the existing collection with just http://fabrikam.com use the syntax ## PARAMETERS ### -Url + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + URL of the domain authorized to send cross-domain scripting requests. URLs must be prefaced using either the http: or the https: prefix. For example: @@ -76,8 +80,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -91,13 +94,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsWebOrigin` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Web.Origin The `New-CsWebOrigin` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Web.Origin object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsWebServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/New-CsWebServiceConfiguration.md similarity index 86% rename from skype/skype-ps/skype/New-CsWebServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/New-CsWebServiceConfiguration.md index 8b4f16252e..43cfcbab70 100644 --- a/skype/skype-ps/skype/New-CsWebServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsWebServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cswebserviceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsWebServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cswebserviceconfiguration +schema: 2.0.0 +title: New-CsWebServiceConfiguration --- # New-CsWebServiceConfiguration @@ -124,41 +125,58 @@ For example: ## PARAMETERS -### -Identity -Unique identifier for the Web Services configuration settings to be created. -To create settings configured at the site scope, use syntax similar to this: +### -AllowAnonymousAccessToLWAConference -`-Identity "site:Redmond"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -To create settings configured at the service scope, use syntax similar to this: +When set to True (the default value), anonymous users will be allowed to attend Skype for Business web App conferences. -`-Identity "service:WebServer:atl-cs-001.litwareinc.com"` -Note that any settings created at the service scope must be assigned to the Web Server service. +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` +### -AllowExternalAuthentication + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), OAuth authentication can be used to authenticate external users. ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAnonymousAccessToLWAConference -When set to True (the default value), anonymous users will be allowed to attend Skype for Business web App conferences. +### -AutoLaunchLyncWebAccess + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter has been deprecated for use with the on-premises version of Skype for Business Server. + +When set to True, Skype for Business Web App will automatically be used as the default web popup for joining an online conference, provided that the prerequisites for using Skype for Business Web App (for example, Silverlight have been installed and Internet Explorer is not blocking pop-up windows) have been met. + +The default value is True. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -168,6 +186,9 @@ Accept wildcard characters: False ``` ### -CASigningKeyLength + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Sets the size of the certification authority (CA) signing key, the private key used by a CA to sign digital certificates. The signing key length can be set to any integer value between 2048 and 16384 bytes; the default value is 2048. @@ -175,7 +196,30 @@ The signing key length can be set to any integer value between 2048 and 16384 by Type: UInt64 Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CrossDomainAuthorizationList + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Collection of domains allowed to host web applications that send cross-domain scripting requests to the Skype for Business Server deployment. + +Domains to be added to the list must be created using the `New-CsWebOrigin` cmdlet and then added to the new collection of Web service configuration settings. +Domain names must be prefaced using the http: or the https: prefix. +See Example 3 of this help topic for more information. + +This parameter was introduced in the February, 2013 release of Lync Server 2013. + +```yaml +Type: PSListModifier +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -185,6 +229,9 @@ Accept wildcard characters: False ``` ### -DefaultValidityPeriodHours + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When using certificate authentication, clients can request the period of time (in hours) that the certificate remains valid. DefaultValidityPeriodHours represents the amount of time a certificate will remain valid if the client does not request a custom validity period. @@ -195,7 +242,6 @@ The default value is 4320 (180 days). Type: UInt64 Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -205,6 +251,9 @@ Accept wildcard characters: False ``` ### -EnableCertChainDownload + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If set to True, servers presented with an authentication certificate will download the certificate chain for that certificate. The certificate chain traces an individual certificate back to the issuing CA. Certificates will not be accepted for authentication unless the certificate's CA is trusted. @@ -213,7 +262,6 @@ Certificates will not be accepted for authentication unless the certificate's CA Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -223,6 +271,9 @@ Accept wildcard characters: False ``` ### -EnableGroupExpansion + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If set to True, group expansion will be enabled in Skype for Business. With group expansion, users can configure a distribution group as a contact and then "expand" that group. When a group has been expanded, users can see all the individual members of a group and their current presence information. @@ -232,7 +283,6 @@ When a group has been expanded, users can see all the individual members of a gr Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -241,15 +291,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InferCertChainFromSSL -If set to True, servers will use the certificate information included in the Secure Sockets Layer (SSL) protocol to determine the issuing CA. -Certificates will not be accepted for authentication unless the certificate's CA is trusted. +### -EnableMediaBasicAuth + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: $true | $false ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -258,17 +309,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MACResolverUrl -URL for a Web service capable of performing Media Access Control (MAC) resolution. -MAC resolution involves taking the MAC address of a connected client and returning the chassis and port IDs of the network switch that client is connected to. -MAC resolution is used by the Enhanced 9-1-1 service. +### -EnableStatisticsInResponse + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +When set to True ($True) the X-MS-WebInfraStats header is included in all HTTP responses. +The default value is False ($False). ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -277,16 +328,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxCSRKeySize -Sets the maximum size of the certificate signing request (CSR) key. -(A CSR is a message sent from an applicant to a CA in order to apply for a digital certificate.) The maximum size can be set to any integer value between 1024 and 16384 bytes. -The default value is 16384. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: UInt64 +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -295,18 +346,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxGroupSizeToExpand -Represents the maximum number of people that will be displayed when a group is expanded. -For example, if MaxGroupSizeToExpand is set to 75, only the first 75 members of the group will be displayed any time the group is expanded. +### -HstsMaxAgeInSeconds -MaxGroupSizeToExpand can be set to any integer value between 1 and 1000, inclusive. -The default value is 100. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the time in seconds of the max-age setting in the Strict-Transport-Security (STS) header of an HTTPS response. +A negative value will suppress the STS header in the HTTPS response. +The default is 315,360,000 (one year.) ```yaml -Type: UInt32 +Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -315,36 +366,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxValidityPeriodHours -When using certificate authentication, clients can request the period of time (in hours) that the certificate remains valid. -MaxValidityPeriodHours represents the maximum amount of time a client can request. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the Web Services configuration settings to be created. +To create settings configured at the site scope, use syntax similar to this: + +`-Identity "site:Redmond"` + +To create settings configured at the service scope, use syntax similar to this: + +`-Identity "service:WebServer:atl-cs-001.litwareinc.com"` + +Note that any settings created at the service scope must be assigned to the Web Server service. -MaxValidityPeriodHours can be any integer value between 8 hours and 8760 hours (365 days). -The default value is 8760. ```yaml -Type: UInt64 +Type: XdsIdentity Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MinCSRKeySize -Sets the minimum size of the CSR key. -The minimum size can be set to any integer value between 1024 and 16384 bytes. -The default value is 16384. +### -InferCertChainFromSSL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True, servers will use the certificate information included in the Secure Sockets Layer (SSL) protocol to determine the issuing CA. +Certificates will not be accepted for authentication unless the certificate's CA is trusted. ```yaml -Type: UInt64 +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -353,18 +413,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MinValidityPeriodHours -When using certificate authentication, clients can request the period of time (in hours) that the certificate remains valid. -MinValidityPeriodHours represents the minimum amount of time a client can request. +### -InMemory + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Creates an object reference without actually committing the object as a permanent change. +If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. -MinValidityPeriodHours can be any integer value between 8 hours and 4320 hours (180 days). -The default value is 8. ```yaml -Type: UInt64 +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -373,15 +433,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SecondaryLocationSourceUrl -URL for a Web service that can process a location request. -This service is typically used only when location requests cannot be resolved locally. +### -MACResolverUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL for a Web service capable of performing Media Access Control (MAC) resolution. +MAC resolution involves taking the MAC address of a connected client and returning the chassis and port IDs of the network switch that client is connected to. +MAC resolution is used by the Enhanced 9-1-1 service. + ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -390,17 +454,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TrustedCACerts -Collection of certificates representing certificate chains trusted by the Web server. -New certificates added to the collection must be created using the `New-CsWebTrustedCACertificate` cmdlet. +### -MaxCSRKeySize -This collection is not used if the InferCertChainFromSSL property is set to True. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Sets the maximum size of the certificate signing request (CSR) key. +(A CSR is a message sent from an applicant to a CA in order to apply for a digital certificate.) The maximum size can be set to any integer value between 1024 and 16384 bytes. +The default value is 16384. ```yaml -Type: PSListModifier +Type: UInt64 Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -409,32 +474,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseCertificateAuth -When set to True (the default value), clients can be authenticated using certificates. -Set this value to False ($False) to disable certificate authentication. +### -MaxGroupSizeToExpand -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Represents the maximum number of people that will be displayed when a group is expanded. +For example, if MaxGroupSizeToExpand is set to 75, only the first 75 members of the group will be displayed any time the group is expanded. -### -UsePinAuth -When set to True (the default value), clients can be authenticated using personal identification numbers (PINs). -Set this value to False ($False) to disable PIN authentication. +MaxGroupSizeToExpand can be set to any integer value between 1 and 1000, inclusive. +The default value is 100. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -443,21 +496,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseWindowsAuth -Determines how (and if) users will be authenticated using Windows authentication; that is, using the same credentials they used when they logged on to Windows. -Valid values are: +### -MaxValidityPeriodHours -Negotiate - The client and server will work together to determine the proper authentication protocol (either Kerberos or NTLM). +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -NTLM - Windows authentication will be allowed, but only using the NTLM protocol. +When using certificate authentication, clients can request the period of time (in hours) that the certificate remains valid. +MaxValidityPeriodHours represents the maximum amount of time a client can request. -None - Windows authentication will not be allowed. +MaxValidityPeriodHours can be any integer value between 8 hours and 8760 hours (365 days). +The default value is 8760. ```yaml -Type: UseWindowsAuth +Type: UInt64 Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -466,14 +518,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -MinCSRKeySize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Sets the minimum size of the CSR key. +The minimum size can be set to any integer value between 1024 and 16384 bytes. +The default value is 16384. ```yaml -Type: SwitchParameter +Type: UInt64 Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -482,16 +538,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -Creates an object reference without actually committing the object as a permanent change. -If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set-\. +### -MinValidityPeriodHours + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When using certificate authentication, clients can request the period of time (in hours) that the certificate remains valid. +MinValidityPeriodHours represents the minimum amount of time a client can request. +MinValidityPeriodHours can be any integer value between 8 hours and 4320 hours (180 days). +The default value is 8. ```yaml -Type: SwitchParameter +Type: UInt64 Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -500,30 +560,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MobilePreferredAuthType -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Specifies the preferred authentication type to be used by mobile applications. +If an unsupported method is specified, the web ticket service will not start and an event will be logged by the Skype for Business Server. +Accepted values for the MobilePreferredAuthType parameter are: -### -Confirm -Prompts you for confirmation before executing the command. +None + +OAuth + +WebTicketServiceAnon + +WebTicketServiceWinNegotiate + +WebTicketServiceWinNtlm + +WebTicketServiceCert + +WebTicketServicePin + +WsFedPassive + +WsFedBearer + +WebTicketServiceAuth ```yaml -Type: SwitchParameter +Type: MobilePreferredAuthType Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -532,17 +600,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowDownloadCommunicatorAttendeeLink -This parameter has been deprecated for use with the on-premises version of Skype for Business Server. +### -PendingGetWaitSupportingApps -If set to True (the default value), users joining a meeting by using a client application other than Skype for Business will see a link that points them toward a download for Skype for Business Web App. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Specifies a semicolon-separated list of applications for which PendingGetWaitTimeOutInMinutes need to be set. +Supported applications are Android, iPhone, iPad, Macintosh, Windows. +To support all applications you can give All as input. +For example: +- To support Android and Macintosh - Android;Macintosh; +- To support all devices - All; +The default value is None. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -551,18 +624,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowJoinUsingLegacyClientLink -This parameter has been deprecated for use with the on-premises version of Skype for Business Server. +### -PendingGetWaitTimeOutInMinutes -If set to True, users joining a meeting by using a client application other than Skype for Business will be given the opportunity to join the meeting by using their current client application. -The default value is False. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Specifies the time in minutes to send an event at a particular interval to Keep Alive EventChannel. +The value can be specified in between 5 to 15 minutes (both inclusive). +The default value is 15 minutes. ```yaml -Type: Boolean +Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -571,14 +644,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowExternalAuthentication -When set to True (the default value), OAuth authentication can be used to authenticate external users. +### -SecondaryLocationSourceUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL for a Web service that can process a location request. +This service is typically used only when location requests cannot be resolved locally. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -587,19 +663,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AutoLaunchLyncWebAccess -This parameter has been deprecated for use with the on-premises version of Skype for Business Server. +### -ShowAlternateJoinOptionsExpanded -When set to True, Skype for Business Web App will automatically be used as the default web popup for joining an online conference, provided that the prerequisites for using Skype for Business Web App (for example, Silverlight have been installed and Internet Explorer is not blocking pop-up windows) have been met. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The default value is True. +This parameter has been deprecated for use with the on-premises version of Skype for Business Server. + +When set to True then alternate options for joining an online conference will automatically be expanded and shown to users. +When set to False (the default value) these options will be available, but the user will have to display the list of options for themselves. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -608,18 +685,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowAlternateJoinOptionsExpanded +### -ShowDownloadCommunicatorAttendeeLink + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This parameter has been deprecated for use with the on-premises version of Skype for Business Server. -When set to True then alternate options for joining an online conference will automatically be expanded and shown to users. -When set to False (the default value) these options will be available, but the user will have to display the list of options for themselves. +If set to True (the default value), users joining a meeting by using a client application other than Skype for Business will see a link that points them toward a download for Skype for Business Web App. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -628,15 +706,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseWsFedPassiveAuth -When set to True, allows for passive authentication: authentication of users by using URL redirection or smart linking. -The default value is False ($False). +### -ShowJoinUsingLegacyClientLink + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter has been deprecated for use with the on-premises version of Skype for Business Server. + +If set to True, users joining a meeting by using a client application other than Skype for Business will be given the opportunity to join the meeting by using their current client application. +The default value is False. + ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -645,14 +728,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WsFedPassiveMetadataUri -URI used by the WS-federation Web requestor protocol. +### -TrustedCACerts + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Collection of certificates representing certificate chains trusted by the Web server. +New certificates added to the collection must be created using the `New-CsWebTrustedCACertificate` cmdlet. + +This collection is not used if the InferCertChainFromSSL property is set to True. ```yaml -Type: String +Type: PSListModifier Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -661,20 +749,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CrossDomainAuthorizationList -Collection of domains allowed to host web applications that send cross-domain scripting requests to the Skype for Business Server deployment. +### -UseCertificateAuth -Domains to be added to the list must be created using the `New-CsWebOrigin` cmdlet and then added to the new collection of Web service configuration settings. -Domain names must be prefaced using the http: or the https: prefix. -See Example 3 of this help topic for more information. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -This parameter was introduced in the February, 2013 release of Lync Server 2013. +When set to True (the default value), clients can be authenticated using certificates. +Set this value to False ($False) to disable certificate authentication. ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -683,14 +768,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMediaBasicAuth -PARAMVALUE: $true | $false +### -UseDomainAuthInLWA + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, domain authentication can be employed as a way to authenticate Skype for Business Web App users. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -699,15 +786,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableStatisticsInResponse -When set to True ($True) the X-MS-WebInfraStats header is included in all HTTP responses. -The default value is False ($False). +### -UsePinAuth + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), clients can be authenticated using personal identification numbers (PINs). +Set this value to False ($False) to disable PIN authentication. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -716,16 +805,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HstsMaxAgeInSeconds -Specifies the time in seconds of the max-age setting in the Strict-Transport-Security (STS) header of an HTTPS response. -A negative value will suppress the STS header in the HTTPS response. -The default is 315,360,000 (one year.) +### -UseWebClientLegacyUI + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +If true ($True), then the legacy web interface is presented to the client. +If false ($False), the standard web interface is used. +The default is false. ```yaml -Type: Int64 +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -734,16 +825,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PendingGetWaitTimeOutInMinutes -Specifies the time in minutes to send an event at a particular interval to Keep Alive EventChannel. -The value can be specified in between 5 to 15 minutes (both inclusive). -The default value is 15 minutes. +### -UseWindowsAuth + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Determines how (and if) users will be authenticated using Windows authentication; that is, using the same credentials they used when they logged on to Windows. +Valid values are: + +Negotiate - The client and server will work together to determine the proper authentication protocol (either Kerberos or NTLM). + +NTLM - Windows authentication will be allowed, but only using the NTLM protocol. + +None - Windows authentication will not be allowed. ```yaml -Type: Int64 +Type: UseWindowsAuth Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -752,20 +850,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PendingGetWaitSupportingApps -Specifies a semicolon-separated list of applications for which PendingGetWaitTimeOutInMinutes need to be set. -Supported applications are Android, iPhone, iPad, Macintosh, Windows. -To support all applications you can give All as input. -For example: -- To support Android and Macintosh - Android;Macintosh; -- To support all devices - All; -The default value is None. +### -UseWsFedPassiveAuth + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, allows for passive authentication: authentication of users by using URL redirection or smart linking. +The default value is False ($False). ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -774,36 +869,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MobilePreferredAuthType -Specifies the preferred authentication type to be used by mobile applications. -If an unsupported method is specified, the web ticket service will not start and an event will be logged by the Skype for Business Server. -Accepted values for the MobilePreferredAuthType parameter are: - -None - -OAuth - -WebTicketServiceAnon - -WebTicketServiceWinNegotiate - -WebTicketServiceWinNtlm - -WebTicketServiceCert - -WebTicketServicePin - -WsFedPassive +### -WsFedPassiveMetadataUri -WsFedBearer +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -WebTicketServiceAuth +URI used by the WS-federation Web requestor protocol. ```yaml -Type: MobilePreferredAuthType +Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -812,14 +887,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseDomainAuthInLWA -When set to True, domain authentication can be employed as a way to authenticate Skype for Business Web App users. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -828,16 +905,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseWebClientLegacyUI -If true ($True), then the legacy web interface is presented to the client. -If false ($False), the standard web interface is used. -The default is false. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/New-CsWebTrustedCACertificate.md b/skype/skype-ps/SkypeForBusiness/New-CsWebTrustedCACertificate.md similarity index 92% rename from skype/skype-ps/skype/New-CsWebTrustedCACertificate.md rename to skype/skype-ps/SkypeForBusiness/New-CsWebTrustedCACertificate.md index 1ae3b83bb3..50e7f40803 100644 --- a/skype/skype-ps/skype/New-CsWebTrustedCACertificate.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsWebTrustedCACertificate.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-cswebtrustedcacertificate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsWebTrustedCACertificate -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-cswebtrustedcacertificate +schema: 2.0.0 +title: New-CsWebTrustedCACertificate --- # New-CsWebTrustedCACertificate @@ -37,7 +38,7 @@ In most cases, the CA that issued the default certificate will be the only certi ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` $x = New-CsWebTrustedCACertificate -Thumbprint "D543DFF74FEEA425162FD25F342786F1AB453BB3" -CAStore TrustedRootCA @@ -55,18 +56,23 @@ The parameter value ${Add=$x} tells the cmdlet to add the certificate stored in ## PARAMETERS -### -Thumbprint -Thumbprint of the certificate which should be trusted by Lync Phone Edition. -You can retrieve certificate issuer and thumbprint values by running this command: +### -CAStore -`Get-CsCertificate | Select-Object Issuer, Thumbprint` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the name of the certificate store (on the local computer) where the certificate is stored. +Valid values are: + +TrustedRootCA +IntermediateCA + +ThirdPartyRootCA ```yaml -Type: String +Type: CAStore Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -75,21 +81,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CAStore -Indicates the name of the certificate store (on the local computer) where the certificate is stored. -Valid values are: +### -Thumbprint -TrustedRootCA +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -IntermediateCA +Thumbprint of the certificate which should be trusted by Lync Phone Edition. +You can retrieve certificate issuer and thumbprint values by running this command: + +`Get-CsCertificate | Select-Object Issuer, Thumbprint` -ThirdPartyRootCA ```yaml -Type: CAStore +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -103,13 +108,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsWebTrustedCACertificate` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Web.CACertID The `New-CsWebTrustedCACertificate` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Web.CACertID object. ## NOTES diff --git a/skype/skype-ps/skype/New-CsXmppAllowedPartner.md b/skype/skype-ps/SkypeForBusiness/New-CsXmppAllowedPartner.md similarity index 89% rename from skype/skype-ps/skype/New-CsXmppAllowedPartner.md rename to skype/skype-ps/SkypeForBusiness/New-CsXmppAllowedPartner.md index 3143cc1192..9b60859d65 100644 --- a/skype/skype-ps/skype/New-CsXmppAllowedPartner.md +++ b/skype/skype-ps/SkypeForBusiness/New-CsXmppAllowedPartner.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/new-csxmppallowedpartner applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: New-CsXmppAllowedPartner -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/new-csxmppallowedpartner +schema: 2.0.0 +title: New-CsXmppAllowedPartner --- # New-CsXmppAllowedPartner @@ -50,7 +51,7 @@ Skype for Business Server Control Panel: To create a new XMPP allowed partner us ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` New-CsXmppAllowedPartner -Identity "contoso.com" -PartnerType "PublicVerified" ``` @@ -59,7 +60,7 @@ The command shown in Example 1 creates a new XMPP allowed partner: contoso.com. In this example, the PartnerType property is set to "PublicVerified". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` New-CsXmppAllowedPartner -Identity "fabrikam.com" -AdditionalDomains "research.fabrikam2.com" ``` @@ -70,53 +71,10 @@ In addition to the root domain (fabrikam.com), the AdditionalDomains property is ## PARAMETERS -### -Domain -Primary domain of the XMPP allowed partner; for example: - -`-Domain "fabrikam.com"` - -You can specify the primary domain by using either the Domain parameter or the Identity parameter. -However, you cannot use both parameters in the same command. - -Additional domains can be specified by using the AdditionalDomains parameter. - -```yaml -Type: String -Parameter Sets: ParentAndRelativeKey -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Identity -Primary domain of the XMPP allowed partner; for example: - -``-Identity "fabrikam.com"` - -You can specify the primary domain by using either the Identity parameter or the Domain parameter. -However, you cannot use both parameters in the same command. - -Additional domains can be specified by using the AdditionalDomains parameter. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -AdditionalDomains -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -AdditionalDomains Additional XMPP domains belonging to the allowed partner. Multiple domains can be specified by separated domain names by using commas; for example: @@ -125,8 +83,7 @@ Multiple domains can be specified by separated domain names by using commas; for ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -135,14 +92,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -ConnectionLimit + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Specifies the maximum number of simultaneous connections allowed to a specific partner. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -151,14 +110,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConnectionLimit -Specifies the maximum number of simultaneous connections allowed to a specific partner. +### -Description + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Enables administrators to provide additional text regarding the XMPP allowed partner. +For example, the Description might include contact information for the partner. ```yaml -Type: UInt32 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -167,17 +129,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide additional text regarding the XMPP allowed partner. -For example, the Description might include contact information for the partner. +### -Domain + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Primary domain of the XMPP allowed partner; for example: + +`-Domain "fabrikam.com"` + +You can specify the primary domain by using either the Domain parameter or the Identity parameter. +However, you cannot use both parameters in the same command. + +Additional domains can be specified by using the AdditionalDomains parameter. ```yaml Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Parameter Sets: ParentAndRelativeKey +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -185,6 +155,9 @@ Accept wildcard characters: False ``` ### -EnableKeepAlive + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Indicates whether or not the XMPP partner should periodically transmit "keep alive" packets in order to verify that the connection is still active. The default value is True. @@ -192,8 +165,7 @@ The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -203,13 +175,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -218,15 +192,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Primary domain of the XMPP allowed partner; for example: + +``-Identity "fabrikam.com"` + +You can specify the primary domain by using either the Identity parameter or the Domain parameter. +However, you cannot use both parameters in the same command. + +Additional domains can be specified by using the AdditionalDomains parameter. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -InMemory + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Creates an object reference without actually committing the object as a permanent change. If you assign the output of this cmdlet called with this parameter to a variable, you can make changes to the properties of the object reference and then commit those changes by calling this cmdlet's matching Set- cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -236,6 +237,9 @@ Accept wildcard characters: False ``` ### -PartnerType + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Specifies the relationship between Skype for Business Server and the XMPP partner. Allowed values are: @@ -251,8 +255,7 @@ The default value is PublicUnverified. ```yaml Type: PartnerType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -262,13 +265,15 @@ Accept wildcard characters: False ``` ### -ProxyFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Full qualified domain name of the proxy server used by the XMPP partner. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -278,6 +283,9 @@ Accept wildcard characters: False ``` ### -SaslNegotiation + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Indicates support for the Simple Authentication and Security Layer protocol, a protocol used for server authentication. Allowed values are: @@ -294,8 +302,7 @@ The default value is Required. ```yaml Type: SaslNegotiation Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -305,6 +312,9 @@ Accept wildcard characters: False ``` ### -SupportDialbackNegotiation + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Indicates whether dialback negotiation will be supported. With dialback negotiation, when Server A contacts Server B communication is not immediately established. Instead, Server B first attempts to verify the identity of Server A by contacting the authoritative DNS server for the domain that Server A claims to be from. @@ -318,8 +328,7 @@ The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -329,6 +338,9 @@ Accept wildcard characters: False ``` ### -TlsNegotiation + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Indicates support for the Transport Layer Security protocol, a protocol used to encrypt server-to-server data streams. Allowed values are: @@ -343,8 +355,25 @@ NotSupported (TLS negotiation will not be support The default value is Required. ```yaml Type: TlsNegotiation Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -354,13 +383,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -374,13 +405,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `New-CsXmppAllowedPartner` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppAllowedPartner The `New-CsXmppAllowedPartner` cmdlet creates new instances of the Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppAllowedPartner#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Publish-CsLisConfiguration.md b/skype/skype-ps/SkypeForBusiness/Publish-CsLisConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Publish-CsLisConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Publish-CsLisConfiguration.md index a3a95573fd..c63745e70f 100644 --- a/skype/skype-ps/skype/Publish-CsLisConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Publish-CsLisConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/publish-cslisconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Publish-CsLisConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/publish-cslisconfiguration +schema: 2.0.0 +title: Publish-CsLisConfiguration --- # Publish-CsLisConfiguration @@ -33,7 +34,7 @@ The configuration can be removed from the Central Management store by calling th ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Publish-CsLisConfiguration ``` @@ -44,13 +45,15 @@ This command commits the LIS configuration to the Central Management store. ## PARAMETERS ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -59,14 +62,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -75,14 +80,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -96,12 +103,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### None This cmdlet does not return a value. ## NOTES diff --git a/skype/skype-ps/skype/Publish-CsTopology.md b/skype/skype-ps/SkypeForBusiness/Publish-CsTopology.md similarity index 86% rename from skype/skype-ps/skype/Publish-CsTopology.md rename to skype/skype-ps/SkypeForBusiness/Publish-CsTopology.md index a947773c93..8db97250ee 100644 --- a/skype/skype-ps/skype/Publish-CsTopology.md +++ b/skype/skype-ps/SkypeForBusiness/Publish-CsTopology.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/publish-cstopology applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Publish-CsTopology -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/publish-cstopology +schema: 2.0.0 +title: Publish-CsTopology --- # Publish-CsTopology @@ -55,7 +56,7 @@ After publishing the topology in this manner, you will then need to reconfigure ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` (Get-CsTopology -AsXml).ToString() \> C:\Topologies\Topology.xml @@ -69,23 +70,10 @@ To carry out these tasks, the first command in the example uses the `Get-CsTopol ## PARAMETERS -### -FileName -Full path to the XML file containing the new topology information. - -```yaml -Type: String -Parameter Sets: Filename -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -BackupFileName -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -BackupFileName Full path to the backup file automatically created when you run the `Publish-CsTopology` cmdlet. If this parameter is not specified, then the `Publish-CsTopology` cmdlet will create a backup file in your Temp folder (%temp%) similar to this: Publish-CsTopology-Backup-\[2010_10_01\]\[08_30_00\]. In that file name, 2010_10_01 represents the date that publication took place: year (2010), month (10) and day (01). @@ -95,8 +83,7 @@ In addition, 08_30_00 represents the time of day when publication took place: ho ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -106,14 +93,16 @@ Accept wildcard characters: False ``` ### -Document + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to publish an XML element rather than an XML file. This XML element must be configured as a System.XML.Linq.XElement object. ```yaml Type: XElement Parameter Sets: Document -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -122,37 +111,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalCatalog -Fully qualified domain name (FQDN) of a global catalog server in your domain. -This parameter is not required if you are running the `Publish-CsTopology` cmdlet on a computer with an account in your domain. +### -FileName +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Full path to the XML file containing the new topology information. ```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Filename +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalSettingsDomainController -FQDN of a domain controller where global settings are stored. -If global settings are stored in the System container in Active Directory Domain Services, then this parameter must point to the root domain controller. -If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. +### -FinalizeUninstall + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Used only when uninstalling Skype for Business Server. After the Central Management Server has been removed, use `Publish-CsTopology` and the FinalizeUninstall parameter to publish an empty topology. +Among other things, this removes all the Active Directory entries for the Central Management Server. ```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: Finalize +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -160,13 +150,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,15 +167,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: `-Report "C:\Logs\Publish_Topology.html"` +### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of a global catalog server in your domain. +This parameter is not required if you are running the `Publish-CsTopology` cmdlet on a computer with an account in your domain. + ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -192,14 +187,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. +### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of a domain controller where global settings are stored. +If global settings are stored in the System container in Active Directory Domain Services, then this parameter must point to the root domain controller. +If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. + ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: `-Report "C:\Logs\Publish_Topology.html"` + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -209,13 +228,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -224,18 +245,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FinalizeUninstall -Used only when uninstalling Skype for Business Server. After the Central Management Server has been removed, use `Publish-CsTopology` and the FinalizeUninstall parameter to publish an empty topology. -Among other things, this removes all the Active Directory entries for the Central Management Server. +### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. ```yaml Type: SwitchParameter -Parameter Sets: Finalize -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: wi -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -247,14 +268,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Publish-CsTopology` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None Instead, the `Publish-CsTopology` cmdlet publishes instances of the Microsoft.Rtc.Management.Deploy.Internal.DefaultTopology object. ## NOTES diff --git a/skype/skype-ps/skype/Register-CsHybridPSTNAppliance.md b/skype/skype-ps/SkypeForBusiness/Register-CsHybridPSTNAppliance.md similarity index 89% rename from skype/skype-ps/skype/Register-CsHybridPSTNAppliance.md rename to skype/skype-ps/SkypeForBusiness/Register-CsHybridPSTNAppliance.md index 9dcace377f..e7f3dcf1e9 100644 --- a/skype/skype-ps/skype/Register-CsHybridPSTNAppliance.md +++ b/skype/skype-ps/SkypeForBusiness/Register-CsHybridPSTNAppliance.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/register-cshybridpstnappliance applicable: Skype for Business Online -title: Register-CsHybridPSTNAppliance -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/register-cshybridpstnappliance +schema: 2.0.0 +title: Register-CsHybridPSTNAppliance --- # Register-CsHybridPSTNAppliance @@ -37,7 +39,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Insert example commands for example 1. ``` @@ -47,14 +49,18 @@ Insert descriptive text for example 1. ## PARAMETERS -### -MediationServerFqdn -Mediation Server FQDN of this Skype for Business Cloud Connector Edition appliance. +### -Force + +> Applicable: Skype for Business Online + +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -63,14 +69,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MediationServerIPAddress -Mediation Server IP address of this Skype for Business Cloud Connector Edition appliance. +### -InMemory + +> Applicable: Skype for Business Online + +PARAMVALUE: SwitchParameter ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -79,14 +87,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -Name of Skype for Business Cloud Connector Edition appliance. +### -MediationServerFqdn + +> Applicable: Skype for Business Online + +Mediation Server FQDN of this Skype for Business Cloud Connector Edition appliance. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -95,14 +105,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SiteName -Name of Skype for Business Cloud Connector Edition site that the appliance belongs to. +### -MediationServerIPAddress + +> Applicable: Skype for Business Online + +Mediation Server IP address of this Skype for Business Cloud Connector Edition appliance. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -111,14 +123,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -PARAMVALUE: SwitchParameter +### -Name + +> Applicable: Skype for Business Online + +Name of Skype for Business Cloud Connector Edition appliance. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -127,16 +141,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -SiteName + +> Applicable: Skype for Business Online + +Name of Skype for Business Cloud Connector Edition site that the appliance belongs to. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -145,14 +159,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InMemory -PARAMVALUE: SwitchParameter +### -Tenant + +> Applicable: Skype for Business Online + +PARAMVALUE: Guid ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -161,14 +177,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -PARAMVALUE: Guid +### -Confirm + +> Applicable: Skype for Business Online + +PARAMVALUE: SwitchParameter ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -178,13 +196,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/Remove-CsAVEdgeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAVEdgeConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsAVEdgeConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsAVEdgeConfiguration.md index 37d8b834d3..474e19d830 100644 --- a/skype/skype-ps/skype/Remove-CsAVEdgeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAVEdgeConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csavedgeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsAVEdgeConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csavedgeconfiguration +schema: 2.0.0 +title: Remove-CsAVEdgeConfiguration --- # Remove-CsAVEdgeConfiguration @@ -37,7 +38,7 @@ Instead, the properties contained within the global collection will all be reset ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsAVEdgeConfiguration -Identity site:Redmond ``` @@ -46,7 +47,7 @@ The command shown in Example 1 removes the A/V Edge configuration settings that After the settings are removed, A/V Edge servers in the Redmond site will be governed by the global configuration settings. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsAVEdgeConfiguration -Filter "service:*" | Remove-CsAVEdgeConfiguration ``` @@ -56,7 +57,7 @@ To do this, the command first calls the `Get-CsAVEdgeConfiguration` cmdlet along This filtered collection is then piped to the `Remove-CsAVEdgeConfiguration` cmdlet, which deletes each item in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsAVEdgeConfiguration | Where-Object {$_.MaxBandwidthPerUserKB -lt 5000} | Remove-CsAVEdgeConfiguration ``` @@ -69,7 +70,28 @@ The filtered collection is then piped to the `Remove-CsAVEdgeConfiguration` cmdl ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of A/V Edge configuration settings to be removed. To "remove" the global collection, use the following syntax: `-Identity global`. (As noted previously, the global settings cannot be removed; the properties can only be reset to their default values.) To remove a site collection, use syntax similar to this: `-Identity site:Redmond`. @@ -82,8 +104,7 @@ You cannot use wildcards when specifying a policy Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -92,14 +113,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -109,29 +132,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -145,14 +154,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Edge.MediaRelaySettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.MediaRelaySettings + The `Remove-CsAVEdgeConfiguration` cmdlet accepts pipelined input of media relay settings objects. These objects retrieved by running the Get-CsAVEdgeConfiguration cmdlet. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.MediaRelaySettings The `Remove-CsAVEdgeConfiguration` cmdlet does not return a value or object. Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.MediaRelaySettings object. diff --git a/skype/skype-ps/skype/Remove-CsAdditionalInternalDomain.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAdditionalInternalDomain.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsAdditionalInternalDomain.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsAdditionalInternalDomain.md index 9840f5844b..3fd74591d2 100644 --- a/skype/skype-ps/skype/Remove-CsAdditionalInternalDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAdditionalInternalDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csadditionalinternaldomain applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsAdditionalInternalDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csadditionalinternaldomain +schema: 2.0.0 +title: Remove-CsAdditionalInternalDomain --- # Remove-CsAdditionalInternalDomain @@ -31,7 +32,7 @@ domains. ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ```powershell Remove-CsAdditionalInternalDomain -Identity fabrikam.com ``` @@ -40,30 +41,16 @@ Example 1 removes the additional internal domain with the Identity fabrikam.com. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Force Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -73,13 +60,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) for the new additional internal domain. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 1 @@ -88,14 +77,34 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Remove-CsAddressBookConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsAddressBookConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookConfiguration.md index 6462ca6564..206c467c91 100644 --- a/skype/skype-ps/skype/Remove-CsAddressBookConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csaddressbookconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsAddressBookConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csaddressbookconfiguration +schema: 2.0.0 +title: Remove-CsAddressBookConfiguration --- # Remove-CsAddressBookConfiguration @@ -44,7 +45,7 @@ Instead, running the `Remove-CsAddressBookConfiguration` cmdlet against the glob ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsAddressBookConfiguration -Identity site:Redmond ``` @@ -53,7 +54,7 @@ In this example, the `Remove-CsAddressBookConfiguration` cmdlet is used to delet Using the Identity parameter ensures that only the specified Address Book settings will be removed. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAddressBookConfiguration -Filter site:* | Remove-CsAddressBookConfiguration ``` @@ -63,7 +64,7 @@ To do this, the `Get-CsAddressBookConfiguration` cmdlet is used to retrieve a co The retrieved collection is then piped to the `Remove-CsAddressBookConfiguration` cmdlet, which removes all the items in that collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAddressBookConfiguration | Where-Object {$_.KeepDuration -lt 30.} | Remove-CsAddressBookConfiguration ``` @@ -76,7 +77,28 @@ This collection is then piped to the `Where-Object` cmdlet, which selects only t ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of Address Book configuration settings to be removed. To remove the global collection, use the following syntax: `-Identity global`. (When you "remove" the global settings you simply reset all the properties to their default values.) To remove a site collection, use syntax similar to this: `-Identity site:Redmond`. @@ -85,8 +107,7 @@ Note that you cannot use wildcards when specifying a policy Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -95,14 +116,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -112,29 +135,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -148,13 +157,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookSettings The `Remove-CsAddressBookConfiguration` cmdlet accepts pipelined input of Address Book configuration objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookSettings The `Remove-CsAddressBookConfiguration` cmdlet does not return a value or object. Instead, the cmdlet removes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookSettings object. diff --git a/skype/skype-ps/skype/Remove-CsAddressBookNormalizationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookNormalizationConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Remove-CsAddressBookNormalizationConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookNormalizationConfiguration.md index 5aa40f5cda..e9973f09fe 100644 --- a/skype/skype-ps/skype/Remove-CsAddressBookNormalizationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookNormalizationConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csaddressbooknormalizationconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsAddressBookNormalizationConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csaddressbooknormalizationconfiguration +schema: 2.0.0 +title: Remove-CsAddressBookNormalizationConfiguration --- # Remove-CsAddressBookNormalizationConfiguration @@ -38,7 +39,7 @@ That means, in some cases, you might need to create identical rules: one for ass ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsAddressBookNormalizationConfiguration -Identity "site:Redmond" ``` @@ -47,7 +48,7 @@ The command shown in Example 1 deletes the Address Book normalization configurat After this collection has been deleted, Address Book servers in the Redmond site will use the global configuration settings to handle phone number normalization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAddressBookNormalizationConfiguration -Filter "site:*" | Remove-CsAddressBookNormalizationConfiguration ``` @@ -60,7 +61,28 @@ When this command completes, the deployment will be limited to the global collec ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of Address Book configuration settings to be removed. For example: `-Identity "site:Redmond"` @@ -69,8 +91,7 @@ Note that you cannot use wildcards when specifying the collection to be removed. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -80,13 +101,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -95,30 +118,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -132,13 +141,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationSettings The `Remove-CsAddressBookNormalizationConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationSettings object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsAddressBookNormalizationConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsAddressBookNormalizationRule.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookNormalizationRule.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsAddressBookNormalizationRule.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookNormalizationRule.md index b1f7133ca9..057f79cb71 100644 --- a/skype/skype-ps/skype/Remove-CsAddressBookNormalizationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAddressBookNormalizationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csaddressbooknormalizationrule applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsAddressBookNormalizationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csaddressbooknormalizationrule +schema: 2.0.0 +title: Remove-CsAddressBookNormalizationRule --- # Remove-CsAddressBookNormalizationRule @@ -32,7 +33,7 @@ That means, in some cases, you might need to create identical rules: one for ass ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsAddressBookNormalizationRule -Identity "Global/Generic_All" ``` @@ -40,7 +41,7 @@ Remove-CsAddressBookNormalizationRule -Identity "Global/Generic_All" The command shown in Example 1 removes the Generic_All normalization rule from the global collection of Address Book normalization rules. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAddressBookNormalizationRule -Identity "site:Redmond" | Remove-CsAddressBookNormalizationRule ``` @@ -51,7 +52,7 @@ Those rules are then piped to and deleted by, the `Remove-CsAddressBookNormaliza When the command finishes running the normalization rules collection for the Redmond site will still exist, but the collection will no longer contain any rules. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAddressBookNormalizationRule | Where-Object {$_.Pattern -eq "E164"} | Remove-CsAddressBookNormalizationRule ``` @@ -64,15 +65,35 @@ Any rules that meet that criterion are then piped to the `Remove-CsAddressBookNo ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the rule being removed. The Identity specified must include the scope followed by a slash followed by the name; for example: site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -82,13 +103,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -97,30 +120,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -134,13 +143,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationRule#Decorated The `Remove-CsAddressBookNormalizationRule` cmdlet accepts pipelined input of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationRule#Decorated object. ## OUTPUTS -### -None. +### Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationRule#Decorated Instead, the `Remove-CsAddressBookNormalizationRule` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationRule#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsAdminRole.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAdminRole.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsAdminRole.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsAdminRole.md index 0902573360..29483b4fe9 100644 --- a/skype/skype-ps/skype/Remove-CsAdminRole.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAdminRole.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csadminrole applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsAdminRole -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csadminrole +schema: 2.0.0 +title: Remove-CsAdminRole --- # Remove-CsAdminRole @@ -103,7 +104,7 @@ To avoid these confirmation prompts, use the Confirm parameter and set the param ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsAdminRole -Identity "RedmondHelpDesk" ``` @@ -111,7 +112,7 @@ Remove-CsAdminRole -Identity "RedmondHelpDesk" The command shown in Example 1 deletes the RBAC role with the Identity RedmondHelpDesk. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Remove-CsAdminRole -Filter "*Redmond*" ``` @@ -119,7 +120,7 @@ Remove-CsAdminRole -Filter "*Redmond*" Example 2 deletes all of the RBAC roles that have the string value "Redmond" somewhere in their Identity. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsAdminRole | Where-Object {$_.IsStandardRole -eq $False} | Remove-CsAdminRole ``` @@ -133,33 +134,35 @@ In turn, those custom roles are piped to and deleted by, the `Remove-CsAdminRole ## PARAMETERS -### -Identity -Unique identifier for the RBAC role to be deleted. -The Identity for an RBAC role must be the same as the SamAccountName for the Active Directory universal security group associated with that role. -For example, the Help Desk role has an Identity equal to CsHelpDesk; CsHelpDesk is also the SamAccountName of the Active Directory security group associated with that role. +### -Filter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to use wildcards in order to specify the custom RBAC roles to be removed. +For example, to remove all the custom roles that include the string value "Redmond" in their Identity, you can use this syntax: `-Filter "*Redmond*"`. ```yaml Type: String -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: Filter +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Enables you to use wildcards in order to specify the custom RBAC roles to be removed. -For example, to remove all the custom roles that include the string value "Redmond" in their Identity, you can use this syntax: `-Filter "*Redmond*"`. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String -Parameter Sets: Filter -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -168,7 +171,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the RBAC role to be deleted. +The Identity for an RBAC role must be the same as the SamAccountName for the Active Directory universal security group associated with that role. +For example, the Help Desk role has an Identity equal to CsHelpDesk; CsHelpDesk is also the SamAccountName of the Active Directory security group associated with that role. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByPropertyName) +Accept wildcard characters: False +``` + ### -Sid + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to use a Security Identifier (SID) to specify the RBAC role to be deleted. SIDs are assigned by Skype for Business Server at the time that the RBAC role is created and look similar to this: S-1-5-21-1573807623-1597889489-1765977225-1145. The SID for a given RBAC role can be retrieved by using the `Get-CsAdminRole` cmdlet. @@ -177,8 +203,7 @@ The SID for a given RBAC role can be retrieved by using the `Get-CsAdminRole` cm ```yaml Type: String Parameter Sets: SID -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -187,30 +212,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Enables you to bypass the confirmation prompt that appears when you try to delete an RBAC role. +To bypass the prompt, include the Confirm parameter and set the parameter value to $False: -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +`Remove-CsAdminRole RedmondAdministrators -Confirm:$False` ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -219,17 +233,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Enables you to bypass the confirmation prompt that appears when you try to delete an RBAC role. -To bypass the prompt, include the Confirm parameter and set the parameter value to $False: +### -WhatIf -`Remove-CsAdminRole RedmondAdministrators -Confirm:$False` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -243,13 +256,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The `Remove-CsAdminRole` cmdlet accepts pipelined input of user objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Roles.Role The `Remove-CsAdminRole` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Roles.Role object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsAllowedDomain.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAllowedDomain.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsAllowedDomain.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsAllowedDomain.md index 369b896c1d..edecd7b258 100644 --- a/skype/skype-ps/skype/Remove-CsAllowedDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAllowedDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csalloweddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsAllowedDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csalloweddomain +schema: 2.0.0 +title: Remove-CsAllowedDomain --- # Remove-CsAllowedDomain @@ -44,7 +45,7 @@ Note that a domain cannot simultaneously appear on both the allowed and the bloc ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsAllowedDomain -Identity fabrikam.com ``` @@ -52,7 +53,7 @@ Remove-CsAllowedDomain -Identity fabrikam.com The command shown in Example 1 removes the domain fabrikam.com from the list of allowed domains. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsAllowedDomain -Filter *fabrikam* | Remove-CsAllowedDomain ``` @@ -62,7 +63,7 @@ To do this, the command first uses the `Get-CsAllowedDomain` cmdlet and the Filt That filtered collection is then piped to the `Remove-CsAllowedDomain` cmdlet, which, in turn, removes all of the items in the filtered collection from the list of allowed domains. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsAllowedDomain | Where-Object {$_.ProxyFqdn -eq $Null} | Remove-CsAllowedDomain ``` @@ -73,7 +74,7 @@ That collection is piped to the `Where-Object` cmdlet, which picks out only thos The filtered collection is then piped to the `Remove-CsAllowedDomain` cmdlet, which removes each domain in the collection from the allowed list. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsAllowedDomain | Where-Object {$_.Comment -match "Ken Myer"} | Remove-CsAllowedDomain ``` @@ -86,15 +87,35 @@ This filtered collection is then piped to the `Remove-CsAllowedDomain` cmdlet, w ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the domain to be removed from the allowed list; for example, fabrikam.com. You cannot use wildcards when specifying a domain Identity. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -103,14 +124,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -120,29 +143,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -156,13 +165,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Edge.AllowedDomain object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.AllowedDomain The `Remove-CsAllowedDomain` cmdlet accepts pipelined instances of the allowed domain object. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.AllowedDomain Deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.AllowedDomain object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsAnalogDevice.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAnalogDevice.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsAnalogDevice.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsAnalogDevice.md index 2934cae81d..5f3a4f1d71 100644 --- a/skype/skype-ps/skype/Remove-CsAnalogDevice.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAnalogDevice.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csanalogdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsAnalogDevice -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csanalogdevice +schema: 2.0.0 +title: Remove-CsAnalogDevice --- # Remove-CsAnalogDevice @@ -42,7 +43,7 @@ Additionally, the contact object associated with that device will be deleted fro ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsAnalogDevice -Identity "CN={e5e7daba-394e-46ec-95a1-1f2a9947aad2},CN=Users,DC=litwareinc,DC=com" ``` @@ -50,7 +51,7 @@ Remove-CsAnalogDevice -Identity "CN={e5e7daba-394e-46ec-95a1-1f2a9947aad2},CN=Us Example 1 deletes the analog device that has the Identity CN={e5e7daba-394e-46ec-95a1-1f2a9947aad2},CN=Users,DC=litwareinc,DC=com. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsAnalogDevice -Filter {DisplayName -eq "Building 14 Receptionist"} | Remove-CsAnalogDevice ``` @@ -60,7 +61,7 @@ To carry out this task, the command first calls the `Get-CsAnalogDevice` cmdlet The returned items are then piped to and removed by, the `Remove-CsAnalogDevice` cmdlet. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsAnalogDevice -Filter {VoicePolicy -eq "RedmondVoicePolicy"} | Remove-CsAnalogDevice ``` @@ -70,7 +71,7 @@ To do this, the `Get-CsAnalogDevice` cmdlet and the Filter parameter are used to The filtered collection is then piped to the `Remove-CsAnalogDevice` cmdlet, which deletes each item in that collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsAnalogDevice -Filter {AnalogFax -eq $True} | Remove-CsAnalogDevice ``` @@ -83,6 +84,9 @@ In turn, this filtered collection is piped to the `Remove-CsAnalogDevice` cmdlet ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the analog device to be removed. Analog devices are identified by using the Active Directory distinguished name (DN) of the associated contact object. By default, these devices, use a globally unique identifier (GUID) as their common name; that means analog devices will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. @@ -92,8 +96,7 @@ Because of that you might find it easier to retrieve analog devices by using the ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -102,14 +105,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -118,14 +123,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -139,13 +146,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.ADConnect.Schema.OCSADAnalogDeviceContact object. +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADAnalogDeviceContact + The `Remove-CsAnalogDevice` cmdlet accepts pipelined instances of the analog device object. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADAnalogDeviceContact The `Remove-CsAnalogDevice` cmdlet deletes existing instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADAnalogDeviceContact object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsAnnouncement.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAnnouncement.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsAnnouncement.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsAnnouncement.md index b51ed922b3..1d23fd3c2c 100644 --- a/skype/skype-ps/skype/Remove-CsAnnouncement.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAnnouncement.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csannouncement applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsAnnouncement -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csannouncement +schema: 2.0.0 +title: Remove-CsAnnouncement --- # Remove-CsAnnouncement @@ -38,7 +39,7 @@ However, the AnnouncementId property value (the GUID of the Announcement that wa ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsAnnouncement -Identity "ApplicationServer:Redmond.litwareinc.com/1951f734-c80f-4fb2-965d-51807c792b90" ``` @@ -47,7 +48,7 @@ Example 1 removes the announcement that has the Identity "ApplicationServer:Redm Because Identities must be unique, this command will remove, at most, a single announcement. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Remove-CsAnnouncement -Identity "ApplicationServer:Redmond.litwareinc.com" ``` @@ -59,7 +60,28 @@ Specifying the parameter value "ApplicationServer:Redmond.litwareinc.com" (witho ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier for the Announcement you want to remove. The value for the Identity parameter can be supplied in one of two ways: @@ -69,8 +91,7 @@ The value for the Identity parameter can be supplied in one of two ways: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -79,14 +100,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -96,29 +119,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -132,12 +141,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.AnnouncementServiceSettings.Announcement Deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AnnouncementServiceSettings.Announcement object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsArchivingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsArchivingConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsArchivingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsArchivingConfiguration.md index cd4dcbd64d..26d9aa540d 100644 --- a/skype/skype-ps/skype/Remove-CsArchivingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsArchivingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csarchivingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsArchivingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csarchivingconfiguration +schema: 2.0.0 +title: Remove-CsArchivingConfiguration --- # Remove-CsArchivingConfiguration @@ -50,7 +51,7 @@ In turn, that will disable archiving at the global scope. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsArchivingConfiguration -Identity site:Redmond ``` @@ -58,7 +59,7 @@ Remove-CsArchivingConfiguration -Identity site:Redmond Example 1 uses the `Remove-CsArchivingConfiguration` cmdlet to delete the archiving configuration settings with the identity site:Redmond. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsArchivingConfiguration -Filter "site:*" | Remove-CsArchivingConfiguration ``` @@ -69,7 +70,7 @@ This is done by using the filter value "site:*", which limits the returned data The filtered collection is then piped to the `Remove-CsArchivingConfiguration` cmdlet, which deletes each item in that collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsArchivingConfiguration | Where-Object {$_.EnableArchiving -eq "None"} | Remove-CsArchivingConfiguration ``` @@ -82,7 +83,28 @@ The filtered collection is then piped to the `Remove-CsArchivingConfiguration` c ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of archiving configuration settings to be removed. To remove the global collection, use the following syntax: `-Identity global`. (Note that you cannot actually remove the global settings; instead, you can only reset the properties to their default values.) To remove a site collection, use syntax similar to this: `-Identity site:Redmond`. @@ -98,8 +120,7 @@ You cannot use wildcards when specifying a policy Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -108,14 +129,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -125,29 +148,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -161,13 +170,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings + The `Remove-CsArchivingConfiguration` cmdlet accepts pipelined input of archiving configuration objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings The `Remove-CsArchivingConfiguration` cmdlet does not return a value or object. Instead, the cmdlet removes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings object. diff --git a/skype/skype-ps/skype/Remove-CsArchivingPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsArchivingPolicy.md similarity index 91% rename from skype/skype-ps/skype/Remove-CsArchivingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsArchivingPolicy.md index aad1e6bdd9..0f47cd2e5e 100644 --- a/skype/skype-ps/skype/Remove-CsArchivingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsArchivingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csarchivingpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsArchivingPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csarchivingpolicy +schema: 2.0.0 +title: Remove-CsArchivingPolicy --- # Remove-CsArchivingPolicy @@ -55,7 +56,7 @@ That's because the default value for both these properties (ArchiveInternal and ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsArchivingPolicy -Identity site:Redmond ``` @@ -64,7 +65,7 @@ In Example 1, the `Remove-CsArchivingPolicy` cmdlet is used to delete the policy Note that, when a policy configured at the site scope is deleted, users previously managed by the site policy will automatically be governed by the global archiving policy instead. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsArchivingPolicy -Filter site:* | Remove-CsArchivingPolicy ``` @@ -75,7 +76,7 @@ This is done by using the filter value "site:*", which instructs the `Get-CsArch After the collection has been returned, the data is piped to the `Remove-CsArchivingPolicy` cmdlet, which deletes all the policies in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsArchivingPolicy | Where-Object {$_.ArchiveExternal -eq $False} | Remove-CsArchivingPolicy ``` @@ -88,7 +89,32 @@ The filtered collection is then passed to the `Remove-CsArchivingPolicy` cmdlet, ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If this parameter is present, the policy will automatically be removed even if it is currently assigned to at least one use. +If this parameter is not present, then the `Remove-CsArchivingPolicy` cmdlet will not automatically remove a per-user policy that is assigned to at least one user. +Instead, a confirmation prompt will appear asking if you are sure that you want to remove the policy. +You must answer yes (by pressing the Y key) before the command will continue and the policy 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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the archiving policy to be removed. Archiving policies can be configured at the global, site, or per-user scopes. To remove the global policy, use this syntax: `-Identity global`. @@ -103,8 +129,7 @@ Wildcards are not allowed when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -113,34 +138,23 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -If this parameter is present, the policy will automatically be removed even if it is currently assigned to at least one use. -If this parameter is not present, then the `Remove-CsArchivingPolicy` cmdlet will not automatically remove a per-user policy that is assigned to at least one user. -Instead, a confirmation prompt will appear asking if you are sure that you want to remove the policy. -You must answer yes (by pressing the Y key) before the command will continue and the policy will be removed. +### -Tenant +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the archiving policy is being removed. +For example: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,13 +164,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -165,21 +181,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the archiving policy is being removed. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -193,13 +204,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.IM.IMArchivingPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.IM.IMArchivingPolicy + The `Remove-CsArchivingPolicy` cmdlet accepts pipelined input of archiving policy objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.IM.IMArchivingPolicy The `Remove-CsArchivingPolicy` cmdlet does not return a value or object. Instead, the cmdlet removes instances of the Microsoft.Rtc.Management.WritableConfig.Policy.IM.IMArchivingPolicy object. diff --git a/skype/skype-ps/skype/Remove-CsAutodiscoverConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsAutodiscoverConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsAutodiscoverConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsAutodiscoverConfiguration.md index 28d818613b..4672130163 100644 --- a/skype/skype-ps/skype/Remove-CsAutodiscoverConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsAutodiscoverConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csautodiscoverconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsAutodiscoverConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csautodiscoverconfiguration +schema: 2.0.0 +title: Remove-CsAutodiscoverConfiguration --- # Remove-CsAutodiscoverConfiguration @@ -49,7 +50,7 @@ In that case, however, the global settings will not be removed; however, any Aut ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsAutoDiscoverConfiguration -Identity "site:Redmond" ``` @@ -57,7 +58,7 @@ Remove-CsAutoDiscoverConfiguration -Identity "site:Redmond" The command shown in Example 1 deletes the Autodiscover configuration settings for the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAutoDiscoverConfiguration -Filter "site:*" | Remove-CsAutoDiscoverConfiguration ``` @@ -69,7 +70,28 @@ That filtered collection is then piped to the `Remove-CsAutoDiscoverConfiguratio ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the Autodiscover settings to be removed. Autodiscover settings can be configured at the global or the site scope. To "remove" the global policy, use this syntax: `-Identity global`. @@ -85,8 +107,7 @@ Note that wildcards are not allowed when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -96,13 +117,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -111,30 +134,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -148,14 +157,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WriteableConfig.Settings.AutoDiscoverConfiguration.AutoDiscoverConfiguration. +### Microsoft.Rtc.Management.WriteableConfig.Settings.AutoDiscoverConfiguration.AutoDiscoverConfiguration The `Remove-CsAutoDiscoverConfiguration` cmdlet accepts pipelined input of AutoDiscoverConfiguration objects ## OUTPUTS -### -None. +### Microsoft.Rtc.Management.WriteableConfig.Settings.AutoDiscoverConfiguration.AutoDiscoverConfiguration Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.AutoDiscoverConfiguration.AutoDiscoverConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsBackupServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsBackupServiceConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsBackupServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsBackupServiceConfiguration.md index c6a0bc6cfc..443be0b04a 100644 --- a/skype/skype-ps/skype/Remove-CsBackupServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsBackupServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csbackupserviceconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsBackupServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csbackupserviceconfiguration +schema: 2.0.0 +title: Remove-CsBackupServiceConfiguration --- # Remove-CsBackupServiceConfiguration @@ -35,7 +36,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsBackupServiceConfiguration -Identity "global" ``` @@ -46,7 +47,28 @@ Note that even though Skype for Business Server only uses a single, global colle ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique Identity of the backup service configuration settings. Although you can only have a single, global instance of these settings, you still need to specify an Identity when calling the `Remove-CsBackupServiceConfiguration` cmdlet: @@ -56,8 +78,7 @@ Although you can only have a single, global instance of these settings, you stil ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -67,13 +88,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -82,30 +105,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -119,13 +128,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.BackupService.BackupServiceConfiguration The `Remove-CsBackupServiceConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.BackupService.BackupServiceConfiguration object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsBackupServiceConfiguration` cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.BackupService.BackupServiceConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsBandwidthPolicyServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsBandwidthPolicyServiceConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Remove-CsBandwidthPolicyServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsBandwidthPolicyServiceConfiguration.md index 41f3e9cac6..a3c714bb6b 100644 --- a/skype/skype-ps/skype/Remove-CsBandwidthPolicyServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsBandwidthPolicyServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csbandwidthpolicyserviceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsBandwidthPolicyServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csbandwidthpolicyserviceconfiguration +schema: 2.0.0 +title: Remove-CsBandwidthPolicyServiceConfiguration --- # Remove-CsBandwidthPolicyServiceConfiguration @@ -34,7 +35,7 @@ You can also use the cmdlet to "remove" the global bandwidth policy service; how ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsBandwidthPolicyServiceConfiguration -Identity site:Redmond ``` @@ -42,7 +43,7 @@ Remove-CsBandwidthPolicyServiceConfiguration -Identity site:Redmond This example removes the bandwidth policy service configuration defined for the Redmond site (-Identity site:Redmond). -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsBandwidthPolicyServiceConfiguration | Where-Object {$_.EnableLogging -eq $False} | Remove-CsBandwidthPolicyServiceConfiguration ``` @@ -57,15 +58,35 @@ This collection is then piped to the `Remove-CsBandwidthPolicyServiceConfigurati ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the configuration you want to remove. This identifier will consist of the scope (for the global configuration) or the scope and name (for a site-level configuration, such as site:Redmond). ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -74,14 +95,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -91,29 +114,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -127,13 +136,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.BandwidthPolicyServiceConfiguration.BandwidthPolicyServiceConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.BandwidthPolicyServiceConfiguration.BandwidthPolicyServiceConfiguration + Accepts pipelined input of bandwidth policy service configuration objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.BandwidthPolicyServiceConfiguration.BandwidthPolicyServiceConfiguration This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.BandwidthPolicyServiceConfiguration.BandwidthPolicyServiceConfiguration. diff --git a/skype/skype-ps/skype/Remove-CsBlockedDomain.md b/skype/skype-ps/SkypeForBusiness/Remove-CsBlockedDomain.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsBlockedDomain.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsBlockedDomain.md index 29b6a48035..4d2a56293b 100644 --- a/skype/skype-ps/skype/Remove-CsBlockedDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsBlockedDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csblockeddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsBlockedDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csblockeddomain +schema: 2.0.0 +title: Remove-CsBlockedDomain --- # Remove-CsBlockedDomain @@ -45,7 +46,7 @@ A domain cannot simultaneously appear on both the allowed and the blocked lists. ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsBlockedDomain -Identity fabrikam.com ``` @@ -54,7 +55,7 @@ The command shown in Example 1 removes the domain fabrikam.com from the list of This is done by calling the `Remove-CsBlockedDomain` cmdlet and specifying the domain with the Identity "fabrikam.com". -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsBlockedDomain -Filter *fabrikam* | Remove-CsBlockedDomain ``` @@ -64,7 +65,7 @@ To do this, the `Get-CsBlockedDomain` cmdlet and the Filter parameter are first That collection is then piped to the `Remove-CsBlockedDomain` cmdlet, which deletes each item in the collection from the list of blocked domains. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsBlockedDomain | Remove-CsBlockedDomain ``` @@ -77,15 +78,35 @@ The net result: no domains will be left on the blocked domain list. ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the domain to be removed from the blocked list; for example, fabrikam.com. Note that you cannot use wildcards when specifying a domain Identity. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -94,14 +115,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -111,29 +134,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -147,13 +156,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Edge.BlockedDomain object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.BlockedDomain + The `Remove-CsBlockedDomain` cmdlet accepts pipelined instances of the blocked domain object. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.BlockedDomain Deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.BlockedDomain object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsBusyOptions.md b/skype/skype-ps/SkypeForBusiness/Remove-CsBusyOptions.md similarity index 86% rename from skype/skype-ps/skype/Remove-CsBusyOptions.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsBusyOptions.md index 3a462337d7..cf0f6041f8 100644 --- a/skype/skype-ps/skype/Remove-CsBusyOptions.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsBusyOptions.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csbusyoptions applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsBusyOptions -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csbusyoptions +schema: 2.0.0 +title: Remove-CsBusyOptions --- # Remove-CsBusyOptions @@ -26,7 +27,7 @@ This cmdlet removes configuration information about Busy Options for a specific ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsBusyOptions -Identity "Ken Myer" ``` @@ -35,23 +36,10 @@ This example removes Busy Options for "Ken Myer". ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Identity -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Identity Indicates the Identity of the user account to be modified. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. You can use the asterisk (*) wildcard character when using the display name as the user Identity. For example, the Identity "*Smith" returns all the users who have a display name that ends with the string value "Smith". @@ -59,8 +47,7 @@ You can use the asterisk (*) wildcard character when using the display name as t ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 0 @@ -70,13 +57,33 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -86,6 +93,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -93,7 +103,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -107,12 +116,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.AD.UserIdParameter object. +### Microsoft.Rtc.Management.AD.UserIdParameter + ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.BusyOptions.BusyOptions This cmdlet does not return any objects. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsCallParkOrbit.md b/skype/skype-ps/SkypeForBusiness/Remove-CsCallParkOrbit.md similarity index 84% rename from skype/skype-ps/skype/Remove-CsCallParkOrbit.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsCallParkOrbit.md index c2fc47f998..0f62924d0c 100644 --- a/skype/skype-ps/skype/Remove-CsCallParkOrbit.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsCallParkOrbit.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cscallparkorbit applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsCallParkOrbit -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cscallparkorbit +schema: 2.0.0 +title: Remove-CsCallParkOrbit --- # Remove-CsCallParkOrbit @@ -33,7 +34,7 @@ The freed numbers can then be used in a newly defined call park orbit. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsCallParkOrbit -Identity "Redmond CPO 1" ``` @@ -41,7 +42,7 @@ Remove-CsCallParkOrbit -Identity "Redmond CPO 1" In this example, the `Remove-CsCallParkOrbit` cmdlet is used to delete the call park orbit range with the name Redmond CPO 1. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsCallParkOrbit | Remove-CsCallParkOrbit ``` @@ -51,7 +52,7 @@ The command first calls the `Get-CsCallParkOrbit` cmdlet with no parameters to r It then pipes that collection of call park orbit ranges to the `Remove-CsCallParkOrbit` cmdlet, which removes each call park orbit. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsCallParkOrbit -Filter *Redmond* | Remove-CsCallParkOrbit ``` @@ -63,15 +64,35 @@ This collection is piped to the `Remove-CsCallParkOrbit` cmdlet, which removes e ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name of the call park orbit range. This name was assigned by the administrator when the call park orbit range was defined. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -80,14 +101,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -97,29 +120,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -133,13 +142,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Voice.Helpers.DisplayCallParkOrbit object. +### Microsoft.Rtc.Management.Voice.Helpers.DisplayCallParkOrbit + Accepts pipelined input of call park orbit objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.Helpers.DisplayCallParkOrbit This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayCallParkOrbit. diff --git a/skype/skype-ps/skype/Remove-CsCallViaWorkPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsCallViaWorkPolicy.md similarity index 86% rename from skype/skype-ps/skype/Remove-CsCallViaWorkPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsCallViaWorkPolicy.md index 80f2007953..9c58841b9b 100644 --- a/skype/skype-ps/skype/Remove-CsCallViaWorkPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsCallViaWorkPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cscallviaworkpolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsCallViaWorkPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cscallviaworkpolicy +schema: 2.0.0 +title: Remove-CsCallViaWorkPolicy --- # Remove-CsCallViaWorkPolicy @@ -28,7 +29,7 @@ Use this cmdlet to delete an existing call via work policy. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsCallViaWorkPolicy -Identity CvWStandardPolicy ``` @@ -38,7 +39,28 @@ This example removes a per-user scoped policy named "CvWStandardPolicy". ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the identity of the policy to be removed. Call via work policies can be specified at the global, site, or per-user scope. @@ -51,8 +73,7 @@ Per-user syntax: `-Identity CallviaWorkStandard` ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -61,30 +82,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Tenant -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -93,14 +100,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -This parameter is reserved for internal Microsoft use. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -110,13 +119,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -130,13 +141,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsCdrConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsCdrConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsCdrConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsCdrConfiguration.md index fd052dd951..22acce957f 100644 --- a/skype/skype-ps/skype/Remove-CsCdrConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsCdrConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cscdrconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsCdrConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cscdrconfiguration +schema: 2.0.0 +title: Remove-CsCdrConfiguration --- # Remove-CsCdrConfiguration @@ -47,7 +48,7 @@ If you run the `Remove-CsCdrConfiguration` cmdlet against the global settings, t ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsCdrConfiguration -Identity site:Redmond ``` @@ -56,7 +57,7 @@ Example 1 uses the `Remove-CsCdrConfiguration` cmdlet to remove the CDR settings Using the Identity parameter ensures that only the settings assigned to the specified site will be removed. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsCdrConfiguration -Filter site:* | Remove-CsCdrConfiguration ``` @@ -66,7 +67,7 @@ To do this, the command first uses the `Get-CsCdrConfiguration` cmdlet and the F The filtered collection is then piped to the `Remove-CsCdrConfiguration` cmdlet, which deletes all the items in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsCdrConfiguration | Where-Object {$_.KeepCallDetailForDays -lt 30} | Remove-CsCdrConfiguration ``` @@ -79,7 +80,28 @@ The filtered collection is then piped to the `Remove-CsCdrConfiguration` cmdlet, ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the CDR configuration settings to be removed. To "remove" the global settings, use this syntax: `-Identity global`. (Note, again, that you cannot actually remove the global settings; all you can do is reset the properties to their default values.) To remove settings from the site scope, use syntax similar to this: `-Identity site:Redmond`. @@ -88,8 +110,7 @@ You cannot use wildcards when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -98,14 +119,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -115,29 +138,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -151,14 +160,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.CallDetailRecording.CdrSettings. +### Microsoft.Rtc.Management.WritableConfig.Settings.CallDetailRecording.CdrSettings The `Remove-CsCdrConfiguration` cmdlet accepts pipelined input of CDR configuration objects. ## OUTPUTS -### -None. +### Microsoft.Rtc.Management.WritableConfig.Settings.CallDetailRecording.CdrSettings Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CallDetailRecording.CdrSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsCertificate.md b/skype/skype-ps/SkypeForBusiness/Remove-CsCertificate.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsCertificate.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsCertificate.md index f66a9b06f6..5f2b90bb26 100644 --- a/skype/skype-ps/skype/Remove-CsCertificate.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsCertificate.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cscertificate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsCertificate -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cscertificate +schema: 2.0.0 +title: Remove-CsCertificate --- # Remove-CsCertificate @@ -40,7 +41,7 @@ Remove-CsCertificate -Type WebServicesExternal -Force ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsCertificate -Type WebServicesExternal ``` @@ -53,60 +54,54 @@ Remove-CsCertificate -Type WebServicesExternal -Force ## PARAMETERS -### -Type -Type of certificate to be deleted. -Certificate types include (but are not limited to): - -- AccessEdgeExternal - -- AudioVideoAuthentication - -- DataEdgeExternal - -- Default - -- External - -- Internal - -- PICWebService (Skype for Business Online only) +### -Force -- ProvisionService (Skype for Business Online only) +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -- WebServicesExternal +Bypasses the confirmation prompt that typically occurs if you attempt to delete a certificate that is currently in use. -- WebServicesInternal +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -- WsFedTokenTransfer +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -For example, this syntax deletes the Default certificate: -Type Default. +### -Identity -You can delete multiple types in a single command by separating the certificate types with commas: +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 --Type Internal,External,Default +When set to Global, removes the certificate from the global scope. +When not specified, certificates are removed from the local computer. ```yaml -Type: CertType[] +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -NetportId + +> Applicable: Lync Server 2010 + Reserved for future use. This parameter is for certificates dedicated to a specific port, a scenario not yet supported by Lync Server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010 +Aliases: Required: False Position: Named @@ -115,14 +110,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Bypasses the confirmation prompt that typically occurs if you attempt to delete a certificate that is currently in use. +### -Previous + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When specified, removes the previously-assigned certificate instead of the currently-assigned certificate. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,16 +129,18 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to record detailed information about the procedures carried out by the `Remove-CsCertificate` cmdlet. -The parameter value should be the full path to the HTML file to be generated; for example: +The parameter value should be the full path to the HTML file to be generated; for example: -Report C:\Logs\Certificates.html. If the specified file already exists it will automatically be overwritten with the new information. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,14 +149,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Type + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of certificate to be deleted. +Certificate types include (but are not limited to): + +- AccessEdgeExternal + +- AudioVideoAuthentication + +- DataEdgeExternal + +- Default + +- External + +- Internal + +- PICWebService (Skype for Business Online only) + +- ProvisionService (Skype for Business Online only) + +- WebServicesExternal + +- WebServicesInternal + +- WsFedTokenTransfer + +For example, this syntax deletes the Default certificate: -Type Default. + +You can delete multiple types in a single command by separating the certificate types with commas: + +-Type Internal,External,Default ```yaml -Type: SwitchParameter +Type: CertType[] Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,13 +197,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -182,31 +214,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -When set to Global, removes the certificate from the global scope. -When not specified, certificates are removed from the local computer. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Previous -When specified, removes the previously-assigned certificate instead of the currently-assigned certificate. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -220,14 +237,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Remove-CsCertificate` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsCertificate` cmdlet deletes instances of the Microsoft.Rtc.Management.Deployment.CertificateReference object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsClientPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsClientPolicy.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsClientPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsClientPolicy.md index dad1f49490..00e8a54633 100644 --- a/skype/skype-ps/skype/Remove-CsClientPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsClientPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csclientpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsClientPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/remove-csclientpolicy +schema: 2.0.0 +title: Remove-CsClientPolicy --- # Remove-CsClientPolicy @@ -39,7 +41,7 @@ However, all the properties in the global policy will be reset to their default ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsClientPolicy -Identity SalesPolicy ``` @@ -47,7 +49,7 @@ Remove-CsClientPolicy -Identity SalesPolicy In Example 1, the `Remove-CsClientPolicy` cmdlet is used to delete the client policy that has the Identity SalesPolicy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClientPolicy -Filter "tag:*" | Remove-CsClientPolicy ``` @@ -57,7 +59,7 @@ The command uses the `Get-CsClientPolicy` cmdlet and the Filter parameter to ret The filtered collection is then piped to the `Remove-CsClientPolicy` cmdlet, which removes each policy in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClientPolicy | Where-Object {$_.EnableAppearOffline -eq $True} | Remove-CsClientPolicy ``` @@ -70,7 +72,32 @@ In turn, this filtered collection is piped to the `Remove-CsClientPolicy` cmdlet ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +If this parameter is present, the policy will automatically be removed even if it is currently assigned to at least one user. +If this parameter is not present, then the `Remove-CsClientPolicy` cmdlet will not automatically remove a per-user policy that is assigned to at least one user. +Instead, a confirmation prompt will appear asking if you are sure that you want to remove the policy. +You must answer yes (by pressing the Y key) before the command will continue and the policy 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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the client policy to be removed. To "remove" the global policy, use the following syntax: `-Identity global`. (Note that the global policy cannot actually be removed. @@ -82,8 +109,7 @@ You cannot use wildcards when specifying a policy Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -92,34 +118,24 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -If this parameter is present, the policy will automatically be removed even if it is currently assigned to at least one user. -If this parameter is not present, then the `Remove-CsClientPolicy` cmdlet will not automatically remove a per-user policy that is assigned to at least one user. -Instead, a confirmation prompt will appear asking if you are sure that you want to remove the policy. -You must answer yes (by pressing the Y key) before the command will continue and the policy will be removed. +### -Tenant +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the client policy is being removed. +For example: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -129,13 +145,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -144,22 +162,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the client policy is being removed. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` - -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +### -WhatIf -`Get-CsTenant | Select-Object DisplayName, TenantID` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -173,13 +185,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Client.ClientPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Client.ClientPolicy + The `Remove-CsClientPolicy` cmdlet accepts pipelined instances of the client policy object. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Client.ClientPolicy The `Remove-CsClientPolicy` cmdlet does not return a value. Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Client.ClientPolicy object. diff --git a/skype/skype-ps/skype/Remove-CsClientVersionConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsClientVersionConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionConfiguration.md index fee4af8bf2..946fa11a75 100644 --- a/skype/skype-ps/skype/Remove-CsClientVersionConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csclientversionconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsClientVersionConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csclientversionconfiguration +schema: 2.0.0 +title: Remove-CsClientVersionConfiguration --- # Remove-CsClientVersionConfiguration @@ -45,7 +46,7 @@ In that case, the global settings will not be removed; instead, the global prope ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsClientVersionConfiguration -Identity site:Redmond ``` @@ -53,7 +54,7 @@ Remove-CsClientVersionConfiguration -Identity site:Redmond The command shown in Example 1 deletes the client version configuration settings that have the Identity "site:Redmond". -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsClientVersionConfiguration -Filter site:* | Remove-CsClientVersionConfiguration ``` @@ -63,7 +64,7 @@ To accomplish this task the command first calls the `Get-CsClientVersionConfigur This filtered collection is then piped to the `Remove-CsClientVersionConfiguration` cmdlet, which deletes each item in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsClientVersionConfiguration | Where-Object {$_.Enabled -eq $False} | Remove-CsClientVersionConfiguration ``` @@ -76,7 +77,28 @@ From there, the filtered collection is piped to the `Remove-CsClientVersionConfi ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of client version configuration settings to be removed. To remove the global collection, use the following syntax: `-Identity global`. (Keep in mind that the global settings will not actually be removed; instead, the global properties will all be reset to their default values.) To remove a site collection, use syntax similar to this: `-Identity site:Redmond`. @@ -85,8 +107,7 @@ Note that you cannot use wildcards when specifying the Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -95,14 +116,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -112,29 +135,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -148,14 +157,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionConfiguration + The `Remove-CsClientVersionConfiguration` cmdlet accepts pipelined instances of the client version configuration object. ## OUTPUTS -### -None. +### None Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsClientVersionPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionPolicy.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsClientVersionPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionPolicy.md index 73274296e7..c694397d9d 100644 --- a/skype/skype-ps/skype/Remove-CsClientVersionPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csclientversionpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsClientVersionPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csclientversionpolicy +schema: 2.0.0 +title: Remove-CsClientVersionPolicy --- # Remove-CsClientVersionPolicy @@ -57,7 +58,7 @@ Client version policies enforced in your organization do not override the client ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsClientVersionPolicy -Identity site:Redmond ``` @@ -65,7 +66,7 @@ Remove-CsClientVersionPolicy -Identity site:Redmond The command shown in Example 1 deletes the client version policy for the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClientVersionPolicy -Filter tag:* | Remove-CsClientVersionPolicy ``` @@ -77,7 +78,28 @@ This filtered collection is then piped to the `Remove-CsClientVersionPolicy` cmd ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the policy to be deleted. To remove a policy configured at the site scope, use syntax similar to this: `-Identity "site:Redmond"`. To remove a policy configured at the service scope, use syntax similar to this: `-Identity "Registrar:atl-cs-001.litwareinc.com"`. @@ -90,8 +112,7 @@ To remove per-user policies, use syntax similar to this: `-Identity "SalesDepart ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -100,30 +121,23 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the client version policy is being removed. +For example: -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -133,13 +147,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -148,21 +164,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the client version policy is being removed. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -176,13 +187,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionPolicy + The `Remove-CsClientVersionPolicy` cmdlet accepts pipelined instances of the client version policy object. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionPolicy The `Remove-CsClientVersionPolicy` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsClientVersionPolicyRule.md b/skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionPolicyRule.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsClientVersionPolicyRule.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionPolicyRule.md index 9ab5db8977..014562693c 100644 --- a/skype/skype-ps/skype/Remove-CsClientVersionPolicyRule.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsClientVersionPolicyRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csclientversionpolicyrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsClientVersionPolicyRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csclientversionpolicyrule +schema: 2.0.0 +title: Remove-CsClientVersionPolicyRule --- # Remove-CsClientVersionPolicyRule @@ -69,7 +70,7 @@ Client version policies enforced in your organization do not override the client ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsClientVersionPolicyRule -Identity site:Redmond/74ba9211-8610-42f9-91ba-846cdee98820 ``` @@ -78,7 +79,7 @@ The command shown in Example 1 deletes the client version policy rule that has t Because Identities must be unique, this command will only delete, at most, a single rule. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsClientVersionPolicyRule -Filter "site:Redmond/*" | Remove-CsClientVersionPolicyRule ``` @@ -88,7 +89,7 @@ To do this, the command first calls the `Get-CsClientVersionPolicyRule` cmdlet a This filtered collection is then piped to the `Remove-CsClientVersionPolicyRule` cmdlet, which deletes each item in that collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsClientVersionPolicyRule | Where-Object {$_.Enabled -eq $False} | Remove-CsClientVersionPolicyRule ``` @@ -101,7 +102,28 @@ The filtered collection is then piped to the `Remove-CsClientVersionPolicyRule` ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the client version policy rule to be removed. The Identity of a client version rule consists of the scope where the rule has been configured plus a globally unique identifier (GUID). That means that a rule will have an Identity similar to this: site:Redmond/1987d3c2-4544-489d-bbe3-59f79f530a83. @@ -109,8 +131,7 @@ That means that a rule will have an Identity similar to this: site:Redmond/1987d ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -119,30 +140,23 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the client version policy rule is being removed. +For example: -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -152,13 +166,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -167,21 +183,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the client version policy rule is being removed. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -195,14 +206,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.Rule object. +### Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.Rule + The `Remove-CsClientVersionPolicyRule` cmdlet accepts pipelined instances of the client version rule object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsClientVersionPolicyRule` cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.Rule object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsClsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsClsConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsClsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsClsConfiguration.md index 2e6f11933a..0dccfd628b 100644 --- a/skype/skype-ps/skype/Remove-CsClsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsClsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csclsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsClsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csclsconfiguration +schema: 2.0.0 +title: Remove-CsClsConfiguration --- # Remove-CsClsConfiguration @@ -47,7 +48,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsClsConfiguration -Identity "site:Redmond" ``` @@ -55,7 +56,7 @@ Remove-CsClsConfiguration -Identity "site:Redmond" The command shown in Example 1 removes the centralized logging configuration settings applied to the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClsConfiguration -Filter "site:*" | Remove-CsClsConfiguration ``` @@ -65,7 +66,7 @@ To do this, the command first calls the `Get-CsClsConfiguration` cmdlet along th Those settings are then piped to, and removed by, the `Remove-CsClsConfiguration` cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClsConfiguration | Where-Object {$_.EtlFileRolloverSizeMB -gt 20} | Remove-CsClsConfiguration ``` @@ -78,7 +79,28 @@ Settings that meet that criterion are then piped to and delete by, the `Remove-C ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of centralized logging configuration settings you want to remove. To remove the global settings use this syntax: @@ -96,8 +118,7 @@ Note that you cannot use wildcards when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -107,13 +128,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -122,30 +145,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -159,13 +168,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -The `Remove-CsClsConfiguration` cmdlet accepts pipelined instances of the icrosoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.CentralizedLoggingConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.CentralizedLoggingConfiguration +The `Remove-CsClsConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.CentralizedLoggingConfiguration object. ## OUTPUTS -### -None. +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.CentralizedLoggingConfiguration Instead, the `Remove-CsClsConfiguration` cmdlet deletes existing instances of the icrosoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.CentralizedLoggingConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsClsRegion.md b/skype/skype-ps/SkypeForBusiness/Remove-CsClsRegion.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsClsRegion.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsClsRegion.md index d453a56054..ab43a9799e 100644 --- a/skype/skype-ps/skype/Remove-CsClsRegion.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsClsRegion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csclsregion applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsClsRegion -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csclsregion +schema: 2.0.0 +title: Remove-CsClsRegion --- # Remove-CsClsRegion @@ -39,7 +40,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsClsRegion -Identity "global/US" ``` @@ -47,7 +48,7 @@ Remove-CsClsRegion -Identity "global/US" The command shown in Example 1 removes the centralized logging region that has the Identity global/US. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClsRegion -Filter "global/*" | Remove-CsClsRegion ``` @@ -57,7 +58,7 @@ To do this, the command first calls the `Get-CsClsRegion` cmdlet along with the These regions are then piped to, and deleted by, the `Remove-CsClsRegion` cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClsRegion | Where-Object {$_.SecurityGroupSuffix -eq "EMEA" | Remove-CsClsRegion ``` @@ -70,7 +71,28 @@ That subcollection of regions is then piped to the `Remove-CsClsRegion` cmdlet, ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the centralized logging region to be removed. A region identity consists of the scope where the region was created followed by the region name. For example, to delete a region named US created at the global scope, use the following syntax: @@ -80,8 +102,7 @@ For example, to delete a region named US created at the global scope, use the fo ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -91,13 +112,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -106,30 +129,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -143,13 +152,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Region#Decorated The `Remove-CsClsRegion` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Region#Decorated object. ## OUTPUTS -### -None. +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Region#Decorated Instead, the `Remove-CsClsRegion` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Region#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsClsScenario.md b/skype/skype-ps/SkypeForBusiness/Remove-CsClsScenario.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsClsScenario.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsClsScenario.md index c1cf3ade17..185779e160 100644 --- a/skype/skype-ps/skype/Remove-CsClsScenario.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsClsScenario.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csclsscenario applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsClsScenario -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csclsscenario +schema: 2.0.0 +title: Remove-CsClsScenario --- # Remove-CsClsScenario @@ -40,7 +41,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsClsScenario -Identity "site:Redmond/WAC" ``` @@ -48,7 +49,7 @@ Remove-CsClsScenario -Identity "site:Redmond/WAC" The command shown in Example 1 removes the WAC scenario from the global collection of centralized logging configuration settings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClsScenario | Where-Object {$_.Name -eq "HybridVoice" | Remove-CsClsScenario ``` @@ -61,7 +62,28 @@ The HybridVoice scenarios are then piped to and deleted by, the `Remove-CsClsSce ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the scenario to be removed. A scenario consists of two parts: the scope where the scenario is configured (that is, the collection of centralized logging configuration settings where the scenario can be found) and the scenario name. For example: @@ -77,8 +99,7 @@ If you do that, however, the entire collection of centralized logging configurat ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -88,13 +109,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -103,30 +126,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -140,13 +149,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Scenario#Decorated The `Remove-CsClsScenario` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Scenario#Decorated object. ## OUTPUTS -### -None. +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Scenario#Decorated Instead, the `Remove-CsClsScenario` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Scenario#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsClsSecurityGroup.md b/skype/skype-ps/SkypeForBusiness/Remove-CsClsSecurityGroup.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsClsSecurityGroup.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsClsSecurityGroup.md index 823296de5b..7384efae2f 100644 --- a/skype/skype-ps/skype/Remove-CsClsSecurityGroup.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsClsSecurityGroup.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csclssecuritygroup applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsClsSecurityGroup -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csclssecuritygroup +schema: 2.0.0 +title: Remove-CsClsSecurityGroup --- # Remove-CsClsSecurityGroup @@ -39,7 +40,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsClsSecurityGroup -Identity "global/HelpDesk" ``` @@ -47,7 +48,7 @@ Remove-CsClsSecurityGroup -Identity "global/HelpDesk" The command shown in Example 1 deletes the centralized logging security group with the Identity Global/HelpDesk. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClsSecurityGroup | Remove-CsClsSecurityGroup ``` @@ -57,7 +58,7 @@ To do this, the command first calls the `Get-CsClsSecurityGroup` cmdlet without That collection is then piped to the `Remove-CsClsSecurityGroup` cmdlet, which deletes each group in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClsSecurityGroup | Where-Object {$_.AccessLevel -eq "Tier3"} | Remove-CsClsSecurityGroup ``` @@ -70,7 +71,28 @@ In turn, those groups are piped to and removed by, the `Remove-CsClsSecurityGrou ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the centralized logging security group to be removed. A security group identity consists of the scope where the group was created followed by the group name. For example, to remove a group named HelpDesk created at the global scope, use the following syntax: @@ -80,8 +102,7 @@ For example, to remove a group named HelpDesk created at the global scope, use t ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -91,13 +112,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -106,30 +129,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -143,13 +152,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.SecurityGroup#Decorated The `Remove-CsClsSecurityGroup` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.SecurityGroup#Decorated object. ## OUTPUTS -### -None. +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.SecurityGroup#Decorated Instead, the `Remove-CsClsSecurityGroup` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.SecurityGroup#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsCommonAreaPhone.md b/skype/skype-ps/SkypeForBusiness/Remove-CsCommonAreaPhone.md similarity index 91% rename from skype/skype-ps/skype/Remove-CsCommonAreaPhone.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsCommonAreaPhone.md index 2a890219dc..428d529bb5 100644 --- a/skype/skype-ps/skype/Remove-CsCommonAreaPhone.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsCommonAreaPhone.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cscommonareaphone applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsCommonAreaPhone -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cscommonareaphone +schema: 2.0.0 +title: Remove-CsCommonAreaPhone --- # Remove-CsCommonAreaPhone @@ -47,7 +48,7 @@ In addition, the contact object associated with that phone will be deleted from ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Get-CsCommonAreaPhone -Filter {DisplayName -eq "Building 14 Lobby"} | Remove-CsCommonAreaPhone ``` @@ -57,7 +58,7 @@ To do this, the command first calls the `Get-CsCommonAreaPhone` cmdlet along wit The returned object is then piped to, and deleted by, the `Remove-CsCommonAreaPhone` cmdlet. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsCommonAreaPhone -Filter {DialPlan -eq $Null} | Remove-CsCommonAreaPhone ``` @@ -67,7 +68,7 @@ This task is carried out by first using the `Get-CsCommonAreaPhone` cmdlet and t This filtered collection is then piped to the `Remove-CsCommonAreaPhone` cmdlet, which deletes each phone in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsCommonAreaPhone -OU "ou=Redmond,dc=litwareinc,dc=com" | Remove-CsCommonAreaPhone ``` @@ -80,6 +81,9 @@ The returned collection is then piped to the `Remove-CsCommonAreaPhone` cmdlet, ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the common area phone. Common area phones are identified using the Active Directory distinguished name of the associated contact object. By default, common area phones use a globally unique identifier (GUID) as their common name, which means phones will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. @@ -89,8 +93,7 @@ Because of that, you might find it easier to retrieve common area phones by usin ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -99,14 +102,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -115,14 +120,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -136,13 +143,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact object. +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact + The `Remove-CsCommonAreaPhone` cmdlet accepts pipelined instances of the common area phone object. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact The `Remove-CsCommonAreaPhone` cmdlet deletes existing instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsConferenceDirectory.md b/skype/skype-ps/SkypeForBusiness/Remove-CsConferenceDirectory.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsConferenceDirectory.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsConferenceDirectory.md index 407a22cf8c..9a766946b3 100644 --- a/skype/skype-ps/skype/Remove-CsConferenceDirectory.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsConferenceDirectory.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csconferencedirectory applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsConferenceDirectory -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csconferencedirectory +schema: 2.0.0 +title: Remove-CsConferenceDirectory --- # Remove-CsConferenceDirectory @@ -40,7 +41,7 @@ Note that if you need to move a directory from one pool to another, you can do s ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsConferenceDirectory -Identity 2 ``` @@ -48,7 +49,7 @@ Remove-CsConferenceDirectory -Identity 2 The command shown in Example 1 deletes the conference directory with the Identity 2. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsConferenceDirectory | Where-Object {$_.ServiceID -match "UserServer:atl-cs-001.litwareinc.com"} | Remove-CsConferenceDirectory ``` @@ -61,14 +62,36 @@ In turn, that filtered collection is piped to and deleted by, the `Remove-CsConf ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, removes the conference directory even if the pool that hosts the directory is currently unavailable. +By default, the `Remove-CsConferenceDirectory` cmdlet will not remove directories if the corresponding pool cannot be contacted. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Numeric identity of the conference directory to be removed. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -77,16 +100,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -When present, removes the conference directory even if the pool that hosts the directory is currently unavailable. -By default, the `Remove-CsConferenceDirectory` cmdlet will not remove directories if the corresponding pool cannot be contacted. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -96,29 +119,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -132,14 +141,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.PstnConf.ConferenceDirectories object. +### Microsoft.Rtc.Management.WritableConfig.Settings.PstnConf.ConferenceDirectories + The `Remove-CsConferenceDirectory` cmdlet accepts pipelined input of conference directory objects. ## OUTPUTS -### -None. +### None Instead, the `Removes-CsConferenceDirectory` cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PstnConf.ConferenceDirectories object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsConferenceDisclaimer.md b/skype/skype-ps/SkypeForBusiness/Remove-CsConferenceDisclaimer.md similarity index 86% rename from skype/skype-ps/skype/Remove-CsConferenceDisclaimer.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsConferenceDisclaimer.md index efd4048142..4adfc59359 100644 --- a/skype/skype-ps/skype/Remove-CsConferenceDisclaimer.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsConferenceDisclaimer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csconferencedisclaimer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsConferenceDisclaimer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csconferencedisclaimer +schema: 2.0.0 +title: Remove-CsConferenceDisclaimer --- # Remove-CsConferenceDisclaimer @@ -36,7 +37,7 @@ The `Remove-CsConferenceDisclaimer` cmdlet enables you to reset your conference ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsConferenceDisclaimer -Identity global ``` @@ -47,7 +48,28 @@ That means that both the disclaimer Header and Body will be set to null values, ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique Identity of the conference disclaimer to be removed. Although you can only have a single, global instance of the conference disclaimer, you must still use the Identity parameter when calling the `Remove-CsConferenceDisclaimer` cmdlet. @@ -55,8 +77,7 @@ Although you can only have a single, global instance of the conference disclaime ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -65,14 +86,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -82,29 +105,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -118,14 +127,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConferenceDisclaimer object. +### Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConferenceDisclaimer + The `Remove-CsConferenceDisclaimer` cmdlet accepts pipelined input of conference disclaimer objects. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsConferenceDisclaimer` cmdlet resets existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConferenceDisclaimer object to their default property values. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsConferencingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsConferencingConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsConferencingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsConferencingConfiguration.md index 4164a16021..b1d5deedd5 100644 --- a/skype/skype-ps/skype/Remove-CsConferencingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsConferencingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csconferencingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsConferencingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csconferencingconfiguration +schema: 2.0.0 +title: Remove-CsConferencingConfiguration --- # Remove-CsConferencingConfiguration @@ -51,7 +52,7 @@ For example, if you previously changed the maximum content storage value to 200 ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsConferencingConfiguration -Identity site:Redmond ``` @@ -60,7 +61,7 @@ Example 1 deletes the conferencing configuration settings applied to the Redmond When site settings such as these are deleted, users in the site will automatically inherit the settings found in the global conferencing configuration settings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsConferencingConfiguration -Filter site:* | Remove-CsConferencingConfiguration ``` @@ -70,7 +71,7 @@ To do this, the command first calls the `Get-CsConferencingConfiguration` cmdlet This filtered collection is then piped to the `Remove-CsConferencingConfiguration` cmdlet, which deletes each item in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsConferencingConfiguration | Where-Object {$_.Organization -ne "Litwareinc"} | Remove-CsConferencingConfiguration ``` @@ -83,7 +84,28 @@ Finally, the filtered collection is piped to the `Remove-CsConferencingConfigura ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the collection of conferencing configuration settings to be removed. To remove settings configured at the site scope, use syntax similar to this: `-Identity "site:Redmond"`. To remove settings configured at the service scope, use syntax similar to this: `-Identity "service:ConferencingServer:atl-cs-001.litwareinc.com"`. @@ -95,8 +117,7 @@ In that case, however, those settings will not be removed; instead, all the prop ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -105,14 +126,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -122,29 +145,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -158,14 +167,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConfSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConfSettings + The `Remove-CsConferencingConfiguration` cmdlet accepts pipelined instances of the conferencing configuration object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsConferencingConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConfSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsConferencingPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsConferencingPolicy.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsConferencingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsConferencingPolicy.md index cbc2051711..65f02c1ee0 100644 --- a/skype/skype-ps/skype/Remove-CsConferencingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsConferencingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csconferencingpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsConferencingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/remove-csconferencingpolicy +schema: 2.0.0 +title: Remove-CsConferencingPolicy --- # Remove-CsConferencingPolicy @@ -48,7 +50,7 @@ In that case, however the policy will not be removed; instead, all the global po ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsConferencingPolicy -Identity SalesConferencingPolicy ``` @@ -56,7 +58,7 @@ Remove-CsConferencingPolicy -Identity SalesConferencingPolicy In Example 1, the `Remove-CsConferencingPolicy` cmdlet is used to delete the conferencing policy with the Identity SalesConferencingPolicy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsConferencingPolicy -Filter "site:*" | Remove-CsConferencingPolicy ``` @@ -66,7 +68,7 @@ To accomplish this task, the command first uses the `Get-CsConferencingPolicy` c That filtered collection is then piped to the `Remove-CsConferencingPolicy` cmdlet, which deletes each item in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsConferencingPolicy | Where-Object {$_.MaxMeetingSize -gt 100} | Remove-CsConferencingPolicy ``` @@ -79,7 +81,30 @@ Finally, that filtered collection is passed to the `Remove-CsConferencingPolicy` ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +If present, causes the `Remove-CsConferencingPolicy` cmdlet to delete the per-user policy even if the policy in question is currently assigned to at least one user. +If not present, you will be asked to confirm the deletion request before the policy 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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the conferencing policy to be removed. Conferencing policies can be configured at the global, site, or per-user scopes. To remove the global policy, use this syntax: `-Identity global`. @@ -93,8 +118,7 @@ Wildcards are not allowed when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -103,33 +127,24 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -If present, causes the `Remove-CsConferencingPolicy` cmdlet to delete the per-user policy even if the policy in question is currently assigned to at least one user. -If not present, you will be asked to confirm the deletion request before the policy will be removed. +### -Tenant +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the conferencing policy is being removed. +For example: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,6 +154,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. @@ -146,7 +164,6 @@ Prompts you for confirmation before executing the command. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -155,22 +172,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the conferencing policy is being removed. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -184,13 +196,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Meeting.MeetingPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Meeting.MeetingPolicy + The `Remove-CsConferencingPolicy` cmdlet accepts pipelined instances of the meeting policy object. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Meeting.MeetingPolicy The `Remove-CsConferencingPolicy` cmdlet does not return a value or object. Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Meeting.MeetingPolicy object. diff --git a/skype/skype-ps/skype/Remove-CsConfigurationStoreLocation.md b/skype/skype-ps/SkypeForBusiness/Remove-CsConfigurationStoreLocation.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsConfigurationStoreLocation.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsConfigurationStoreLocation.md index 654ff393a0..5decd0d21d 100644 --- a/skype/skype-ps/skype/Remove-CsConfigurationStoreLocation.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsConfigurationStoreLocation.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csconfigurationstorelocation applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsConfigurationStoreLocation -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csconfigurationstorelocation +schema: 2.0.0 +title: Remove-CsConfigurationStoreLocation --- # Remove-CsConfigurationStoreLocation @@ -38,7 +39,7 @@ After the SCP has been deleted, you can recreate it (or create a new service con ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsConfigurationStoreLocation ``` @@ -47,7 +48,7 @@ The command shown in Example 1 removes the Active Directory service control poin To restore this SCP (or to create a new SCP), you must run the `Set-CsConfigurationStoreLocation` cmdlet. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Remove-CsConfigurationStoreLocation -Report C:\Logs\Store_Location.html ``` @@ -61,16 +62,16 @@ If the file does not exist, it will be created when the command runs. ## PARAMETERS -### -GlobalSettingsDomainController -Fully qualified domain name (FQDN) of a domain controller where global settings are stored. -If global settings are stored in the Active Directory System container, then this parameter must point to the root domain controller. -If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -79,14 +80,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of a domain controller where global settings are stored. +If global settings are stored in the Active Directory System container, then this parameter must point to the root domain controller. +If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,14 +101,16 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: `-Report "C:\Logs\ConfigurationStore.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -112,14 +119,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -128,14 +137,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -149,13 +160,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Remove-CsConfigurationStoreLocation` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Remove-CsConfigurationStoreLocation` cmdlet does not return any objects or values. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsConversationHistoryConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsConversationHistoryConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsConversationHistoryConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsConversationHistoryConfiguration.md index 1d6e47fc07..bf0819e70f 100644 --- a/skype/skype-ps/skype/Remove-CsConversationHistoryConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsConversationHistoryConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csconversationhistoryconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsConversationHistoryConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csconversationhistoryconfiguration +schema: 2.0.0 +title: Remove-CsConversationHistoryConfiguration --- # Remove-CsConversationHistoryConfiguration @@ -39,7 +40,7 @@ If you run the `Remove-CsConversationHistoryConfiguration` cmdlet then CachedUse ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsConversationHistoryConfiguration -Identity "global" ``` @@ -49,7 +50,28 @@ The command shown in Example 1 resets all the properties in the global collectio ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the conversation history configuration settings to be deleted. Because there is only a single, global collection of settings per deployment, the only allowed syntax is the following: @@ -58,8 +80,7 @@ Because there is only a single, global collection of settings per deployment, th ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -69,13 +90,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -84,30 +107,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -121,13 +130,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.ConversationHistory.ConversationHistorySettings `Remove-CsConversationHistoryConfiguration` accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ConversationHistory.ConversationHistorySettings object. ## OUTPUTS -### -None. +### Microsoft.Rtc.Management.WritableConfig.Settings.ConversationHistory.ConversationHistorySettings Instead, `Remove-CsConversationHistoryConfiguration` resets instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ConversationHistory.ConversationHistorySettings object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsCpsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsCpsConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Remove-CsCpsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsCpsConfiguration.md index 31f01a2608..fa8f3cdf87 100644 --- a/skype/skype-ps/skype/Remove-CsCpsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsCpsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cscpsconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsCpsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cscpsconfiguration +schema: 2.0.0 +title: Remove-CsCpsConfiguration --- # Remove-CsCpsConfiguration @@ -39,7 +40,7 @@ In the case of the Global configuration, however, the configuration will not act ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsCpsConfiguration -Identity site:Redmond1 ``` @@ -48,7 +49,7 @@ Example 1 uses the `Remove-CsCpsConfiguration` cmdlet to delete the Call Park se Because identities are unique, this command will result in only one configuration being deleted. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsCpsConfiguration -Filter site:* | Remove-CsCpsConfiguration ``` @@ -61,15 +62,35 @@ Note that any time you remove Call Park service settings from a site, the site w ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the Call Park service configuration you want to remove. This identifier will be either Global or site:\, where \ is the name of the site to which the configuration applies. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -78,14 +99,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -95,29 +118,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -131,13 +140,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.CallParkServiceSettings.CallParkServiceSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.CallParkServiceSettings.CallParkServiceSettings + Accepts pipelined input of Call Park service configuration objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CallParkServiceSettings.CallParkServiceSettings Removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.CallParkServiceSettings.CallParkServiceSettings. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsDeviceUpdateConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsDeviceUpdateConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsDeviceUpdateConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsDeviceUpdateConfiguration.md index 3ba03e403a..8eab03c315 100644 --- a/skype/skype-ps/skype/Remove-CsDeviceUpdateConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsDeviceUpdateConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csdeviceupdateconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsDeviceUpdateConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csdeviceupdateconfiguration +schema: 2.0.0 +title: Remove-CsDeviceUpdateConfiguration --- # Remove-CsDeviceUpdateConfiguration @@ -46,7 +47,7 @@ That means that MaxLogCacheLimit will be reset to 512,000 bytes. ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsDeviceUpdateConfiguration -Identity global ``` @@ -55,7 +56,7 @@ In Example 1, the `Remove-CsDeviceUpdateConfiguration` cmdlet is used to "remove Because the global settings cannot actually be removed, the command will not delete anything; however, all the properties in the global device update configuration settings will be reset to their default values. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Remove-CsDeviceUpdateConfiguration -Identity site:Redmond ``` @@ -64,7 +65,7 @@ The command shown in Example 2 removes the device update configuration settings Because these settings were configured at the site scope, they will be deleted and the Redmond site will no longer have its own set of device update configuration settings. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsDeviceUpdateConfiguration -Filter "site:*" | Remove-CsDeviceUpdateConfiguration ``` @@ -74,7 +75,7 @@ To do this, the `Get-CsDeviceUpdateConfiguration` cmdlet and the Filter paramete That collection is then piped to the `Remove-CsDeviceUpdateConfiguration` cmdlet, which removes each of the items in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsDeviceUpdateConfiguration | Where-Object {$_.MaxLogFileSize -lt 1024000} | Remove-CsDeviceUpdateConfiguration ``` @@ -87,7 +88,28 @@ That filtered collection is then piped to the `Remove-CsDeviceUpdateConfiguratio ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the device update configuration settings to be removed. To refer to the global settings, use this syntax: `-Identity global`. To refer to site settings, use syntax similar to this: `-Identity site:Redmond`. @@ -96,8 +118,7 @@ Note that you cannot use wildcards when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -106,14 +127,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -123,29 +146,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -159,14 +168,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdateConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdateConfiguration + The `Remove-CsDeviceUpdateConfiguration` cmdlet accepts pipelined instances of the device update configuration object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsDeviceUpdateConfiguration` cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdateConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsDeviceUpdateRule.md b/skype/skype-ps/SkypeForBusiness/Remove-CsDeviceUpdateRule.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsDeviceUpdateRule.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsDeviceUpdateRule.md index f13625d1e3..3d0a83c5e0 100644 --- a/skype/skype-ps/skype/Remove-CsDeviceUpdateRule.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsDeviceUpdateRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csdeviceupdaterule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsDeviceUpdateRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csdeviceupdaterule +schema: 2.0.0 +title: Remove-CsDeviceUpdateRule --- # Remove-CsDeviceUpdateRule @@ -38,7 +39,7 @@ To help lessen this confusion, the `Remove-CsDeviceUpdateRule` cmdlet can be use ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsDeviceUpdateRule -Identity service:WebServer:atl-cs-001.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9 ``` @@ -47,7 +48,7 @@ Example 1 deletes the device update rule with the Identity service:WebServer:atl After the rule has been deleted, the corresponding firmware update will no longer be available for use. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsDeviceUpdateRule | Remove-CsDeviceUpdateRule ``` @@ -57,7 +58,7 @@ This is done by calling the `Get-CsDeviceUpdateRule` cmdlet (without any paramet That collection is then piped to the `Remove-CsDeviceUpdateRule` cmdlet, which, in turn, deletes each rule in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsDeviceUpdateRule -Filter service:WebServer:atl-cs-001.litwareinc.com* | Remove-CsDeviceUpdateRule ``` @@ -67,7 +68,7 @@ To do this, the command first uses the `Get-CsDeviceUpdateRule` cmdlet and the F This collection is then piped to the `Remove-CsDeviceUpdateRule` cmdlet, which deletes each rule in that collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsDeviceUpdateRule | Where-Object {$_.Brand -eq "LG-Nortel"} | Remove-CsDeviceUpdateRule ``` @@ -80,7 +81,28 @@ The filtered collection is then piped to the `Remove-CsDeviceUpdateRule` cmdlet, ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the device update rule. The Identity of a device update rule is composed of two parts: The service scope where the rule has been applied (for example, service:WebServer:atl-cs-001.litwareinc.com) and the globally unique identifier (GUID) that was pre-assigned to the rule (for example, d5ce3c10-2588-420a-82ac-dc2d9b1222ff9). Based on this, the Identity for a given device update rule will look something like this: "service:WebServer:atl-cs-001.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9". @@ -90,8 +112,7 @@ Wildcards are not allowed when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -100,14 +121,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -117,29 +140,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -153,13 +162,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdate.Rule object. +### Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdate.Rule + The `Remove-CsDeviceUpdateRule` cmdlet accepts pipelined instances of the device update rule object. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.Rule The `Remove-CsDeviceUpdateRule` cmdlet does not return a value or object. Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.Rule object. diff --git a/skype/skype-ps/skype/Remove-CsDiagnosticConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsDiagnosticConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsDiagnosticConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsDiagnosticConfiguration.md index 863e71f71f..4444cb5ce9 100644 --- a/skype/skype-ps/skype/Remove-CsDiagnosticConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsDiagnosticConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csdiagnosticconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsDiagnosticConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csdiagnosticconfiguration +schema: 2.0.0 +title: Remove-CsDiagnosticConfiguration --- # Remove-CsDiagnosticConfiguration @@ -44,7 +45,7 @@ That means that all the filters added to that collection will be removed. ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsDiagnosticConfiguration -Identity site:Redmond ``` @@ -52,7 +53,7 @@ Remove-CsDiagnosticConfiguration -Identity site:Redmond Example 1 deletes the diagnostic configuration settings that have the Identity site:Redmond. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsDiagnosticConfiguration -Filter site:* | Remove-CsDiagnosticConfiguration ``` @@ -62,7 +63,7 @@ To do this, the command calls the `Get-CsDiagnosticConfiguration` cmdlet along w The filtered collection is then piped to the `Remove-CsDiagnosticConfiguration` cmdlet, which removes each item in that collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsDiagnosticConfiguration | Remove-CsDiagnosticConfiguration ``` @@ -74,7 +75,28 @@ These items are then piped to the `Remove-CsDiagnosticConfiguration` cmdlet, whi ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the diagnostic configuration settings to be removed. To remove settings configured at the site scope, use syntax similar to this: `-Identity "site:Redmond"`. @@ -85,8 +107,7 @@ However, the global settings will not actually be removed; instead, the properti ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -95,14 +116,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -112,29 +135,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -148,14 +157,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticFilterSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticFilterSettings + The `Remove-CsDiagnosticConfiguration` cmdlet accepts pipelined instances of the diagnostic filter settings object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsDiagnosticConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticFilterSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsDiagnosticHeaderConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsDiagnosticHeaderConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsDiagnosticHeaderConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsDiagnosticHeaderConfiguration.md index 5b42883a96..ceb14e2c26 100644 --- a/skype/skype-ps/skype/Remove-CsDiagnosticHeaderConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsDiagnosticHeaderConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csdiagnosticheaderconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsDiagnosticHeaderConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csdiagnosticheaderconfiguration +schema: 2.0.0 +title: Remove-CsDiagnosticHeaderConfiguration --- # Remove-CsDiagnosticHeaderConfiguration @@ -46,7 +47,7 @@ Instead, the two properties contained in the global collection -- SendToExternal ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsDiagnosticHeaderConfiguration -Identity site:Redmond ``` @@ -54,7 +55,7 @@ Remove-CsDiagnosticHeaderConfiguration -Identity site:Redmond In Example 1, the diagnostic header configuration settings that have the Identity site:Redmond are removed. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsDiagnosticHeaderConfiguration -Filter service:* | Remove-CsDiagnosticHeaderConfiguration ``` @@ -65,7 +66,7 @@ The filter value "service:*" limits the returned data to those settings where th This filtered collection is then piped to the `Remove-CsDiagnosticHeaderConfiguration` cmdlet, which deletes each item in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsDiagnosticHeaderConfiguration | Where-Object {$_.SendToExternalNetworks -eq $True} | Remove-CsDiagnosticHeaderConfiguration ``` @@ -78,7 +79,28 @@ These settings are then piped to the `Remove-CsDiagnosticHeaderConfiguration` cm ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the diagnostic header configuration settings to be removed. To remove settings configured at the site scope, use syntax similar to this: `-Identity "site:Redmond"`. To remove settings configured at the service scope, use syntax similar to this: `-Identity "service:EdgeServer:atl-edge-001.litwareinc.com"`. @@ -90,8 +112,7 @@ Note, however, that the global settings will not actually be removed; instead, t ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -100,14 +121,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -117,29 +140,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -153,14 +162,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings + The `Remove-CsDiagnosticHeaderConfiguration` cmdlet accepts pipelined instances of the diagnostic header settings object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsDiagnosticHeaderConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsDialInConferencingAccessNumber.md b/skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingAccessNumber.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsDialInConferencingAccessNumber.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingAccessNumber.md index 7f4137e2f9..9ec35e442a 100644 --- a/skype/skype-ps/skype/Remove-CsDialInConferencingAccessNumber.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingAccessNumber.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csdialinconferencingaccessnumber applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsDialInConferencingAccessNumber -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csdialinconferencingaccessnumber +schema: 2.0.0 +title: Remove-CsDialInConferencingAccessNumber --- # Remove-CsDialInConferencingAccessNumber @@ -39,7 +40,7 @@ When you run the `Remove-CsDialInConferencingAccessNumber` cmdlet, the cmdlet no ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsDialInConferencingAccessNumber -Identity sip:RedmondDialIn@litwareinc.com ``` @@ -47,7 +48,7 @@ Remove-CsDialInConferencingAccessNumber -Identity sip:RedmondDialIn@litwareinc.c The command shown in Example 1 deletes the dial-in conferencing access number that has the Identity sip:RedmondDialIn@litwareinc.com. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsDialInConferencingAccessNumber -Filter {LineUri -like "tel:+1800*"} | Remove-CsDialInConferencingAccessNumber ``` @@ -57,7 +58,7 @@ To do this, the command uses the `Get-CsDialInConferencingAccessNumber` cmdlet a This filtered collection is then piped to the `Remove-CsDialInConferencingAccessNumber` cmdlet, which deletes each number in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsDialInConferencingAccessNumber -Region "Redmond" | Remove-CsDialInConferencingAccessNumber ``` @@ -67,7 +68,7 @@ To carry out this task, the `Get-CsDialInConferencingAccessNumber` cmdlet and th (That is, any access number that includes Redmond in its list of regions.) This collection is then piped to the `Remove-CsDialInConferencingAccessNumber` cmdlet, which deletes all the access numbers in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsDialInConferencingAccessNumber -Region $Null | Remove-CsDialInConferencingAccessNumber ``` @@ -77,7 +78,7 @@ To do this, the `Get-CsDialInConferencingAccessNumber` cmdlet is called along wi That collection is then piped to the `Remove-CsDialInConferencingAccessNumber` cmdlet, which deletes all the numbers in the collection. -### -------------------------- Example 5 ------------------------ +### Example 5 ``` Get-CsDialInConferencingAccessNumber | Where-Object {$_.PrimaryLanguage -ne "it-IT"} | Remove-CsDialInConferencingAccessNumber ``` @@ -88,7 +89,7 @@ That collection is then piped to the `Where-Object` cmdlet, which picks out any Finally, the filtered collection is piped to the `Remove-CsDialInConferencingAccessNumber` cmdlet, which deletes all the access numbers in the collection. -### -------------------------- Example 6 ------------------------ +### Example 6 ``` Get-CsDialInConferencingAccessNumber -Filter {DisplayName -eq "Default Dial-In Access Number"} | Remove-CsDialInConferencingAccessNumber ``` @@ -101,14 +102,16 @@ The returned object is then piped to the `Remove-CsDialInConferencingAccessNumbe ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address of the dial-in conferencing access number (that is, the contact object that represents that number) to be removed. You must include the sip: prefix when specifying the Identity; for example: `-Identity "sip:RedmondDialIn@litwareinc.com"`. ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -117,14 +120,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -133,14 +138,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -154,13 +161,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Xds.AccessNumber object. +### Microsoft.Rtc.Management.Xds.AccessNumber + The `Remove-CsDialInConferencingAccessNumber` cmdlet accepts pipelined input of the access number object. ## OUTPUTS -### +### Microsoft.Rtc.Management.Xds.AccessNumber The `Remove-CsDialInConferencingAccessNumber` cmdlet deletes instances of the Microsoft.Rtc.Management.Xds.AccessNumber object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsDialInConferencingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsDialInConferencingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingConfiguration.md index e0c94267aa..d713fe98a1 100644 --- a/skype/skype-ps/skype/Remove-CsDialInConferencingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csdialinconferencingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsDialInConferencingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csdialinconferencingconfiguration +schema: 2.0.0 +title: Remove-CsDialInConferencingConfiguration --- # Remove-CsDialInConferencingConfiguration @@ -44,7 +45,7 @@ Instead, all the properties within that collection of settings will be reset to ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CSDialInConferencingConfiguration -Identity "site:Redmond" ``` @@ -52,7 +53,7 @@ Remove-CSDialInConferencingConfiguration -Identity "site:Redmond" In Example 1, the dial-in conferencing configuration settings for the Redmond site are deleted. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CSDialInConferencingConfiguration -Filter "site:*" | Remove-CSDialInConferencingConfiguration ``` @@ -62,7 +63,7 @@ To do this, the command first uses the `Get-CSDialInConferencingConfiguration` c (The filter value "site:*" ensures that only settings that have an Identity that begins with the string value "site:" are returned.) This filtered collection is then piped to the `Remove-CSDialInConferencingConfiguration` cmdlet, which removes each item in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CSDialInConferencingConfiguration | Where-Object {$_.EnableNameRecording -eq $False} | Remove-CSDialInConferencingConfiguration ``` @@ -75,7 +76,28 @@ In turn, this filtered collection is piped to the `Remove-CSDialInConferencingCo ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the dial-in conferencing configuration settings to be removed. To refer to the global settings, use this syntax: `-Identity global`. To refer to site settings, use syntax similar to this: `-Identity site:Redmond`. @@ -84,8 +106,7 @@ Note that you cannot use wildcards when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -94,14 +115,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -111,29 +134,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -147,14 +156,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingConfiguration + The `Remove-CSDialInConferencingConfiguration` cmdlet accepts pipelined instances of the dial-in conferencing configuration object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CSDialInConferencingConfiguration` cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsDialInConferencingDtmfConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingDtmfConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsDialInConferencingDtmfConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingDtmfConfiguration.md index 8eaaf5a8d7..f9b95d7458 100644 --- a/skype/skype-ps/skype/Remove-CsDialInConferencingDtmfConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsDialInConferencingDtmfConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csdialinconferencingdtmfconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsDialInConferencingDtmfConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csdialinconferencingdtmfconfiguration +schema: 2.0.0 +title: Remove-CsDialInConferencingDtmfConfiguration --- # Remove-CsDialInConferencingDtmfConfiguration @@ -49,7 +50,7 @@ If you now run the `Remove-CSDialInConferencingDtmfConfiguration` cmdlet against ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CSDialInConferencingDtmfConfiguration -Identity site:Redmond ``` @@ -57,7 +58,7 @@ Remove-CSDialInConferencingDtmfConfiguration -Identity site:Redmond Example 1 deletes the collection of DTMF configuration settings that has the Identity site:Redmond. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CSDialInConferencingDtmfConfiguration -Filter "site:*" | Remove-CSDialInConferencingDtmfConfiguration ``` @@ -67,7 +68,7 @@ To perform this task, the command first uses the `Get-CSDialInConferencingDtmfCo This filtered collection is then piped to the `Remove-CSDialInConferencingConfiguration` cmdlet, which removes each item in that collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CSDialInConferencingDtmfConfiguration | Where-Object {$_.PrivateRollCallCommand -eq $Null} | Remove-CSDialInConferencingDtmfConfiguration ``` @@ -80,7 +81,28 @@ The filtered collection is then piped to the `Remove-CSDialInConferencingDtmfCon ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of DTMF settings to be removed. To "remove" the global settings, use this syntax: `-Identity global`. (As noted earlier, you cannot actually remove the global setting; all you can do is reset the properties to their default values.) To remove a collection configured at the site scope, use syntax similar to this: `-Identity site:Redmond`. @@ -89,8 +111,7 @@ You cannot use wildcards when specifying an Identity ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -99,14 +120,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -116,29 +139,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -152,14 +161,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingDtmfConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingDtmfConfiguration + The `Remove-CsDialInConferencingDtmfConfiguration` cmdlet accepts pipelined instances of the dial-in conference DTMF configuration object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CSDialInConferencingDtmfConfiguration` cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingDtmfConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsDialPlan.md b/skype/skype-ps/SkypeForBusiness/Remove-CsDialPlan.md similarity index 86% rename from skype/skype-ps/skype/Remove-CsDialPlan.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsDialPlan.md index e42285747c..20d55ef7e7 100644 --- a/skype/skype-ps/skype/Remove-CsDialPlan.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsDialPlan.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csdialplan applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsDialPlan -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csdialplan +schema: 2.0.0 +title: Remove-CsDialPlan --- # Remove-CsDialPlan @@ -37,7 +38,7 @@ If the global dial plan is removed, any associated normalization rules will also ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsDialPlan -Identity RedmondDialPlan ``` @@ -47,7 +48,7 @@ Note that when you delete a dial plan, you do not necessarily have to assign a n Instead, those users will use the dial plan assigned to their service or site, or the global plan. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsDialPlan | Where-Object {$_.Description -match "Redmond"} | Remove-CsDialPlan ``` @@ -60,14 +61,34 @@ After that's done, the filtered collection is passed to the `Remove-CsDialPlan` ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the dial plan you want to remove. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -76,14 +97,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -93,29 +116,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -129,13 +138,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile + The `Remove-CsDialPlan` cmdlet accepts pipelined input of dial plan objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile This cmdlet removes instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsEnhancedEmergencyServiceDisclaimer.md b/skype/skype-ps/SkypeForBusiness/Remove-CsEnhancedEmergencyServiceDisclaimer.md similarity index 83% rename from skype/skype-ps/skype/Remove-CsEnhancedEmergencyServiceDisclaimer.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsEnhancedEmergencyServiceDisclaimer.md index 12953178d6..abb0cd685b 100644 --- a/skype/skype-ps/skype/Remove-CsEnhancedEmergencyServiceDisclaimer.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsEnhancedEmergencyServiceDisclaimer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csenhancedemergencyservicedisclaimer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsEnhancedEmergencyServiceDisclaimer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csenhancedemergencyservicedisclaimer +schema: 2.0.0 +title: Remove-CsEnhancedEmergencyServiceDisclaimer --- # Remove-CsEnhancedEmergencyServiceDisclaimer @@ -34,7 +35,7 @@ This message will be displayed only if the LocationRequired property of the user ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsEnhancedEmergencyServiceDisclaimer -Identity global ``` @@ -46,14 +47,34 @@ It simply sets the Body property to an empty string. ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This value is required and must be set to Global. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -62,14 +83,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -79,29 +102,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -115,13 +124,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Location.EnhancedEmergencyServiceDisclaimer object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Location.EnhancedEmergencyServiceDisclaimer + Accepts pipelined input of an enhanced emergency service disclaimer object. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Location.EnhancedEmergencyServiceDisclaimer This cmdlet does not return a value or an object. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Location.EnhancedEmergencyServiceDisclaimer. diff --git a/skype/skype-ps/skype/Remove-CsExUmContact.md b/skype/skype-ps/SkypeForBusiness/Remove-CsExUmContact.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsExUmContact.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsExUmContact.md index 264bd46774..08343dfd49 100644 --- a/skype/skype-ps/skype/Remove-CsExUmContact.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsExUmContact.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csexumcontact applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsExUmContact -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csexumcontact +schema: 2.0.0 +title: Remove-CsExUmContact --- # Remove-CsExUmContact @@ -31,7 +32,7 @@ Any of the objects that are created can be removed with the `Remove-CsExUmContac ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsExUmContact -Identity sip:exumsa1@fabrikam.com ``` @@ -39,7 +40,7 @@ Remove-CsExUmContact -Identity sip:exumsa1@fabrikam.com This example removes the Exchange UM contact with the SIP address exumsa1@fabrikam.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsExUmContact -Filter {LineURI -like "tel:425*"} | Remove-CsExUmContact ``` @@ -54,6 +55,9 @@ Once we have that collection of objects, we pipe the collection to the `Remove-C ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the contact object you want to remove. Contact identities can be specified using one of four formats: 1) The contact's SIP address; 2) the contact's user principal name (UPN); 3) the contact's domain name and logon name, in the form domain\logon (for example, litwareinc\exum1) and 4) the contact's Active Directory display name (for example, Team Auto Attendant). @@ -63,8 +67,7 @@ Full data type: Microsoft.Rtc.Management.AD.UserIdParameter ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -73,14 +76,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -89,14 +94,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -110,13 +117,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact object. +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact + Accepts pipelined input of Exchange UM contact objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact This cmdlet does not return an object. It removes an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact. diff --git a/skype/skype-ps/skype/Remove-CsExternalAccessPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsExternalAccessPolicy.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsExternalAccessPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsExternalAccessPolicy.md index d10506b89c..aaad09ae2a 100644 --- a/skype/skype-ps/skype/Remove-CsExternalAccessPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsExternalAccessPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csexternalaccesspolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsExternalAccessPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/remove-csexternalaccesspolicy +schema: 2.0.0 +title: Remove-CsExternalAccessPolicy --- # Remove-CsExternalAccessPolicy @@ -53,7 +55,7 @@ Instead, the properties of the global policy will simply be reset to their defau ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsExternalAccessPolicy -Identity site:Redmond ``` @@ -61,7 +63,7 @@ Remove-CsExternalAccessPolicy -Identity site:Redmond In Example 1, the external access policy with the Identity site:Redmond is deleted. After the policy is removed, users in the Redmond site will have their external access permissions governed by the global policy. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsExternalAccessPolicy -Filter site:* | Remove-CsExternalAccessPolicy ``` @@ -70,7 +72,7 @@ Example 2 deletes all the external access policies that have been configured at To carry out this task, the command first uses the `Get-CsExternalAccessPolicy` cmdlet and the Filter parameter to return a collection of policies configured at the site scope; the filter value "site:*" limits the returned data to external access policies that have an Identity that begins with the string value "site:". The filtered collection is then piped to the `Remove-CsExternalAccessPolicy` cmdlet, which deletes each policy in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True} | Remove-CsExternalAccessPolicy ``` @@ -80,7 +82,7 @@ To do this, the command first calls the `Get-CsExternalAccessPolicy` cmdlet to r This collection is then piped to the `Where-Object` cmdlet, which picks out only those policies where the EnableFederationAccess property is equal to True. This filtered collection is then piped to the `Remove-CsExternalAccessPolicy` cmdlet, which deletes each policy in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsExternalAccessPolicy | Where-Object {$_.EnableFederationAccess -eq $True -or $_.EnablePublicCloudAccess -eq $True} | Remove-CsExternalAccessPolicy ``` @@ -96,7 +98,28 @@ To delete all the policies where both EnableFederationAccess and EnablePublicClo ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the external access policy to be removed. External access policies can be configured at the global, site, or per-user scopes. To "remove" the global policy, use this syntax: `-Identity global`. @@ -110,7 +133,6 @@ Note that wildcards are not allowed when specifying an Identity. Type: XdsIdentity Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 2 @@ -119,30 +141,23 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the external access policy is being removed. +For example: -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -152,13 +167,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -167,21 +184,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the external access policy is being removed. -For example: +### -WhatIf -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: - -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -195,14 +207,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy + The `Remove-CsExternalAccessPolicy` cmdlet accepts pipelined input of the external access policy object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsExternalAccessPolicy` cmdlet does not return a value or object. Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy object. diff --git a/skype/skype-ps/skype/Remove-CsExternalUserCommunicationPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsExternalUserCommunicationPolicy.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsExternalUserCommunicationPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsExternalUserCommunicationPolicy.md index a7a6576fd6..bad39de2f4 100644 --- a/skype/skype-ps/skype/Remove-CsExternalUserCommunicationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsExternalUserCommunicationPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csexternalusercommunicationpolicy applicable: Skype for Business Online -title: Remove-CsExternalUserCommunicationPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/remove-csexternalusercommunicationpolicy +schema: 2.0.0 +title: Remove-CsExternalUserCommunicationPolicy --- # Remove-CsExternalUserCommunicationPolicy @@ -27,7 +29,7 @@ Remove-CsExternalUserCommunicationPolicy [-Tenant ] [-Identity] {{ Add example code here }} ``` @@ -36,30 +38,16 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Online -### -Force {{Fill Force Description}} ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -69,13 +57,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + {{Fill Identity Description}} ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 1 @@ -85,13 +75,33 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + {{Fill Tenant Description}} ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Online + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -101,6 +111,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -108,7 +121,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/Remove-CsFIPSConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsFIPSConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsFIPSConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsFIPSConfiguration.md index 21351e05ab..be10e4a004 100644 --- a/skype/skype-ps/skype/Remove-CsFIPSConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsFIPSConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csfipsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsFIPSConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csfipsconfiguration +schema: 2.0.0 +title: Remove-CsFIPSConfiguration --- # Remove-CsFIPSConfiguration @@ -41,7 +42,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsFIPSConfiguration -Identity "Global" ``` @@ -51,7 +52,28 @@ Example 1 resets the properties in the global collection of FIPS configuration s ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique Identity of the FIPS configuration settings to be removed. Because Skype for Business Server only supports a single, global collection of FIPS settings, the only collection that can be deleted is the global collection: @@ -64,8 +86,7 @@ Instead, the lone property in that collection - RequireFIPSCompliantMedia - will ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -74,30 +95,24 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Globally unique identifier (GUID) of the Skype for Business Server tenant account for the FIPS configuration settings being deleted. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -106,22 +121,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Server tenant account for the FIPS configuration settings being deleted. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` - -You can return the tenant ID for each of your tenants by running this command: +### -Confirm -`Get-CsTenant | Select-Object DisplayName, TenantID` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -131,13 +140,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -151,13 +162,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.FIPSConfiguration.FIPSConfiguration The `Remove-CsFIPSConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.FIPSConfiguration.FIPSConfiguration object ## OUTPUTS -### -None. +### None Instead, the `Remove-CsFIPSConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.FIPSConfiguration.FIPSConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsFileTransferFilterConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsFileTransferFilterConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsFileTransferFilterConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsFileTransferFilterConfiguration.md index bcffa2634d..d1b5d53c95 100644 --- a/skype/skype-ps/skype/Remove-CsFileTransferFilterConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsFileTransferFilterConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csfiletransferfilterconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsFileTransferFilterConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csfiletransferfilterconfiguration +schema: 2.0.0 +title: Remove-CsFileTransferFilterConfiguration --- # Remove-CsFileTransferFilterConfiguration @@ -37,7 +38,7 @@ In that case, however, the global configuration will not be removed; instead, al ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsFileTransferFilterConfiguration -Identity site:Redmond ``` @@ -45,7 +46,7 @@ Remove-CsFileTransferFilterConfiguration -Identity site:Redmond In Example 1, the `Remove-CsFileTransferFilterConfiguration` cmdlet is used to remove the file transfer filter configuration that has the Identity site:Redmond. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsFileTransferFilterConfiguration -Filter site:* | Remove-CsFileTransferFilterConfiguration ``` @@ -56,7 +57,7 @@ The filter value "site:*" tells the `Get-CsFileTransferFilterConfiguration` cmdl The filtered collection of configurations is then piped to the `Remove-CsFileTransferFilterConfiguration` cmdlet, which deletes each item in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsFileTransferFilterConfiguration | Where-Object {$_.Enabled -eq $False} | Remove-CsFileTransferFilterConfiguration ``` @@ -69,7 +70,28 @@ That filtered collection is then piped to the `Remove-CsFileTransferFilterConfig ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the file transfer configuration to be removed. To refer to the global configuration, use this syntax: `-Identity global`. To refer to a configuration at the site scope, use syntax similar to this: `-Identity site:Redmond`. @@ -78,8 +100,7 @@ Note that you cannot use wildcard values when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -88,14 +109,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -105,29 +128,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -141,13 +150,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.FileTransferFilterConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.FileTransferFilterConfiguration + Accepts pipelined input of file transfer filter configuration objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.FileTransferFilterConfiguration This cmdlet does not return a value or object. Instead, it removes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.FileTransferFilterConfiguration object. diff --git a/skype/skype-ps/skype/Remove-CsGroupPickupUserOrbit.md b/skype/skype-ps/SkypeForBusiness/Remove-CsGroupPickupUserOrbit.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsGroupPickupUserOrbit.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsGroupPickupUserOrbit.md index f6a9d6484e..790f68f6e6 100644 --- a/skype/skype-ps/skype/Remove-CsGroupPickupUserOrbit.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsGroupPickupUserOrbit.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csgrouppickupuserorbit applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsGroupPickupUserOrbit -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csgrouppickupuserorbit +schema: 2.0.0 +title: Remove-CsGroupPickupUserOrbit --- # Remove-CsGroupPickupUserOrbit @@ -27,7 +28,7 @@ This cmdlet will throw an exception if the user does not have an assigned group ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsGroupPickupUserOrbit sip:ken.myer@contoso.com ``` @@ -39,7 +40,28 @@ The first parameter after the cmdlet is assumed to be the User parameter value. ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -User + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the user whose group pickup orbit number will be removed. Because User is a positional parameter, the -User syntax is not required. The first parameter after the cmdlet is assumed to be the User parameter value. @@ -51,7 +73,6 @@ You can also reference a user account by using the user's Active Directory disti Type: String Parameter Sets: (All) Aliases: DisplayName, SipAddress, Identity -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 1 @@ -61,13 +82,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -76,30 +99,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -113,13 +122,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String This cmdlet supports pipelined input from the Get-CsUser cmdlet. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsHealthMonitoringConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsHealthMonitoringConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsHealthMonitoringConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsHealthMonitoringConfiguration.md index d7ea78fe80..f2f9267421 100644 --- a/skype/skype-ps/skype/Remove-CsHealthMonitoringConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsHealthMonitoringConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cshealthmonitoringconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsHealthMonitoringConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cshealthmonitoringconfiguration +schema: 2.0.0 +title: Remove-CsHealthMonitoringConfiguration --- # Remove-CsHealthMonitoringConfiguration @@ -44,7 +45,7 @@ The `Remove-CsHealthMonitoringConfiguration` cmdlet provides a way for you to re ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsHealthMonitoringConfiguration -Identity atl-cs-001.litwareinc.com ``` @@ -53,7 +54,7 @@ The command shown in Example 1 deletes the collection of health monitoring confi Because identities must be unique, this command will delete, at most, a single collection of settings. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsHealthMonitoringConfiguration | Remove-CsHealthMonitoringConfiguration ``` @@ -63,7 +64,7 @@ To do this, the command first calls the `Get-CsHealthMonitoringConfiguration` cm This collection is then piped to the `Remove-CsHealthMonitoringConfiguration` cmdlet, which deletes each item in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsHealthMonitoringConfiguration -Filter *.litwareinc.com | Remove-CsHealthMonitoringConfiguration ``` @@ -73,7 +74,7 @@ To do this, the `Get-CsHealthMonitoringConfiguration` cmdlet is called along wit The filtered collection is then piped to the `Remove-CsHealthMonitoringConfiguration` cmdlet, which deletes each item in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` (Get-CsHealthMonitoringConfiguration | Where-Object {$_.FirstTestUserSipUri -eq "sip:kenmyer@litwareinc.com" -or $_.SecondTestUserSipUri -eq " sip:kenmyer@litwareinc.com"}) | Remove-CsHealthMonitoringConfiguration ``` @@ -86,15 +87,35 @@ In turn, those settings are piped to and removed by, the `Remove-CsHealthMonitor ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the pool hosting the health monitoring configuration settings that are to be deleted. For example: -Identity atl-cs-001.litwareinc.com. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -103,14 +124,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -120,29 +143,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -156,14 +165,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.HealthMonitoring.HealthMonitoringSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.HealthMonitoring.HealthMonitoringSettings + The `Remove-CsHealthMonitoringConfiguration` cmdlet accepts pipelined instances of the health monitoring configuration object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsHealthMonitoringConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.HealthMonitoring.HealthMonitoringSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsHostedVoicemailPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsHostedVoicemailPolicy.md similarity index 83% rename from skype/skype-ps/skype/Remove-CsHostedVoicemailPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsHostedVoicemailPolicy.md index ce701e607c..b7d9315686 100644 --- a/skype/skype-ps/skype/Remove-CsHostedVoicemailPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsHostedVoicemailPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cshostedvoicemailpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsHostedVoicemailPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cshostedvoicemailpolicy +schema: 2.0.0 +title: Remove-CsHostedVoicemailPolicy --- # Remove-CsHostedVoicemailPolicy @@ -30,7 +31,7 @@ This cmdlet removes a policy that specifies how to route unanswered calls to the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsHostedVoicemailPolicy -Identity ExRedmond ``` @@ -38,7 +39,7 @@ Remove-CsHostedVoicemailPolicy -Identity ExRedmond This command removes the hosted voice mail policy for the ExRedmond per-user policy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsHostedVoicemailPolicy -Filter tag* | Remove-CsHostedVoicemailPolicy ``` @@ -50,15 +51,35 @@ That set of policies is then piped to the `Remove-CsHostedVoicemailPolicy` cmdle ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier for the hosted voice mail policy that you want to remove. This identifier includes the scope (in the case of global), the scope and site (for a site policy, such as site:Redmond), or the policy name (for a per-user policy, such as HVUserPolicy). ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -67,30 +88,24 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for the hosted voicemail policy being deleted. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -100,13 +115,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -115,22 +132,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for the hosted voicemail policy being deleted. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` - -You can return the tenant ID for each of your tenants by running this command: +### -WhatIf -`Get-CsTenant | Select-Object DisplayName, TenantID` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -144,13 +155,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.HostedVoicemailPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.HostedVoicemailPolicy + Accepts pipelined input of hosted voice mail policy objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.HostedVoicemailPolicy This cmdlet does not return an object. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.HostedVoicemailPolicy. diff --git a/skype/skype-ps/skype/Remove-CsHostingProvider.md b/skype/skype-ps/SkypeForBusiness/Remove-CsHostingProvider.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsHostingProvider.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsHostingProvider.md index 8dd1e03560..b6fdae0a1b 100644 --- a/skype/skype-ps/skype/Remove-CsHostingProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsHostingProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cshostingprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsHostingProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cshostingprovider +schema: 2.0.0 +title: Remove-CsHostingProvider --- # Remove-CsHostingProvider @@ -51,7 +52,7 @@ To re-establish the relationship, you can use the `Enable-CsHostingProvider` cmd ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsHostingProvider -Identity "Fabrikam.com" ``` @@ -60,7 +61,7 @@ The command show in Example 1 deletes the hosting provider with the Identity Fab After the hosting provider has been deleted, federation with Fabrikam.com (and any domains associated with Fabrikam.com) will be terminated. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsHostingProvider | Remove-CsHostingProvider ``` @@ -71,7 +72,7 @@ That collection is then piped to the `Remove-CsHostingProvider` cmdlet, which de When this command completes there will no longer be any hosting providers configured for use. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsHostingProvider -Filter "*Fabrikam*" | Remove-CsHostingProvider ``` @@ -82,7 +83,7 @@ For example, this command returns such providers as Fabrikam.com, Fabrikam.net a The filtered collection is then piped to the `Remove-CsHostingProvider` cmdlet, which deletes each item in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsHostingProvider | Where-Object {$_.VerificationLevel -ne "AlwaysVerifiable"} | Remove-CsHostingProvider ``` @@ -93,7 +94,7 @@ The resulting collection is then piped to the `Where-Object` cmdlet, which picks The filtered collection is then piped to the `Remove-CsHostingProvider` cmdlet, which removes each provider in that collection. -### -------------------------- Example 5 ------------------------ +### Example 5 ``` Get-CsHostingProvider | Where-Object {$_.Enabled -eq $False} | Remove-CsHostingProvider ``` @@ -106,15 +107,35 @@ The filtered collection is then piped to the `Remove-CsHostingProvider` cmdlet, ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the hosting provider to be removed. The Identity is a string value; the Identity might be the fully qualified domain name (FQDN) of the hosting provider (for example, fabrikam.com) or perhaps the name of the company providing the services (Fabrikam, Inc.). ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -123,14 +144,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -140,29 +163,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -176,14 +185,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayHostingProvider object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayHostingProvider + The `Remove-CsHostingProvider` cmdlet accepts pipelined instances of the hosting provider object. ## OUTPUTS -### -None. +### None Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayHostingProvider object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsHybridApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/Remove-CsHybridApplicationEndpoint.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsHybridApplicationEndpoint.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsHybridApplicationEndpoint.md index 947839dc20..52df57a218 100644 --- a/skype/skype-ps/skype/Remove-CsHybridApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsHybridApplicationEndpoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cshybridapplicationendpoint applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsHybridApplicationEndpoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cshybridapplicationendpoint +schema: 2.0.0 +title: Remove-CsHybridApplicationEndpoint --- # Remove-CsHybridApplicationEndpoint @@ -28,7 +29,7 @@ This cmdlet removes an existing hybrid application endpoint user object in Activ ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Remove-CsHybridApplicationEndpoint -Identity "CN={4f6c99fe-7999-4088-ac4d-e88e0b3d3820},OU=Redmond,DC=litwareinc,DC=com" ``` @@ -37,30 +38,16 @@ This example removes the specified hybrid application endpoint including the Act ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Identity -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Identity The ApplicationId for the endpoint that is being deleted. ```yaml Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 0 @@ -69,14 +56,34 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Remove-CsHybridPSTNSite.md b/skype/skype-ps/SkypeForBusiness/Remove-CsHybridPSTNSite.md similarity index 93% rename from skype/skype-ps/skype/Remove-CsHybridPSTNSite.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsHybridPSTNSite.md index 57891ebc8e..6498cf191a 100644 --- a/skype/skype-ps/skype/Remove-CsHybridPSTNSite.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsHybridPSTNSite.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cshybridpstnsite applicable: Skype for Business Online -title: Remove-CsHybridPSTNSite -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/remove-cshybridpstnsite +schema: 2.0.0 +title: Remove-CsHybridPSTNSite --- # Remove-CsHybridPSTNSite @@ -39,7 +41,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsHybridPSTNSite -Identity "SeattlePSTN" ``` @@ -49,31 +51,18 @@ This example removes the "SeattlePSTN" hybrid public switched telephone network ## PARAMETERS -### -Identity -Specifies the identity of the hybrid public switched telephone network (PSTN) site. -For example: `-Identity "SeattlePSTN"`. +### -Force -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +> Applicable: Skype for Business Online -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -82,25 +71,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Identity + +> Applicable: Skype for Business Online + +Specifies the identity of the hybrid public switched telephone network (PSTN) site. +For example: `-Identity "SeattlePSTN"`. ```yaml -Type: SwitchParameter +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Specifies the global unique identifier (GUID) of the Skype for Business Online tenant account on which the cmdlet will operate. For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"`. @@ -113,8 +106,25 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Online + +The Confirm switch causes the command to pause processing and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -124,6 +134,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -131,7 +144,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named @@ -145,13 +157,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsImConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsImConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Remove-CsImConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsImConfiguration.md index 9b6ba26e08..0bbc4025f2 100644 --- a/skype/skype-ps/skype/Remove-CsImConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsImConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csimconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsImConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csimconfiguration +schema: 2.0.0 +title: Remove-CsImConfiguration --- # Remove-CsImConfiguration @@ -27,7 +28,7 @@ Use the Remove-CsImConfiguration cmdlet to remove a new Instant Messaging (IM) c ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Remove-CsImConfiguration -Identity "Site:Redmond" ``` @@ -36,30 +37,16 @@ This example removes the existing Redmond site IM configuration. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Force Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -69,13 +56,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier specifying the scope and, in some cases the name, of the IM configuration. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -85,13 +74,33 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -101,13 +110,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Remove-CsImFilterConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsImFilterConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Remove-CsImFilterConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsImFilterConfiguration.md index 25c342bb06..2225f80fd4 100644 --- a/skype/skype-ps/skype/Remove-CsImFilterConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsImFilterConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csimfilterconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsImFilterConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csimfilterconfiguration +schema: 2.0.0 +title: Remove-CsImFilterConfiguration --- # Remove-CsImFilterConfiguration @@ -34,7 +35,7 @@ Running this cmdlet against the Global identity will simply reset the global con ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsImFilterConfiguration -Identity site:Redmond ``` @@ -43,7 +44,7 @@ In Example 1, the `Remove-CsImFilterConfiguration` cmdlet is used to remove the When an IM filter configuration is removed from a site, that site will automatically begin using the global settings in its place. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsImFilterConfiguration -Filter site:* | Remove-CsImFilterConfiguration ``` @@ -55,7 +56,28 @@ The filtered collection of configurations is then piped to the `Remove-CsImFilte ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identity of the configuration to be removed. This will be either Global or Site:\ (where \ represents the name of the site to which the settings apply). @@ -64,8 +86,7 @@ Full Data Type: Microsoft.Rtc.Management.Xds.XdsIdentity ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -74,14 +95,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -91,29 +114,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -127,13 +136,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration + Accepts pipelined input of IM filter configuration objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration Removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsImTranslationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsImTranslationConfiguration.md similarity index 84% rename from skype/skype-ps/skype/Remove-CsImTranslationConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsImTranslationConfiguration.md index f3d59ef6ed..86c501c333 100644 --- a/skype/skype-ps/skype/Remove-CsImTranslationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsImTranslationConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csimtranslationconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsImTranslationConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csimtranslationconfiguration +schema: 2.0.0 +title: Remove-CsImTranslationConfiguration --- # Remove-CsImTranslationConfiguration @@ -27,7 +28,7 @@ This cmdlet is reserved for internal Microsoft use. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` This cmdlet is reserved for internal Microsoft use. ``` @@ -37,46 +38,52 @@ This cmdlet is reserved for internal Microsoft use. ## PARAMETERS -### -Identity +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -86,13 +93,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Remove-CsKerberosAccountAssignment.md b/skype/skype-ps/SkypeForBusiness/Remove-CsKerberosAccountAssignment.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsKerberosAccountAssignment.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsKerberosAccountAssignment.md index acd10f5224..29f724d492 100644 --- a/skype/skype-ps/skype/Remove-CsKerberosAccountAssignment.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsKerberosAccountAssignment.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cskerberosaccountassignment applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsKerberosAccountAssignment -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cskerberosaccountassignment +schema: 2.0.0 +title: Remove-CsKerberosAccountAssignment --- # Remove-CsKerberosAccountAssignment @@ -44,7 +45,7 @@ This removes the account's service principal name from Active Directory and comp ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsKerberosAccountAssignment -Identity "site:Redmond" @@ -54,7 +55,7 @@ Enable-CsTopology The commands shown in Example 1 remove the Kerberos account assignment from the Redmond site, then call the `Enable-CsTopology` cmdlet to finish disabling Kerberos web authentication. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsKerberosAccountAssignment | Remove-CsKerberosAccountAssignment @@ -69,15 +70,35 @@ When that's done, the second command in the example calls the `Enable-CsTopology ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, suppresses all error messages except for fatal errors. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the site where the Kerberos account assignment is to be removed. (This is the Identity of the site, not of the Kerberos account.) For example: `-Identity "site:Redmond"`. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -86,14 +107,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -When present, suppresses all error messages except for fatal errors. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -103,29 +126,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -139,14 +148,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.KerberosAccount.KerberosAccountAssignment object. +### Microsoft.Rtc.Management.WritableConfig.Settings.KerberosAccount.KerberosAccountAssignment + The `Remove-CsKerberosAccountAssignment` cmdlet accepts pipelined instances of the Kerberos account assignment object. ## OUTPUTS -### -None. +### None The `Remove-CsKerberosAccountAssignment` cmdlet does not return any objects or values. Instead, the cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.KerberosAccount.KerberosAccountAssignment object. diff --git a/skype/skype-ps/skype/Remove-CsLisLocation.md b/skype/skype-ps/SkypeForBusiness/Remove-CsLisLocation.md similarity index 56% rename from skype/skype-ps/skype/Remove-CsLisLocation.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsLisLocation.md index ccca42e1b3..edd1eb47f2 100644 --- a/skype/skype-ps/skype/Remove-CsLisLocation.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsLisLocation.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cslislocation applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsLisLocation -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cslislocation +schema: 2.0.0 +title: Remove-CsLisLocation --- # Remove-CsLisLocation @@ -51,7 +52,7 @@ You can use the `Remove-CsLisPort` cmdlet, the `Remove-CsLisSubnet` cmdlet, the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsLisLocation -Location Bldg30NEWing -HouseNumber 1000 -StreetName Main -City Redmond -State WA -Country US ``` @@ -63,7 +64,7 @@ If you don't supply parameter values for all non-null properties, the location w You will be prompted for any parameter that you haven't specified in the command, but if they contain null values you can simply press Enter at each prompt. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLisLocation -Unreferenced | Remove-CsLisLocation ``` @@ -77,13 +78,15 @@ This collection is then piped to the `Remove-CsLisLocation` cmdlet, which remove ## PARAMETERS ### -City + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The location city. ```yaml Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedMandatorySet, LocationEnumeratedOptionalSet +Aliases: Required: True Position: Named @@ -92,27 +95,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -CompanyName -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -CompanyName The name of the company at this location. ```yaml Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedMandatorySet, LocationEnumeratedOptionalSet +Aliases: Required: True Position: Named @@ -121,28 +113,17 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Country -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Country The country/region this location is in. This value will contain two characters or less. ```yaml Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedMandatorySet, LocationEnumeratedOptionalSet +Aliases: Required: True Position: Named @@ -151,28 +132,17 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -HouseNumber -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -HouseNumber The house number of the location. For a company this is the number on the street where the company is located. ```yaml Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedMandatorySet, LocationEnumeratedOptionalSet +Aliases: Required: True Position: Named @@ -181,28 +151,17 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -HouseNumberSuffix -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -HouseNumberSuffix Additional information for the house number, such as 1/2 or A. For example, 1234 1/2 Oak Street or 1234 A Elm Street. ```yaml Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedMandatorySet, LocationEnumeratedOptionalSet +Aliases: Required: True Position: Named @@ -211,27 +170,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Location -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Location The name for this location. ```yaml Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedMandatorySet, LocationEnumeratedOptionalSet +Aliases: Required: True Position: Named @@ -240,27 +188,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PostalCode -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PostalCode The postal code associated with this location. ```yaml Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedMandatorySet, LocationEnumeratedOptionalSet +Aliases: Required: True Position: Named @@ -269,28 +206,17 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PostDirectional -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PostDirectional The directional designation of a street name. For example, NE or NW for Main Street NE or 7th Avenue NW. ```yaml Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedMandatorySet, LocationEnumeratedOptionalSet +Aliases: Required: True Position: Named @@ -299,28 +225,17 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PreDirectional -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PreDirectional The directional designation for a street name that precedes the name of the street. For example, NE or NW for NE Main Street or NW 7th Avenue. ```yaml Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedMandatorySet, LocationEnumeratedOptionalSet +Aliases: Required: True Position: Named @@ -329,28 +244,17 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -State -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -State The state or province associated with this location. This value will be two characters or less. ```yaml Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedMandatorySet, LocationEnumeratedOptionalSet +Aliases: Required: True Position: Named @@ -359,27 +263,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -StreetName -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -StreetName The name of the street for this location. ```yaml Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedMandatorySet, LocationEnumeratedOptionalSet +Aliases: Required: True Position: Named @@ -388,27 +281,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -StreetSuffix -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -StreetSuffix The type of street designated in a street name, such as Street, Avenue, or Court. ```yaml Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedMandatorySet, LocationEnumeratedOptionalSet +Aliases: Required: True Position: Named @@ -417,27 +299,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -446,14 +317,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -467,14 +340,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String Accepts pipelined input of LIS location objects. ## OUTPUTS -### +### None This cmdlet does not return a value or object. -It removes an object of type System.Management.Automation.PSCustomObject. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsLisPort.md b/skype/skype-ps/SkypeForBusiness/Remove-CsLisPort.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsLisPort.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsLisPort.md index 6a06ce9cb4..03f90a2a94 100644 --- a/skype/skype-ps/skype/Remove-CsLisPort.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsLisPort.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cslisport applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsLisPort -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cslisport +schema: 2.0.0 +title: Remove-CsLisPort --- # Remove-CsLisPort @@ -40,7 +41,7 @@ If you attempt to remove a port that does not exist, no action will be taken and ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsLisPort -ChassisID 99-99-99-99-99-99 -PortID 4200 -PortIDSubType 1 ``` @@ -52,7 +53,7 @@ This parameter and value could also have been entered like this: `-PortIDSubType If this port was associated with a location, that location will not be removed, only the port will be removed from the location mapping. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLisPort | Where-Object {$_.HouseNumber -eq ""} | Remove-CsLisPort ``` @@ -70,14 +71,16 @@ You can remove locations by calling the `Remove-CsLisLocation` cmdlet. ## PARAMETERS ### -ChassisID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Media Access Control (MAC) address of the port's switch. This value will be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -87,13 +90,15 @@ Accept wildcard characters: False ``` ### -PortID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The ID of the port you want to remove. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -103,6 +108,9 @@ Accept wildcard characters: False ``` ### -PortIDSubType + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The subtype of the port you want to remove. This value can be entered as a numeric value or a string, but it must be a valid subtype. Valid subtypes are: @@ -116,8 +124,7 @@ Valid subtypes are: ```yaml Type: PortIDSubType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -126,14 +133,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -142,14 +151,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -163,14 +174,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String Accepts pipelined input of LIS port objects. ## OUTPUTS -### +### None This cmdlet does not return a value. -It removes an object of type System.Management.Automation.PSCustomObject. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsLisServiceProvider.md b/skype/skype-ps/SkypeForBusiness/Remove-CsLisServiceProvider.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsLisServiceProvider.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsLisServiceProvider.md index e7c73e5c72..6448c9c76b 100644 --- a/skype/skype-ps/skype/Remove-CsLisServiceProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsLisServiceProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cslisserviceprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsLisServiceProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cslisserviceprovider +schema: 2.0.0 +title: Remove-CsLisServiceProvider --- # Remove-CsLisServiceProvider @@ -31,7 +32,7 @@ This cmdlet removes an entry for a provider; after running this cmdlet there wil ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsLisServiceProvider ``` @@ -42,14 +43,16 @@ There will only be, at most, one service provider defined, which will be removed ## PARAMETERS -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -58,14 +61,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -79,14 +84,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String Accepts pipelined input of a Location Information Server (LIS) service provider object. ## OUTPUTS -### +### None This cmdlet does not return an object or a value. -It removes an object of type System.Management.Automation.PSCustomObject. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsLisSubnet.md b/skype/skype-ps/SkypeForBusiness/Remove-CsLisSubnet.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsLisSubnet.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsLisSubnet.md index 3ce56e33d1..094b852c16 100644 --- a/skype/skype-ps/skype/Remove-CsLisSubnet.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsLisSubnet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cslissubnet applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsLisSubnet -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cslissubnet +schema: 2.0.0 +title: Remove-CsLisSubnet --- # Remove-CsLisSubnet @@ -36,7 +37,7 @@ If you attempt to remove a subnet that does not exist, no action will be taken a ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsLisSubnet -Subnet 192.10.10.0 ``` @@ -48,7 +49,7 @@ The value of the Subnet in this example is an IPv4 address, 192.10.10.0. If this subnet is associated with a location, that location will not be removed, only the subnet will be removed from the location mapping. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLisSubnet | Where-Object {$_.Location -eq "Bldg30/Room1000"} | Remove-CsLisSubnet ``` @@ -65,6 +66,9 @@ You can remove locations by calling the `Remove-CsLisLocation` cmdlet. ## PARAMETERS ### -Subnet + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The IP address of the subnet you want to remove. This value will be an IPv4 address (digits separated by periods, such as 192.0.2.0). @@ -72,8 +76,7 @@ This value will be an IPv4 address (digits separated by periods, such as 192.0.2 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -82,14 +85,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -98,14 +103,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -119,13 +126,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String Accepts pipelined input of Location Information Server (LIS) subnet objects. ## OUTPUTS -### -This cmdlet removes an object of type System.Management.Automation.PSCustomObject. +### None +This cmdlet does not return an object or a value. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsLisSwitch.md b/skype/skype-ps/SkypeForBusiness/Remove-CsLisSwitch.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsLisSwitch.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsLisSwitch.md index 5ef8122f1d..489a9e8fbd 100644 --- a/skype/skype-ps/skype/Remove-CsLisSwitch.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsLisSwitch.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cslisswitch applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsLisSwitch -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cslisswitch +schema: 2.0.0 +title: Remove-CsLisSwitch --- # Remove-CsLisSwitch @@ -39,7 +40,7 @@ If you attempt to remove a switch that does not exist, no action will be taken a ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsLisSwitch -ChassisID 99-99-99-99-99-99 ``` @@ -50,7 +51,7 @@ This command will not succeed if the ChassisID is referenced by a port. Also, if this switch was associated with a location, that location will not be removed, only the switch will be removed from the location mapping. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLisSwitch | Where-Object {$_.City -eq ""} | Remove-CsLisSwitch ``` @@ -68,14 +69,16 @@ You can remove locations by calling the `Remove-CsLisLocation` cmdlet. ## PARAMETERS ### -ChassisID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Media Access Control (MAC) address of the network switch. This value will be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -84,14 +87,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -100,14 +105,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -121,14 +128,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String Accepts pipelined input of LIS switch objects. ## OUTPUTS -### +### None This cmdlet does not return a value. -It removes an object of type System.Management.Automation.PSCustomObject. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsLisWirelessAccessPoint.md b/skype/skype-ps/SkypeForBusiness/Remove-CsLisWirelessAccessPoint.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsLisWirelessAccessPoint.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsLisWirelessAccessPoint.md index 044104f835..8e66321086 100644 --- a/skype/skype-ps/skype/Remove-CsLisWirelessAccessPoint.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsLisWirelessAccessPoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csliswirelessaccesspoint applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsLisWirelessAccessPoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csliswirelessaccesspoint +schema: 2.0.0 +title: Remove-CsLisWirelessAccessPoint --- # Remove-CsLisWirelessAccessPoint @@ -36,7 +37,7 @@ If you attempt to remove a WAP that does not exist, no action will be taken and ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsLisWirelessAccessPoint -BSSID 99-99-99-99-99-99 ``` @@ -46,7 +47,7 @@ Example 1 removes the LIS WAP location with the BSSID 99-99-99-99-99-99. If this WAP was associated with a location, that location will not be removed, only the WAP will be removed from the location mapping. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLisWirelessAccessPoint | Where-Object {$_.Location -like "*Bldg30*"} | Remove-CsLisWirelessAccessPoint ``` @@ -62,14 +63,16 @@ Note that, as in Example 1, no locations are removed from the location configura ## PARAMETERS ### -BSSID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Basic Service Set Identifier (BSSID) of the wireless access point you want to remove. This value will be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -78,14 +81,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -94,14 +99,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -115,13 +122,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String Accepts pipelined input of LIS wireless access point objects. ## OUTPUTS -### -This cmdlet removes an object of type System.Management.Automation.PSCustomObject. +### None +This cmdlet does not return an object or a value. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsLocationPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsLocationPolicy.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsLocationPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsLocationPolicy.md index b6aa1cf457..c06fe6833a 100644 --- a/skype/skype-ps/skype/Remove-CsLocationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsLocationPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cslocationpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsLocationPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cslocationpolicy +schema: 2.0.0 +title: Remove-CsLocationPolicy --- # Remove-CsLocationPolicy @@ -38,7 +39,7 @@ If this cmdlet is run against a per-user location policy that is assigned to use ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsLocationPolicy -Identity Reno ``` @@ -48,7 +49,7 @@ When a per-user policy is removed, users or groups who were assigned that policy If no policy has been configured for their site, then these users and groups will use the global location policy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLocationPolicy | Where-Object {$_.EnhancedEmergencyServicesEnabled -eq $false} | Remove-CsLocationPolicy ``` @@ -61,7 +62,29 @@ Finally, this filtered collection is passed to the `Remove-CsLocationPolicy` cmd ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifying this parameter will bypass any confirmation prompts and the deletion will occur without any warning notice. +For example, if a per-user location policy is assigned to one or more users, a confirmation prompt will be displayed before deletion if this parameter is not included in the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the location policy you want to remove. To remove the global location policy (which simply resets that policy to its default values), use a value of Global. For a policy created at the site scope, this value will be in the form site:\, where site name is the name of a site defined in the Skype for Business Server deployment (for example, site:Redmond). @@ -71,8 +94,7 @@ For a policy created at the per-user scope, this value will simply be the name o ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -81,31 +103,23 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Specifying this parameter will bypass any confirmation prompts and the deletion will occur without any warning notice. -For example, if a per-user location policy is assigned to one or more users, a confirmation prompt will be displayed before deletion if this parameter is not included in the command. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the location policy is being removed. +For example: -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -115,13 +129,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -130,21 +146,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the location policy is being removed. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -158,13 +169,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationPolicy + Accepts pipelined input of location policy objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationPolicy This cmdlet does not return a value or object. Instead, the cmdlet removes instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationPolicy object. diff --git a/skype/skype-ps/skype/Remove-CsManagementConnection.md b/skype/skype-ps/SkypeForBusiness/Remove-CsManagementConnection.md similarity index 92% rename from skype/skype-ps/skype/Remove-CsManagementConnection.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsManagementConnection.md index 6df3c26265..2c203c83e7 100644 --- a/skype/skype-ps/skype/Remove-CsManagementConnection.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsManagementConnection.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csmanagementconnection applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsManagementConnection -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csmanagementconnection +schema: 2.0.0 +title: Remove-CsManagementConnection --- # Remove-CsManagementConnection @@ -41,7 +42,7 @@ Note, too that this cmdlet only affects the management connection information fo ## EXAMPLES -### ------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsManagementConnection ``` @@ -51,14 +52,16 @@ The command shown in Example 1 removes the existing management connection inform ## PARAMETERS -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -67,14 +70,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -88,14 +93,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Remove-CsManagementConnection` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsManagementConnection` cmdlet deletes instances of the Microsoft.Rtc.Management.Xds.ManagementConnection object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsMcxConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsMcxConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsMcxConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsMcxConfiguration.md index 87060d1bca..fdfe04428c 100644 --- a/skype/skype-ps/skype/Remove-CsMcxConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsMcxConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csmcxconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsMcxConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csmcxconfiguration +schema: 2.0.0 +title: Remove-CsMcxConfiguration --- # Remove-CsMcxConfiguration @@ -46,7 +47,7 @@ Instead, the properties in the global collection will simply be reset to their d ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsMcxConfiguration -Identity "site:Redmond" ``` @@ -54,7 +55,7 @@ Remove-CsMcxConfiguration -Identity "site:Redmond" The command shown in Example 1 deletes the collection of Mobility Service configuration settings assigned to the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMcxConfiguration -Filter "service:*" | Remove-CsMcxConfiguration ``` @@ -64,7 +65,7 @@ To do this, the `Get-CsMcxConfiguration` cmdlet is used along with the Filter pa That filtered collection is then piped to and deleted by, the `Remove-CsMcxConfiguration` cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsMcxConfiguration | Where-Object {$_.ExposedWebURL -eq "Internal"} | Remove-CsMcxConfiguration ``` @@ -75,7 +76,7 @@ This collection is then piped to the `Where-Object` cmdlet, which picks out only In turn, that filtered collection is piped to the `Remove-CsMcxConfiguration` cmdlet, which deletes each item in that filtered collection. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsMcxConfiguration | Where-Object {$_.PushNotificationProxyUri -eq $Null} | Remove-CsMcxConfiguration ``` @@ -88,7 +89,28 @@ Any settings that meet that criterion are then piped to and deleted by, the `Rem ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the Mobility Service configuration settings to be removed. To "remove" the global settings, use this syntax: @@ -109,8 +131,7 @@ You cannot use wildcards when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -120,13 +141,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -135,30 +158,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -172,14 +181,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WriteableConfig.Settings.McxConfiguration.McxConfiguration. +### Microsoft.Rtc.Management.WriteableConfig.Settings.McxConfiguration.McxConfiguration The `Remove-CsMcxConfiguration` cmdlet accepts pipelined input of McxConfiguration objects. ## OUTPUTS -### -None. +### Microsoft.Rtc.Management.WritableConfig.Settings.McxConfiguration.McxConfiguration Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.McxConfiguration.McxConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsMediaConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsMediaConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Remove-CsMediaConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsMediaConfiguration.md index afa18b9584..6365d50fec 100644 --- a/skype/skype-ps/skype/Remove-CsMediaConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsMediaConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csmediaconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsMediaConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csmediaconfiguration +schema: 2.0.0 +title: Remove-CsMediaConfiguration --- # Remove-CsMediaConfiguration @@ -33,7 +34,7 @@ In that case, however, the settings will not actually be removed; instead, they ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsMediaConfiguration -Identity site:Redmond1 ``` @@ -42,7 +43,7 @@ In Example 1, the `Remove-CsMediaConfiguration` cmdlet is used to delete the med When media settings are removed from the site scope, that site will automatically begin to use the global media settings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMediaConfiguration | Where-Object {$_.EncryptionLevel -eq "RequireEncryption"} | Remove-CsMediaConfiguration ``` @@ -53,7 +54,7 @@ That information is then piped to the `Where-Object` cmdlet, which applies a fil Finally, that filtered set of data is passed to the `Remove-CsMediaConfiguration` cmdlet, which deletes each item in the set. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsMediaConfiguration -Filter service:* | Remove-CsMediaConfiguration ``` @@ -66,15 +67,35 @@ That set of collections is then piped the `Remove-CsMediaConfiguration` cmdlet, ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the media configuration settings you want to remove. This identifier specifies the scope at which this configuration is applied (global, site, or service). ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -83,14 +104,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -100,29 +123,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -136,13 +145,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings + Accepts pipelined input of media configuration objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings Removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsMeetingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsMeetingConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsMeetingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsMeetingConfiguration.md index 29096e1294..a6d14f9722 100644 --- a/skype/skype-ps/skype/Remove-CsMeetingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsMeetingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csmeetingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsMeetingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csmeetingconfiguration +schema: 2.0.0 +title: Remove-CsMeetingConfiguration --- # Remove-CsMeetingConfiguration @@ -41,7 +42,7 @@ Instead, all the properties in the global collection will be reset to their defa ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsMeetingConfiguration -Identity site:Redmond ``` @@ -50,7 +51,7 @@ In Example 1, the meeting configuration settings that have the Identity site:Red When these settings are removed from the Redmond site users in that site will automatically inherit the global meeting configuration settings. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsMeetingConfiguration -Filter "site:*" | Remove-CsMeetingConfiguration ``` @@ -60,7 +61,7 @@ To do this, the command first calls the `Get-CsMeetingConfiguration` cmdlet alon This filtered collection is then piped to the `Remove-CsMeetingConfiguration` cmdlet, which deletes each item in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsMeetingConfiguration | Where-Object {$_.AdmitAnonymousUsersByDefault -eq $True} | Remove-CsMeetingConfiguration ``` @@ -73,7 +74,28 @@ The filtered collection is then piped to the `Remove-CsMeetingConfiguration` cmd ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the meeting configuration settings to be removed. To "remove" the global settings, use this syntax: `-Identity global`. (As noted previously, you cannot actually remove the global settings; all you can do is reset the properties to their default values.) To remove settings from the site scope, use syntax similar to this: `-Identity site:Redmond.` @@ -84,8 +106,7 @@ Note that you cannot use wildcards when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -94,23 +115,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant Globally unique identifier (GUID) of the Skype for Business Online tenant account for the meeting configuration settings being deleted. For example: @@ -124,8 +132,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,14 +141,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -150,14 +159,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -171,14 +182,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.MeetingConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.MeetingConfiguration + The `Remove-CsMeetingConfiguration` cmdlet accepts pipelined instances of the meeting configuration object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsMeetingConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.MeetingConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsMobilityPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsMobilityPolicy.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsMobilityPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsMobilityPolicy.md index bf1e210f0e..04b38c6434 100644 --- a/skype/skype-ps/skype/Remove-CsMobilityPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsMobilityPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csmobilitypolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsMobilityPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/remove-csmobilitypolicy +schema: 2.0.0 +title: Remove-CsMobilityPolicy --- # Remove-CsMobilityPolicy @@ -53,7 +55,7 @@ In this case, that means enabling Call via Work. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsMobilityPolicy -Identity "site:Redmond" ``` @@ -62,7 +64,7 @@ The command shown in Example 1 removes the mobility policy configured for the Re When the policy is removed, users previously managed by the Redmond site policy will now be managed by the global policy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMobilityPolicy -Filter "tag:*" | Remove-CsMobilityPolicy ``` @@ -72,7 +74,7 @@ To do this, the command first uses the `Get-CsMobilityPolicy` cmdlet and the Fil That collection of per-user policies is then piped to the `Remove-CsMobilityPolicy` cmdlet, which deletes each policy in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsMobilityPolicy | Where-Object {$_.EnableOutsideVoice -eq $False} | Remove-CsMobilityPolicy ``` @@ -85,7 +87,34 @@ Any policies where EnableOutsideVoice is False are then piped to and removed by, ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +If this parameter is present, the policy will be removed even if it is currently assigned to at least one user. +If this parameter is not present, then the `Remove-CsMobilityPolicy` cmdlet will not automatically remove a per-user policy that is assigned to at least one user. +Instead, a confirmation prompt will appear asking if you are sure that you want to remove the policy. +You must answer yes (by pressing the Y key) before the command will continue and the policy is removed. + +This parameter applies only to per-user policies. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the client policy to be removed. To "remove" the global policy, use the following syntax: @@ -108,8 +137,7 @@ You cannot use wildcards when specifying a policy Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -118,37 +146,24 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Tenant +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the mobility policy is being removed. +For example: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` -### -Force -If this parameter is present, the policy will be removed even if it is currently assigned to at least one user. -If this parameter is not present, then the `Remove-CsMobilityPolicy` cmdlet will not automatically remove a per-user policy that is assigned to at least one user. -Instead, a confirmation prompt will appear asking if you are sure that you want to remove the policy. -You must answer yes (by pressing the Y key) before the command will continue and the policy is removed. +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: -This parameter applies only to per-user policies. +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -157,15 +172,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -174,22 +191,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the mobility policy is being removed. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -203,14 +215,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WriteableConfig.Policy.Mobility.Mobility. +### Microsoft.Rtc.Management.WriteableConfig.Policy.Mobility.Mobility The `Remove-CsMobilityPolicy` cmdlet accepts pipelined instances of the Mobility object. ## OUTPUTS -### -None. +### Microsoft.Rtc.Management.WriteableConfig.Policy.Mobility.Mobility Instead, the `Remove-CsMobilityPolicy` cmdlet deletes instances of the Microsoft.Rtc.Management.WriteableConfig.Policy.Mobility.Mobility object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsNetworkBandwidthPolicyProfile.md b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkBandwidthPolicyProfile.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsNetworkBandwidthPolicyProfile.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsNetworkBandwidthPolicyProfile.md index 134bd4667f..db2ebe9665 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkBandwidthPolicyProfile.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkBandwidthPolicyProfile.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkbandwidthpolicyprofile applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsNetworkBandwidthPolicyProfile -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkbandwidthpolicyprofile +schema: 2.0.0 +title: Remove-CsNetworkBandwidthPolicyProfile --- # Remove-CsNetworkBandwidthPolicyProfile @@ -35,7 +36,7 @@ You must first remove the profile from all sites, inter-site policies and networ ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsNetworkBandwidthPolicyProfile -Identity LowBWProfile ``` @@ -44,7 +45,7 @@ This example removes the bandwidth policy profile with the Identity LowBWProfile Because identities must be unique this will remove, at most, one profile. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkSite | Where-Object {$_.BWPolicyProfileID -eq "LowBWProfile"} | Set-CsNetworkSite -BWPolicyProfileID $null @@ -64,15 +65,35 @@ To ensure that the profile is not in use anywhere in the network configuration, ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A string value that uniquely identifies the bandwidth policy profile you want to remove. Specifying an Identity will remove, at most, one profile. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -81,14 +102,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -98,29 +121,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -134,13 +143,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType + Accepts pipelined input of network bandwidth policy profile objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType. diff --git a/skype/skype-ps/skype/Remove-CsNetworkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkConfiguration.md similarity index 82% rename from skype/skype-ps/skype/Remove-CsNetworkConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsNetworkConfiguration.md index ae7068d77e..0266ade8c6 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsNetworkConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkconfiguration +schema: 2.0.0 +title: Remove-CsNetworkConfiguration --- # Remove-CsNetworkConfiguration @@ -30,7 +31,7 @@ WARNING: Running this cmdlet will delete an entire network configuration, includ ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsNetworkConfiguration -Identity Global -Confirm ``` @@ -41,14 +42,34 @@ The Confirm parameter is used so you'll be prompted to verify you really want to ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This will always be Global. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -57,14 +78,17 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. +It is recommended that you always use this parameter with this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -74,30 +98,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. -It is recommended that you always use this parameter with this cmdlet. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -111,13 +120,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkConfigurationSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkConfigurationSettings + Accepts pipelined input of a network configuration object. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkConfigurationSettings This cmdlet does not return an object. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkConfigurationSettings object. diff --git a/skype/skype-ps/skype/Remove-CsNetworkInterRegionRoute.md b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkInterRegionRoute.md similarity index 85% rename from skype/skype-ps/skype/Remove-CsNetworkInterRegionRoute.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsNetworkInterRegionRoute.md index 3df20e1a1b..1426cfadad 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkInterRegionRoute.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkInterRegionRoute.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkinterregionroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsNetworkInterRegionRoute -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkinterregionroute +schema: 2.0.0 +title: Remove-CsNetworkInterRegionRoute --- # Remove-CsNetworkInterRegionRoute @@ -32,7 +33,7 @@ This cmdlet removes one of these route associations. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsNetworkInterRegionRoute -Identity NA_APAC_Route ``` @@ -40,7 +41,7 @@ Remove-CsNetworkInterRegionRoute -Identity NA_APAC_Route Example 1 removes the route with the Identity NA_APAC_Route. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkInterRegionRoute | Where-Object {$_.NetworkRegionID1 -eq "NorthAmerica" -or $_.NetworkRegionID2 -eq "NorthAmerica"} | Remove-CsNetworkInterRegionRoute ``` @@ -56,7 +57,28 @@ Once the collection contains only the routes that include the NorthAmerica regio ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier for the network region route you want to remove. Network region routes are created only at the global scope, so this identifier does not need to specify a scope. Instead, it contains a string that is a unique name that identifies that route. @@ -64,8 +86,7 @@ Instead, it contains a string that is a unique name that identifies that route. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -74,14 +95,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -91,29 +114,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -127,13 +136,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkRegionRouteType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkRegionRouteType + Accepts pipelined input of network inter-region route objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkRegionRouteType This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkRegionRouteType. diff --git a/skype/skype-ps/skype/Remove-CsNetworkInterSitePolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkInterSitePolicy.md similarity index 83% rename from skype/skype-ps/skype/Remove-CsNetworkInterSitePolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsNetworkInterSitePolicy.md index 8dc5aaec89..f93adff410 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkInterSitePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkInterSitePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkintersitepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsNetworkInterSitePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkintersitepolicy +schema: 2.0.0 +title: Remove-CsNetworkInterSitePolicy --- # Remove-CsNetworkInterSitePolicy @@ -31,7 +32,7 @@ This cmdlet removes a network site policy that associates a bandwidth limitation ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsNetworkInterSitePolicy -Identity Reno_Portland ``` @@ -39,7 +40,7 @@ Remove-CsNetworkInterSitePolicy -Identity Reno_Portland This example removes the network site policy with the Identity Reno_Portland. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkInterSitePolicy | Remove-CsNetworkInterSitePolicy ``` @@ -51,7 +52,28 @@ That collection is then piped to the `Remove-CsNetworkInterSitePolicy` cmdlet, w ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the network site policy you want to remove. Network site policies are created only at the global scope, so this identifier does not need to specify a scope. Instead, it contains a string that is a unique name that identifies that site policy. @@ -59,8 +81,7 @@ Instead, it contains a string that is a unique name that identifies that site po ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -69,14 +90,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -86,29 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -122,13 +131,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkSitePolicyType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkSitePolicyType + Accepts pipelined input of network inter-site policy objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkSitePolicyType This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkSitePolicyType. diff --git a/skype/skype-ps/skype/Remove-CsNetworkRegion.md b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkRegion.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsNetworkRegion.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsNetworkRegion.md index 3f35e18280..438a3ec194 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkRegion.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkRegion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkregion applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsNetworkRegion -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkregion +schema: 2.0.0 +title: Remove-CsNetworkRegion --- # Remove-CsNetworkRegion @@ -37,7 +38,7 @@ If you attempt to remove a region associated with a site you'll receive an error ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsNetworkRegion -Identity NorthAmerica ``` @@ -46,7 +47,7 @@ Example 1 removes the network region with the Identity NorthAmerica. Because identities are unique this command removes only one network region. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkRegion | Where-Object {$_.CentralSite -eq "site:Redmond"} | Remove-CsNetworkRegion ``` @@ -58,7 +59,7 @@ The `Where-Object` cmdlet filters this collection to return only those items (ne After narrowing the collection down to those items, this new collection is piped to the `Remove-CsNetworkRegion` cmdlet, which removes every item in that collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsNetworkSite | Where-Object {$_.NetworkRegionID -eq "NorthAmerica"} | Set-CsNetworkSite -NetworkRegionID $null -BypassID $null @@ -84,15 +85,35 @@ At this point we can call line 2, which removes the network region. ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the network region you want to remove. The Identity will be in the form of a string that uniquely identifies that region. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -101,14 +122,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -118,29 +141,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -154,13 +163,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType + Accepts pipelined input of network region objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType. diff --git a/skype/skype-ps/skype/Remove-CsNetworkRegionLink.md b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkRegionLink.md similarity index 83% rename from skype/skype-ps/skype/Remove-CsNetworkRegionLink.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsNetworkRegionLink.md index 57fec11fcc..0066fd5907 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkRegionLink.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkRegionLink.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkregionlink applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsNetworkRegionLink -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworkregionlink +schema: 2.0.0 +title: Remove-CsNetworkRegionLink --- # Remove-CsNetworkRegionLink @@ -31,7 +32,7 @@ This cmdlet does not impact any physical connections, but it does remove the lin ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsNetworkRegionLink -Identity NA_EMEA ``` @@ -39,7 +40,7 @@ Remove-CsNetworkRegionLink -Identity NA_EMEA This first example removes the network region link with the Identity NA_EMEA. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkRegionLink | Where-Object {$_.BWPolicyProfileID -eq "HighBWLimits"} | Remove-CsNetworkRegionLink ``` @@ -53,7 +54,28 @@ If this property is equal to (-eq) HighBWLimits, we pipe that member to the `Rem ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the network region link you want to remove. Network region links are created only at the global scope, so this identifier does not need to specify a scope. Instead, it contains a string that is a unique name that identifies that link. @@ -61,8 +83,7 @@ Instead, it contains a string that is a unique name that identifies that link. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -71,14 +92,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -88,29 +111,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -124,13 +133,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionLinkType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionLinkType + Accepts pipelined input of network region link objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionLinkType This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionLinkType. diff --git a/skype/skype-ps/skype/Remove-CsNetworkSite.md b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkSite.md similarity index 82% rename from skype/skype-ps/skype/Remove-CsNetworkSite.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsNetworkSite.md index 385a4f9411..cb5d6f9ad6 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkSite.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkSite.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworksite applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsNetworkSite -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworksite +schema: 2.0.0 +title: Remove-CsNetworkSite --- # Remove-CsNetworkSite @@ -30,7 +31,7 @@ This cmdlet removes a site from the CAC or E9-1-1 configuration. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsNetworkSite -Identity Vancouver ``` @@ -38,7 +39,7 @@ Remove-CsNetworkSite -Identity Vancouver This example removes the site with the Identity Vancouver from the CAC or E9-1-1 configuration. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkSite | Where-Object {$_.BWPolicyProfileID -eq "LowBWProfile"} | Remove-CsNetworkSite ``` @@ -51,7 +52,28 @@ This new collection is then piped to the `Remove-CsNetworkSite` cmdlet to remove ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the network site you want to remove. Sites are created only at the global scope, so you do not need to specify a scope. Instead, you need to specify only the site ID. @@ -59,8 +81,7 @@ Instead, you need to specify only the site ID. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -69,14 +90,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -86,29 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -122,13 +131,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType + Accepts pipelined input of network site objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType. diff --git a/skype/skype-ps/skype/Remove-CsNetworkSubnet.md b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkSubnet.md similarity index 83% rename from skype/skype-ps/skype/Remove-CsNetworkSubnet.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsNetworkSubnet.md index 60a89146b9..57cccff9cb 100644 --- a/skype/skype-ps/skype/Remove-CsNetworkSubnet.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsNetworkSubnet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworksubnet applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsNetworkSubnet -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csnetworksubnet +schema: 2.0.0 +title: Remove-CsNetworkSubnet --- # Remove-CsNetworkSubnet @@ -31,7 +32,7 @@ Use this cmdlet to remove a network subnet. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsNetworkSubnet -Identity 172.11.15.0 ``` @@ -39,7 +40,7 @@ Remove-CsNetworkSubnet -Identity 172.11.15.0 This example removes the subnet with the Identity (the Subnet ID) 172.11.15.0. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkSubnet | Where-Object {$_.NetworkSiteID -eq "Vancouver"} | Remove-CsNetworkSubnet ``` @@ -54,15 +55,35 @@ Now that the collection consists only of subnets associated with the Vancouver s ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique subnet ID of the subnet you want to remove. This value will be an IP address (such as 174.11.12.0). ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -71,14 +92,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -88,29 +111,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -124,13 +133,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.SubnetType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.SubnetType + Accepts pipelined input of network subnet objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.SubnetType This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.SubnetType. diff --git a/skype/skype-ps/skype/Remove-CsOAuthServer.md b/skype/skype-ps/SkypeForBusiness/Remove-CsOAuthServer.md similarity index 85% rename from skype/skype-ps/skype/Remove-CsOAuthServer.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsOAuthServer.md index 8841ad2fa5..fb06c5e6d6 100644 --- a/skype/skype-ps/skype/Remove-CsOAuthServer.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsOAuthServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csoauthserver applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsOAuthServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csoauthserver +schema: 2.0.0 +title: Remove-CsOAuthServer --- # Remove-CsOAuthServer @@ -39,7 +40,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsOAuthServer -Identity "Office365" ``` @@ -47,7 +48,7 @@ Remove-CsOAuthServer -Identity "Office365" The command shown in Example 1 deletes a single OAuth server: the server with the identity "Office 365". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsOAuthServer | Remove-CsOAuthServer ``` @@ -59,33 +60,16 @@ These servers are then piped to, and removed by, the `Remove-CsOAuthServer` cmdl ## PARAMETERS -### -Identity -Unique identifier for the OAuth server to be deleted. -For example: - -`-Identity "Office 365"` - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -94,23 +78,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the OAuth server to be deleted. +For example: + +`-Identity "Office 365"` ```yaml -Type: SwitchParameter +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for the OAuth server being deleted. For example: @@ -125,8 +117,25 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -136,13 +145,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -156,14 +167,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.OAuthServer#Decorated The `Remove-CsOAuthServer` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.OAuthServer#Decorated object. ## OUTPUTS -### -None. -Instead, the `Remove-CsOAuthServer` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.OAuthServer#Decorated object. +### None +This cmdlet does not return a value or object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsOutboundCallingNumberTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Remove-CsOutboundCallingNumberTranslationRule.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsOutboundCallingNumberTranslationRule.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsOutboundCallingNumberTranslationRule.md index 340683cf93..9062a4c281 100644 --- a/skype/skype-ps/skype/Remove-CsOutboundCallingNumberTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsOutboundCallingNumberTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csoutboundcallingnumbertranslationrule applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsOutboundCallingNumberTranslationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csoutboundcallingnumbertranslationrule +schema: 2.0.0 +title: Remove-CsOutboundCallingNumberTranslationRule --- # Remove-CsOutboundCallingNumberTranslationRule @@ -41,7 +42,7 @@ Select the rule to be deleted and then click Remove. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsOutboundCallingNumberTranslationRule -Identity "site:Redmond/SevenDigit" ``` @@ -49,7 +50,7 @@ Remove-CsOutboundCallingNumberTranslationRule -Identity "site:Redmond/SevenDigit The command shown in Example 1 removes the outbound calling number translation rule that has the Identity site:Redmond/SevenDigit. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Remove-CsOutboundCallingNumberTranslationRule -Identity "site:Redmond" ``` @@ -58,7 +59,7 @@ In Example 2, all the outbound calling number translation rules configured for t To do this, the command calls the `Remove-CsOutboundCallingNumberTranslationRule` cmdlet along with the Identity parameter; the parameter value "site:Redmond" ensures that all the translation rules configured for the Redmond site will be removed. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsOutboundCallingNumberTranslationRule | Where-Object {$_.Pattern -eq '^\+1425(\d{7})$'} | Remove-CsOutboundCallingNumberTranslationRule ``` @@ -71,7 +72,28 @@ That filtered collection is then piped to the `Remove-CsOutboundCallingNumberTra ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the outbound translation rule you want to remove. The Identity consists of the scope followed by a unique name within each scope. For example: @@ -81,8 +103,7 @@ For example: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -92,13 +113,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -107,30 +130,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -144,14 +153,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.CallingNumberTranslationRule#Decorated The `Remove-CsOutboundCallingNumberTranslationRule` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.CallingNumberTranslationRule#Decorated object. ## OUTPUTS -### -None. -Instead, the `Remove-CsOutboundCallingNumberTranslationRule` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.CallingNumberTranslationRule#Decorated object. +### None +This cmdlet does not return a value or object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsOutboundTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Remove-CsOutboundTranslationRule.md similarity index 85% rename from skype/skype-ps/skype/Remove-CsOutboundTranslationRule.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsOutboundTranslationRule.md index 4ead086ae1..76ec8bbd0f 100644 --- a/skype/skype-ps/skype/Remove-CsOutboundTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsOutboundTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csoutboundtranslationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsOutboundTranslationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csoutboundtranslationrule +schema: 2.0.0 +title: Remove-CsOutboundTranslationRule --- # Remove-CsOutboundTranslationRule @@ -36,7 +37,7 @@ That means that using this cmdlet to remove a rule will remove it from the trunk ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsOutboundTranslationRule -Identity "site:Redmond/Prefix Redmond" ``` @@ -45,7 +46,7 @@ This example removes an existing outbound translation rule for site Redmond name Identities are unique, so this command will delete a single rule. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsOutboundTranslationRule -Filter site:* | Remove-CsOutboundTranslationRule ``` @@ -57,7 +58,28 @@ This collection is then piped to the `Remove-CsOutboundTranslationRule` cmdlet, ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the outbound translation rule you want to remove. The Identity consists of the scope followed by a unique name within each scope. For example, `site:Redmond/OutboundRule1`. @@ -65,8 +87,7 @@ For example, `site:Redmond/OutboundRule1`. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -75,14 +96,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -92,29 +115,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -128,13 +137,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TranslationRule object. +### Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TranslationRule + Accepts pipelined input of outbound translation rule objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TranslationRule. diff --git a/skype/skype-ps/skype/Remove-CsPartnerApplication.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPartnerApplication.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsPartnerApplication.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPartnerApplication.md index 1095f08f13..6ec4cb8ac7 100644 --- a/skype/skype-ps/skype/Remove-CsPartnerApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPartnerApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspartnerapplication applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsPartnerApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspartnerapplication +schema: 2.0.0 +title: Remove-CsPartnerApplication --- # Remove-CsPartnerApplication @@ -39,7 +40,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsPartnerApplication -Identity "MicrosoftExchange" ``` @@ -47,7 +48,7 @@ Remove-CsPartnerApplication -Identity "MicrosoftExchange" The command shown in Example 1 deletes the partner application with the Identity "MicrosoftExchange". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPartnerApplication | Remove-CsPartnerApplication ``` @@ -57,7 +58,7 @@ To do this, the command first uses the `Get-CsPartnerApplication` cmdlet in orde This collection is then piped to the `Remove-CsPartnerApplication` cmdlet, which deletes each application in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPartnerApplication | Where-Object {$_.ApplicationTrustLevel -ne "Full"} | Remove-CsPartnerApplication ``` @@ -70,7 +71,28 @@ The applications that meet that criterion are then piped to and removed by, the ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the partner application to be removed. For example: @@ -81,8 +103,7 @@ Note that you cannot use wildcard characters when specifying an Identity. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -91,30 +112,24 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for the partner application being deleted. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -123,22 +138,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for the partner application being deleted. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` - -You can return the tenant ID for each of your tenants by running this command: +### -Confirm -`Get-CsTenant | Select-Object DisplayName, TenantID` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -148,13 +157,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -168,14 +179,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.PartnerApplication#Decorated The `Remove-CsPartnerApplication` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.PartnerApplication#Decorated object. ## OUTPUTS -### -None. -Instead, the `Remove-CsPartnerApplication` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.PartnerApplication#Decorated object. +### None +This cmdlet does not return a value or object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatAddin.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatAddin.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsPersistentChatAddin.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatAddin.md index 40d9000d06..0a0ff2e78b 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatAddin.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatAddin.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchataddin applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsPersistentChatAddin -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchataddin +schema: 2.0.0 +title: Remove-CsPersistentChatAddin --- # Remove-CsPersistentChatAddin @@ -47,7 +48,7 @@ Select the add-in to be removed, click Edit and then click Delete. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsPersistentChatAddin -Identity "atl-cs-001.litwareinc.com\ITChatAddin" ``` @@ -55,7 +56,7 @@ Remove-CsPersistentChatAddin -Identity "atl-cs-001.litwareinc.com\ITChatAddin" Example 1 removes the Persistent Chat add-in ITChatAddin found on the pool `atl-cs-001.litwareinc.com`. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatAddin | Remove-CsPersistentChatAddin ``` @@ -67,7 +68,28 @@ This collection is piped to the `Remove-CsPersistentChatAddin` cmdlet, which the ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Suppresses the display of any non-fatal error message that might occur when running the command; for example, attempting to remove an add-in that is currently associated with one or more chat rooms. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the Persistent Chat add-in to be removed. The Identity is composed of the fully qualified domain name of the Persistent Chat pool where the add-in is located, a "\" character and the add-in name. For example: @@ -77,8 +99,7 @@ For example: ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 1 @@ -88,13 +109,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Allows you to pass a reference to an object to the cmdlet. ```yaml Type: Addin Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 1 @@ -104,13 +127,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -119,30 +144,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command; for example, attempting to remove an add-in that is currently associated with one or more chat rooms. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -156,15 +167,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.PersistentChat.Cmdlets.AddinObject The `Remove-CsPersistentChatAddin` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.AddinObject object. The cmdlet will also accept a string value representing the Identity of an existing add-in. ## OUTPUTS -### -None. -Instead, the `Remove-CsPersistentChatAddin` cmdlet deletes existing instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.AddinObject object. +### None +This cmdlet does not return a value or object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatCategory.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatCategory.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsPersistentChatCategory.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatCategory.md index 658c5fe6a8..3afcab77ec 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatCategory.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatCategory.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatcategory applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsPersistentChatCategory -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatcategory +schema: 2.0.0 +title: Remove-CsPersistentChatCategory --- # Remove-CsPersistentChatCategory @@ -53,7 +54,7 @@ Select the category to be removed, click Edit and then click Delete. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsPersistentChatCategory -Identity "atl-cs-001.litwareinc.com\helpdesk" ``` @@ -61,7 +62,7 @@ Remove-CsPersistentChatCategory -Identity "atl-cs-001.litwareinc.com\helpdesk" The command shown in Example 1 removes the Persistent Chat category that has the Identity `"atl-cs-001.litwareinc.com\helpdesk"`. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatCategory | Remove-CsPersistentChatCategory ``` @@ -74,6 +75,9 @@ This collection is piped to the `Remove-CsPersistentChatCategory` cmdlet, which ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the Persistent Chat category to be removed. An Identity consists of the PoolFqdn plus the category Name; for example: @@ -82,8 +86,7 @@ An Identity consists of the PoolFqdn plus the category Name; for example: ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 1 @@ -93,13 +96,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Allows you to pass a reference to an object to the cmdlet. ```yaml Type: Category Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 1 @@ -109,13 +114,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -125,13 +132,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -145,15 +154,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.PersistentChat.Cmdlets.CategoryObject The `Remove-CsPersistentChatCategory` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.CategoryObject object. The cmdlet will also accept string values representing the Identity of an existing Persistent Chat category. ## OUTPUTS -### -None. -Instead, the `Remove-CsPersistentChatCategory` cmdlet deletes existing instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.CategoryObject object. +### None +This cmdlet does not return a value or object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatComplianceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatComplianceConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsPersistentChatComplianceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatComplianceConfiguration.md index cfca03a5d7..99569100e9 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatComplianceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatComplianceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatcomplianceconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2015 -title: Remove-CsPersistentChatComplianceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatcomplianceconfiguration +schema: 2.0.0 +title: Remove-CsPersistentChatComplianceConfiguration --- # Remove-CsPersistentChatComplianceConfiguration @@ -40,7 +41,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsPersistentChatComplianceConfiguration -Identity "site:Redmond" ``` @@ -48,7 +49,7 @@ Remove-CsPersistentChatComplianceConfiguration -Identity "site:Redmond" Example 1 removes the Persistent Chat compliance configuration settings applied to the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatComplianceConfiguration -Filter "site:*" | Remove-CsPersistentChatComplianceConfiguration ``` @@ -58,7 +59,7 @@ To do that, the command first uses the `Get-CsPersistentChatComplianceConfigurat After the site-scoped settings have been retrieved, they are then piped to and removed by, the `Remove-CsPersistentChatComplianceConfiguration` cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatComplianceConfiguration | Where-Object {$_.AddUserDetals -eq $True -and $_.AddChatRoomDetails -eq $True} | Remove-CsPersistentChatComplianceConfiguration ``` @@ -71,7 +72,28 @@ This filtered collection is then piped to the `Remove-CsPersistentChatCompliance ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the Persistent Chat compliance settings to be removed. To remove a collection of settings configured at the site scope, use syntax similar to this: @@ -91,8 +113,7 @@ Instead, all the properties within that collection will be reset to their defaul ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 2 @@ -102,13 +123,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -117,30 +140,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -154,14 +163,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatComplianceConfiguration The `Remove-CsPersistentChatComplianceConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatComplianceConfiguration object. ## OUTPUTS -### -None. -Instead, the `Remove-CsPersistentChatComplianceConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatComplianceConfiguration object. +### None +This cmdlet does not return a value or object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsPersistentChatConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatConfiguration.md index 9ad34a8583..6455ecf59e 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsPersistentChatConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatconfiguration +schema: 2.0.0 +title: Remove-CsPersistentChatConfiguration --- # Remove-CsPersistentChatConfiguration @@ -40,7 +41,7 @@ Select the collection to be removed, click Edit and then click Delete. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsPersistentChatConfiguration -Identity "site:Redmond" ``` @@ -48,7 +49,7 @@ Remove-CsPersistentChatConfiguration -Identity "site:Redmond" The command shown in Example 1 deletes the Persistent Chat configuration settings for the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatConfiguration -Filter "site:*" | Remove-CsPersistentChatConfiguration ``` @@ -58,7 +59,7 @@ To do this, the command first employs the `Get-CsPersistentChatConfiguration` cm These settings are then piped to the `Remove-CsPersistentChatConfiguration` cmdlet, which deletes all the settings applied to the site scope. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatConfiguration | Where-Object {$_.DefaultChatHistory -gt 30} | Remove-CsPersistentChatConfiguration ``` @@ -71,7 +72,28 @@ The filtered collection is then piped to the `Remove-CsPersistentChatConfigurati ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the Persistent Chat configuration settings to be removed. To remove a collection of settings configured at the site scope, use syntax similar to this: @@ -91,8 +113,7 @@ Instead, all the properties within that collection will be reset to their defaul ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 2 @@ -102,13 +123,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -117,30 +140,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -154,14 +163,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatConfiguration The `Remove-CsPersistentChatConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatConfiguration object. ## OUTPUTS -### -None. -Instead, the `Remove-CsPersistentChatConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatConfiguration object. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatEndpoint.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatEndpoint.md similarity index 91% rename from skype/skype-ps/skype/Remove-CsPersistentChatEndpoint.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatEndpoint.md index 7443eaddef..171782a88f 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatEndpoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatendpoint applicable: Lync Server 2013, Skype for Business Server 2015 -title: Remove-CsPersistentChatEndpoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatendpoint +schema: 2.0.0 +title: Remove-CsPersistentChatEndpoint --- # Remove-CsPersistentChatEndpoint @@ -39,7 +40,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsPersistentChatEndpoint -Identity "sip:pce@litwareinc.com" ``` @@ -48,7 +49,7 @@ The command shown in Example 1 deletes the Persistent Chat endpoint that has the In this example, the SIP address is used for the Identity -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatEndpoint -PersistentChatPoolFqdn "atl-pcpool-001.litwareinc.com" | Remove-CsPersistentChatEndpoint ``` @@ -58,7 +59,7 @@ To carry out this task, the command first uses the `Get-CsPersistentChatEndpoint The endpoints in that collection are then piped to and removed by, the `Remove-CsPersistentChatEndpoint` cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatEndpoint | Remove-CsPersistentChatEndpoint ``` @@ -70,7 +71,28 @@ This collection is then piped to the `Remove-CsPersistentChatEndpoint` cmdlet, w ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Suppresses the display of any non-fatal error message that might occur when running the command + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the Persistent Chat endpoint to be removed. Endpoint Identities are typically specified using the endpoint's SIP address or display name; for example: @@ -83,8 +105,7 @@ However, you can also use the full Identity of the endpoint; for example: ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 1 @@ -94,13 +115,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -109,30 +132,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -146,13 +155,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSPersistentChatContact The `Remove-CsPersistentChatEndpoint` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSPersistentChatContact class. ## OUTPUTS -### -None. +### None The `Remove-CsPersistentChatEndpoint` cmdlet does not return objects or data. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatMessage.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatMessage.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsPersistentChatMessage.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatMessage.md index dd1b9a62b1..cf1370128c 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatMessage.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatMessage.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatmessage applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsPersistentChatMessage -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatmessage +schema: 2.0.0 +title: Remove-CsPersistentChatMessage --- # Remove-CsPersistentChatMessage @@ -49,7 +50,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsPersistentChatMessage -Identity "atl-persistentchat-001.litwareinc.com\ITChatRoom" -EndDate "4/1/2012" ``` @@ -57,7 +58,7 @@ Remove-CsPersistentChatMessage -Identity "atl-persistentchat-001.litwareinc.com\ The command shown in Example 1 removes all the Persistent Chat messages posted on or before April 1, 2012 from the ITChatRoom chat room on the server atl-persistentchat-001.litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Remove-CsPersistentChatMessage -Identity "atl-persistentchat-001.litwareinc.com\ITChatRoom" -UserUri "sip:kenmyer@litwareinc.com" ``` @@ -67,69 +68,17 @@ In Example 2, all Persistent Chat messages posted by the user kenmyer@litwareinc ## PARAMETERS -### -Identity -Unique identifier for the chat room containing the message to be deleted. -For example: - -`-Identity "atl-persistentchat-001.litwareinc.com\ITChatRoom"` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Remove -When present, removes the Persistent Chat message without leaving a replacement message. - -You cannot use both the Remove parameter and the ReplaceMessage parameter in the same command. - -```yaml -Type: SwitchParameter -Parameter Sets: Remove -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ReplaceMessage -Enables administrators to specify the text of the replacement message. -By default, the replacement message reads "This message was replaced by the Persistent Chat administrator." - -```yaml -Type: String -Parameter Sets: Replace -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -CaseSensitive -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -CaseSensitive When present, indicates that case sensitivity should be used when searching for messages to be removed. (In other words, an uppercase "A" will be treated as a different character than a lowercase "a".) By default, searches are not case sensitive. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -138,30 +87,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -EndDate -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +> Applicable: Lync Server 2013, Skype for Business Server 2015 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EndDate Enables you to filter for messages that were posted on or before the specified date. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -171,6 +106,9 @@ Accept wildcard characters: False ``` ### -Filter + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Keywords that can be used to help identify the messages to be deleted. For example, to search for all messages that include the keyword "Fabrikam" use this syntax: @@ -187,8 +125,7 @@ To look for messages using any one of the provided keywords, use the MatchClause ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -197,7 +134,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Unique identifier for the chat room containing the message to be deleted. +For example: + +`-Identity "atl-persistentchat-001.litwareinc.com\ITChatRoom"` + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MatchClause + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Specifies how the `Remove-CsPersistentChatMessage` cmdlet handles multiple keywords. Allowed values are: @@ -213,8 +174,7 @@ For example, this syntax searches for messages that have the exact phrase "For i ```yaml Type: AndOr Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -223,14 +183,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Remove + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +When present, removes the Persistent Chat message without leaving a replacement message. + +You cannot use both the Remove parameter and the ReplaceMessage parameter in the same command. + +```yaml +Type: SwitchParameter +Parameter Sets: Remove +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ReplaceMessage + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Enables administrators to specify the text of the replacement message. +By default, the replacement message reads "This message was replaced by the Persistent Chat administrator." + +```yaml +Type: String +Parameter Sets: Replace +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -StartDate + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to filter for messages that were posted on or after the specified date. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -240,13 +241,33 @@ Accept wildcard characters: False ``` ### -UserUri + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + SIP address of the user who posted the message (or messages) that should be removed. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -256,13 +277,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -276,14 +299,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Remove-CsPersistentChatMessage` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatPolicy.md similarity index 92% rename from skype/skype-ps/skype/Remove-CsPersistentChatPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatPolicy.md index 75517edccd..bd3381de72 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatpolicy applicable: Lync Server 2013, Skype for Business Server 2015 -title: Remove-CsPersistentChatPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatpolicy +schema: 2.0.0 +title: Remove-CsPersistentChatPolicy --- # Remove-CsPersistentChatPolicy @@ -41,7 +42,7 @@ Select the policy to be removed, click Edit and then click Delete. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsPersistentChatPolicy -Identity "RedmondPersistentChatPolicy" ``` @@ -49,7 +50,7 @@ Remove-CsPersistentChatPolicy -Identity "RedmondPersistentChatPolicy" The command shown in Example 1 removes the per-user Persistent Chat policy with the Identity RedmondPersistentChatPolicy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatPolicy -Filter "site:*" | Remove-CsPersistentChatPolicy ``` @@ -59,7 +60,7 @@ To do this, the command first uses the `Get-CsPersistentChatPolicy` cmdlet and t (This is done by using the filter value "site:*".) These policies are then piped to and deleted by, the `Remove-CsPersistentChatPolicy` cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatPolicy | Where-Object {$_.EnablePersistentChat -eq $True} | Remove-CsPersistentChatPolicy ``` @@ -72,7 +73,30 @@ That collection is then piped to the `Remove-CsPersistentChatPolicy` cmdlet, whi ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +If present, causes the `Remove-CsPersistentChatPolicy` cmdlet to delete the per-user policy even if the policy is currently assigned to at least one user. +If not present, you will be asked to confirm the deletion request before a policy still in use 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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identity of the Persistent Chat policy to be deleted. To remove a site-scoped policy, use syntax similar to this: @@ -90,8 +114,7 @@ Instead, all the properties in the global policy will be reset to their default ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 2 @@ -100,32 +123,23 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +> Applicable: Skype for Business Server 2015 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the Persistent Chat policy is being removed. +For example: -### -Force -If present, causes the `Remove-CsPersistentChatPolicy` cmdlet to delete the per-user policy even if the policy is currently assigned to at least one user. -If not present, you will be asked to confirm the deletion request before a policy still in use will be removed. +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -134,14 +148,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: cf Required: False Position: Named @@ -150,21 +166,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the Persistent Chat policy is being removed. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2013, Skype for Business Server 2015 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015 +Aliases: wi Required: False Position: Named @@ -178,13 +189,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.PersistentChat.PersistentChatPolicy The `Remove-CsPersistentChatPolicy` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Policy.PersistentChat.PersistentChatPolicy object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsPersistentChatPolicy` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Policy.PersistentChat.PersistentChatPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPersistentChatRoom.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatRoom.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsPersistentChatRoom.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatRoom.md index d789e263f1..3120493ab4 100644 --- a/skype/skype-ps/skype/Remove-CsPersistentChatRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPersistentChatRoom.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatroom applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsPersistentChatRoom -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspersistentchatroom +schema: 2.0.0 +title: Remove-CsPersistentChatRoom --- # Remove-CsPersistentChatRoom @@ -46,7 +47,7 @@ To delete the room, click Edit and then click Delete. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsPersistentChatRoom -Identity "atl-gc-001.litwareinc.com\RedmondChatRoom" ``` @@ -54,7 +55,7 @@ Remove-CsPersistentChatRoom -Identity "atl-gc-001.litwareinc.com\RedmondChatRoom The command shown in Example 1 removes the Persistent Chat chat room RedmondChatRoom. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatRoom | Remove-CsPersistentChatRoom ``` @@ -64,7 +65,7 @@ To do this, the command first calls the `Get-CsPersistentChatRoom` cmdlet withou This collection is then piped to the `Remove-CsPersistentChatRoom` cmdlet, which deletes each room in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatRoom -Privacy "Closed" | Remove-CsPersistentChatRoom ``` @@ -76,7 +77,28 @@ This collection is then piped to the `Remove-CsPersistentChatConfiguration` cmdl ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique Identifier for the Persistent Chat chat room being removed. The Identity for a chat room consists of the Persistent Chat pool where the room has been configured plus the name of the room; for example: @@ -85,8 +107,7 @@ The Identity for a chat room consists of the Persistent Chat pool where the room ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 1 @@ -96,13 +117,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: ChatRoom Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 1 @@ -112,13 +135,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -127,30 +152,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -164,14 +175,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.PersistentChat.Cmdlets.ChatRoomObject The `Remove-CsPersistentChatRooms` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.ChatRoomObject object. ## OUTPUTS -### -None. -Instead, the `Remove-CsPersistentChatRoom` cmdlet deletes existing instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.ChatRoomObject object. +### None +This cmdlet does not return a value or object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPinPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPinPolicy.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsPinPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPinPolicy.md index b50a7851b2..aa180531b0 100644 --- a/skype/skype-ps/skype/Remove-CsPinPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPinPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspinpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsPinPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspinpolicy +schema: 2.0.0 +title: Remove-CsPinPolicy --- # Remove-CsPinPolicy @@ -47,7 +48,7 @@ If you remove the global policy, the minimum PIN length will be reset to the def ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsPinPolicy -Identity RedmondUsersPinPolicy ``` @@ -55,7 +56,7 @@ Remove-CsPinPolicy -Identity RedmondUsersPinPolicy Example 1 removes the per-user PIN policy with the Identity RedmondUsersPinPolicy. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsPinPolicy -Filter "site:*" | Remove-CsPinPolicy ``` @@ -65,7 +66,7 @@ To do this, the `Get-CsPinPolicy` cmdlet is used, along with the Filter paramete This collection is then piped to the `Remove-CsPinPolicy` cmdlet, which deletes each policy in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsPinPolicy | Where-Object {$_.AllowCommonPatterns -eq $True} | Remove-CsPinPolicy ``` @@ -76,7 +77,7 @@ This collection is then piped to the `Where-Object` cmdlet, which selects only t Finally, that filtered collection is piped to the `Remove-CsPinPolicy` cmdlet, which deletes each policy in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsPinPolicy | Remove-CsPinPolicy ``` @@ -89,7 +90,28 @@ Instead, all the properties in the global policy will be reset to their default ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier assigned to the policy when it was created. PIN policies can be assigned at the global, site, or per-user scope. To refer to the global instance, use this syntax: @@ -108,8 +130,7 @@ To refer to a policy at the per-user scope, use syntax similar to this: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -118,30 +139,23 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the PIN policy is being removed. +For example: -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -151,13 +165,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -166,21 +182,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the PIN policy is being removed. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -194,15 +205,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.UserPin.UserPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.UserPin.UserPolicy + The `Remove-CsPinPolicy` cmdlet accepts pipelined input of the PIN policy object. ## OUTPUTS -### +### None The `Remove-CsPinPolicy` cmdlet does not return a value or object. -Instead, the cmdlet removes one or more instances of the Microsoft.Rtc.Management.WritableConfig.Policy.UserPin.UserPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPlatformServiceSettings.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPlatformServiceSettings.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsPlatformServiceSettings.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPlatformServiceSettings.md index a4f1d6ea41..d77fb2327b 100644 --- a/skype/skype-ps/skype/Remove-CsPlatformServiceSettings.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPlatformServiceSettings.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csplatformservicesettings applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsPlatformServiceSettings -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csplatformservicesettings +schema: 2.0.0 +title: Remove-CsPlatformServiceSettings --- # Remove-CsPlatformServiceSettings @@ -28,7 +29,7 @@ The `Remove-CsPlatformServiceSettings` cmdlet reset the global configuration in ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` PS C:\> Remove-CsPlatformServiceSettings -Identity Global ``` @@ -37,30 +38,16 @@ This example reset the global configuration to default value. Global configurati ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Force Suppresses any confirmation prompts that would otherwise be displayed before testing. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -70,13 +57,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the Platform Service Settings to be removed. ```yaml Type: XdsIdentity Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 1 @@ -85,7 +74,28 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +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 +``` + ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -93,7 +103,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Remove-CsPresencePolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPresencePolicy.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsPresencePolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPresencePolicy.md index 7257c10c6d..4b2bc40885 100644 --- a/skype/skype-ps/skype/Remove-CsPresencePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPresencePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspresencepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsPresencePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspresencepolicy +schema: 2.0.0 +title: Remove-CsPresencePolicy --- # Remove-CsPresencePolicy @@ -49,7 +50,7 @@ This cmdlet can also be run against the global policy; however, if you do this t ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsPresencePolicy -Identity "RedmondPresencePolicy" ``` @@ -57,7 +58,7 @@ Remove-CsPresencePolicy -Identity "RedmondPresencePolicy" Example 1 deletes the per-user presence policy with the Identity RedmondPresencePolicy. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsPresencePolicy -Filter "tag:*" | Remove-CsPresencePolicy ``` @@ -67,7 +68,7 @@ The command shown in Example 2 removes all the presence policies that have been The filtered collection is then piped to the `Remove-CsPresencePolicy` cmdlet, which deletes each policy in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsPresencePolicy | Where-Object {$_.MaxPromptedSubscriber -gt 500} | Remove-CsPresencePolicy ``` @@ -80,7 +81,30 @@ In turn, that filtered collection is then piped to the `Remove-CsPresencePolicy` ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If present, causes the `Remove-CsPresencePolicy` cmdlet to delete the per-user policy even if the policy is currently assigned to at least one user. +If not present, you will be asked to confirm the deletion request before a policy still in use 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 +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the presence policy to be removed. To remove a policy configured at the site scope, use syntax similar to this: `-Identity "site:Redmond"`. To remove a policy configured at the per-user scope, use syntax similar to this: @@ -95,8 +119,7 @@ Instead, the properties within that policy will be reset to their default values ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -105,32 +128,23 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -If present, causes the `Remove-CsPresencePolicy` cmdlet to delete the per-user policy even if the policy is currently assigned to at least one user. -If not present, you will be asked to confirm the deletion request before a policy still in use will be removed. +### -Tenant +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the presence policy is being removed. +For example: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -140,13 +154,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -155,21 +171,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the presence policy is being removed. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -183,14 +194,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Presence.PresencePolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Presence.PresencePolicy + The `Remove-CsPresencePolicy` cmdlet accepts pipelined input of the presence policy object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsPresencePolicy` cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Presence.PresencePolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPresenceProvider.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPresenceProvider.md similarity index 86% rename from skype/skype-ps/skype/Remove-CsPresenceProvider.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPresenceProvider.md index 66ad10e6b7..f16dc49046 100644 --- a/skype/skype-ps/skype/Remove-CsPresenceProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPresenceProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspresenceprovider applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsPresenceProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspresenceprovider +schema: 2.0.0 +title: Remove-CsPresenceProvider --- # Remove-CsPresenceProvider @@ -36,7 +37,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsPresenceProvider -Identity "global/fabrikam.com" ``` @@ -44,7 +45,7 @@ Remove-CsPresenceProvider -Identity "global/fabrikam.com" The command shown in Example 1 removes the presence provider with the Identity "global/fabrikam.com". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPresenceProvider | Remove-CsPresenceProvider ``` @@ -54,7 +55,7 @@ To do this, the command first calls the `Get-CsPresenceProvider` cmdlet without That collection is then piped to the `Remove-CsPresenceProvider` cmdlet, which deletes each item (that is, each provider) in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPresenceProvider | Where-Object {$_.Fqdn -match "fabrikam.com"} | Remove-CsPresenceProvider ``` @@ -67,7 +68,28 @@ In turn, that filtered collection is then piped to the `Remove-CsPresenceProvide ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the presence provider to be removed. To remove a single provider, use the actual Identity of the provider, which includes both the scope and the provider Fqdn: @@ -81,8 +103,7 @@ This syntax removes all the providers configured at the global scope: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -92,13 +113,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -107,30 +130,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -144,14 +153,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PresenceProvider#Decorated The `Remove-CsPresenceProvider` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PresenceProvider#Decorated object. ## OUTPUTS -### -None. -Instead, the `Remove-CsPresenceProvider` cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PresenceProvider#Decorated object. +### None +The `Remove-CsPresenceProvider` cmdlet does not return a value or object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPrivacyConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPrivacyConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsPrivacyConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPrivacyConfiguration.md index f0a1d07838..fee0cb94c7 100644 --- a/skype/skype-ps/skype/Remove-CsPrivacyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPrivacyConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csprivacyconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsPrivacyConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csprivacyconfiguration +schema: 2.0.0 +title: Remove-CsPrivacyConfiguration --- # Remove-CsPrivacyConfiguration @@ -48,7 +49,7 @@ If you now "delete" the global collection EnablePrivacyMode will revert to its d ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsPrivacyConfiguration -Identity site:Redmond ``` @@ -57,7 +58,7 @@ Example 1 returns the privacy configuration settings assigned to the Redmond sit When these settings are deleted, users in the Redmond site will automatically inherit the global privacy configuration settings. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsPrivacyConfiguration -Filter "site:*" | Remove-CsPrivacyConfiguration ``` @@ -66,7 +67,7 @@ In Example 2, all the privacy configuration settings assigned at the site scope The filtered collection is then piped to the `Remove-CsPrivacyConfiguration` cmdlet, which removes each item in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsPrivacyConfiguration | Where-Object {$_.EnablePrivacyMode -eq $False} | Remove-CsPrivacyConfiguration ``` @@ -79,7 +80,28 @@ This filtered collection is piped to the `Remove-CsPrivacyConfiguration` cmdlet, ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the privacy configuration settings to be removed. To remove settings configured at the site scope, use syntax similar to this: @@ -97,8 +119,7 @@ Instead, all the properties in that collection will be reset to their default va ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -108,6 +129,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which privacy configuration settings being deleted. For example: @@ -121,8 +145,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,14 +154,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -148,29 +173,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -184,14 +195,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PrivacyConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PrivacyConfiguration + The `Remove-CsPrivacyConfiguration` cmdlet accepts pipelined input of the privacy configuration object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsPrivacyConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PrivacyConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsProxyConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsProxyConfiguration.md similarity index 92% rename from skype/skype-ps/skype/Remove-CsProxyConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsProxyConfiguration.md index fdf06b7833..f92bd0944f 100644 --- a/skype/skype-ps/skype/Remove-CsProxyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsProxyConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csproxyconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsProxyConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csproxyconfiguration +schema: 2.0.0 +title: Remove-CsProxyConfiguration --- # Remove-CsProxyConfiguration @@ -73,7 +74,28 @@ This subset of proxy configuration settings is then piped to the `Remove-CsProxy ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the proxy server configuration settings to be removed; for example: `-Identity "service:Registrar:atl-cs-001.litwareinc.com"` @@ -87,7 +109,6 @@ Instead, the properties within that global collection will all be reset to their Type: XdsIdentity Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 2 @@ -96,14 +117,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -113,29 +136,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Remove-CsPublicProvider.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPublicProvider.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsPublicProvider.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPublicProvider.md index 85a18e6544..7ad4baefe9 100644 --- a/skype/skype-ps/skype/Remove-CsPublicProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPublicProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspublicprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsPublicProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspublicprovider +schema: 2.0.0 +title: Remove-CsPublicProvider --- # Remove-CsPublicProvider @@ -44,7 +45,7 @@ To re-establish the relationship you can use the `Enable-CsPublicProvider` cmdle ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsPublicProvider -Identity "Skype" ``` @@ -53,7 +54,7 @@ Example 1 deletes the public provider with the Identity Skype. After this command has completed, Skype will no longer appear in the list of configured public providers; at that point, the only way to re-establish federation with Skype is to re-create the provider. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsPublicProvider | Remove-CsPublicProvider ``` @@ -63,7 +64,7 @@ To do this, the command first uses the `Get-CsPublicProvider` cmdlet to return a This collection is then piped to the `Remove-CsPublicProvider` cmdlet, which, in turn, deletes each provider in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsPublicProvider | Where-Object {$_.Enabled -eq $False} | Remove-CsPublicProvider ``` @@ -76,7 +77,28 @@ That filtered collection is then piped to the `Remove-CsPublicProvider` cmdlet, ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the public provider to be removed. The Identity typically the name of the website providing the services. @@ -84,8 +106,7 @@ The Identity typically the name of the website providing the services. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -94,14 +115,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -111,29 +134,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -147,14 +156,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayPublicProvider object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayPublicProvider + The `Remove-CsPublicProvider` cmdlet accepts pipelined instances of the public provider object. ## OUTPUTS -### -None. +### None Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayPublicProvider object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsPushNotificationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsPushNotificationConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsPushNotificationConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsPushNotificationConfiguration.md index 75b54cd946..a2d8dad083 100644 --- a/skype/skype-ps/skype/Remove-CsPushNotificationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsPushNotificationConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cspushnotificationconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsPushNotificationConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cspushnotificationconfiguration +schema: 2.0.0 +title: Remove-CsPushNotificationConfiguration --- # Remove-CsPushNotificationConfiguration @@ -49,7 +50,7 @@ In this case, that means that push notifications will be disabled from both the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsPushNotificationConfiguration -Identity "site:Redmond" ``` @@ -57,7 +58,7 @@ Remove-CsPushNotificationConfiguration -Identity "site:Redmond" The command shown in Example 1 deletes the collection of push notification settings assigned to the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPushNotificationConfiguration -Filter "site:*" | Remove-CsPushNotificationConfiguration ``` @@ -67,7 +68,7 @@ To perform this task, the cmdlet first uses the `Get-CsPushNotificationConfigura The site-scoped settings are then piped to and deleted by, the `Remove-CsPushNotificationConfiguration` cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPushNotificationConfiguration | Where-Object {$_.EnableMicrosoftPushNotificationService -eq $False} | Remove-CsPushNotificationConfiguration ``` @@ -80,7 +81,28 @@ This filtered collection is then piped to the `Remove-CsPushNotificationConfigur ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of push notification configuration settings to be removed. To remove the global collection, use the following syntax: @@ -97,8 +119,7 @@ You cannot use wildcards when specifying a policy Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -107,30 +128,24 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for the push notification configuration settings being deleted. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,22 +154,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for the push notification configuration settings being deleted. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` - -You can return the tenant ID for each of your tenants by running this command: +### -Confirm -`Get-CsTenant | Select-Object DisplayName, TenantID` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -164,13 +173,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -184,15 +195,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WriteableConfig.Settings.PushNotificationConfiguration.PushNotificationConfiguration. +### Microsoft.Rtc.Management.WriteableConfig.Settings.PushNotificationConfiguration.PushNotificationConfiguration The `Remove-CsPushNotificationConfiguration` cmdlet accepts pipelined instances of the PushNotificationConfiguration object. ## OUTPUTS -### -None. -Instead, the `Remove-CsPushNotificationConfiguration` cmdlet deletes instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.PushNotificationConfiguration.PushNotificationConfiguration object. +### None +This cmdlet does not return a value or object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsQoEConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsQoEConfiguration.md similarity index 84% rename from skype/skype-ps/skype/Remove-CsQoEConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsQoEConfiguration.md index 02136f6354..7b9b2a1820 100644 --- a/skype/skype-ps/skype/Remove-CsQoEConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsQoEConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csqoeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsQoEConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csqoeconfiguration +schema: 2.0.0 +title: Remove-CsQoEConfiguration --- # Remove-CsQoEConfiguration @@ -32,7 +33,7 @@ Calling this cmdlet on the global QoE configuration will reset all properties to ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsQoEConfiguration -Identity site:Redmond ``` @@ -41,7 +42,7 @@ Example 1 uses the `Remove-CsQoEConfiguration` cmdlet to remove the QoE settings Using the Identity parameter ensures that only the settings assigned to the specified site will be removed. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsQoEConfiguration -Filter site:* | Remove-CsQoEConfiguration ``` @@ -51,7 +52,7 @@ To do this, the command first uses the `Get-CsQoEConfiguration` cmdlet and the F The filtered collection is then passed to the `Remove-CsQoEConfiguration` cmdlet, which deletes all the items in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsQoEConfiguration | Where-Object {$_.KeepQoEDataForDays -lt 30} | Remove-CsQoEConfiguration ``` @@ -64,7 +65,28 @@ In turn, the filtered collection is piped to the `Remove-CsQoEConfiguration` cmd ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the settings you want to remove. Possible values are global and site:\, where \ is the name of the site in your Skype for Business Server deployment with the settings to be removed. @@ -72,8 +94,7 @@ Possible values are global and site:\, where \ is the na ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -82,14 +103,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -99,29 +122,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -135,15 +144,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.QoE.QoESettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.QoE.QoESettings + Accepts pipelined input of QoE configuration objects. ## OUTPUTS -### +### None This cmdlet does not return a value or object. -Instead, it removes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.QoE.QoESettings object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsRegistrarConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsRegistrarConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsRegistrarConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsRegistrarConfiguration.md index 698ba81e59..bd402a7524 100644 --- a/skype/skype-ps/skype/Remove-CsRegistrarConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsRegistrarConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csregistrarconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsRegistrarConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csregistrarconfiguration +schema: 2.0.0 +title: Remove-CsRegistrarConfiguration --- # Remove-CsRegistrarConfiguration @@ -46,7 +47,7 @@ For example, if you have changed the value of the MinEndpointExpiration property ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsRegistrarConfiguration -Identity site:Redmond ``` @@ -55,7 +56,7 @@ The command shown in Example 1 deletes the Registrar configuration settings assi When these settings are deleted, Registrars in the Redmond site will automatically use the global Registrar settings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsRegistrarConfiguration -Filter "service:*" | Remove-CsRegistrarConfiguration ``` @@ -65,7 +66,7 @@ To do this, the command first calls the `Get-CsRegistrarConfiguration` cmdlet al The filtered collection is then piped to the `Remove-CsRegistrarConfiguration` cmdlet, which deletes each item in that collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsRegistrarConfiguration | Where-Object {$_.EnableDHCPServer -eq $True} | Remove-CsRegistrarConfiguration ``` @@ -78,7 +79,28 @@ In turn, the filtered collection is piped to the `Remove-CsRegistrarConfiguratio ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the Registrar configuration settings to be removed. To remove settings configured at the site scope, use syntax similar to this: `-Identity site:Redmond`. To remove settings at the service level, use syntax like this: @@ -93,8 +115,7 @@ Instead, all the properties in the global collection will be reset to their defa ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -103,14 +124,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -120,29 +143,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -156,14 +165,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Registrar.RegistrarSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Registrar.RegistrarSettings + The `Remove-CsRegistrarConfiguration` cmdlet accepts pipelined instances of the Registrar settings object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsRegistrarConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Registrar.RegistrarSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsReportingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsReportingConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Remove-CsReportingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsReportingConfiguration.md index f39a678c24..788b8c7323 100644 --- a/skype/skype-ps/skype/Remove-CsReportingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsReportingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csreportingconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsReportingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csreportingconfiguration +schema: 2.0.0 +title: Remove-CsReportingConfiguration --- # Remove-CsReportingConfiguration @@ -32,7 +33,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsReportingConfiguration -Identity "service:MonitoringDatabase:atl-sql-002.litwareinc.com" ``` @@ -40,7 +41,7 @@ Remove-CsReportingConfiguration -Identity "service:MonitoringDatabase:atl-sql-00 In Example 1, the reporting configuration settings with the Identity service:MonitoringDatabase:atl-sql-002.litwareinc.com are removed. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsReportingConfiguration | Remove-CsReportingConfiguration ``` @@ -50,7 +51,7 @@ To do this, the command first uses the `Get-CsReportingConfiguration` cmdlet to This collection is then piped to the `Remove-CsReportingConfiguration` cmdlet, which removes each item in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsReportingConfiguration | Where-Object {$_.ReportingUrl -eq "https://atl-sql-002.litwareinc.com/lync_reports" | Remove-CsReportingConfiguration ``` @@ -66,7 +67,28 @@ That filtered collection is then piped to the `Remove-CsReportingConfiguration` ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service Identity of the monitoring database whose reporting configuration settings are to be removed. For example: @@ -75,8 +97,7 @@ For example: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -86,13 +107,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -101,30 +124,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -138,14 +147,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Reporting.ReportingConfiguration The `Remove-CsReportingConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Reporting.ReportingConfiguration object. ## OUTPUTS -### -None. -Instead, the `Remove-CsReportingConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Reporting.ReportingConfiguration object. +### None +This cmdlet does not return a value or object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsRgsAgentGroup.md b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsAgentGroup.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsRgsAgentGroup.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsRgsAgentGroup.md index 7062f37fd4..bdd29259d2 100644 --- a/skype/skype-ps/skype/Remove-CsRgsAgentGroup.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsAgentGroup.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csrgsagentgroup applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsRgsAgentGroup -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csrgsagentgroup +schema: 2.0.0 +title: Remove-CsRgsAgentGroup --- # Remove-CsRgsAgentGroup @@ -40,7 +41,7 @@ If you only want to remove a single agent from a group, use the `Set-CsRgsAgentG ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Get-CsRgsAgentGroup -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Remove-CsRgsAgentGroup ``` @@ -50,7 +51,7 @@ To do this, the command first uses `Get-CsRgsAgentGroup` to return all the agent Those groups are then piped to and removed by, the `Remove-CsRgsAgentGroup` cmdlet. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsRgsAgentGroup -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" | Remove-CsRgsAgentGroup ``` @@ -60,7 +61,7 @@ To do this, `Get-CsRgsAgentGroup` is first used to return the Help Desk agent gr This group is then piped to `Remove-CsRgsAgentGroup`, which removes the group from the service. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsRgsAgentGroup -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Where-Object {$_.RoutingMethod -ne "RoundRobin"} | Remove-CsRgsAgentGroup ``` @@ -74,6 +75,9 @@ The filtered collection is then piped to `Remove-CsRgsAgentGroup`, which deletes ## PARAMETERS ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Forces removal of the agent group. If this parameter is present, the agent group will be deleted without warning, even if it is used by an active workflow. If this parameter is not present, then you will be asked to confirm the deletion of any agent group currently being used by an active workflow. @@ -81,8 +85,7 @@ If this parameter is not present, then you will be asked to confirm the deletion ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -91,30 +94,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Object reference pointing to the agent group to be removed. +When piping workflow objects to `Remove-CsRgsAgentGroup` you can leave off the Instance parameter. + +To use the Instance parameter use commands similar to this: + +`$x = Get-CsRgsAgentGroup -Identity ApplicationServer:atl-cs-001.litwareinc.com /1987d3c2-4544-489d-bbe3-59f79f530a83` + +`Remove-CsRgsAgentGroup -Instance $x` + +Note that you can only remove a single agent group at a time when using the Instance parameter. +That means that your object reference ($x) cannot contain multiple agent group objects. + ```yaml -Type: SwitchParameter +Type: AgentGroup Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -123,30 +141,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Object reference pointing to the agent group to be removed. -When piping workflow objects to `Remove-CsRgsAgentGroup` you can leave off the Instance parameter. - -To use the Instance parameter use commands similar to this: - -`$x = Get-CsRgsAgentGroup -Identity ApplicationServer:atl-cs-001.litwareinc.com /1987d3c2-4544-489d-bbe3-59f79f530a83` +### -WhatIf -`Remove-CsRgsAgentGroup -Instance $x` - -Note that you can only remove a single agent group at a time when using the Instance parameter. -That means that your object reference ($x) cannot contain multiple agent group objects. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: AgentGroup +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -155,14 +164,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Rgs.Management.WritableSettings.AgentGroup object. +### Microsoft.Rtc.Rgs.Management.WritableSettings.AgentGroup + `Remove-CsRgsAgentGroup` accepts pipelined instances of the Response Group agent group object. ## OUTPUTS -### -`Remove-CsRgsAgentGroup` deletes existing instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.AgentGroup object. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsRgsHolidaySet.md b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsHolidaySet.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsRgsHolidaySet.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsRgsHolidaySet.md index 65b20debef..1a85e329df 100644 --- a/skype/skype-ps/skype/Remove-CsRgsHolidaySet.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsHolidaySet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csrgsholidayset applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsRgsHolidaySet -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csrgsholidayset +schema: 2.0.0 +title: Remove-CsRgsHolidaySet --- # Remove-CsRgsHolidaySet @@ -57,7 +58,7 @@ If all you want to do is remove a single holiday from a holiday set (for example ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Get-CsRgsHolidaySet -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -Name "2010 Holidays" | Remove-CsRgsHolidaySet ``` @@ -67,7 +68,7 @@ To do this, the command first calls `Get-CsRgsHolidaySet` along with two paramet The returned object is then piped to `Remove-CsRgsHolidaySet`, which deletes the holiday set 2010 Holidays. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsRgsHolidaySet -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" | Select-Object Identity -ExpandProperty HolidayList | Where-Object {$_.Name -eq "New Year's Day"} | Remove-CsRgsHolidaySet ``` @@ -81,7 +82,7 @@ The selected information (holiday set Identity and holiday property values) is t The filtered collection of holiday sets is then piped to `Remove-CsRgsHolidaySet`, which deletes each holiday set that includes the holiday New Year's Day. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsRgsHolidaySet -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" | Where-Object {$_.HolidayList.Count -lt 5} | Remove-CsRgsHolidaySet ``` @@ -95,6 +96,9 @@ These holiday sets are then piped to and deleted by, the `Remove-CsRgsHolidaySet ## PARAMETERS ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Forces removal of the holiday set. If this parameter is present, the holiday set will be deleted without warning, even if it is used by an active workflow. If this parameter is not present then you will be asked to confirm the deletion of any holiday set currently assigned to an active workflow. @@ -102,8 +106,7 @@ If this parameter is not present then you will be asked to confirm the deletion ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -112,30 +115,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Object reference pointing to the holiday set to be removed. +When piping workflow objects to `Remove-CsRgsHolidaySet` you can leave off the Instance parameter. + +To use the Instance parameter use commands similar to this: + +`$x = Get-CsRgsHolidaySet -Identity ApplicationServer:atl-cs-001.litwareinc.com /1987d3c2-4544-489d-bbe3-59f79f530a83` + +`Remove-CsRgsHolidaySet -Instance $x` + +Note that you can only remove a single holiday set at a time when using the Instance parameter. +That means that your object reference ($x) cannot contain multiple holiday set objects. + ```yaml -Type: SwitchParameter +Type: HolidaySet Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is for testing purposes only. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -144,30 +162,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Object reference pointing to the holiday set to be removed. -When piping workflow objects to `Remove-CsRgsHolidaySet` you can leave off the Instance parameter. - -To use the Instance parameter use commands similar to this: - -`$x = Get-CsRgsHolidaySet -Identity ApplicationServer:atl-cs-001.litwareinc.com /1987d3c2-4544-489d-bbe3-59f79f530a83` +### -WhatIf -`Remove-CsRgsHolidaySet -Instance $x` - -Note that you can only remove a single holiday set at a time when using the Instance parameter. -That means that your object reference ($x) cannot contain multiple holiday set objects. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: HolidaySet +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -176,14 +185,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Rgs.Management.WritableSettings.HolidaySet object. +### Microsoft.Rtc.Rgs.Management.WritableSettings.HolidaySet + `Remove-CsRgsHolidaySet` accepts pipelined instances of the Response Group holiday set object. ## OUTPUTS -### -`Remove-CsRgsHolidaySet` deletes existing instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.HolidaySet object. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsRgsHoursOfBusiness.md b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsHoursOfBusiness.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsRgsHoursOfBusiness.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsRgsHoursOfBusiness.md index d9620b6ae4..3307d8c7fb 100644 --- a/skype/skype-ps/skype/Remove-CsRgsHoursOfBusiness.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsHoursOfBusiness.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csrgshoursofbusiness applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsRgsHoursOfBusiness -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csrgshoursofbusiness +schema: 2.0.0 +title: Remove-CsRgsHoursOfBusiness --- # Remove-CsRgsHoursOfBusiness @@ -49,7 +50,7 @@ For example: ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Get-CsRgsHoursOfBusiness -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" | Remove-CsRgsHoursOfBusiness ``` @@ -59,7 +60,7 @@ To do this, the command first calls `Get-CsRgsHoursOfBusiness` to return all the These sets are then piped to the `Remove-CsRgsHoursOfBusiness` cmdlet, which deletes each business hours set that is passed to it. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsRgsHoursOfBusiness -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -Name "Help Desk Business Hours" | Remove-CsRgsHoursOfBusiness ``` @@ -67,7 +68,7 @@ Get-CsRgsHoursOfBusiness -Identity "service:ApplicationServer:atl-cs-001.litware In Example 2, a single set of business hours is removed from ApplicationServer:atl-cs-001.litwareinc.com: the collection named Help Desk Business Hours. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsRgsHoursOfBusiness -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" | Where-Object {$_.SundayTimeRange1 -ne $Null -or $_.SundayTimeRange2 -ne $Null} | Remove-CsRgsHoursOfBusiness ``` @@ -78,7 +79,7 @@ These sets are then piped to the `Where-Object` cmdlet, which selects only those (If a time range property is not null, then that means business hours have been configured for that time interval.) Any set that meets at least one of those criteria is then piped to the `Remove-CsRgsHoursOfBusiness` cmdlet, which removes that set of business hours. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsRgsHoursOfBusiness -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" | Where-Object {$_.Custom -eq $True} | Remove-CsRgsHoursOfBusiness -Force ``` @@ -92,6 +93,9 @@ These sets are then piped to and deleted by, `Remove-CsRgsHoursOfBusiness`. ## PARAMETERS ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Forces the deletion of a business hours set. If this parameter is present, the set will be deleted without warning, even if the set is currently assigned to an active workflow. If this parameter is not present then you will be asked to confirm the deletion of any business hours set currently assigned to an active workflow. @@ -99,8 +103,7 @@ If this parameter is not present then you will be asked to confirm the deletion ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -109,30 +112,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Object reference pointing to the business hours set to be removed. +When piping workflow objects to `Remove-CsRgsHoursOfBusiness` you can leave off the Instance parameter. + +To use the Instance parameter use commands similar to this: + +`$x = Get-CsRgsHoursOfBusiness -Identity ApplicationServer:atl-cs-001.litwareinc.com /1987d3c2-4544-489d-bbe3-59f79f530a83` + +`Remove-CsRgsHoursOfBusiness -Instance $x` + +Note that you can only remove a single business hours set at a time when using the Instance parameter. +That means that your object reference ($x) cannot contain multiple business hour objects. + ```yaml -Type: SwitchParameter +Type: BusinessHours Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -141,30 +159,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Object reference pointing to the business hours set to be removed. -When piping workflow objects to `Remove-CsRgsHoursOfBusiness` you can leave off the Instance parameter. - -To use the Instance parameter use commands similar to this: - -`$x = Get-CsRgsHoursOfBusiness -Identity ApplicationServer:atl-cs-001.litwareinc.com /1987d3c2-4544-489d-bbe3-59f79f530a83` +### -WhatIf -`Remove-CsRgsHoursOfBusiness -Instance $x` - -Note that you can only remove a single business hours set at a time when using the Instance parameter. -That means that your object reference ($x) cannot contain multiple business hour objects. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: BusinessHours +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -173,14 +182,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Rgs.Management.WritableSettings.BusinessHours object. +### Microsoft.Rtc.Rgs.Management.WritableSettings.BusinessHours + `Remove-CsRgsHoursOfBusiness` accepts pipelined instances of the Response Group business hours object. ## OUTPUTS -### -Deletes existing instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.BusinessHours object. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsRgsQueue.md b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsQueue.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsRgsQueue.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsRgsQueue.md index a930605625..df56a33879 100644 --- a/skype/skype-ps/skype/Remove-CsRgsQueue.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsQueue.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csrgsqueue applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsRgsQueue -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csrgsqueue +schema: 2.0.0 +title: Remove-CsRgsQueue --- # Remove-CsRgsQueue @@ -45,7 +46,7 @@ Because of that, you might want to use the `Get-CsRgsQueue` cmdlet to check the ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Remove-CsRgsQueue ``` @@ -55,7 +56,7 @@ To do this, the command first uses `Get-CsRgsQueue` to return a collection of al This collection is then piped to `Remove-CsRgsQueue`, which deletes each queue in the collection. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk Queue" | Remove-CsRgsQueue ``` @@ -64,7 +65,7 @@ In Example 2, a single Response Group queue is deleted: the queue named "Help De To delete this queue, `Get-CsRgsQueue` is called along with the Identity and Name parameters; the single queue returned by this call is then piped to and deleted by, `Remove-CsRgsQueue`. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com | Where-Object {$_.OverflowCandidate -eq "NewestCall"} | Remove-CsRgsQueue ``` @@ -78,6 +79,9 @@ The filtered collection is then piped to `Remove-CsRgsQueue`, which deletes each ## PARAMETERS ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Forces the deletion of a Response Group queue. If this parameter is present, the queue will be deleted without warning, even if the queue is assigned to an active workflow. If this parameter is not present then you will be asked to confirm the deletion of any queue currently in use by an active workflow. @@ -85,8 +89,7 @@ If this parameter is not present then you will be asked to confirm the deletion ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -95,30 +98,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Object reference pointing to the queue to be removed. +When piping workflow objects to `Remove-CsRgsQueue` you can leave off the Instance parameter. + +To use the Instance parameter use commands similar to this: + +`$x = Get-CsRgsQueue -Identity ApplicationServer:atl-cs-001.litwareinc.com /1987d3c2-4544-489d-bbe3-59f79f530a83` + +`Remove-CsRgsQueue -Instance $x` + +Note that you can only remove a single queue at a time when using the Instance parameter. +That means that your object reference ($x) cannot contain multiple queue objects. + ```yaml -Type: SwitchParameter +Type: Queue Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -127,30 +145,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Object reference pointing to the queue to be removed. -When piping workflow objects to `Remove-CsRgsQueue` you can leave off the Instance parameter. - -To use the Instance parameter use commands similar to this: - -`$x = Get-CsRgsQueue -Identity ApplicationServer:atl-cs-001.litwareinc.com /1987d3c2-4544-489d-bbe3-59f79f530a83` +### -WhatIf -`Remove-CsRgsQueue -Instance $x` - -Note that you can only remove a single queue at a time when using the Instance parameter. -That means that your object reference ($x) cannot contain multiple queue objects. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Queue +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` @@ -159,14 +168,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Rgs.Management.WritableSettings.Queue object. +### Microsoft.Rtc.Rgs.Management.WritableSettings.Queue + `Remove-CsRgsQueue` accepts pipelined instances of the Response Group queue object. ## OUTPUTS -### -`Remove-CsRgsQueue` deletes existing instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Queue object. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsRgsWorkflow.md b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsWorkflow.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsRgsWorkflow.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsRgsWorkflow.md index e12c40c092..c39f32cda5 100644 --- a/skype/skype-ps/skype/Remove-CsRgsWorkflow.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsRgsWorkflow.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csrgsworkflow applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsRgsWorkflow -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csrgsworkflow +schema: 2.0.0 +title: Remove-CsRgsWorkflow --- # Remove-CsRgsWorkflow @@ -45,7 +46,7 @@ For example: ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Get-CsRgsWorkflow -Identity Service:ApplicationServer:atl-cs-001.litwareinc.com | Remove-CsRgsWorkflow ``` @@ -55,7 +56,7 @@ To do this, the command first calls `Get-CsRgsWorkflow` to return a collection o That collection is then piped to `Remove-CsRgsWorkflow`, which deletes each workflow in the collection. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsRgsWorkflow service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk Workflow" | Remove-CsRgsWorkflow ``` @@ -65,7 +66,7 @@ To do this, `Get-CsRgsWorkflow` is first used to return the workflow named Help That workflow is then piped to and deleted by, `Remove-CsRgsWorkflow`. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsRgsWorkflow service:ApplicationServer:atl-cs-001.litwareinc.com | Where-Object {$_.Language -eq "en-us"} | Remove-CsRgsWorkflow ``` @@ -77,7 +78,7 @@ English (en-us). This filtered collection is then piped to the `Remove-CsRgsWorkflow` cmdlet, which deletes each item in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsRgsWorkflow service:ApplicationServer:atl-cs-001.litwareinc.com | Where-Object {$_.CustomMusicOnHoldFile -ne $Null} | Remove-CsRgsWorkflow ``` @@ -90,7 +91,30 @@ That collection is then piped to the `Where-Object` cmdlet, which selects only t ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Forces removal of the workflow. +If this parameter is present, the workflow will be deleted without warning, even if it is currently active. +If this parameter is not present then you will be asked to confirm the deletion of any active workflow. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Object reference pointing to the workflow to be removed. When piping workflow objects to `Remove-CsRgsWorkflow` you can leave off the Instance parameter. @@ -106,8 +130,7 @@ That means that your object reference ($x) cannot contain multiple workflow obje ```yaml Type: Workflow Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -116,16 +139,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Force -Forces removal of the workflow. -If this parameter is present, the workflow will be deleted without warning, even if it is currently active. -If this parameter is not present then you will be asked to confirm the deletion of any active workflow. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -135,29 +158,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -171,14 +180,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Rgs.Management.WritableSettings.Workflow object. +### Microsoft.Rtc.Rgs.Management.WritableSettings.Workflow + `Remove-CsRgsWorkflow` accepts pipelined instances of the Response Group workflow object. ## OUTPUTS -### -`Remove-CsRgsWorkflow` deletes existing instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Workflow object. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsRoutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsRoutingConfiguration.md similarity index 83% rename from skype/skype-ps/skype/Remove-CsRoutingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsRoutingConfiguration.md index ad76c4dab3..fc56301e29 100644 --- a/skype/skype-ps/skype/Remove-CsRoutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsRoutingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsRoutingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csroutingconfiguration +schema: 2.0.0 +title: Remove-CsRoutingConfiguration --- # Remove-CsRoutingConfiguration @@ -34,7 +35,7 @@ WARNING: Removing the routing configuration (in other words, setting the list of ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsRoutingConfiguration -Identity Global -Confirm ``` @@ -45,15 +46,35 @@ This action deletes all defined voice routes, so we added the Confirm parameter ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The scope of the routing configuration to remove. This value must be Global. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -62,14 +83,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -79,29 +102,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -115,14 +124,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Policy.Voice.PSTNRoutingSettings object. +### Microsoft.Rtc.Management.Policy.Voice.PSTNRoutingSettings + Accepts pipelined input of a routing configuration object. ## OUTPUTS -### -This cmdlet removes (resets) an object of type Microsoft.Rtc.Management.Policy.Voice.PSTNRoutingSettings. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsServerApplication.md b/skype/skype-ps/SkypeForBusiness/Remove-CsServerApplication.md similarity index 84% rename from skype/skype-ps/skype/Remove-CsServerApplication.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsServerApplication.md index a83b20565e..9c996012ab 100644 --- a/skype/skype-ps/skype/Remove-CsServerApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsServerApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csserverapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsServerApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csserverapplication +schema: 2.0.0 +title: Remove-CsServerApplication --- # Remove-CsServerApplication @@ -34,7 +35,7 @@ However, the software itself is not uninstalled and the application can be re-en ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsServerApplication -Identity "service:EdgeServer:atl-edge-001.litwareinc.com/EdgeMonitor" ``` @@ -43,7 +44,7 @@ In Example 1, the server application that has the Identity service: EdgeServer:a Because Identities must be unique, this command will never delete more than a single application. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsServerApplication | Where-Object {$_.Critical -eq $False} | Remove-CsServerApplication ``` @@ -54,7 +55,7 @@ This collection is then piped to the `Where-Object` cmdlet, which picks all the This filtered collection is then piped to the `Remove-CsServerApplication` cmdlet, which deletes each item in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsServerApplication -Filter "service:EdgeServer:atl-cs-001.litwareinc.com/*" | Remove-CsServerApplication ``` @@ -66,7 +67,28 @@ In turn, that collection is piped to the `Remove-CsServerApplication` cmdlet, wh ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the server application to be removed. Server application Identities are composed of the service where the application is hosted plus the application name. For example, the server application named QoEAgent might have an Identity similar to this: service:Registrar:atl-cs-001.litwareinc.com/QoEAgent. @@ -74,8 +96,7 @@ For example, the server application named QoEAgent might have an Identity simila ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -84,14 +105,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -101,29 +124,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -137,14 +146,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.ServerApplication.Application object. +### Microsoft.Rtc.Management.WritableConfig.Settings.ServerApplication.Application + The `Remove-CsServerApplication` cmdlet accepts pipelined instances of the server application object. ## OUTPUTS -### -The `Remove-CsServerApplication` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ServerApplication.Application object. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsSimpleUrlConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsSimpleUrlConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsSimpleUrlConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsSimpleUrlConfiguration.md index 4d7b1655df..11165da5eb 100644 --- a/skype/skype-ps/skype/Remove-CsSimpleUrlConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsSimpleUrlConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cssimpleurlconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsSimpleUrlConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cssimpleurlconfiguration +schema: 2.0.0 +title: Remove-CsSimpleUrlConfiguration --- # Remove-CsSimpleUrlConfiguration @@ -58,7 +59,7 @@ If you later decide to delete one or more of the site-scoped collections, you ca ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsSimpleUrlConfiguration -Identity "site:Redmond" ``` @@ -67,7 +68,7 @@ The command shown in Example 1 deletes the simple URL configuration collection a This command deletes all the simple URLs assigned to the specified site. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsSimpleUrlConfiguration -Filter "site:*" | Remove-CsSimpleUrlConfiguration ``` @@ -79,7 +80,28 @@ The filtered collection is then piped to the `Remove-CsSimpleUrlConfiguration` c ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of simple URLs to be removed. To remove a collection from the site scope, use syntax similar to this: @@ -98,8 +120,7 @@ Instead, all the Simple URLs within that collection will be deleted. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -108,30 +129,24 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for the Simple URL configuration settings being deleted. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,13 +156,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -156,22 +173,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for the Simple URL configuration settings being deleted. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` - -You can return the tenant ID for each of your tenants by running this command: +### -WhatIf -`Get-CsTenant | Select-Object DisplayName, TenantID` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -185,14 +196,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.SimpleUrl.SimpleUrlConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.SimpleUrl.SimpleUrlConfiguration + The `Remove-CsSimpleUrlConfiguration` cmdlet accepts pipelined instances of the simple URL configuration object. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsSipDomain.md b/skype/skype-ps/SkypeForBusiness/Remove-CsSipDomain.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsSipDomain.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsSipDomain.md index d59dc449bb..07fbfadcbe 100644 --- a/skype/skype-ps/skype/Remove-CsSipDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsSipDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cssipdomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsSipDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cssipdomain +schema: 2.0.0 +title: Remove-CsSipDomain --- # Remove-CsSipDomain @@ -43,7 +44,7 @@ To remove a SIP domain currently in use, you must first assign new SIP addresses ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsSipDomain -Identity fabrikam.com ``` @@ -53,7 +54,7 @@ Note that this command will fail if fabrikam.com is the only SIP domain currentl That's because your topology must include at least one SIP domain. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsSipDomain | Where-Object {$_.IsDefault -ne $True} | Remove-CsSipDomain ``` @@ -66,7 +67,28 @@ The net effect: the default domain is filtered out and the remaining domains are ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the SIP domain to be removed: For example: `-Identity fabrikam.com` @@ -75,8 +97,7 @@ Fully qualified domain name (FQDN) of the SIP domain to be removed: For example: ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -85,14 +106,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -102,29 +125,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -138,14 +147,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Xds.SipDomain object. +### Microsoft.Rtc.Management.Xds.SipDomain + The `Remove-CsSipDomain` cmdlet accepts pipelined instances of the SIP domain object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsSipDomain` cmdlet deletes existing instance of the Microsoft.Rtc.Management.Xds.SipDomain object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsSipResponseCodeTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Remove-CsSipResponseCodeTranslationRule.md similarity index 86% rename from skype/skype-ps/skype/Remove-CsSipResponseCodeTranslationRule.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsSipResponseCodeTranslationRule.md index 6dcccff10c..15bf7dc7a3 100644 --- a/skype/skype-ps/skype/Remove-CsSipResponseCodeTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsSipResponseCodeTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cssipresponsecodetranslationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsSipResponseCodeTranslationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cssipresponsecodetranslationrule +schema: 2.0.0 +title: Remove-CsSipResponseCodeTranslationRule --- # Remove-CsSipResponseCodeTranslationRule @@ -48,7 +49,7 @@ The `Remove-CsSipResponseCodeTranslationRule` cmdlet provides a way for you to d ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsSipResponseCodeTranslationRule -Identity "PstnGateway:192.168.0.240/Rule404" ``` @@ -56,7 +57,7 @@ Remove-CsSipResponseCodeTranslationRule -Identity "PstnGateway:192.168.0.240/Rul The command shown in Example 1 deletes a single response code translation rule: the rule that has the Identity PstnGateway:192.168.0.240/Rule404. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsSipResponseCodeTranslationRule -Filter "service:PstnGateway:192.168.0.240/*" | Remove-CsSipResponseTranslationCode ``` @@ -66,7 +67,7 @@ To do this, the command first calls the `Get-CsSipResponseCodeTranslationRule` c This filtered collection is then piped to the `Remove-CsSipResponseTranslationCode` cmdlet, which deletes each rule in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsSipResponseCodeTranslationRule | Where-Object {$_.ReceivedISUPCauseValue -eq -1} | Remove-CsSipResponseTranslationCode ``` @@ -80,7 +81,28 @@ From there, the filtered collection is piped to the `Remove-CsSipResponseTransla ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the translation rule to be removed. The identity for a translation rule consists of two parts: the scope where the rule was configured and the name given to the rule when it was created. For example, a translation rule named Rule404 that was created at the global scope would have an Identity that looked like this: global/Rule404. @@ -88,8 +110,7 @@ For example, a translation rule named Rule404 that was created at the global sco ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -98,14 +119,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -115,29 +138,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -151,15 +160,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.SipResponseCodeTranslationRule#Decorated object. +### Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.SipResponseCodeTranslationRule#Decorated The `Remove-CsSipResponseCodeTranslationRule` cmdlet accepts pipelined instances of the SIP response code translation rule object. ## OUTPUTS -### -The `Remove-CsSipResponseCodeTranslationRule` cmdlet does not return any objects or values. -Instead, the cmdlet deletes modifies instances of the Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.SipResponseCodeTranslationRule#Decorated object. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsSlaConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsSlaConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Remove-CsSlaConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsSlaConfiguration.md index 9cf8fa98a8..c6256398a6 100644 --- a/skype/skype-ps/skype/Remove-CsSlaConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsSlaConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csslaconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsSlaConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csslaconfiguration +schema: 2.0.0 +title: Remove-CsSlaConfiguration --- # Remove-CsSlaConfiguration @@ -22,9 +23,9 @@ Remove-CsSlaConfiguration [-Identity] [-Confirm] [-PassThru] [ ``` ## DESCRIPTION -Shared Line Appearance (SLA) is a feature in Skype for Business (SfB) for handling multiple calls on a specific number called a shared number. SLA can configure any enterprise voice enabled SfB user as a shared number with multiple lines to respond to multiple calls. The calls are not actually received on the shared number, instead they are forwarded to users that act as delegates for the shared number. Any one of the delegates can pick up the call while the rest of the delegates get a notification on their phone about who picked up the call and which line has become busy as a result. Both the number of lines and the delegates are configurable for a shared number in SLA. In addition, advanced options such as BusyOption (what happens in a situation when all lines are busy) and MissedCallOption (the case in which none of the delegates pick up a call) etc. can also be configured for a shared number. +Shared Line Appearance (SLA) is a feature in Skype for Business (SfB) for handling multiple calls on a specific number called a shared number. SLA can configure any enterprise voice enabled SfB user as a shared number with multiple lines to respond to multiple calls. The calls are not actually received on the shared number, instead they are forwarded to users that act as delegates for the shared number. Any one of the delegates can pick up the call while the rest of the delegates get a notification on their phone about who picked up the call and which line has become busy as a result. Both the number of lines and the delegates are configurable for a shared number in SLA. In addition, advanced options such as BusyOption (what happens in a situation when all lines are busy) and MissedCallOption (the case in which none of the delegates pick up a call) etc. can also be configured for a shared number. -The Remove-CsSlaConfiguration cmdlet removes an SLA configuration. +The Remove-CsSlaConfiguration cmdlet removes an SLA configuration. Note: Logging in with the account created for the SLA number is not supported. Using the SLA number account with any device or Desktop Client can result in unpredictable behavior. It is not necessary to use that account for the Shared Line Appearance feature to function. By default, members of the RTCUniversalServerAdmins group are authorized to run the Remove-CsSlaConfiguration cmdlet. To return a list of all the role-based access control (RBAC) roles this cmdlet has been assigned to (including any custom RBAC roles you have created yourself), run the following command from the Windows PowerShell prompt: @@ -32,9 +33,9 @@ Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Remove-CsSlaConfiguration"} ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` -PS C:\> Remove-CsSlaConfiguration -Identity SLAGroup1 +PS C:\> Remove-CsSlaConfiguration -Identity SLAGroup1 ``` This example removes the Shared Line Appearance configuration named "SLAGroup1". @@ -43,6 +44,9 @@ This example removes the Shared Line Appearance configuration named "SLAGroup1". ## PARAMETERS ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the SLA group to be removed. User Identities can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). You can also reference a user account by using the Active Directory distinguished name. You can use the asterisk (\*) wildcard character when using the Display Name as the user Identity. For example, the Identity "\*Smith" returns all the users who have a display name that ends with the string value "Smith". @@ -50,8 +54,7 @@ You can use the asterisk (\*) wildcard character when using the Display Name as ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -60,14 +63,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -PassThru + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to pass a user object through the pipeline that represents the SLA group being removed. By default, the Remove-CsSlaConfiguration cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -76,14 +81,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the SLA group being removed. By default, the Remove-CsSlaConfiguration cmdlet does not pass objects through the pipeline. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -93,13 +100,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Remove-CsSlaDelegates.md b/skype/skype-ps/SkypeForBusiness/Remove-CsSlaDelegates.md similarity index 91% rename from skype/skype-ps/skype/Remove-CsSlaDelegates.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsSlaDelegates.md index 66462078dc..285d38a23b 100644 --- a/skype/skype-ps/skype/Remove-CsSlaDelegates.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsSlaDelegates.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cssladelegates applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsSlaDelegates -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cssladelegates +schema: 2.0.0 +title: Remove-CsSlaDelegates --- # Remove-CsSlaDelegates @@ -35,7 +36,7 @@ Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Remove-CsSlaDelegates"} ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Remove-CsSlaDelegates -Identity SLAGroup1 -Delegate sip:SLA_Delegate3@contoso.com ``` @@ -46,13 +47,15 @@ This example removes SLA_Delegate3@contoso.com as delegate in SLA group named SL ## PARAMETERS ### -Delegate + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the delegate to be removed from the SLA group. This parameter requires a valid sip address. ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -62,6 +65,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the identity of the shared number to which the delegate will be removed. User identities can be specified using one of five formats: - SIP address. Example: sip:kenmyer@litwareinc.com. @@ -73,8 +79,7 @@ Indicates the identity of the shared number to which the delegate will be remove ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -83,14 +88,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -PassThru + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +The presence of the passthru switch causes the cmdlet to pass the current objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -99,14 +106,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -The presence of the passthru switch causes the cmdlet to pass the current objects through the pipeline. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -116,13 +125,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Remove-CsStaticRoutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsStaticRoutingConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsStaticRoutingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsStaticRoutingConfiguration.md index 7c0a317d02..7749ced793 100644 --- a/skype/skype-ps/skype/Remove-CsStaticRoutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsStaticRoutingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csstaticroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsStaticRoutingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csstaticroutingconfiguration +schema: 2.0.0 +title: Remove-CsStaticRoutingConfiguration --- # Remove-CsStaticRoutingConfiguration @@ -45,7 +46,7 @@ That means that all the routes assigned to the global collection will be deleted ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsStaticRoutingConfiguration -Identity "service:Registrar:atl-cs-001.litwareinc.com" ``` @@ -53,7 +54,7 @@ Remove-CsStaticRoutingConfiguration -Identity "service:Registrar:atl-cs-001.litw The command shown in Example 1 removes the static routing configuration collection that has the Identity service:Registrar:atl-cs-001.litwareinc.com. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsStaticRoutingConfiguration -Filter "service:*" | Remove-CsStaticRoutingConfiguration ``` @@ -63,7 +64,7 @@ To do this, the command starts off by using the `Get-CsStaticRoutingConfiguratio This filtered collection is then piped to the `Remove-CsStaticRoutingConfiguration` cmdlet, which deletes each item in that collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsStaticRoutingConfiguration | Where-Object {$_.Route.Count -eq 0} | Remove-CsStaticRoutingConfiguration ``` @@ -76,7 +77,28 @@ The filtered information is then piped to the `Remove-CsStaticRoutingConfigurati ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the static routing configuration collection to be removed. To remove a collection configured at the service scope, use syntax similar to this: @@ -94,8 +116,7 @@ That means that all the items in the Route property will be deleted. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -104,14 +125,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -121,29 +144,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -157,13 +166,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.RoutingSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.RoutingSettings + The `Remove-CsStaticRoutingConfiguration` cmdlet accepts pipelined instances of the static routing settings object. ## OUTPUTS -### +### None The `Remove-CsStaticRoutingConfiguration` cmdlet does not return a value or object. Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.RoutingSettings object. diff --git a/skype/skype-ps/skype/Remove-CsStorageServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsStorageServiceConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Remove-CsStorageServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsStorageServiceConfiguration.md index 47b61a9369..56d34f3cd2 100644 --- a/skype/skype-ps/skype/Remove-CsStorageServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsStorageServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csstorageserviceconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsStorageServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csstorageserviceconfiguration +schema: 2.0.0 +title: Remove-CsStorageServiceConfiguration --- # Remove-CsStorageServiceConfiguration @@ -41,7 +42,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsStorageServiceConfiguration -Identity "site:Redmond" ``` @@ -49,7 +50,7 @@ Remove-CsStorageServiceConfiguration -Identity "site:Redmond" The command shown in Example 1 deletes the storage service configuration settings applied to the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsStorageServiceConfiguration -Filter "site:*" | Remove-CsStorageServiceConfiguration ``` @@ -61,7 +62,28 @@ That collection is then piped to the `Remove-CsStorageServiceConfiguration` cmdl ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of storage service configuration settings to be removed. To remove a collection applied to the site scope, use syntax similar to this: @@ -78,8 +100,7 @@ Instead, the properties within that collection will all be reset to their defaul ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -89,13 +110,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -104,30 +127,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -141,13 +150,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.StorageService.StorageServiceSettings The `Remove-CsStorageServiceConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.StorageService.StorageServiceSettings object. ## OUTPUTS -### -None. +### None The `Remove-CsStorageServiceConfiguration` cmdlet does not return any objects or data. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsTeamsUpgradePolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTeamsUpgradePolicy.md similarity index 98% rename from skype/skype-ps/skype/Remove-CsTeamsUpgradePolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsTeamsUpgradePolicy.md index f8d9052ec0..8c35c1db3d 100644 --- a/skype/skype-ps/skype/Remove-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTeamsUpgradePolicy.md @@ -1,14 +1,14 @@ --- +applicable: Skype for Business Server 2015, Skype for Business Server 2019 +author: hirenshah1 external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: rogupta Module Name: SkypeForBusiness +ms.author: hirshah online version: https://learn.microsoft.com/powershell/module/skype/remove-csteamsupgradepolicy -applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsTeamsUpgradePolicy schema: 2.0.0 -manager: rogupta -author: hirenshah1 -ms.author: hirshah -ms.reviewer: +title: Remove-CsTeamsUpgradePolicy --- # Remove-CsTeamsUpgradePolicy @@ -43,13 +43,14 @@ This removes the TeamsUpgradePolicy for site named Redmond1. ### -Identity +> Applicable: Skype for Business Server 2019 + The identity of the policy. To specify the global policy for the organization, use "global". To specify a specific site, use "site:\" where "\" is the name of the site. To specify a policy that can be assigned as needed to any users, simply specify a name of your choosing. ```yaml Type: XdsIdentity Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: True Position: 1 Default value: None diff --git a/skype/skype-ps/skype/Remove-CsTelemetryConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTelemetryConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsTelemetryConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsTelemetryConfiguration.md index ce9b3db03d..7ff8d89008 100644 --- a/skype/skype-ps/skype/Remove-CsTelemetryConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTelemetryConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstelemetryconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsTelemetryConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cstelemetryconfiguration +schema: 2.0.0 +title: Remove-CsTelemetryConfiguration --- # Remove-CsTelemetryConfiguration @@ -27,7 +28,7 @@ For privacy information, see the Skype for Business Privacy Statement (https://g ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsTelemetryConfiguration -Identity Site:Redmond ``` @@ -35,7 +36,7 @@ Remove-CsTelemetryConfiguration -Identity Site:Redmond This example removes the telemetry configuration for the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsTelemetryConfiguration -Filter "Site:*" | Remove-CsTelemetryConfiguration ``` @@ -46,7 +47,28 @@ The result is that all "Site" scoped telemetry configurations are removed. ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier that includes the scope of the telemetry configuration. Telemetry configurations can be scoped at the Global, Site, or Service level. For example, "site:Redmond" (for site). @@ -67,8 +89,7 @@ Specifying the Global configuration will return it to the default Global setting ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -78,13 +99,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -93,30 +116,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -130,13 +139,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### XdsIdentity This cmdlet takes pipeline input of the `Get-CsTelemetryConfiguration` cmdlet as shown in Example 2. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsTenantUpdateTimeWindow.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTenantUpdateTimeWindow.md similarity index 91% rename from skype/skype-ps/skype/Remove-CsTenantUpdateTimeWindow.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsTenantUpdateTimeWindow.md index 0927a0240a..2db58f3e4d 100644 --- a/skype/skype-ps/skype/Remove-CsTenantUpdateTimeWindow.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTenantUpdateTimeWindow.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstenantupdatetimewindow applicable: Skype for Business Online -title: Remove-CsTenantUpdateTimeWindow -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/remove-cstenantupdatetimewindow +schema: 2.0.0 +title: Remove-CsTenantUpdateTimeWindow --- # Remove-CsTenantUpdateTimeWindow @@ -34,7 +36,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsTenantUpdateTimeWindow -Identity "AlwaysOn" ``` @@ -44,48 +46,54 @@ This example removes the tenant update time window. ## PARAMETERS -### -Identity -Specifies the identity of the tenant update time window. +### -Force + +> Applicable: Skype for Business Online + +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml -Type: XdsGlobalRelativeIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -PARAMVALUE: SwitchParameter +### -Identity + +> Applicable: Skype for Business Online + +Specifies the identity of the tenant update time window. ```yaml -Type: SwitchParameter +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Tenant + +> Applicable: Skype for Business Online + +PARAMVALUE: Guid ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -94,14 +102,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -PARAMVALUE: Guid +### -Confirm + +> Applicable: Skype for Business Online + +PARAMVALUE: SwitchParameter ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -111,13 +121,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/Remove-CsTestDevice.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTestDevice.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsTestDevice.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsTestDevice.md index 0cf245979f..111cf9c62a 100644 --- a/skype/skype-ps/skype/Remove-CsTestDevice.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTestDevice.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstestdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsTestDevice -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cstestdevice +schema: 2.0.0 +title: Remove-CsTestDevice --- # Remove-CsTestDevice @@ -45,7 +46,7 @@ You can also use the cmdlet to remove all the test devices configured for a give ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsTestDevice -Identity site:Redmond ``` @@ -54,7 +55,7 @@ Example 1 removes all the test devices from the Redmond site. This will remove the device collection as well as the individual test devices. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsTestDevice | Remove-CsTestDevice ``` @@ -63,7 +64,7 @@ The command shown in Example 2 removes all the test devices configured for use i Note that the global test device collection cannot be removed; however, this command will delete all the individual test devices configured at the global level. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsTestDevice -Filter "site:" | Remove-CsTestDevice ``` @@ -73,7 +74,7 @@ To carry out this task, the `Get-CsTestDevice` cmdlet and the Filter parameter a This filtered collection is then piped to the `Remove-CsTestDevice` cmdlet, which deletes all the items in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsTestDevice | Where-Object {$_.Name -match "LG-Nortel Phone"} | Remove-CsTestDevice ``` @@ -86,7 +87,28 @@ Any test device meeting that criterion is then deleted by using the `Remove-CsTe ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the test device to be removed. To remove a specific device, include both the scope (for example, site:Redmond) and the device name; for example: @@ -105,8 +127,7 @@ The global test device collection itself cannot be removed; however, the followi ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -115,14 +136,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -132,29 +155,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -168,13 +177,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.TestDevice object. +### Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.TestDevice + The `Remove-CsTestDevice` cmdlet accepts pipelined input of the test device object. ## OUTPUTS -### +### None The `Remove-CsTestDevice` cmdlet does not return a value or object. Instead, the cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.TestDevice object. diff --git a/skype/skype-ps/skype/Remove-CsTestUserCredential.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTestUserCredential.md similarity index 91% rename from skype/skype-ps/skype/Remove-CsTestUserCredential.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsTestUserCredential.md index 2d8afa8192..aa23f7471a 100644 --- a/skype/skype-ps/skype/Remove-CsTestUserCredential.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTestUserCredential.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstestusercredential applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsTestUserCredential -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cstestusercredential +schema: 2.0.0 +title: Remove-CsTestUserCredential --- # Remove-CsTestUserCredential @@ -42,7 +43,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsTestUserCredential "sip:kenmyer@litwareinc.com" ``` @@ -50,7 +51,7 @@ Remove-CsTestUserCredential "sip:kenmyer@litwareinc.com" The command shown in Example 1 removes the user with the SIP address sip:kenmyer@litwareinc.com from the collection of users configured as watcher node test users. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $ErrorActionPreference = "SilentlyContinue" @@ -71,7 +72,28 @@ The final command in the example resets the value of $ErrorActionPreference to " ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address of the account whose test user credentials are being removed. For example: @@ -80,8 +102,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -91,13 +112,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -106,30 +129,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -143,14 +152,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Remove-CsTestUserCredential` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsTestUserCredential` cmdlet deletes existing instances of the System.Management.Automation.PSCredential object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsThirdPartyVideoSystem.md b/skype/skype-ps/SkypeForBusiness/Remove-CsThirdPartyVideoSystem.md similarity index 91% rename from skype/skype-ps/skype/Remove-CsThirdPartyVideoSystem.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsThirdPartyVideoSystem.md index a55a5ee89b..f617553af4 100644 --- a/skype/skype-ps/skype/Remove-CsThirdPartyVideoSystem.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsThirdPartyVideoSystem.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csthirdpartyvideosystem applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsThirdPartyVideoSystem -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csthirdpartyvideosystem +schema: 2.0.0 +title: Remove-CsThirdPartyVideoSystem --- # Remove-CsThirdPartyVideoSystem @@ -31,7 +32,7 @@ These contact objects can later be deleted by using the `Remove-CsThirdPartyVide ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsThirdPartyVideoSystem -Identity "CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com" ``` @@ -40,7 +41,7 @@ The command shown in Example 1 removes the third-party video system that has the Video system identities can be returned by using the `Get-CsThirdPartyVideoSystem` cmdlet. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsThirdPartyVideoSystem -Filter {DisplayName -eq "Redmond Video System"} | Remove-CsThirdPartyVideoSystem ``` @@ -49,7 +50,7 @@ In Example 2, the `Remove-CsThirdPartyVideoSystem` cmdlet is used to delete the To do this, the command first uses `Get-CsThirdPartyVideoSystem` and the Filter parameter to retrieve the Redmond Video System contact object (and does this without having to specify an Identity like CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com.) That contact object is then piped to and deleted by, the `Remove-CsThirdPartyVideoSystem` cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsThirdPartyVideoSystem | Remove-CsThirdPartyVideoSystem ``` @@ -62,6 +63,9 @@ Those video systems are then piped to and removed by, the `Remove-CsThirdPartyVi ## PARAMETERS ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the third party video system to be removed. Video systems are identified by using the Active Directory distinguished name (DN) of the associated contact object. By default, these contacts use a globally unique identifier (GUID) as their common name; that means video systems will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. @@ -70,8 +74,7 @@ Because of that you might find it easier to retrieve video systems by using the ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -81,13 +84,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -97,13 +102,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -117,13 +124,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADThirdPartyVideoSystemContact The `Remove-CsThirdPartyVideoSystem` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADThirdPartyVideoSystemContact object. ## OUTPUTS -### -None. +### None The `Remove-CsThirdPartyVideoSystem` cmdlet does not return any objects or data. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsThirdPartyVideoSystemPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsThirdPartyVideoSystemPolicy.md similarity index 92% rename from skype/skype-ps/skype/Remove-CsThirdPartyVideoSystemPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsThirdPartyVideoSystemPolicy.md index e2e7dcdc56..7b1bd11008 100644 --- a/skype/skype-ps/skype/Remove-CsThirdPartyVideoSystemPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsThirdPartyVideoSystemPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csthirdpartyvideosystempolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsThirdPartyVideoSystemPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csthirdpartyvideosystempolicy +schema: 2.0.0 +title: Remove-CsThirdPartyVideoSystemPolicy --- # Remove-CsThirdPartyVideoSystemPolicy @@ -44,7 +45,7 @@ In this case, that means that the SupportsSendingLowResolution property will be ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsThirdPartyVideoSystemPolicy -Identity "RedmondVideoSystemPolicy ``` @@ -52,7 +53,7 @@ Remove-CsThirdPartyVideoSystemPolicy -Identity "RedmondVideoSystemPolicy The command shown in Example 1 removes the per-user third-party video system policy with the Identity RedmondVideoSystemPolicy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsThirdPartyVideoSystemPolicy | Remove-CsThirdPartyVideoSystemPolicy ``` @@ -63,7 +64,7 @@ Note that the global policy will not actually be deleted; Skype for Business Ser However, all the properties within the global policy will be reset to their default values. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsThirdPartyVideoSystemPolicy -Filter "site:*" | Remove-CsThirdPartyVideoSystemPolicy ``` @@ -75,7 +76,28 @@ Those policies are then piped to the `Remove-CsThirdPartyVideoSystemPolicy` cmdl ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identity assigned to the policy when it was created. Third party video system policies can be assigned at the global, site, or per-user scope. To refer to the global instance, use this syntax: @@ -99,8 +121,7 @@ Wildcard characters such as the asterisk (*) cannot be used with the Identity pa ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -109,30 +130,23 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Describes what would happen if you executed the command without actually executing the command. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for the third party video system policy being removed. +For example: -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,21 +155,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for the third party video system policy being removed. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -Confirm -You can return the tenant ID for each of your tenants by running this command: +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -165,13 +174,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -185,13 +196,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.ThirdPartyVideoSystem.ThirdPartyVideoSystemPolicy The `Remove-CsThirdPartyVideoSystemPolicy` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ThirdPartyVideoSystem.ThirdPartyVideoSystemPolicy object ## OUTPUTS -### -None. +### None Instead, the `Remove-CsThirdPartyVideoSystemPolicy` cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ThirdPartyVideoSystem.ThirdPartyVideoSystemPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsTrunkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTrunkConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Remove-CsTrunkConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsTrunkConfiguration.md index 4c863ae2fc..acffa0be64 100644 --- a/skype/skype-ps/skype/Remove-CsTrunkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTrunkConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstrunkconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsTrunkConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cstrunkconfiguration +schema: 2.0.0 +title: Remove-CsTrunkConfiguration --- # Remove-CsTrunkConfiguration @@ -34,7 +35,7 @@ Instead the configuration will be "reset" and all custom settings will be replac ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsTrunkConfiguration -Identity site:Redmond ``` @@ -42,7 +43,7 @@ Remove-CsTrunkConfiguration -Identity site:Redmond This example removes the trunk configuration with the Identity site:Redmond. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsTrunkConfiguration -Filter site:* | Remove-CsTrunkConfiguration ``` @@ -54,14 +55,34 @@ This collection of configurations is then piped to the `Remove-CsTrunkConfigurat ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the trunk configuration you want to remove. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -70,14 +91,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -87,29 +110,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -123,13 +132,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TrunkConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TrunkConfiguration + Accepts pipelined input of trunk configuration objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TrunkConfiguration. diff --git a/skype/skype-ps/skype/Remove-CsTrustedApplication.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplication.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsTrustedApplication.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplication.md index f740667361..afdfc8b58c 100644 --- a/skype/skype-ps/skype/Remove-CsTrustedApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstrustedapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsTrustedApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cstrustedapplication +schema: 2.0.0 +title: Remove-CsTrustedApplication --- # Remove-CsTrustedApplication @@ -39,7 +40,7 @@ While this prefix is part of the Identity, it's not required when you specify th ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsTrustedApplication -Identity TrustPool.litwareinc.com/tapp2 ``` @@ -47,7 +48,7 @@ Remove-CsTrustedApplication -Identity TrustPool.litwareinc.com/tapp2 This example removes the trusted application with the Identity TrustPool.litwareinc.com/tapp2 from the associated trusted service. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsTrustedApplication -Filter *trust* | Remove-CsTrustedApplication ``` @@ -61,15 +62,35 @@ The collection of trusted applications that is retrieved is then piped to the `R ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the trusted application to be removed from the trusted application pool. Identity values must be entered in the format \/\, where pool FQDN is the FQDN of the pool on which the application resides and application ID is the name of the application. ```yaml Type: ExternalApplicationIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -78,14 +99,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -95,29 +118,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -131,13 +140,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Xds.DisplayTrustedApplication object. +### Microsoft.Rtc.Management.Xds.DisplayTrustedApplication + Accepts pipelined input of trusted application objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.Xds.DisplayTrustedApplication. diff --git a/skype/skype-ps/skype/Remove-CsTrustedApplicationComputer.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationComputer.md similarity index 86% rename from skype/skype-ps/skype/Remove-CsTrustedApplicationComputer.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationComputer.md index b98867daaa..44ecef012d 100644 --- a/skype/skype-ps/skype/Remove-CsTrustedApplicationComputer.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationComputer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstrustedapplicationcomputer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsTrustedApplicationComputer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cstrustedapplicationcomputer +schema: 2.0.0 +title: Remove-CsTrustedApplicationComputer --- # Remove-CsTrustedApplicationComputer @@ -37,7 +38,7 @@ If you want to remove the only computer on a pool you must remove the entire poo ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsTrustedApplicationComputer -Identity Trust1.litwareinc.com ``` @@ -45,7 +46,7 @@ Remove-CsTrustedApplicationComputer -Identity Trust1.litwareinc.com This example removes the computer with the FQDN Trust1.litwareinc.com. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsTrustedApplicationComputer -Filter Trust* | Remove-CsTrustedApplicationComputer ``` @@ -59,14 +60,34 @@ Keep in mind that this won't remove the computers from a pool if removing those ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The fully qualified domain name (FQDN) of the computer to remove. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -75,14 +96,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -92,29 +115,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -128,13 +137,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Xds.DisplayComputer object. +### Microsoft.Rtc.Management.Xds.DisplayComputer + Accepts pipelined input of trusted application computer objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.Xds.DisplayComputer. diff --git a/skype/skype-ps/skype/Remove-CsTrustedApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationEndpoint.md similarity index 86% rename from skype/skype-ps/skype/Remove-CsTrustedApplicationEndpoint.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationEndpoint.md index e90e6d3555..96eb6d38d9 100644 --- a/skype/skype-ps/skype/Remove-CsTrustedApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationEndpoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstrustedapplicationendpoint applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsTrustedApplicationEndpoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cstrustedapplicationendpoint +schema: 2.0.0 +title: Remove-CsTrustedApplicationEndpoint --- # Remove-CsTrustedApplicationEndpoint @@ -30,7 +31,7 @@ This cmdlet removes an existing endpoint contact object from Active Directory Do ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsTrustedApplicationEndpoint -Identity "Endpoint 1" ``` @@ -39,7 +40,7 @@ This example removes the endpoint contact with the Identity (in this case the di Because identities must be unique, this command will remove, at most, one endpoint. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsTrustedApplicationEndpoint -ApplicationId tapp2 | Remove-CsTrustedApplicationEndpoint ``` @@ -54,13 +55,15 @@ Keep in mind that this call to the `Get-CsTrustedApplicationEndpoint` cmdlet cou ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Identity (the distinguished name of the contact), SIP address, or display name of the application endpoint to be removed. ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -69,14 +72,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -85,14 +90,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -106,13 +113,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact object. +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact + Accepts pipelined input of trusted application endpoint objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact. diff --git a/skype/skype-ps/skype/Remove-CsTrustedApplicationPool.md b/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationPool.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsTrustedApplicationPool.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationPool.md index 1d488c17fc..5af06df656 100644 --- a/skype/skype-ps/skype/Remove-CsTrustedApplicationPool.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsTrustedApplicationPool.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cstrustedapplicationpool applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsTrustedApplicationPool -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cstrustedapplicationpool +schema: 2.0.0 +title: Remove-CsTrustedApplicationPool --- # Remove-CsTrustedApplicationPool @@ -36,7 +37,7 @@ Keep in mind that removing the pool also removes all computers, applications and ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsTrustedApplicationPool -Identity TrustPool.litwareinc.com ``` @@ -46,7 +47,7 @@ We use the Identity parameter to specify the FQDN of the pool we want to remove. Because identities are unique, this command will remove, at most, one pool. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsTrustedApplicationPool | Where-Object {$_.PoolFqdn -match "trust*"} | Remove-CsTrustedApplicationPool ``` @@ -61,14 +62,34 @@ Finally, this collection is piped to the `Remove-CsTrustedApplicationPool` cmdle ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The fully qualified domain name (FQDN) or service ID of the pool you want to remove. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -77,14 +98,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -94,29 +117,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -130,13 +139,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Xds.DisplayExternalServer object. +### Microsoft.Rtc.Management.Xds.DisplayExternalServer + Accepts pipelined input of trusted application pool objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.Xds.DisplayExternalServer. diff --git a/skype/skype-ps/skype/Remove-CsUCPhoneConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsUCPhoneConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsUCPhoneConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsUCPhoneConfiguration.md index f45cd01e67..2ae8733502 100644 --- a/skype/skype-ps/skype/Remove-CsUCPhoneConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsUCPhoneConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csucphoneconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsUCPhoneConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csucphoneconfiguration +schema: 2.0.0 +title: Remove-CsUCPhoneConfiguration --- # Remove-CsUCPhoneConfiguration @@ -47,7 +48,7 @@ For example, if you have changed the phone lock time interval to 30 minutes, "re ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsUCPhoneConfiguration -Identity site:Redmond ``` @@ -56,7 +57,7 @@ The command shown in Example 1 removes the UC phone configuration settings for t When settings are removed from a site scope, users in that site will have their UC phones governed by the global phone configuration settings. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsUCPhoneConfiguration -Filter site:* | Remove-CsUCPhoneConfiguration ``` @@ -66,7 +67,7 @@ To do this, the command first uses the `Get-CsUCPhoneConfiguration` cmdlet and t This filtered collection is then piped to the `Remove-CsUCPhoneConfiguration` cmdlet, which removes each item in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsUCPhoneConfiguration | Where-Object {$_.EnforcePhoneLock -eq $False} | Remove-CsUCPhoneConfiguration ``` @@ -77,7 +78,7 @@ This collection is piped to the `Where-Object` cmdlet, which picks out only thos In turn, that filtered collection is piped to the `Remove-CsUCPhoneConfiguration` cmdlet, which removes each item in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsUCPhoneConfiguration | Where-Object {$_.SIPSecurityMode -ne "High"} | Remove-CsUCPhoneConfiguration ``` @@ -90,7 +91,28 @@ This collection is then piped to the `Where-Object` cmdlet, which selects only t ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of UC phone configuration settings to be removed. To remove a site collection use syntax similar to this: @@ -106,8 +128,7 @@ Note that you cannot use wildcards when specifying a policy Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -116,14 +137,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -133,29 +156,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -169,14 +178,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.UcPhoneSettings object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.UcPhoneSettings + The `Remove-CsUCPhoneConfiguration` cmdlet accepts pipelined instances of the UC phone settings object. ## OUTPUTS -### -None. +### None Instead, the cmdlet removes instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.UcPhoneSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsUnassignedNumber.md b/skype/skype-ps/SkypeForBusiness/Remove-CsUnassignedNumber.md similarity index 84% rename from skype/skype-ps/skype/Remove-CsUnassignedNumber.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsUnassignedNumber.md index 76c0291f9f..95289b5a32 100644 --- a/skype/skype-ps/skype/Remove-CsUnassignedNumber.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsUnassignedNumber.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csunassignednumber applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsUnassignedNumber -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csunassignednumber +schema: 2.0.0 +title: Remove-CsUnassignedNumber --- # Remove-CsUnassignedNumber @@ -32,7 +33,7 @@ This cmdlet removes the settings that define that routing. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsUnassignedNumber -Identity UNSet1 ``` @@ -40,7 +41,7 @@ Remove-CsUnassignedNumber -Identity UNSet1 In this example, the unassigned number settings with the Identity UNSet1 are removed. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUnassignedNumber | Where-Object {$_.AnnouncementName -match "Welcome"} | Remove-CsUnassignedNumber ``` @@ -53,14 +54,34 @@ Finally, the narrowed-down collection is passed to the `Remove-CsUnassignedNumbe ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique name for the range of unassigned numbers you want to remove. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -69,14 +90,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -86,29 +109,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -122,13 +131,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange object. +### Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange + Accepts pipelined input of unassigned number objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It removes an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange. diff --git a/skype/skype-ps/skype/Remove-CsUserAcp.md b/skype/skype-ps/SkypeForBusiness/Remove-CsUserAcp.md similarity index 85% rename from skype/skype-ps/skype/Remove-CsUserAcp.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsUserAcp.md index dc022a2e7e..debdde7d26 100644 --- a/skype/skype-ps/skype/Remove-CsUserAcp.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsUserAcp.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csuseracp applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsUserAcp -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/remove-csuseracp +schema: 2.0.0 +title: Remove-CsUserAcp --- # Remove-CsUserAcp @@ -50,7 +52,7 @@ For example this command removes any audio conferencing providers that have the ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsUserAcp -Identity "Ken Myer" ``` @@ -58,7 +60,7 @@ Remove-CsUserAcp -Identity "Ken Myer" The command shown in Example 1 removes all the audio conferencing providers that have been assigned to the user Ken Myer. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsUser | Remove-CsUserAcp ``` @@ -68,7 +70,7 @@ To do this, the command first uses the `Get-CsUser` cmdlet to retrieve a collect That collection is then piped to the `Remove-CsUserAcp` cmdlet, which removes all the audio conferencing providers that have been assigned to each user in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Remove-CsUserAcp -Identity "Ken Myer" -Name "Fabrikam ACP" ``` @@ -76,7 +78,7 @@ Remove-CsUserAcp -Identity "Ken Myer" -Name "Fabrikam ACP" In Example 3, all the audio conferencing providers that have the Name "Fabrikam ACP" are removed from Ken Myer's user account. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsUserAcp | Where-Object {$_.AcpInfo -match "14255551298"} | Remove-CsUserAcp ``` @@ -90,6 +92,9 @@ This filtered collection is then piped to the `Remove-CsUserAcp` cmdlet, which r ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account from which the audio conferencing provider is to be removed. You can specify a user's identity using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory Domain Services display name (for example, Ken Myer). User Identities can also be reference by using the user's Active Directory distinguished name. @@ -101,8 +106,7 @@ For example, the Identity "* Smith" returns all the users with a display name th ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -112,6 +116,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the audio conferencing provider. For example: @@ -121,8 +128,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,18 +137,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TollNumber -Non-toll-free phone number used for audio conferences. +### -ParticipantPasscode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Passcode required when connecting to a conference by using the audio conferencing provider. For example: -`-TollNumber "14255551298"` +`-PassCode "0712"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -152,6 +160,9 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to pass a user object through the pipeline that represents the user who is having the audio conferencing provider removed. By default, the `Remove-CsUserAcp` cmdlet does not pass objects through the pipeline. @@ -159,8 +170,7 @@ By default, the `Remove-CsUserAcp` cmdlet does not pass objects through the pipe ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -169,15 +179,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -TollNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Non-toll-free phone number used for audio conferences. +For example: + +`-TollNumber "14255551298"` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -187,6 +202,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. @@ -194,7 +212,6 @@ Prompts you for confirmation before executing the command. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -203,18 +220,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ParticipantPasscode -Passcode required when connecting to a conference by using the audio conferencing provider. -For example: +### -WhatIf -`-PassCode "0712"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -228,15 +244,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -String or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.Stringor Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. The `Remove-CsUserAcp` cmdlet accepts a pipelined string value representing the Identity of a user account that has been enabled for Skype for Business Server. The cmdlet also accepts pipelined instances of the Active Directory user object. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsUserReplicatorConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsUserReplicatorConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsUserReplicatorConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsUserReplicatorConfiguration.md index 1c2fa5fc3f..016dfebbaa 100644 --- a/skype/skype-ps/skype/Remove-CsUserReplicatorConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsUserReplicatorConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csuserreplicatorconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsUserReplicatorConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csuserreplicatorconfiguration +schema: 2.0.0 +title: Remove-CsUserReplicatorConfiguration --- # Remove-CsUserReplicatorConfiguration @@ -53,7 +54,7 @@ In the case of the User Replicator, that means erasing the list of domains that ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsUserReplicatorConfiguration -Identity global ``` @@ -63,7 +64,28 @@ Example 1 resets the global User Replicator configuration settings. ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the User Replicator configuration settings to be removed. To remove settings at the service scope, use syntax similar to this: @@ -80,8 +102,7 @@ You cannot use wildcards when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -90,14 +111,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -107,29 +130,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -143,14 +152,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.UserReplicator.UserReplicatorConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.UserReplicator.UserReplicatorConfiguration + The `Remove-CsUserReplicatorConfiguration` cmdlet accepts pipelined input of the User Replicator configuration object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsUserReplicatorConfiguration` cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserReplicator.UserReplicatorConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsUserServicesConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsUserServicesConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsUserServicesConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsUserServicesConfiguration.md index 373e6cace5..9b6f635b1b 100644 --- a/skype/skype-ps/skype/Remove-CsUserServicesConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsUserServicesConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csuserservicesconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsUserServicesConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csuserservicesconfiguration +schema: 2.0.0 +title: Remove-CsUserServicesConfiguration --- # Remove-CsUserServicesConfiguration @@ -38,7 +39,7 @@ For example, if you have changed the MaxContacts value in the global settings to ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsUserServicesConfiguration -Identity site:Redmond ``` @@ -46,7 +47,7 @@ Remove-CsUserServicesConfiguration -Identity site:Redmond The command shown in Example 1 removes the User Services configuration settings from the Redmond site (`-Identity site:Redmond`). -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsUserServicesConfiguration -Filter "service:*:" | Remove-CsUserServicesConfiguration ``` @@ -57,7 +58,7 @@ The filter value "service:*" limits returned data to settings configured at the This filtered collection is then piped to the `Remove-CsUserServicesConfiguration` cmdlet, which deletes each item in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsUserServicesConfiguration | Where-Object {$_.MaxContacts -gt 250} | Remove-CsUserServicesConfiguration ``` @@ -70,7 +71,28 @@ Those settings are then piped to and removed by, the `Remove-CsUserServicesConfi ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the User Services configuration settings to be removed. To delete settings configured at the site scope, use syntax similar to this: @@ -88,8 +110,7 @@ Instead, all the properties in that collection will be reset to their default va ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -98,14 +119,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -115,29 +138,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -151,14 +160,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.UserServicesSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.UserServicesSettings + The `Remove-CsUserServicesConfiguration` cmdlet accepts pipelined instances of the User Services settings object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsUserServicesConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.UserServicesSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsUserServicesPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsUserServicesPolicy.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsUserServicesPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsUserServicesPolicy.md index b5402b89cb..38132dae42 100644 --- a/skype/skype-ps/skype/Remove-CsUserServicesPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsUserServicesPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csuserservicespolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsUserServicesPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csuserservicespolicy +schema: 2.0.0 +title: Remove-CsUserServicesPolicy --- # Remove-CsUserServicesPolicy @@ -45,7 +46,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsUserServicesPolicy -Identity "RedmondUserServicesPolicy" ``` @@ -53,7 +54,7 @@ Remove-CsUserServicesPolicy -Identity "RedmondUserServicesPolicy" The command shown in Example 1 deletes the per-user User Services policy RedmondUserServicesPolicy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUserServicesPolicy -Filter "site:*" | Remove-CsUserServicesPolicy ``` @@ -63,7 +64,7 @@ To do this, the command first uses the `Get-CsUserServicesPolicy` cmdlet and the The resulting collection is then piped to the `Remove-CsUserServicesPolicy` cmdlet, which deletes each policy in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsUserServicesPolicy | Where-Object {$_.UcsAllowed -eq $True} | Remove-CsUserServicesPolicy ``` @@ -76,7 +77,28 @@ Those policies are then piped to and removed by, the `Remove-CsUserServicesPolic ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the policy to be deleted. To remove a policy configured at the site scope, use syntax similar to this: @@ -96,8 +118,7 @@ To remove per-user policies, use syntax similar to this: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -106,30 +127,20 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Removes the user services policy assigned to the specified Skype for Business Online tenant. +When removing a policy assigned to a tenant, you must also include the Identity parameter along with the parameter value "global": + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" -Identity "global"` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,18 +149,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Removes the user services policy assigned to the specified Skype for Business Online tenant. -When removing a policy assigned to a tenant, you must also include the Identity parameter along with the parameter value "global": +### -Confirm -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" -Identity "global"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -159,13 +168,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -179,13 +190,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.UserServices.UserServicesPolicy The `Remove-CsUserServicesPolicy` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Policy.UserServices.UserServicesPolicy object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsUserServicesPolicy` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Policy.UserServices.UserServicesPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsUserStoreBackupData.md b/skype/skype-ps/SkypeForBusiness/Remove-CsUserStoreBackupData.md similarity index 88% rename from skype/skype-ps/skype/Remove-CsUserStoreBackupData.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsUserStoreBackupData.md index a03b9546bf..2f9501747c 100644 --- a/skype/skype-ps/skype/Remove-CsUserStoreBackupData.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsUserStoreBackupData.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csuserstorebackupdata applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsUserStoreBackupData -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csuserstorebackupdata +schema: 2.0.0 +title: Remove-CsUserStoreBackupData --- # Remove-CsUserStoreBackupData @@ -39,7 +40,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsUserStoreBackupData -PoolFqdn "atl-cs-001.litwareinc.com" ``` @@ -49,49 +50,55 @@ The command shown in Example 1 removes outdated user store information stored by ## PARAMETERS -### -PoolFqdn -Fully qualified domain name of the pool where "outdated" user information should be removed. -For example: +### -Force -`-PoolFqdn "atl-cs-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool where "outdated" user information should be removed. +For example: + +`-PoolFqdn "atl-cs-001.litwareinc.com"` ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -101,13 +108,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -121,14 +130,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Remove-CsUserStoreBackupData` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsVideoInteropServerConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVideoInteropServerConfiguration.md similarity index 92% rename from skype/skype-ps/skype/Remove-CsVideoInteropServerConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsVideoInteropServerConfiguration.md index 3aebb35e96..ec86105396 100644 --- a/skype/skype-ps/skype/Remove-CsVideoInteropServerConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVideoInteropServerConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvideointeropserverconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsVideoInteropServerConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csvideointeropserverconfiguration +schema: 2.0.0 +title: Remove-CsVideoInteropServerConfiguration --- # Remove-CsVideoInteropServerConfiguration @@ -43,7 +44,7 @@ Skype for Business Server does not allow you to delete the global settings. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsVideoInteropServerConfiguration -Identity "site:Redmond" ``` @@ -51,7 +52,7 @@ Remove-CsVideoInteropServerConfiguration -Identity "site:Redmond" This example deletes the VIS configuration settings assigned to the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVideoInteropServerConfiguration -Filter "site:*" | Remove-CsVideoInteropServerConfiguration ``` @@ -61,7 +62,7 @@ The command calls the `Get-CsVideoInteropServerConfiguration` and filters the co Those configuration objects are then piped to and deleted by, the `Remove-CsVideoInteropServerConfiguration` cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVideoInteropServerConfiguration | Where-Object {$_.EnableEnhancedVideoExperience -eq $True} | Remove-CsVideoInteropServerConfiguration ``` @@ -74,7 +75,28 @@ Those configuration objects are then piped to and deleted by the `Remove-CsVideo ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identity assigned to the video interop service configuration settings when they were created. Video interop settings can be assigned at the global, site, or service scope (for the VideoInteropServer service only). For example, to remove settings configured at the site scope use the following syntax: @@ -89,8 +111,7 @@ Instead, all the properties within the collection will be reset to their default ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -100,13 +121,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -115,30 +138,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -152,13 +161,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.VideoInteropServer.VideoInteropServerConfiguration The `Remove-CsVideoInteropServerConfiguration` cmdlet accepts pipelined input of the Microsoft.Rtc.Management.WritableConfig.Settings.VideoInteropServer.VideoInteropServerConfiguration object. ## OUTPUTS -### -None. +### None The `Remove-CsVideoInteropServerConfiguration` cmdlet deletes instances of the Microsoft.Rtc.Management.WritableConfig.Settings.VideoInteropServer.VideoInteropServerConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md index c5fe430c83..064d514c8a 100644 --- a/skype/skype-ps/skype/Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVideoInteropServerSyntheticTransactionConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvideointeropserversynthetictransactionconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsVideoInteropServerSyntheticTransactionConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csvideointeropserversynthetictransactionconfiguration +schema: 2.0.0 +title: Remove-CsVideoInteropServerSyntheticTransactionConfiguration --- # Remove-CsVideoInteropServerSyntheticTransactionConfiguration @@ -29,7 +30,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsVideoInteropServerSyntheticTransactionConfiguration -Identity "site:Redmond" ``` @@ -39,7 +40,28 @@ This example removes the Video Interop Server synthetic transaction configuratio ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Identity of the VIS configuration to be removed. VIS settings can be configured at the global, site, or service scope (for the VideoInteropServer service only). To refer to the global instance, use this syntax: @@ -53,8 +75,7 @@ Use this syntax to refer to a collection at the site scope: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -64,13 +85,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -79,30 +102,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -116,13 +125,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.VideoInteropServer.VideoInteropServerSyntheticTransactionConfiguration Accepts pipelined instances of the VideoInteropServerSyntheticTransactionConfiguration object. ## OUTPUTS -### -None +### None ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsVideoTrunkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVideoTrunkConfiguration.md similarity index 92% rename from skype/skype-ps/skype/Remove-CsVideoTrunkConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsVideoTrunkConfiguration.md index 820a5f657f..b3583f70e0 100644 --- a/skype/skype-ps/skype/Remove-CsVideoTrunkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVideoTrunkConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvideotrunkconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsVideoTrunkConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csvideotrunkconfiguration +schema: 2.0.0 +title: Remove-CsVideoTrunkConfiguration --- # Remove-CsVideoTrunkConfiguration @@ -47,7 +48,7 @@ However, administrators can use the `New-CsVideoTrunkConfiguration` cmdlet to cr ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsVideoTrunkConfiguration -Identity "site:Seattle" ``` @@ -55,7 +56,7 @@ Remove-CsVideoTrunkConfiguration -Identity "site:Seattle" This example removes the Video Trunk configuration settings scoped to the Seattle site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVideoTrunkConfiguration -Filter "site:*" | Remove-CsVideoTrunkConfiguration ``` @@ -67,7 +68,28 @@ Those configuration objects are then piped to, and removed by, the `Remove-CsVid ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The Identity parameter specifies the Video Trunk configuration to remove. Video Trunk configuration settings can be configured at the global, site, or service scope (for the VideoGateway service only). To refer to the global instance, use this syntax: `-Identity "global"` To refer to a collection at the site scope: `-Identity "site:Redmond"` @@ -81,8 +103,7 @@ Instead, all the properties within the collection will be reset to their default ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -92,13 +113,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -107,30 +130,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -144,13 +153,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.VideoTrunkConfiguration The` Remove-CsVideoTrunkConfiguration` cmdlet accepts pipelined input of the Microsoft.Rtc.Management.WritableConfig.Settings.VideoTrunkConfiguration object. ## OUTPUTS -### -None. +### None The `Remove-CsVideoTrunkConfiguration` cmdlet removes specified Microsoft.Rtc.Management.WritableConfig.Settings.VideoTrunkConfiguration objects. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsVoiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceConfiguration.md similarity index 84% rename from skype/skype-ps/skype/Remove-CsVoiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsVoiceConfiguration.md index ce31f612a4..4497dd8e79 100644 --- a/skype/skype-ps/skype/Remove-CsVoiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoiceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsVoiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoiceconfiguration +schema: 2.0.0 +title: Remove-CsVoiceConfiguration --- # Remove-CsVoiceConfiguration @@ -35,7 +36,7 @@ After calling this cmdlet, a call to the `Get-CsVoiceTestConfiguration` cmdlet w ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsVoiceConfiguration -Identity Global -Confirm ``` @@ -46,15 +47,35 @@ This action deletes all defined voice test configurations, so we added the Confi ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The scope of the voice configuration to remove. This value must be Global. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -63,14 +84,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -80,29 +103,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -116,13 +125,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration + Accepts pipelined input of a voice configuration object. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration This cmdlet removes (resets) an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsVoiceNormalizationRule.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceNormalizationRule.md similarity index 85% rename from skype/skype-ps/skype/Remove-CsVoiceNormalizationRule.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsVoiceNormalizationRule.md index 4513a469fb..be8511a104 100644 --- a/skype/skype-ps/skype/Remove-CsVoiceNormalizationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceNormalizationRule.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoicenormalizationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsVoiceNormalizationRule -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoicenormalizationrule +schema: 2.0.0 +title: Remove-CsVoiceNormalizationRule --- # Remove-CsVoiceNormalizationRule @@ -37,7 +39,7 @@ This means that calling the `Remove-CsVoiceNormalizationRule` cmdlet could leave ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsVoiceNormalizationRule -Identity site:Redmond/SeattleRule1 ``` @@ -45,7 +47,7 @@ Remove-CsVoiceNormalizationRule -Identity site:Redmond/SeattleRule1 This example removes the voice normalization rule with the Identity site:Redmond/SeattleRule1. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Remove-CsVoiceNormalizationRule -Identity site:Redmond ``` @@ -55,51 +57,56 @@ This example removes all voice normalization rules from site Redmond. ## PARAMETERS -### -Identity -The unique identity of the rule to be removed. -If the Identity specified includes the scope followed by a slash and then the name (for example: site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name), the one rule with that unique Identity will be removed. -If the value passed to the Identity contains only the scope (site:Redmond), all normalization rules at that scope will be removed. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: XdsIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identity of the rule to be removed. +If the Identity specified includes the scope followed by a slash and then the name (for example: site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name), the one rule with that unique Identity will be removed. +If the value passed to the Identity contains only the scope (site:Redmond), all normalization rules at that scope will be removed. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Tenant + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +For internal Microsoft usage. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -109,6 +116,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. @@ -116,7 +126,6 @@ Prompts you for confirmation before executing the command. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -125,14 +134,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -For internal Microsoft usage. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -146,13 +158,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule + Accepts pipelined input of voice normalization rule objects. ## OUTPUTS -### +### None This cmdlet deletes an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsVoicePolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVoicePolicy.md similarity index 83% rename from skype/skype-ps/skype/Remove-CsVoicePolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsVoicePolicy.md index 137f719863..fb80140a1a 100644 --- a/skype/skype-ps/skype/Remove-CsVoicePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVoicePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoicepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsVoicePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoicepolicy +schema: 2.0.0 +title: Remove-CsVoicePolicy --- # Remove-CsVoicePolicy @@ -33,7 +34,7 @@ In that case, however, the policy will not actually be removed; instead, the pol ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsVoicePolicy -Identity UserVoicePolicy1 ``` @@ -41,7 +42,7 @@ Remove-CsVoicePolicy -Identity UserVoicePolicy1 This example removes the UserVoicePolicy1 per-user voice policy settings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVoicePolicy -Filter tag* | Remove-CsVoicePolicy ``` @@ -53,15 +54,35 @@ That collection of policies is then piped to the `Remove-CsVoicePolicy` cmdlet t ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier specifying the scope and in some cases the name, of the policy to be removed. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -70,30 +91,23 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for the voice policy being deleted. +For example: -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -103,13 +117,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -118,21 +134,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for the voice policy being deleted. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -146,13 +157,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoicePolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoicePolicy + Accepts pipelined input of voice policy objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It removes an instance of a Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoicePolicy object. diff --git a/skype/skype-ps/skype/Remove-CsVoiceRoute.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceRoute.md similarity index 84% rename from skype/skype-ps/skype/Remove-CsVoiceRoute.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsVoiceRoute.md index 97f01579c4..575325bdab 100644 --- a/skype/skype-ps/skype/Remove-CsVoiceRoute.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceRoute.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoiceroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsVoiceRoute -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoiceroute +schema: 2.0.0 +title: Remove-CsVoiceRoute --- # Remove-CsVoiceRoute @@ -31,7 +32,7 @@ Voice routes are associated with voice policies through PSTN usages, so removing ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsVoiceRoute -Identity Route1 ``` @@ -39,7 +40,7 @@ Remove-CsVoiceRoute -Identity Route1 Removes the settings for the voice route with the identity Route1. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVoiceRoute | Remove-CsVoiceRoute ``` @@ -49,7 +50,7 @@ First all voice routes are retrieved by the `Get-CsVoiceRoute` cmdlet. These voice routes are then piped to the `Remove-CsVoiceRoute` cmdlet, which removes each one. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVoiceRoute -Filter *Redmond* | Remove-CsVoiceRoute ``` @@ -61,15 +62,35 @@ After all of the voice routes with identities that include the string Redmond ar ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A string that uniquely identifies the voice route you want to delete. (If the route name contains a space, such as Test Route, you must enclose the full string in double quotes.) ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -78,14 +99,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -95,29 +118,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -131,13 +140,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route + Accepts pipelined input of voice route objects. ## OUTPUTS -### +### None Removes an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsVoiceRoutingPolicy.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceRoutingPolicy.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsVoiceRoutingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsVoiceRoutingPolicy.md index 2d439ee40e..c9531ad446 100644 --- a/skype/skype-ps/skype/Remove-CsVoiceRoutingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceRoutingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoiceroutingpolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsVoiceRoutingPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoiceroutingpolicy +schema: 2.0.0 +title: Remove-CsVoiceRoutingPolicy --- # Remove-CsVoiceRoutingPolicy @@ -37,7 +38,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsVoiceRoutingPolicy -Identity "RedmondVoiceRoutingPolicy" ``` @@ -45,7 +46,7 @@ Remove-CsVoiceRoutingPolicy -Identity "RedmondVoiceRoutingPolicy" The command shown in Example 1 deletes the voice routing policy RedmondVoiceRoutingPolicy -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVoiceRoutingPolicy -Filter "tag:*" | Remove-CsVoiceRoutingPolicy ``` @@ -55,7 +56,7 @@ To do this, the command first calls the `Get-CsVoiceRoutingPolicy` cmdlet along Those per-user policies are then piped to and removed by, the `Remove-CsVoiceRoutingPolicy` cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVoiceRoutingPolicy | Where-Object {$_.PstnUsages -contains "Long Distance"} | Remove-CsVoiceRoutingPolicy ``` @@ -67,7 +68,33 @@ That collection is then piped to the `Where-Object` cmdlet, which picks out only ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If this parameter is present, the policy will automatically be removed even if it is currently assigned to at least one user. + +If this parameter is not present, then the `Remove-CsVoiceRoutingPolicy` cmdlet will not automatically remove a per-user policy that is assigned to at least one user. +Instead, a confirmation prompt will appear asking if you are sure that you want to remove the policy. +You must answer yes (by pressing the Y key) before the command will continue and the policy 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 +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the voice routing policy to be removed. To "remove" the global policy, use the following syntax: @@ -85,8 +112,7 @@ You cannot use wildcards when specifying a policy Identity. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -96,13 +122,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -111,35 +139,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -If this parameter is present, the policy will automatically be removed even if it is currently assigned to at least one user. - -If this parameter is not present, then the `Remove-CsVoiceRoutingPolicy` cmdlet will not automatically remove a per-user policy that is assigned to at least one user. -Instead, a confirmation prompt will appear asking if you are sure that you want to remove the policy. -You must answer yes (by pressing the Y key) before the command will continue and the policy will be removed. +### -WhatIf +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -153,13 +162,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceRoutingPolicy The `Remove-CsVoiceRoutingPolicy` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceRoutingPolicy object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsVoiceRoutingPolicy` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceRoutingPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsVoiceTestConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceTestConfiguration.md similarity index 83% rename from skype/skype-ps/skype/Remove-CsVoiceTestConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsVoiceTestConfiguration.md index 0a7f3baca9..bb60c78d2a 100644 --- a/skype/skype-ps/skype/Remove-CsVoiceTestConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVoiceTestConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoicetestconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsVoiceTestConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoicetestconfiguration +schema: 2.0.0 +title: Remove-CsVoiceTestConfiguration --- # Remove-CsVoiceTestConfiguration @@ -31,7 +32,7 @@ When you're done with those tests and won't need them again, use this cmdlet to ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsVoiceTestConfiguration -Identity TestConfig1 ``` @@ -39,7 +40,7 @@ Remove-CsVoiceTestConfiguration -Identity TestConfig1 This example removes the voice test configuration settings with the Identity TestConfig1. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVoiceTestConfiguration -Filter *test* | Remove-CsVoiceTestConfiguration ``` @@ -51,14 +52,34 @@ The resulting set of configurations is then piped to the `Remove-CsVoiceTestConf ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A string uniquely identifying the test configuration you want to remove. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -67,14 +88,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -84,29 +107,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -120,13 +129,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration + Accepts pipelined input of voice test configuration objects. ## OUTPUTS -### +### None Removes an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsVoicemailReroutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsVoicemailReroutingConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Remove-CsVoicemailReroutingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsVoicemailReroutingConfiguration.md index 9a5d3a1dfd..0ce4d9d834 100644 --- a/skype/skype-ps/skype/Remove-CsVoicemailReroutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsVoicemailReroutingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoicemailreroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsVoicemailReroutingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csvoicemailreroutingconfiguration +schema: 2.0.0 +title: Remove-CsVoicemailReroutingConfiguration --- # Remove-CsVoicemailReroutingConfiguration @@ -37,7 +38,7 @@ Note that if you call this cmdlet to remove the Global settings, those settings ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsVoicemailReroutingConfiguration -Identity site:Redmond1 ``` @@ -45,7 +46,7 @@ Remove-CsVoicemailReroutingConfiguration -Identity site:Redmond1 This example removes the voice mail rerouting configuration settings for the site Redmond1. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVoicemailReroutingConfiguration | Remove-CsVoicemailReroutingConfiguration ``` @@ -57,15 +58,35 @@ The settings retrieved by this call are then passed to the `Remove-CsVoicemailRe ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the configuration you want to remove. For this cmdlet the Identity will be either Global or Site:\, where \ is the name of the site to which the settings are applied. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -74,14 +95,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -91,29 +114,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -127,13 +136,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.ExumRouting.VoicemailReroutingConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.ExumRouting.VoicemailReroutingConfiguration + Accepts pipelined input of voice mail rerouting configuration objects. ## OUTPUTS -### +### None Removes an object of type Microsoft.Rtc.Management.WritableConfig.Settings.ExumRouting.VoicemailReroutingConfiguration. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsWatcherNodeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsWatcherNodeConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Remove-CsWatcherNodeConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsWatcherNodeConfiguration.md index e6ad98fce0..f2f856cfaa 100644 --- a/skype/skype-ps/skype/Remove-CsWatcherNodeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsWatcherNodeConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cswatchernodeconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsWatcherNodeConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cswatchernodeconfiguration +schema: 2.0.0 +title: Remove-CsWatcherNodeConfiguration --- # Remove-CsWatcherNodeConfiguration @@ -39,7 +40,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Remov ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsWatcherNodeConfiguration -Identity "atl-cs-001.litwareinc.com" ``` @@ -47,7 +48,7 @@ Remove-CsWatcherNodeConfiguration -Identity "atl-cs-001.litwareinc.com" The command shown in Example 1 removes the watcher node configuration settings applied to the pool `atl-cs-001.litwareinc.com`. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsWatcherNodeConfiguration | Remove-CsWatcherNodeConfiguration ``` @@ -58,7 +59,7 @@ This collection is then piped to the `Remove-CsWatcherNodeConfiguration` cmdlet, That effectively removes each watcher node in the organization. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsWatcherNodeConfiguration | Where-Object {$_.TestUsers -contains "sip:kenmyer@litwareinc.com"} | Remove-CsWatcherNodeConfiguration ``` @@ -71,7 +72,28 @@ That filtered collection is then piped to the `Remove-CsWatcherNodeConfiguration ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the pool that has been assigned the watcher node being deleted. For example: @@ -80,8 +102,7 @@ For example: ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -91,13 +112,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -106,30 +129,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -143,13 +152,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.TargetPool#Decorated The `Remove-CsWatcherNodeConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.TargetPool#Decorated object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsWatcherNodeConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.TargetPool#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsWebServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Remove-CsWebServiceConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Remove-CsWebServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsWebServiceConfiguration.md index 11ae5b1038..87b50bd854 100644 --- a/skype/skype-ps/skype/Remove-CsWebServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsWebServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-cswebserviceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsWebServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-cswebserviceconfiguration +schema: 2.0.0 +title: Remove-CsWebServiceConfiguration --- # Remove-CsWebServiceConfiguration @@ -42,7 +43,7 @@ Because the default value for this property is 100, "removing" the global collec ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Remove-CsWebServiceConfiguration -Identity site:Redmond ``` @@ -50,7 +51,7 @@ Remove-CsWebServiceConfiguration -Identity site:Redmond Example 1 removes the Web Services configuration settings for the Redmond site. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsWebServiceConfiguration -Filter "site:*" | Remove-CsWebServiceConfiguration ``` @@ -60,7 +61,7 @@ To carry out this task, the command first calls the `Get-CsWebServiceConfigurati This filtered collection is then piped to the `Remove-CsWebServiceConfiguration` cmdlet, which deletes each item in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsWebServiceConfiguration | Where-Object {$_.EnableGroupExpansion -eq $False} | Remove-CsWebServiceConfiguration ``` @@ -73,7 +74,28 @@ The filtered collection is then piped to the `Remove-CsWebServiceConfiguration` ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the Web Services configuration settings to be removed. To remove settings configured at the site scope, use syntax similar to this: @@ -93,8 +115,7 @@ To reset the global collection, use this syntax: ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -103,14 +124,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -120,29 +143,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -156,14 +165,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Web.WebServiceSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Web.WebServiceSettings + The `Remove-CsWebServiceConfiguration` cmdlet accepts pipelined input of the Web Services settings object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsWebServiceConfiguration` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Web.WebServiceSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Remove-CsXmppAllowedPartner.md b/skype/skype-ps/SkypeForBusiness/Remove-CsXmppAllowedPartner.md similarity index 91% rename from skype/skype-ps/skype/Remove-CsXmppAllowedPartner.md rename to skype/skype-ps/SkypeForBusiness/Remove-CsXmppAllowedPartner.md index fabbb2d393..e0e4ff92ba 100644 --- a/skype/skype-ps/skype/Remove-CsXmppAllowedPartner.md +++ b/skype/skype-ps/SkypeForBusiness/Remove-CsXmppAllowedPartner.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/remove-csxmppallowedpartner applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Remove-CsXmppAllowedPartner -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/remove-csxmppallowedpartner +schema: 2.0.0 +title: Remove-CsXmppAllowedPartner --- # Remove-CsXmppAllowedPartner @@ -40,7 +41,7 @@ Select the partner to be removed, click Edit and then click Delete. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsXmppAllowedPartner -Identity "contoso.com" ``` @@ -48,7 +49,7 @@ Remove-CsXmppAllowedPartner -Identity "contoso.com" Example 1 deletes the XMPP allowed partner with the Identity "contoso.com". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsXmppAllowedPartner | Remove-CsXmppAllowedPartner ``` @@ -58,7 +59,7 @@ To carry out this task the command first calls the `Get-CsXmppAllowedPartner` cm This collection is then piped to the `Remove-CsXmppAllowedPartner` cmdlet, which removes each partner in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsXmppAllowedPartner | Where-Object {$_.PartnerType -eq "PublicUnverified"} | Remove-CsXmppAllowedPartner ``` @@ -71,7 +72,28 @@ The partners that meet that criterion are then piped to and deleted by, the `Rem ## PARAMETERS +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Fully qualified domain name (FQDN) of the XMPP allowed partner to be deleted. For example: @@ -80,8 +102,7 @@ For example: ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 2 @@ -91,13 +112,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -106,30 +129,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -143,13 +152,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppAllowedPartner#Decorated The `Remove-CsXmppAllowedPartner` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppAllowedPartner#Decorated object. ## OUTPUTS -### -None. +### None Instead, the `Remove-CsXmppAllowedPartner` cmdlet deletes existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppAllowedPartner#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Request-CsCertificate.md b/skype/skype-ps/SkypeForBusiness/Request-CsCertificate.md similarity index 81% rename from skype/skype-ps/skype/Request-CsCertificate.md rename to skype/skype-ps/SkypeForBusiness/Request-CsCertificate.md index 56a2d03fd8..1f4ee8c8b5 100644 --- a/skype/skype-ps/skype/Request-CsCertificate.md +++ b/skype/skype-ps/SkypeForBusiness/Request-CsCertificate.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/request-cscertificate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Request-CsCertificate -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/request-cscertificate +schema: 2.0.0 +title: Request-CsCertificate --- # Request-CsCertificate @@ -72,7 +73,7 @@ After that you should be able to retrieve certificate requests. ## EXAMPLES -### -------------------------- Example 1 ----------------------- +### Example 1 ``` Request-CsCertificate -New -Type WebServicesExternal -CA "atl-ca-001.litwareinc.com\myca" ``` @@ -80,7 +81,7 @@ Request-CsCertificate -New -Type WebServicesExternal -CA "atl-ca-001.litwareinc. The command shown in Example 1 creates a new certificate request: it contacts the CA atl-ca-001.litwareinc.com\myca and requests a new WebServicesExternal certificate. -### -------------------------- Example 2 ----------------------- +### Example 2 ``` Request-CsCertificate -List ``` @@ -88,7 +89,7 @@ Request-CsCertificate -List Example 2 lists all the pending certificate requests made by using the `Request-CsCertificate` cmdlet. -### -------------------------- Example 3 ----------------------- +### Example 3 ``` Request-CsCertificate -New -Type WebServicesExternal -Output C:\Certificates\WebServicesExternal.cer ``` @@ -96,7 +97,7 @@ Request-CsCertificate -New -Type WebServicesExternal -Output C:\Certificates\Web Example 3 uses the Output parameter to create an offline certificate request. -### -------------------------- Example 4 ----------------------- +### Example 4 ``` Request-CsCertificate -New -Type Default,WebServicesInternal,WebServicesExternal -ComputerFqdn "atl-cs-001.litwareinc.com" -CA "atl-ca-001.litwareinc.com\myca" -FriendlyName "Standard Edition Certificate" -Template jcila -PrivateKeyExportable $True -DomainName "atl-cs-001.litwareinc.com,atl-ext.litwareinc.com" ``` @@ -105,7 +106,7 @@ Example 4 is a more detailed (and more realistic) example of how to use the `Req This example requests a certificate for use with the Standard Edition of Skype for Business Server. -### -------------------------- Example 5 ----------------------- +### Example 5 ``` Request-CsCertificate -New -Type Default,WebServicesInternal,WebServicesExternal -ComputerFqdn "atl-cs-001.litwareinc.com" -CA "atl-ca-001.litwareinc.com\myca" -FriendlyName "Enterprise Edition Pool Certificate" -Template jcila -PrivateKeyExportable $True -DomainName "pool1.litwareinc.com,pool1int.litwareinc.com,pool1ext.litwareinc.com" ``` @@ -113,7 +114,7 @@ Request-CsCertificate -New -Type Default,WebServicesInternal,WebServicesExternal In Example 5, a pool certificate is requested for use with the Enterprise Edition of Skype for Business Server. -### -------------------------- Example 6 ----------------------- +### Example 6 ``` Request-CsCertificate -New -Type Internal -ComputerFqdn "atl-edge-001" -CA "atl-ca-001.litwareinc.com\myca" -FriendlyName "Internal Edge Certificate" -Template jcila -PrivateKeyExportable $True -DomainName "atl-edge-001.litwareinc.com, ap.litwareinc.com" ``` @@ -121,7 +122,7 @@ Request-CsCertificate -New -Type Internal -ComputerFqdn "atl-edge-001" -CA "atl- Example 6 shows how you can request a certificate for the internal Edge Server. -### -------------------------- Example 7 ----------------------- +### Example 7 ``` Request-CsCertificate -New -Type AccessEdgeExternal,DataEdgeExternal,AudioVideoAuthentication -ComputerFqdn "atl-edge-001" -CA "atl-ca-001.litwareinc.com\myca" -FriendlyName "External Edge Certificate" -Template jcila -PrivateKeyExportable $True -DomainName "atl-edge-001.litwareinc.com,ap.litwareinc.com,dp.litwareinc.com,atl-edge-001" ``` @@ -131,52 +132,20 @@ Example 7 is a variation of the command shown in Example 6, In this case, howeve ## PARAMETERS -### -Type -Type of certificate being requested. -Certificate types include (but are not limited to): - -AccessEdgeExternal - -AudioVideoAuthentication - -DataEdgeExternal - -Default - -External - -Internal - -iPhoneAPNService - -iPadAPNService - -MPNService - -PICWebService (Skype for Business Online only) - -ProvisionService (Skype for Business Online only) - -WebServicesExternal - -WebServicesInternal - -WsFedTokenTransfer - -For example, this syntax requests a new Default certificate: `-Type Default`. - -You can specify multiple types in a single command by separating the certificate types with commas: +### -AllSipDomain -`-Type Internal,External,Default` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +When present, all your SIP domains are automatically added to the certificates Subject Alternative Name field. +If not present, only the primary SIP domain is added by default. +However, additional domains can be specified by using the DomainName parameter. ```yaml -Type: CertType[] +Type: SwitchParameter Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -184,6 +153,9 @@ Accept wildcard characters: False ``` ### -CA + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) that points to the CA. For example: `-CA "atl-ca-001.litwareinc.com\myca"`. To obtain a list of known CAs, type the following at the Windows PowerShell prompt, and then press ENTER: @@ -195,8 +167,7 @@ The Config property returned by Certutil indicates the location of a CA. ```yaml Type: String Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -206,6 +177,9 @@ Accept wildcard characters: False ``` ### -CaAccount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Account name of the user requesting the new certificate, using the format domain_name\user_name. For example: `-CaAccount "litwareinc\kenmyer"`. If not specified, the `Request-CsCertificate` cmdlet will use the credentials of the logged-on user when requesting the new certificate. @@ -214,8 +188,7 @@ If not specified, the `Request-CsCertificate` cmdlet will use the credentials of ```yaml Type: String Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,13 +198,15 @@ Accept wildcard characters: False ``` ### -CaPassword + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Password for the user requesting the new certificate (as specified using the CaAccount parameter). ```yaml Type: String Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -241,13 +216,15 @@ Accept wildcard characters: False ``` ### -City + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + City where the certificate will be deployed. ```yaml Type: String Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -257,14 +234,16 @@ Accept wildcard characters: False ``` ### -Clear + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, deletes any pending certificate requests made by using the `Request-CsCertificate` cmdlet. ```yaml Type: SwitchParameter Parameter Sets: ByClear -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -274,6 +253,9 @@ Accept wildcard characters: False ``` ### -ClientEKU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Set this parameter to True if the certificate is to be used for client authentication. This type of authentication is required if you want your users to be able to exchange instant messages with people who have accounts with AOL. The EKU portion of the parameter name is short for extended key usage; the extended key usage field lists the valid uses for the certificate. @@ -281,8 +263,7 @@ The EKU portion of the parameter name is short for extended key usage; the exten ```yaml Type: Boolean Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -292,6 +273,9 @@ Accept wildcard characters: False ``` ### -ComputerFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of the computer for which the certificate is being requested. When present, this parameter forces the `Request-CsCertificate` cmdlet to connect to the Central Management store in order to locate the specified computer. You should always use the computer name when requesting a certificate, even when requesting a pool certificate. @@ -301,8 +285,7 @@ The `Request-CsCertificate` cmdlet will automatically add the pool name to the S ```yaml Type: Fqdn Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -312,13 +295,15 @@ Accept wildcard characters: False ``` ### -Country + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Country/region where the certificate will be deployed. ```yaml Type: String Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -328,6 +313,9 @@ Accept wildcard characters: False ``` ### -DomainName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Comma-separated list of fully-qualified domain names that should be added to the certificate's Subject Alternative Name field. For example: @@ -337,8 +325,25 @@ For example: ```yaml Type: String Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -348,13 +353,15 @@ Accept wildcard characters: False ``` ### -FriendlyName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + User-assigned name that makes it easier to identify the certificate. ```yaml Type: String Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -364,6 +371,9 @@ Accept wildcard characters: False ``` ### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a global catalog server in your domain. This parameter is not required if you are running the `Request-CsCertificate` cmdlet on a computer with an account in your domain. @@ -371,8 +381,7 @@ This parameter is not required if you are running the `Request-CsCertificate` cm ```yaml Type: Fqdn Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -382,6 +391,9 @@ Accept wildcard characters: False ``` ### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a domain controller where global settings are stored. If global settings are stored in the System container in Active Directory Domain Services then this parameter must point to the root domain controller. If global settings are stored in the Configuration container then any domain controller can be used and this parameter can be omitted. @@ -390,8 +402,7 @@ If global settings are stored in the Configuration container then any domain con ```yaml Type: Fqdn Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -401,6 +412,9 @@ Accept wildcard characters: False ``` ### -KeyAlg + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the type of cryptographic algorithm to be used in generating the public and private keys for the new certificate. Valid key algorithms include: @@ -415,8 +429,7 @@ ECDH_P521 ```yaml Type: KeyAlgorithmIdentifier Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -426,6 +439,9 @@ Accept wildcard characters: False ``` ### -KeySize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the size (in bits) of the private key used by the certificate. Larger key sizes are more secure, but require more processing overhead in order to be decrypted. @@ -435,8 +451,7 @@ For example: `-KeySize 2048`. ```yaml Type: Int32 Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -446,14 +461,16 @@ Accept wildcard characters: False ``` ### -List + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, lists any pending certificate requests made by using the `Request-CsCertificate` cmdlet. ```yaml Type: SwitchParameter Parameter Sets: ByList -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -463,13 +480,15 @@ Accept wildcard characters: False ``` ### -New + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, indicates that you want to request a new certificate. ```yaml Type: SwitchParameter Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -479,14 +498,16 @@ Accept wildcard characters: False ``` ### -Organization + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the organization requesting the new certificate. For example: `-Organization "Litwareinc"`. ```yaml Type: String Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -496,13 +517,15 @@ Accept wildcard characters: False ``` ### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Active Directory organizational unit for the computer that will be assigned the new certificate. ```yaml Type: String Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -512,6 +535,9 @@ Accept wildcard characters: False ``` ### -Output + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Path to the certificate file. If you want to create an offline certificate request use the Output parameter and specify a file path for the certificate request; for example: `-Output C:\Certificates\NewCertificate.pfx`. That will create a certificate request file that can then be emailed to a certification authority for processing. @@ -519,8 +545,7 @@ That will create a certificate request file that can then be emailed to a certif ```yaml Type: String Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -530,14 +555,54 @@ Accept wildcard characters: False ``` ### -PrivateKeyExportable + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Set this parameter to True if you want to make the certificate's private key exportable. When a private key is exportable, the certificate can be copied and used on multiple computers. ```yaml Type: Boolean Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: `-Report "C:\Logs\Certificates.html"` + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RequestId + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Identification number associated with a certificate request. +The RequestID parameter provides a way for you to list, retrieve, or clear an individual certificate. + +```yaml +Type: Int32 +Parameter Sets: ByClear, ByList, ByRetrieve +Aliases: Required: False Position: Named @@ -547,14 +612,16 @@ Accept wildcard characters: False ``` ### -Retrieve + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, retrieves any pending certificate requests made by using the `Request-CsCertificate` cmdlet and attempts to complete the operation and import the requested certificate. ```yaml Type: SwitchParameter Parameter Sets: ByRetrieve -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -564,6 +631,9 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + U.S. state where the certificate will be deployed. For example: `-State WA`. @@ -571,8 +641,7 @@ For example: `-State WA`. ```yaml Type: String Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -582,6 +651,9 @@ Accept wildcard characters: False ``` ### -Template + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the certificate template to be used when generating the new certificate; for example: `-Template "WebServer"`. The requested template must be installed on the CA. Note that the value entered must be the template name, not the template display name. @@ -589,8 +661,7 @@ Note that the value entered must be the template name, not the template display ```yaml Type: String Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -599,49 +670,54 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Type -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Type of certificate being requested. +Certificate types include (but are not limited to): -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: `-Report "C:\Logs\Certificates.html"` +AccessEdgeExternal -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +AudioVideoAuthentication -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +DataEdgeExternal + +Default + +External + +Internal + +iPhoneAPNService + +iPadAPNService + +MPNService + +PICWebService (Skype for Business Online only) + +ProvisionService (Skype for Business Online only) + +WebServicesExternal + +WebServicesInternal + +WsFedTokenTransfer + +For example, this syntax requests a new Default certificate: `-Type Default`. + +You can specify multiple types in a single command by separating the certificate types with commas: + +`-Type Internal,External,Default` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: CertType[] +Parameter Sets: ByNew +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -649,13 +725,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -664,33 +742,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequestId -Identification number associated with a certificate request. -The RequestID parameter provides a way for you to list, retrieve, or clear an individual certificate. - -```yaml -Type: Int32 -Parameter Sets: ByClear, ByList, ByRetrieve -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AllSipDomain -When present, all your SIP domains are automatically added to the certificates Subject Alternative Name field. -If not present, only the primary SIP domain is added by default. -However, additional domains can be specified by using the DomainName parameter. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter -Parameter Sets: ByNew -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -704,14 +765,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Request-CsCertificate` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None Instead, the `Request-CsCertificate` cmdlet helps manage instances of the Microsoft.Rtc.Management.Deployment.CertificateReference object. ## NOTES diff --git a/skype/skype-ps/skype/Reset-CsDeviceUpdateRule.md b/skype/skype-ps/SkypeForBusiness/Reset-CsDeviceUpdateRule.md similarity index 89% rename from skype/skype-ps/skype/Reset-CsDeviceUpdateRule.md rename to skype/skype-ps/SkypeForBusiness/Reset-CsDeviceUpdateRule.md index 70da9753fa..f8ac59a8cc 100644 --- a/skype/skype-ps/skype/Reset-CsDeviceUpdateRule.md +++ b/skype/skype-ps/SkypeForBusiness/Reset-CsDeviceUpdateRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/reset-csdeviceupdaterule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Reset-CsDeviceUpdateRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/reset-csdeviceupdaterule +schema: 2.0.0 +title: Reset-CsDeviceUpdateRule --- # Reset-CsDeviceUpdateRule @@ -53,7 +54,7 @@ If a rule has already been approved, you will need to use the `Restore-CsDeviceU ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Reset-CsDeviceUpdateRule -Identity service:WebServer:atl-cs-001.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9 ``` @@ -61,7 +62,7 @@ Reset-CsDeviceUpdateRule -Identity service:WebServer:atl-cs-001.litwareinc.com/d The command shown in Example 1 resets the device update rule d5ce3c10-2588-420a-82ac-dc2d9b1222ff9 found on the service WebServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsDeviceUpdateRule -Filter service:WebServer:atl-cs-001.litwareinc.com* | Reset-CsDeviceUpdateRule ``` @@ -71,7 +72,7 @@ This is done by first calling the `Get-CsDeviceUpdateRule` cmdlet along with the (By definition, these are all the device update rules that have been assigned to the service WebServer:atl-cs-001.litwareinc.com.) The filtered collection is then piped to the `Reset-CsDeviceUpdateRule` cmdlet, which resets each rule in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsDeviceUpdateRule | Where-Object {$_.Brand -eq "LG-Nortel"} | Reset-CsDeviceUpdateRule ``` @@ -84,7 +85,29 @@ After that the filtered collection is piped to the `Reset-CsDeviceUpdateRule` cm ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the device update rule being reset. The Identity for a device update rule consists of a two parts: the service where the device update rule has been assigned (for example, service:WebServer:atl-cs-001.litwareinc.com) and a globally unique identifier (GUID). Consequently, a device update rule configured for the Redmond site will have an Identity similar to this: "service:WebServer:atl-cs-oo1.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9". @@ -92,8 +115,7 @@ Consequently, a device update rule configured for the Redmond site will have an ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -103,13 +125,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -118,30 +142,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -150,15 +160,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -172,14 +183,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdate.Rule object. +### Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdate.Rule + The `Reset-CsDeviceUpdateRule` cmdlet accepts pipelined instances of the device update rule object. ## OUTPUTS -### -None. +### None Instead, the `Reset-CsDeviceUpdateRule` cmdlet resets instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdate.Rule object. ## NOTES diff --git a/skype/skype-ps/skype/Reset-CsNotificationQueues.md b/skype/skype-ps/SkypeForBusiness/Reset-CsNotificationQueues.md similarity index 86% rename from skype/skype-ps/skype/Reset-CsNotificationQueues.md rename to skype/skype-ps/SkypeForBusiness/Reset-CsNotificationQueues.md index dff712feba..0235a85981 100644 --- a/skype/skype-ps/skype/Reset-CsNotificationQueues.md +++ b/skype/skype-ps/SkypeForBusiness/Reset-CsNotificationQueues.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/reset-csnotificationqueues applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Reset-CsNotificationQueues -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/reset-csnotificationqueues +schema: 2.0.0 +title: Reset-CsNotificationQueues --- # Reset-CsNotificationQueues @@ -25,7 +26,7 @@ The `Reset-CsNotificationQueues` cmdlet resets all presence notification queues. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Reset-CsNotificationQueues -Fqdn FE01.contoso.com ``` @@ -34,14 +35,16 @@ This example resets the notification queues on server FE01.contoso.com. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -50,39 +53,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Fqdn + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the fqdn of the server which you want to reset notification queues. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Fqdn -Specifies the fqdn of the server which you want to reset notification queues. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -90,7 +100,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Reset-CsPoolRegistrarState.md b/skype/skype-ps/SkypeForBusiness/Reset-CsPoolRegistrarState.md similarity index 88% rename from skype/skype-ps/skype/Reset-CsPoolRegistrarState.md rename to skype/skype-ps/SkypeForBusiness/Reset-CsPoolRegistrarState.md index db9733ae64..e378f46c1c 100644 --- a/skype/skype-ps/skype/Reset-CsPoolRegistrarState.md +++ b/skype/skype-ps/SkypeForBusiness/Reset-CsPoolRegistrarState.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/reset-cspoolregistrarstate applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Reset-CsPoolRegistrarState -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/reset-cspoolregistrarstate +schema: 2.0.0 +title: Reset-CsPoolRegistrarState --- # Reset-CsPoolRegistrarState @@ -36,7 +37,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Reset ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Reset-CsPoolRegistrarState -PoolFqdn "atl-cs-001.litwareinc.com" -ResetType ServiceReset ``` @@ -45,7 +46,7 @@ The command shown in Example 1 performs a service reset for the Registrar pool ` Note that, after issuing this command, you will be prompted as to whether or not you want to proceed with the service reset. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Reset-CsPoolRegistrarState -PoolFqdn "atl-cs-001.litwareinc.com" -ResetType ServiceReset -Confirm:$False ``` @@ -57,7 +58,7 @@ As a result, you will not be prompted as to whether or not you want to proceed w Instead, the command will run as soon as you press ENTER. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Reset-CsPoolRegistrarState -PoolFqdn "atl-cs-001.litwareinc.com" -ResetType QuorumLossRecovery ``` @@ -68,7 +69,7 @@ Note that only those services that are in a quorum loss will have to reload user Other services will be unaffected by this command. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Reset-CsPoolRegistrarState -PoolFqdn "atl-cs-001.litwareinc.com" -ResetType FullReset ``` @@ -82,7 +83,7 @@ Because of that, it is recommended that you first try to restart the pool using If that fails, please consult Microsoft support personnel before using the FullReset option. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Reset-CsPoolRegistrarState -PoolFqdn "atl-cs-001.litwareinc.com" -ResetType FullReset -NoReStart ``` @@ -98,33 +99,35 @@ If that fails, please consult Microsoft support personnel before using the FullR ## PARAMETERS -### -PoolFqdn -Fully qualified domain name of the Registrar pool being reset. -For example: +### -Force -`-PoolFqdn "atl-cs-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -MachineFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the computer to be removed from the pool. +This parameter is only used when performing a MachineStateRemoved reset. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -133,14 +136,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -NoReStart + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When specified, services (such as RtcSrv and FabricHostSvc) that are stopped when the cmdlet runs are not restarted. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -149,33 +154,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MachineFqdn -Fully qualified domain name of the computer to be removed from the pool. -This parameter is only used when performing a MachineStateRemoved reset. +### -PoolFqdn -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Fully qualified domain name of the Registrar pool being reset. +For example: -### -NoReStart -When specified, services (such as RtcSrv and FabricHostSvc) that are stopped when the cmdlet runs are not restarted. +`-PoolFqdn "atl-cs-001.litwareinc.com"` ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -183,14 +176,16 @@ Accept wildcard characters: False ``` ### -ResetLocalDatabases + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When specified, stops and restarts the local Skype for Business Server databases in addition to the local Skype for Business Server services. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -200,6 +195,9 @@ Accept wildcard characters: False ``` ### -ResetType + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Type of reset to be performed. Allowed values are:
    @@ -227,8 +225,7 @@ This type of reset should be used only when the server in question (or its datab ```yaml Type: PoolResetType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -237,14 +234,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -ServicesStopDelayMins + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: Int32 + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -253,14 +270,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ServicesStopDelayMins -PARAMVALUE: Int32 +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -274,14 +293,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Reset-CsPoolRegistrarState` cmdlet does not accept pipelined input. ## OUTPUTS -### -String values. +### System.Stringvalues. The `Reset-CsPoolRegistrarState` cmdlet does not return objects. ## NOTES diff --git a/skype/skype-ps/skype/Reset-CsRoutingGroup.md b/skype/skype-ps/SkypeForBusiness/Reset-CsRoutingGroup.md similarity index 84% rename from skype/skype-ps/skype/Reset-CsRoutingGroup.md rename to skype/skype-ps/SkypeForBusiness/Reset-CsRoutingGroup.md index af1ce598f9..9eba007488 100644 --- a/skype/skype-ps/skype/Reset-CsRoutingGroup.md +++ b/skype/skype-ps/SkypeForBusiness/Reset-CsRoutingGroup.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/reset-csroutinggroup applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Reset-CsRoutingGroup -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/reset-csroutinggroup +schema: 2.0.0 +title: Reset-CsRoutingGroup --- # Reset-CsRoutingGroup @@ -29,7 +30,7 @@ Missing routing groups can be identified by using the `Get-CsPoolFabricState` cm ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Reset-CsRoutingGroup -RoutingGroup "bef5fa3b-3c97-4af0-abe7-611deee7616c" -ResetType "Transient" ``` @@ -39,33 +40,16 @@ The command shown in Example 1 performs a transient on the routing group with th ## PARAMETERS -### -RoutingGroup -Globally unique identifier (GUID) of the routing group that needs to be reset. -For example: - -`-RoutingGroup "bef5fa3b-3c97-4af0-abe7-611deee7616c"` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Binding -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Binding PARAMVALUE: String ```yaml Type: String Parameter Sets: (All) Aliases: b -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -74,30 +58,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Force Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -107,13 +77,15 @@ Accept wildcard characters: False ``` ### -HostNameStorageService + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: String ```yaml Type: String Parameter Sets: (All) Aliases: h -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -123,13 +95,15 @@ Accept wildcard characters: False ``` ### -Lyss + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,6 +113,9 @@ Accept wildcard characters: False ``` ### -ResetType + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Type of reset to be performed. Allowed values are: @@ -151,8 +128,7 @@ Allowed values are: ```yaml Type: RgResetType Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -161,14 +137,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RoutingGroup + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Globally unique identifier (GUID) of the routing group that needs to be reset. +For example: + +`-RoutingGroup "bef5fa3b-3c97-4af0-abe7-611deee7616c"` + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TargetFqdn + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the pool containing the routing group that needs to be reset. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -178,13 +195,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -198,14 +217,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Reset-CsRoutingGroup` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None The `Reset-CsRoutingGroup` cmdlet does return objects or data. ## NOTES diff --git a/skype/skype-ps/skype/Restore-CsDeviceUpdateRule.md b/skype/skype-ps/SkypeForBusiness/Restore-CsDeviceUpdateRule.md similarity index 89% rename from skype/skype-ps/skype/Restore-CsDeviceUpdateRule.md rename to skype/skype-ps/SkypeForBusiness/Restore-CsDeviceUpdateRule.md index 2bff596090..f97297ef63 100644 --- a/skype/skype-ps/skype/Restore-CsDeviceUpdateRule.md +++ b/skype/skype-ps/SkypeForBusiness/Restore-CsDeviceUpdateRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/restore-csdeviceupdaterule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Restore-CsDeviceUpdateRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/restore-csdeviceupdaterule +schema: 2.0.0 +title: Restore-CsDeviceUpdateRule --- # Restore-CsDeviceUpdateRule @@ -57,7 +58,7 @@ If there is no such previous version then the update being rolled back will simp ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Restore-CsDeviceUpdateRule -Identity service:WebServer:atl-cs-001.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9 ``` @@ -65,7 +66,7 @@ Restore-CsDeviceUpdateRule -Identity service:WebServer:atl-cs-001.litwareinc.com The command shown in Example 1 restores the device update rule d5ce3c10-2588-420a-82ac-dc2d9b1222ff9 found on the service WebServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsDeviceUpdateRule -Filter service:WebServer:atl-cs-001.litwareinc.com* | Restore-CsDeviceUpdateRule ``` @@ -75,7 +76,7 @@ To do this, the command first calls the `Get-CsDeviceUpdateRule` cmdlet along wi (By definition, these are all the device update rules that have been assigned to the service WebServer:atl-cs-001.litwareinc.com.) This filtered collection is then piped to the `Restore-CsDeviceUpdateRule` cmdlet, which restores each rule in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsDeviceUpdateRule | Where-Object {$_.Brand -eq "LG-Nortel"} | Restore-CsDeviceUpdateRule ``` @@ -88,7 +89,28 @@ The filtered collection is then piped to the `Restore-CsDeviceUpdateRule` cmdlet ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the device update rule being restored. The Identity for a device update rule consists of two parts: the service where the device update rule has been assigned (for example, service:WebServer:atl-cs-001.litwareinc.com) and a globally unique identifier (GUID). Consequently, a device update rule configured for the Redmond site will have an Identity similar to this: service:WebServer:atl-cs-001.litwareinc.com/d5ce3c10-2588-420a-82ac-dc2d9b1222ff9. @@ -96,8 +118,7 @@ Consequently, a device update rule configured for the Redmond site will have an ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -107,13 +128,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,14 +145,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -139,29 +164,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -175,14 +186,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdate.Rule object. +### Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdate.Rule + The `Restore-CsDeviceUpdateRule` cmdlet accepts pipelined instances of the device update rule object. ## OUTPUTS -### -None. +### None Instead, the `Restore-CsDeviceUpdateRule` cmdlet restores instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdate.Rule object. ## NOTES diff --git a/skype/skype-ps/skype/Revoke-CsClientCertificate.md b/skype/skype-ps/SkypeForBusiness/Revoke-CsClientCertificate.md similarity index 89% rename from skype/skype-ps/skype/Revoke-CsClientCertificate.md rename to skype/skype-ps/SkypeForBusiness/Revoke-CsClientCertificate.md index 5b2828745f..daf1fdee14 100644 --- a/skype/skype-ps/skype/Revoke-CsClientCertificate.md +++ b/skype/skype-ps/SkypeForBusiness/Revoke-CsClientCertificate.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/revoke-csclientcertificate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Revoke-CsClientCertificate -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/revoke-csclientcertificate +schema: 2.0.0 +title: Revoke-CsClientCertificate --- # Revoke-CsClientCertificate @@ -43,7 +44,7 @@ In turn, that means that you will not be able to run the `Revoke-CsClientCertifi ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Revoke-CsClientCertificate -Identity "Ken Myer" ``` @@ -51,7 +52,7 @@ Revoke-CsClientCertificate -Identity "Ken Myer" The command shown in Example 1 revokes all the client certificates currently assigned to Ken Myer; this is done by calling the `Revoke-CsClientCertificate` cmdlet followed by the Identity of the user whose certificates are to be revoked. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsUser | Revoke-CsClientCertificate ``` @@ -63,7 +64,28 @@ This collection is then piped to the `Revoke-CsClientCertificate` cmdlet, which ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account for which certificates are to be revoked. User Identities can be specified by using one of four formats: 1) the user's Session Initiation Protocol (SIP) address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. @@ -71,8 +93,7 @@ User Identities can also be referenced by using the user's Active Directory dist ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -81,14 +102,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -98,29 +121,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -134,15 +143,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The `Revoke-CsClientCertificate` cmdlet accepts pipelined input of string values representing the Identity of a user account. The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### -None. +### None Instead, the `Revoke-CsClientCertificate` cmdlet revokes instances of the Microsoft.Rtc.Management.UserPinService.CertInfoDetails object. ## NOTES diff --git a/skype/skype-ps/skype/Revoke-CsOUPermission.md b/skype/skype-ps/SkypeForBusiness/Revoke-CsOUPermission.md similarity index 83% rename from skype/skype-ps/skype/Revoke-CsOUPermission.md rename to skype/skype-ps/SkypeForBusiness/Revoke-CsOUPermission.md index e78386a8cd..3cbb0f2138 100644 --- a/skype/skype-ps/skype/Revoke-CsOUPermission.md +++ b/skype/skype-ps/SkypeForBusiness/Revoke-CsOUPermission.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/revoke-csoupermission applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Revoke-CsOUPermission -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/revoke-csoupermission +schema: 2.0.0 +title: Revoke-CsOUPermission --- # Revoke-CsOUPermission @@ -35,7 +36,7 @@ If you run the `Revoke-CsOUPermission` cmdlet against an OU you will then need t ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Revoke-CsOUPermission -OU "ou=Redmond,dc=litwareinc,dc=com" -ObjectType "user" ``` @@ -43,7 +44,7 @@ Revoke-CsOUPermission -OU "ou=Redmond,dc=litwareinc,dc=com" -ObjectType "user" The command shown in Example 1 revokes user management permissions (-ObjectType "user") for the Redmond OU in the domain litwareinc.com. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Revoke-CsOUPermission -OU "ou=Redmond,dc=litwareinc,dc=com" -ObjectType "user","contact","inetOrgPerson" ``` @@ -53,70 +54,56 @@ In Example 2, three different management permissions (user, contact and inetOrgP ## PARAMETERS -### -ObjectType -Type of object covered by these permissions. -Valid values are: - -User - -Computer - -Contact - -AppContact - -InetOrgPerson +### -Domain -To revoke permissions to multiple object types in the same command, separate the object types by using commas: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-ObjectType "user","computer","contact"` +Name of the domain where the OU is located. +If this parameter is not included the `Revoke-CsOUPermission` cmdlet will look for the OU in the current domain. ```yaml -Type: ObjectType +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OU -Distinguished name of the OU where permissions are to be removed. -For example: +### -DomainController -`-OU "ou=Redmond,dc=litwareinc,dc=com` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You can only remove permissions from a single OU per command. +Enables administrators to specify the fully qualified domain name (FQDN) of the domain controller to be used when running the `Revoke-CsOUPermission` cmdlet. +If not specified, the cmdlet will use the first available domain controller. ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Domain -Name of the domain where the OU is located. -If this parameter is not included the `Revoke-CsOUPermission` cmdlet will look for the OU in the current domain. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -125,16 +112,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables administrators to specify the fully qualified domain name (FQDN) of the domain controller to be used when running the `Revoke-CsOUPermission` cmdlet. -If not specified, the cmdlet will use the first available domain controller. +### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of a global catalog server in your domain. +This parameter is not required if you are running the `Revoke-CsOUPermission` cmdlet on a computer with an account in your domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -143,34 +132,58 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalCatalog -Fully qualified domain name of a global catalog server in your domain. -This parameter is not required if you are running the `Revoke-CsOUPermission` cmdlet on a computer with an account in your domain. +### -ObjectType + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of object covered by these permissions. +Valid values are: + +User + +Computer + +Contact + +AppContact + +InetOrgPerson + +To revoke permissions to multiple object types in the same command, separate the object types by using commas: + +`-ObjectType "user","computer","contact"` ```yaml -Type: Fqdn +Type: ObjectType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Distinguished name of the OU where permissions are to be removed. +For example: + +`-OU "ou=Redmond,dc=litwareinc,dc=com` + +You can only remove permissions from a single OU per command. + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -178,6 +191,9 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: @@ -187,8 +203,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -197,14 +212,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -213,14 +230,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -234,13 +253,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Revoke-CsOUPermission` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Revoke-CsOUPermission` cmdlet does not return any objects or values. ## NOTES diff --git a/skype/skype-ps/skype/Revoke-CsSetupPermission.md b/skype/skype-ps/SkypeForBusiness/Revoke-CsSetupPermission.md similarity index 84% rename from skype/skype-ps/skype/Revoke-CsSetupPermission.md rename to skype/skype-ps/SkypeForBusiness/Revoke-CsSetupPermission.md index 2749dcce16..a5089deb7d 100644 --- a/skype/skype-ps/skype/Revoke-CsSetupPermission.md +++ b/skype/skype-ps/SkypeForBusiness/Revoke-CsSetupPermission.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/revoke-cssetuppermission applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Revoke-CsSetupPermission -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/revoke-cssetuppermission +schema: 2.0.0 +title: Revoke-CsSetupPermission --- # Revoke-CsSetupPermission @@ -37,7 +38,7 @@ In that case, you will need to be an enterprise administrator or a domain admini ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Revoke-CsSetupPermission -ComputerOU "ou=CsServers,dc=litwareinc,dc=com" ``` @@ -48,6 +49,9 @@ The command shown in Example 1 revokes the setup rights applied to the CsServers ## PARAMETERS ### -ComputerOU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Distinguished name (DN) of the OU that contains the accounts for the computers where Skype for Business Server will be (or has been) installed. For example: @@ -62,8 +66,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -73,6 +76,9 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the domain where the OU is located. If this parameter is not included, then the `Revoke-CsSetupPermission` cmdlet will look for the OU in the current domain. @@ -80,8 +86,7 @@ If this parameter is not included, then the `Revoke-CsSetupPermission` cmdlet wi ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -91,6 +96,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified name of the domain controller to be contacted when assigning the policy. For example: @@ -102,8 +110,7 @@ If not specified, the `Revoke-CsSetupPermission` cmdlet will contact the nearest ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -112,20 +119,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalCatalog -Fully qualified name of the global catalog server to be contacted when assigning the policy. -For example: - -`-GlobalCatalog atl-dc-001.litwareinc.com` +### -Force -If not specified, the `Revoke-CsSetupPermission` cmdlet will contact the nearest available global catalog server when assigning the policy. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,14 +137,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified name of the global catalog server to be contacted when assigning the policy. +For example: + +`-GlobalCatalog atl-dc-001.litwareinc.com` + +If not specified, the `Revoke-CsSetupPermission` cmdlet will contact the nearest available global catalog server when assigning the policy. + ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -151,6 +162,9 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: @@ -160,8 +174,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -170,14 +183,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -186,14 +201,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -207,14 +224,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Revoke-CsSetupPermission` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Search-CsClsLogging.md b/skype/skype-ps/SkypeForBusiness/Search-CsClsLogging.md similarity index 82% rename from skype/skype-ps/skype/Search-CsClsLogging.md rename to skype/skype-ps/SkypeForBusiness/Search-CsClsLogging.md index 012dcf1d84..14b394d277 100644 --- a/skype/skype-ps/skype/Search-CsClsLogging.md +++ b/skype/skype-ps/SkypeForBusiness/Search-CsClsLogging.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/search-csclslogging applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Search-CsClsLogging -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/search-csclslogging +schema: 2.0.0 +title: Search-CsClsLogging --- # Search-CsClsLogging @@ -42,7 +43,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Searc ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Search-CsClsLogging -Computers "atl-cs-001.litwareinc.com" -IP "192.168.0.242" ``` @@ -50,7 +51,7 @@ Search-CsClsLogging -Computers "atl-cs-001.litwareinc.com" -IP "192.168.0.242" The command shown in Example 1 searches for the IP address 192.168.0.242 in the log files found on the computer atl-cs-001.litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Search-CsClsLogging -Computers "atl-cs-001.litwareinc.com" -IP "192.168.0.242" -Uri "sip:kenmyer@litwareinc.com" -MatchAll ``` @@ -59,7 +60,7 @@ In Example 2, a search is made for entries that match both the IP address 192.16 The MatchAll parameter specifies that all the criteria must be met for an entry to be recorded as a match. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Search-CsClsLogging -Computers "atl-cs-001.litwareinc.com" -IP "192.168.0.242" -Uri "sip:kenmyer@litwareinc.com" -MatchAny ``` @@ -71,13 +72,15 @@ The MatchAny parameter specifies that just one of the criteria must be met for a ## PARAMETERS ### -AsXml + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When specified, return code information from each computer searched is returned in XML format instead of as a string value. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -87,13 +90,15 @@ Accept wildcard characters: False ``` ### -CallId + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Call identifier to be searched for. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -103,13 +108,15 @@ Accept wildcard characters: False ``` ### -Components + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Comma-separated list of components to be searched. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,6 +126,9 @@ Accept wildcard characters: False ``` ### -Computers + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Comma-separated list of the computers to be searched. For example: @@ -127,8 +137,7 @@ For example: ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,13 +147,15 @@ Accept wildcard characters: False ``` ### -ConferenceId + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Conference ID to be searched for. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -154,14 +165,16 @@ Accept wildcard characters: False ``` ### -CorrelationIds + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Comma-separated list of correlation IDs to search for. A correlation is a 32 bit integer associated with each request. ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -171,6 +184,9 @@ Accept wildcard characters: False ``` ### -EndTime + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Ending date and time for the log entries to be searched. Specified in local time zone. Defaults to 5 minutes after current time if no StartTime specified, otherwise defaults to 30 minutes after StartTime. @@ -182,8 +198,7 @@ For example, on computer running the US English version of Skype for Business Se ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -193,14 +208,16 @@ Accept wildcard characters: False ``` ### -IP + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + IP address being searched for. This must be an actual IP address; you cannot use wildcards when specifying the address. ```yaml Type: IPAddress Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -210,6 +227,9 @@ Accept wildcard characters: False ``` ### -LogLevel + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the minimum type of log entry to be returned. Allowed values are: @@ -234,8 +254,7 @@ For example, if you set the LogLevel to Warning then the cmdlet will return entr ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -245,14 +264,16 @@ Accept wildcard characters: False ``` ### -MatchAll + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, all the included criteria must be matched. This is similar to an AND query in SQL Server. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -262,6 +283,9 @@ Accept wildcard characters: False ``` ### -MatchAny + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, only one of the included criteria must be matched. This is similar to an OR query in SQL Server. This is the default. @@ -269,8 +293,7 @@ This is the default. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -280,14 +303,16 @@ Accept wildcard characters: False ``` ### -OutputFilePath + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, specifies the full path of where to write a text file containing the search results. Otherwise they are written to the console. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -297,14 +322,16 @@ Accept wildcard characters: False ``` ### -Phone + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Phone number to be searched for. This number should be entered using the E.164 format and should not include wildcard characters. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -314,6 +341,9 @@ Accept wildcard characters: False ``` ### -Pools + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Comma-separated list of the pools to be searched. For example: @@ -322,8 +352,7 @@ For example: ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -333,13 +362,15 @@ Accept wildcard characters: False ``` ### -SipContents + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Arbitrary text to search for within the body of a SIP message. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -349,14 +380,16 @@ Accept wildcard characters: False ``` ### -SkipNetworkLogs + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, instructs the `Search-CsClsLogging` cmdlet to avoid searching network logs. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -366,6 +399,9 @@ Accept wildcard characters: False ``` ### -StartTime + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Beginning date and time for the log entries to be searched. Specified in local time zone. Defaults to 30 minutes before EndTime. @@ -377,8 +413,7 @@ For example, on computer running the US English version of Skype for Business Se ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -388,13 +423,15 @@ Accept wildcard characters: False ``` ### -Uri + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Uri to be searched for. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -408,14 +445,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Search-CsClsLogging` cmdlet does not accept pipelined input. ## OUTPUTS -### -String values or XML. +### System.Stringvalues or XML. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsAVEdgeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsAVEdgeConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Set-CsAVEdgeConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsAVEdgeConfiguration.md index 32085367bd..153620cf8f 100644 --- a/skype/skype-ps/skype/Set-CsAVEdgeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAVEdgeConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csavedgeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsAVEdgeConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csavedgeconfiguration +schema: 2.0.0 +title: Set-CsAVEdgeConfiguration --- # Set-CsAVEdgeConfiguration @@ -44,7 +45,7 @@ However, unless instructed by Microsoft support personnel, it is recommended tha ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsAVEdgeConfiguration -Identity global -MaxTokenLifetime "04:00:00" ``` @@ -55,7 +56,28 @@ In this example, the maximum token lifetime is set to 4 hours (04 hours : 00 min ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of A/V Edge configuration settings to be modified. To modify the global collection, use the following syntax: `-Identity global`. To modify a site collection use syntax similar to this: `-Identity site:Redmond`. @@ -64,8 +86,7 @@ Settings configured at the service scope should be referred to using syntax simi ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -75,13 +96,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -90,24 +113,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -MaxTokenLifetime -The maximum amount of time that an authentication token can be used before it expires and must be renewed. -Token lifetimes are expressed using the following format: Days.Hours:Minutes:Seconds. -For example, 13 days must be expressed like this, with a period (.) following the number of days, and colons (:) used to separate the hours, minutes, and seconds: - -13.00:00:00 - -The default value of 8 hours must be expressed like this: +### -MaxBandwidthPerPortKb -08:00:00 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The minimum allowed token lifetime is 1 minute (00:01:00); the maximum allowed lifetime is 180 days (180.00:00:00). +Indicates the maximum amount of bandwidth (in kilobits per second) that can be allocated to a single port. +The maximum bandwidth can be set to any integer value between 1 and 4294967296 (4096 gigabits) per second; the default value is 3000. ```yaml -Type: TimeSpan +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,14 +132,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -MaxBandwidthPerUserKb + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum amount of bandwidth (in kilobits per second) that can be allocated to any one user. +The maximum bandwidth can be set to any integer value between 1 and 4294967296 (4096 gigabits) per second; the default value is 10000. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,14 +151,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MaxTokenLifetime + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The maximum amount of time that an authentication token can be used before it expires and must be renewed. +Token lifetimes are expressed using the following format: Days.Hours:Minutes:Seconds. +For example, 13 days must be expressed like this, with a period (.) following the number of days, and colons (:) used to separate the hours, minutes, and seconds: + +13.00:00:00 + +The default value of 8 hours must be expressed like this: + +08:00:00 + +The minimum allowed token lifetime is 1 minute (00:01:00); the maximum allowed lifetime is 180 days (180.00:00:00). ```yaml -Type: SwitchParameter +Type: TimeSpan Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -149,13 +180,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -164,32 +197,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxBandwidthPerPortKb -Indicates the maximum amount of bandwidth (in kilobits per second) that can be allocated to a single port. -The maximum bandwidth can be set to any integer value between 1 and 4294967296 (4096 gigabits) per second; the default value is 3000. - -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -MaxBandwidthPerUserKb -Indicates the maximum amount of bandwidth (in kilobits per second) that can be allocated to any one user. -The maximum bandwidth can be set to any integer value between 1 and 4294967296 (4096 gigabits) per second; the default value is 10000. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: UInt32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -203,13 +220,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Edge.MediaRelaySettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.MediaRelaySettings + The `Set-CsAVEdgeConfiguration` cmdlet accepts pipelined input of media relay settings objects. ## OUTPUTS -### +### None The `Set-CsAVEdgeConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.MediaRelaySettings object. diff --git a/skype/skype-ps/skype/Set-CsAccessEdgeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsAccessEdgeConfiguration.md similarity index 83% rename from skype/skype-ps/skype/Set-CsAccessEdgeConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsAccessEdgeConfiguration.md index a8885119cb..f3fbc39c79 100644 --- a/skype/skype-ps/skype/Set-CsAccessEdgeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAccessEdgeConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csaccessedgeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsAccessEdgeConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csaccessedgeconfiguration +schema: 2.0.0 +title: Set-CsAccessEdgeConfiguration --- # Set-CsAccessEdgeConfiguration @@ -82,7 +83,7 @@ Instead, you will see and be able to change the property values VerificationLeve ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsAccessEdgeConfiguration -AllowAnonymousUsers $True -VerificationLevel "UseSourceVerification" ``` @@ -90,7 +91,7 @@ Set-CsAccessEdgeConfiguration -AllowAnonymousUsers $True -VerificationLevel "Use In Example 1, two properties of the Access Edge configuration settings are modified: the AllowAnonymousUsers property is set to True and the VerificationLevel property is set to UseSourceVerification. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsAccessEdgeConfiguration -UseDefaultRouting -DefaultRouteFqdn "atl-edge-001.litwareinc.com" ``` @@ -99,7 +100,7 @@ The command shown in Example 2 changes the routing method for the Edge server to In order to do this the command must include both the UseDefaultRouting parameter and the DefaultRouteFqdn parameter, along with a parameter value that specifies the fully qualified domain name of the Edge server. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Set-CsAccessEdgeConfiguration -UseDnsSrvRouting -EnablePartnerDiscovery $True ``` @@ -110,50 +111,58 @@ This requires the use of two parameters: UseDnsSrvRouting (with no parameter val ## PARAMETERS -### -Identity -Unique identifier of the Access Edge configuration settings to be returned. -Because you can only have a single, global instance of these settings, you do not have to include the Identity when calling the `Set-CsAccessEdgeConfiguration` cmdlet. -However, if you prefer, you can use the following syntax to modify the global settings: `-Identity global`. +### -AllowAnonymousUsers +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not anonymous users (that is, unauthenticated users) are allowed to cross the firewall and join meetings and conferences. +The default value is False. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: Identity, DefaultRoute, DnsSrvRouting +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -AllowFederatedUsers + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether internal users are allowed to communicate with users from federated domains. +This property also determines whether internal users can communicate with users in a split domain scenario. +(In a split domain, some of your users have accounts hosted on-premises, while others have accounts hosted off-premises.) The default value is False. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: Identity, DefaultRoute, DnsSrvRouting +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAnonymousUsers -Indicates whether or not anonymous users (that is, unauthenticated users) are allowed to cross the firewall and join meetings and conferences. -The default value is False. +### -AllowOutsideUsers + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether users can access Skype for Business Server across the Internet. +This includes both anonymous users and remote users who are trying to log on to the system. +The default value is True. + ```yaml Type: Boolean Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,16 +171,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowFederatedUsers -Indicates whether internal users are allowed to communicate with users from federated domains. -This property also determines whether internal users can communicate with users in a split domain scenario. -(In a split domain, some of your users have accounts hosted on-premises, while others have accounts hosted off-premises.) The default value is False. +### -BeClearingHouse + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether your Edge servers are directly connected to other organizations. +The default value is False. +This parameter should not be changed unless you are instructed to do so by Microsoft support personnel. ```yaml Type: Boolean -Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: DnsSrvRouting +Aliases: Required: False Position: Named @@ -180,17 +191,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowOutsideUsers -Indicates whether users can access Skype for Business Server across the Internet. -This includes both anonymous users and remote users who are trying to log on to the system. -The default value is True. +### -CertificatesDeletedPercentage +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The default value is 20. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -200,6 +210,9 @@ Accept wildcard characters: False ``` ### -DefaultRouteFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the server used for federation requests. This parameter is required if you use default routing. @@ -209,8 +222,7 @@ Note that you must delete all your hosting providers and all your public provide ```yaml Type: String Parameter Sets: DefaultRoute -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -219,16 +231,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableArchivingDisclaimer -If set to True, Edge Servers send an archiving notification header to federated and clearinghouse partners. -This notification (which informs people that instant messaging (IM) conversations might be archived) can be displayed in the conversation window of a federated or clearinghouse user. -The default value is False. +### -DiscoveredPartnerReportPeriodMinutes + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The default value is 60. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -237,18 +249,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnablePartnerDiscovery -If True, Skype for Business Server will use DNS records to try and discover partner domains not listed in the AllowedDomains list. -If False, Skype for Business Server will only federate with domains found on the AllowedDomains list. -This parameter is required if you use DNS service routing. -The default value is False. +### -DiscoveredPartnerStandardRate +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The default value is 20. ```yaml -Type: Boolean -Parameter Sets: DnsSrvRouting -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: UInt32 +Parameter Sets: Identity, DefaultRoute, DnsSrvRouting +Aliases: Required: False Position: Named @@ -257,14 +267,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsPublicProvider -Must be set to True if the default route requires a public instant messaging license. +### -DiscoveredPartnerVerificationLevel + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Sets the verification level for messages sent to and from the discovered partner. +Allowed values are: + +* AlwaysVerifiable +* AlwaysUnverifiable +* UseSourceVerification ```yaml -Type: Boolean -Parameter Sets: DefaultRoute -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: VerificationLevelType +Parameter Sets: DnsSrvRouting +Aliases: Required: False Position: Named @@ -273,15 +290,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -KeepCrlsUpToDateForPeers -Determines whether or not Edge servers periodically check the certificate revocation lists (CRLs) for federated domain certificates. -The default value is True. +### -DnsSrvCacheRecordCount + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Maximum number of DNS SRV records that can be maintained in the cache. +SRV records are used to specify service locations and port numbers. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -290,16 +309,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MarkSourceVerifiableOnOutgoingMessages -If True, outgoing messages are marked as verifiable; this enables federated domains to determine the verification level for each message. -If False, outgoing messages are all marked as unverifiable. -The default value is True. +### -EnableArchivingDisclaimer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True, Edge Servers send an archiving notification header to federated and clearinghouse partners. +This notification (which informs people that instant messaging (IM) conversations might be archived) can be displayed in the conversation window of a federated or clearinghouse user. +The default value is False. ```yaml Type: Boolean Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -308,17 +329,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutgoingTlsCountForFederatedPartners -Specifies the maximum number of Transport Layer Security (TLS) connections that can be used for each federated partner. -The minimum number of TLS connections is 1, and the maximum number is 4. -By default, OutgoingTlsCountForFederatedPartners is set to 4. -This parameter should not be changed unless you are instructed to do so by Microsoft support personnel. +### -EnableDiscoveredPartnerContactsLimit + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), enables user enumeration protection for Discovered Partner federated peers. + ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -327,15 +348,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseDnsSrvRouting -Indicates that Edge servers should rely on DNS SRV records when sending and receiving federation requests. -This is the default routing method. +### -EnablePartnerDiscovery + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, Skype for Business Server will use DNS records to try and discover partner domains not listed in the AllowedDomains list. +If False, Skype for Business Server will only federate with domains found on the AllowedDomains list. +This parameter is required if you use DNS service routing. +The default value is False. + ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: DnsSrvRouting -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -344,23 +370,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VerificationLevel -If you are using default routing, the VerificationLevel property is used to monitor and assess the verification level of incoming messages. -Valid values are: - -AlwaysVerifiable: All requests received on the default route are marked as verified. -If a verification header is not present it will automatically be added to the message. +### -EnableUserReplicator -AlwaysUnverifiable: Messages are passed only if the addressee (the user the message is intended for) has configured an Allow ACE (access control entry) for the person who sent the message. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -UseSourceVerification: Message verification is based on the verification level included with the message. -If no verification header is present then the message will be marked as unverified. +The default value is False ($False). ```yaml -Type: VerificationLevelType -Parameter Sets: DefaultRoute -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: Identity, DefaultRoute, DnsSrvRouting +Aliases: Required: False Position: Named @@ -370,13 +389,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -385,48 +406,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier of the Access Edge configuration settings to be returned. +Because you can only have a single, global instance of these settings, you do not have to include the Identity when calling the `Set-CsAccessEdgeConfiguration` cmdlet. +However, if you prefer, you can use the following syntax to modify the global settings: `-Identity global`. + ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -BeClearingHouse -Indicates whether your Edge servers are directly connected to other organizations. -The default value is False. -This parameter should not be changed unless you are instructed to do so by Microsoft support personnel. +### -IsPublicProvider + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Must be set to True if the default route requires a public instant messaging license. ```yaml Type: Boolean -Parameter Sets: DnsSrvRouting -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: DefaultRoute +Aliases: Required: False Position: Named @@ -435,16 +463,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseDefaultRouting -Indicates that administrators must specify the fully qualified domain name of the server used to send and receive federation requests. -If you include the UseDefaultRouting parameter then you must also include the DefaultRouteFqdn parameter. +### -KeepCrlsUpToDateForPeers +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Determines whether or not Edge servers periodically check the certificate revocation lists (CRLs) for federated domain certificates. +The default value is True. ```yaml -Type: SwitchParameter -Parameter Sets: DefaultRoute -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: Identity, DefaultRoute, DnsSrvRouting +Aliases: Required: False Position: Named @@ -453,14 +482,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CertificatesDeletedPercentage -The default value is 20. +### -MarkSourceVerifiableOnOutgoingMessages + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, outgoing messages are marked as verifiable; this enables federated domains to determine the verification level for each message. +If False, outgoing messages are all marked as unverifiable. +The default value is True. ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -469,14 +502,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DiscoveredPartnerReportPeriodMinutes -The default value is 60. +### -MaxAcceptedCertificatesStored + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Maximum number of allowed certificates cached by the Edge Server. +The default value is 1000. ```yaml Type: UInt32 Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -485,14 +521,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DiscoveredPartnerStandardRate -The default value is 20. +### -MaxContactsPerDiscoveredPartner + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Maximum number of contacts allowed per discovered partner. +The default value is 1000. ```yaml Type: UInt32 Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -501,19 +540,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DiscoveredPartnerVerificationLevel -Sets the verification level for messages sent to and from the discovered partner. -Allowed values are: +### -MaxRejectedCertificatesStored -* AlwaysVerifiable -* AlwaysUnverifiable -* UseSourceVerification +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Maximum number of rejected certificates cached by the Edge Server. +The default value is 500. ```yaml -Type: VerificationLevelType -Parameter Sets: DnsSrvRouting -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: UInt32 +Parameter Sets: Identity, DefaultRoute, DnsSrvRouting +Aliases: Required: False Position: Named @@ -522,15 +559,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableDiscoveredPartnerContactsLimit -When set to True (the default value), enables user enumeration protection for Discovered Partner federated peers. +### -OutgoingTlsCountForFederatedPartners + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Specifies the maximum number of Transport Layer Security (TLS) connections that can be used for each federated partner. +The minimum number of TLS connections is 1, and the maximum number is 4. +By default, OutgoingTlsCountForFederatedPartners is set to 4. +This parameter should not be changed unless you are instructed to do so by Microsoft support personnel. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -539,14 +580,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableUserReplicator -The default value is False ($False). +### -SkypeSearchUrl + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +URL for the Skype Graph Search service. +This service enables Skype for Business to search for Skype contacts. ```yaml -Type: Boolean +Type: String Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -555,15 +599,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxAcceptedCertificatesStored -Maximum number of allowed certificates cached by the Edge Server. -The default value is 1000. +### -UseDefaultRouting + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates that administrators must specify the fully qualified domain name of the server used to send and receive federation requests. +If you include the UseDefaultRouting parameter then you must also include the DefaultRouteFqdn parameter. + ```yaml -Type: UInt32 -Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: DefaultRoute +Aliases: Required: False Position: Named @@ -572,15 +619,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxContactsPerDiscoveredPartner -Maximum number of contacts allowed per discovered partner. -The default value is 1000. +### -UseDnsSrvRouting + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates that Edge servers should rely on DNS SRV records when sending and receiving federation requests. +This is the default routing method. ```yaml -Type: UInt32 -Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: DnsSrvRouting +Aliases: Required: False Position: Named @@ -589,15 +638,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxRejectedCertificatesStored -Maximum number of rejected certificates cached by the Edge Server. -The default value is 500. +### -VerificationLevel + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If you are using default routing, the VerificationLevel property is used to monitor and assess the verification level of incoming messages. +Valid values are: + +AlwaysVerifiable: All requests received on the default route are marked as verified. +If a verification header is not present it will automatically be added to the message. + +AlwaysUnverifiable: Messages are passed only if the addressee (the user the message is intended for) has configured an Allow ACE (access control entry) for the person who sent the message. + +UseSourceVerification: Message verification is based on the verification level included with the message. +If no verification header is present then the message will be marked as unverified. ```yaml -Type: UInt32 -Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: VerificationLevelType +Parameter Sets: DefaultRoute +Aliases: Required: False Position: Named @@ -606,15 +665,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DnsSrvCacheRecordCount -Maximum number of DNS SRV records that can be maintained in the cache. -SRV records are used to specify service locations and port numbers. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: UInt32 -Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -623,15 +683,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkypeSearchUrl -URL for the Skype Graph Search service. -This service enables Skype for Business to search for Skype contacts. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String -Parameter Sets: Identity, DefaultRoute, DnsSrvRouting -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -645,13 +706,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsAccessEdgeConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsAccessEdgeConfiguration` cmdlet does not return any objects or values. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsAddressBookConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsAddressBookConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Set-CsAddressBookConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsAddressBookConfiguration.md index deb444e50b..f7bf3d7346 100644 --- a/skype/skype-ps/skype/Set-CsAddressBookConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAddressBookConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csaddressbookconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsAddressBookConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csaddressbookconfiguration +schema: 2.0.0 +title: Set-CsAddressBookConfiguration --- # Set-CsAddressBookConfiguration @@ -55,7 +56,7 @@ The `Set-CsAddressBookConfiguration` cmdlet enables you to modify any of the Add ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsAddressBookConfiguration -identity site:Redmond -RunTimeOfDay 23:00 ``` @@ -64,7 +65,7 @@ This example sets the RunTimeOfDay property (the property that determines the ti The Identity parameter is used to limit the change to the Address Book configuration settings with the identity site:Redmond. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAddressBookConfiguration -Filter site:* | Set-CsAddressBookConfiguration -RunTimeOfDay 23:00 ``` @@ -74,7 +75,7 @@ To do this, the command first uses the `Get-CsAddressBookConfiguration` cmdlet a This information is then piped to the `Set-CsAddressBookConfiguration` cmdlet, which modifies the value of the RunTimeOfDay property for each item in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAddressBookConfiguration | Where-Object {$_.KeepDuration -lt 30} | Set-CsAddressBookConfiguration -KeepDuration 30 ``` @@ -87,55 +88,58 @@ This filtered collection is then piped to the `Set-CsAddressBookConfiguration` c ## PARAMETERS -### -Identity -Unique identifier assigned to the collection of Address Book settings. -To refer to the global settings, use this syntax: `-Identity global`. -To refer to a collection configured at the site scope, use syntax similar to this: `-Identity site:Redmond`. -You cannot use wildcard characters when specifying an Identity. +### -EnableFileGeneration -If this parameter is omitted, then the `Set-CsAddressBookConfiguration` cmdlet will modify the global settings. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) the Address Book server generates Address Book index files that can be downloaded by clients. +When set to False, these index files are not generated. +That means that client applications will have to use the Address Book Web Query service when searching for contacts. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -EnablePhotoSearch + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, user photos will be displayed in search results. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableFileGeneration -When set to True (the default value) the Address Book server generates Address Book index files that can be downloaded by clients. -When set to False, these index files are not generated. -That means that client applications will have to use the Address Book Web Query service when searching for contacts. +### -EnableSearchByDialPad +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, users will be able to search for contacts by using their mobile device keypad. +This can be a convenience for mobile users, but has the potential to greatly increase the size of your Address Book database. + +The default value is True ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -144,18 +148,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IgnoreGenericRules -Indicates whether or not the Address Book server ignores the generic normalization rules used when parsing phone numbers. -Generic rules are the rules that are built into Skype for Business Server. -These rules cannot be changed; however, by setting the value of this property to True you can instruct your Address Book servers to ignore these rules and instead use custom rules that you create yourself. -The default value is False. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -164,40 +166,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -KeepDuration -Specifies the amount of time (in days) that Address Book servers will keep change files. -Change files older than the value of the KeepDuration property will be deleted. -The KeepDuration can be set to any integer value between 1 and 90, inclusive. -The default value is 30 days. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier assigned to the collection of Address Book settings. +To refer to the global settings, use this syntax: `-Identity global`. +To refer to a collection configured at the site scope, use syntax similar to this: `-Identity site:Redmond`. +You cannot use wildcard characters when specifying an Identity. + +If this parameter is omitted, then the `Set-CsAddressBookConfiguration` cmdlet will modify the global settings. ```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxDeltaFileSizePercentage -When changes are made to Active Directory (such as a new user being enabled for Skype for Business Server), the Address Book server typically records these changes in a "delta file," a file consisting only of the updated information; Skype for Business Server can then download the delta files rather than a complete Address Book file. -The MaxDeltaFileSizePercentage property determines how large the delta files can get before they are incorporated into the complete Address Book file. -By default, delta files can be as large as 20 percent of the complete Address Book file before a new Address Book file is generated. -At that point, clients will download the complete file rather than a delta file. +### -IgnoreGenericRules -MaxDeltaFileSizePercentage must be entered as a percentage value between 1 and 100, inclusive. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not the Address Book server ignores the generic normalization rules used when parsing phone numbers. +Generic rules are the rules that are built into Skype for Business Server. +These rules cannot be changed; however, by setting the value of this property to True you can instruct your Address Book servers to ignore these rules and instead use custom rules that you create yourself. +The default value is False. ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -206,36 +212,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RunTimeOfDay -Indicates the time of day when the servers generate new Address Book files. -The RunTimeOfDay property is based on a 24-hour clock (hours:minutes:seconds), with 00:00:00 representing midnight and 23:59:00 representing 11:59 P.M.. +### -Instance -The default value is 01:30:00 (1:30 A.M.). +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -SynchronizePollingInterval -Indicates how often Address Book servers synchronize their information with the information stored in the User database. -The SynchronizePollingInterval can be set to any value between 5 seconds (00:00:05) and 3 hours (03:00:00). -The default value is 5 minutes (00:05:00). +### -KeepDuration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the amount of time (in days) that Address Book servers will keep change files. +Change files older than the value of the KeepDuration property will be deleted. +The KeepDuration can be set to any integer value between 1 and 90, inclusive. +The default value is 30 days. + ```yaml -Type: TimeSpan +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -244,17 +252,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseNormalizationRules -Indicates whether Address Book servers should use phone normalization rules when retrieving phone numbers. -If set to False, phone numbers will be retrieved as-is and it will be up to the client application to apply normalization rules when displaying these numbers. +### -MaxDeltaFileSizePercentage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When changes are made to Active Directory (such as a new user being enabled for Skype for Business Server), the Address Book server typically records these changes in a "delta file," a file consisting only of the updated information; Skype for Business Server can then download the delta files rather than a complete Address Book file. +The MaxDeltaFileSizePercentage property determines how large the delta files can get before they are incorporated into the complete Address Book file. +By default, delta files can be as large as 20 percent of the complete Address Book file before a new Address Book file is generated. +At that point, clients will download the complete file rather than a delta file. + +MaxDeltaFileSizePercentage must be entered as a percentage value between 1 and 100, inclusive. -The default value is True. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -263,14 +276,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -MaxFileShareThreadCount + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the maximum number of system resources that can be used by the Address Book server if there are problems accessing the service file share. +The default value is 300. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -279,14 +295,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -PhotoCacheRefreshInterval + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: TimeSpan ```yaml -Type: SwitchParameter +Type: TimeSpan Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -295,14 +313,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -RunTimeOfDay + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the time of day when the servers generate new Address Book files. +The RunTimeOfDay property is based on a 24-hour clock (hours:minutes:seconds), with 00:00:00 representing midnight and 23:59:00 representing 11:59 P.M.. + +The default value is 01:30:00 (1:30 A.M.). + ```yaml -Type: SwitchParameter +Type: DateTime Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -311,14 +335,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnablePhotoSearch -When set to True, user photos will be displayed in search results. +### -SynchronizePollingInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates how often Address Book servers synchronize their information with the information stored in the User database. +The SynchronizePollingInterval can be set to any value between 5 seconds (00:00:05) and 3 hours (03:00:00). +The default value is 5 minutes (00:05:00). ```yaml -Type: Boolean +Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -327,17 +355,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSearchByDialPad -When set to True, users will be able to search for contacts by using their mobile device keypad. -This can be a convenience for mobile users, but has the potential to greatly increase the size of your Address Book database. +### -UseNormalizationRules -The default value is True ($True). +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether Address Book servers should use phone normalization rules when retrieving phone numbers. +If set to False, phone numbers will be retrieved as-is and it will be up to the client application to apply normalization rules when displaying these numbers. + +The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -346,15 +376,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxFileShareThreadCount -Specifies the maximum number of system resources that can be used by the Address Book server if there are problems accessing the service file share. -The default value is 300. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -363,14 +394,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PhotoCacheRefreshInterval -PARAMVALUE: TimeSpan +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: TimeSpan +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -384,13 +417,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookSettings + The `Set-CsAddressBookConfiguration` cmdlet accepts pipelined input of Address Book configuration objects. ## OUTPUTS -### +### None The `Set-CsAddressBookConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookSettings object. diff --git a/skype/skype-ps/skype/Set-CsAddressBookNormalizationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsAddressBookNormalizationConfiguration.md similarity index 92% rename from skype/skype-ps/skype/Set-CsAddressBookNormalizationConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsAddressBookNormalizationConfiguration.md index eb9e97ae29..07f428d102 100644 --- a/skype/skype-ps/skype/Set-CsAddressBookNormalizationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAddressBookNormalizationConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csaddressbooknormalizationconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsAddressBookNormalizationConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csaddressbooknormalizationconfiguration +schema: 2.0.0 +title: Set-CsAddressBookNormalizationConfiguration --- # Set-CsAddressBookNormalizationConfiguration @@ -43,7 +44,7 @@ That means that, in some cases, you might need to create identical rules: one fo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Remove-CsAddressBookNormalizationRule -Identity "global/LongDistanceRule" ``` @@ -62,7 +63,7 @@ This is done by including the AddressBookNormalizationRules parameter and the sy Alternatively, you could remove the rule by using the `Remove-CsAddressBookNormalizationRule` cmdlet -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $x = Get-CsAddressBookNormalizationRule -Identity "global/LongDistanceRule" @@ -78,7 +79,7 @@ This is done by first connecting to the configuration settings for the Redmond s When this command finishes running, both the global collection and the Redmond site collection will have a normalization rule named LongDistanceRule. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsAddressBookNormalizationConfiguration -Identity "site:Redmond" -AddressBookNormalizationRules $Null ``` @@ -91,6 +92,9 @@ However, no normalization rules will be assigned to that collection. ## PARAMETERS ### -AddressBookNormalizationRules + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + A set of normalization rules that have been applied to this collection of Address Book normalization configuration settings. While this set of rules can be modified directly using this cmdlet, it is recommended that you create normalization rules with the `New-CsAddressBookNormalizationRule` cmdlet; this cmdlet creates the rule and assigns it to the specified collection. @@ -100,8 +104,7 @@ In general, this is easier and less error-prone than trying to modify a rules co ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -110,30 +113,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Force Suppresses any confirmation prompts before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -143,6 +132,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of Address Book normalization configuration settings to be modified. To refer to the global settings, use this syntax: `-Identity "global"` @@ -153,8 +145,7 @@ Note that you cannot use wildcards when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -164,13 +155,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,14 +172,34 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -200,13 +213,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationSettings The `Set-CsAddressBookNormalizationConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationSettings object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsAddressBookNormalizationConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsAddressBookNormalizationRule.md b/skype/skype-ps/SkypeForBusiness/Set-CsAddressBookNormalizationRule.md similarity index 88% rename from skype/skype-ps/skype/Set-CsAddressBookNormalizationRule.md rename to skype/skype-ps/SkypeForBusiness/Set-CsAddressBookNormalizationRule.md index c68c1560bb..7ffb08e576 100644 --- a/skype/skype-ps/skype/Set-CsAddressBookNormalizationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAddressBookNormalizationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csaddressbooknormalizationrule applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsAddressBookNormalizationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csaddressbooknormalizationrule +schema: 2.0.0 +title: Set-CsAddressBookNormalizationRule --- # Set-CsAddressBookNormalizationRule @@ -39,7 +40,7 @@ That means, in some cases, you might need to create identical rules: one for ass ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsAddressBookNormalizationRule -Identity "Global/RedmondAddresses" -Priority 1 ``` @@ -47,7 +48,7 @@ Set-CsAddressBookNormalizationRule -Identity "Global/RedmondAddresses" -Priority The command shown in Example 1 changes the priority of the RedmondAddresses normalization rule found in the global collection of Address Book normalization rules. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsAddressBookNormalizationRule | Where-Object {$_.Translation -eq '+1206556$1'} | Set-CsAddressBookNormalizationRule -Translation '+1425556$1' ``` @@ -60,31 +61,17 @@ Those rules are then piped to the `Set-CsAddressBookTranslationRule`, which chan ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Description -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Description Enables administrators to provide explanatory text that accompanies a normalization rule. For example, the Description might explain how the rule converts phone numbers. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -94,13 +81,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -110,14 +99,16 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier for the rule. The Identity specified must include the scope followed by a slash followed by the name; for example: site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -127,13 +118,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -143,6 +136,9 @@ Accept wildcard characters: False ``` ### -Pattern + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + A regular expression that the phone number must match in order for this rule to be applied. The default value is ^(\d{11})$. @@ -151,8 +147,7 @@ This represents any set of numbers up to 11 digits. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,6 +157,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The order in which rules are applied; this is required because a given phone number might match more than one rule. The Priority parameter sets the order in which the rules are tested against a number. If a phone number matches multiple rules, the rule with the highest priority will be selected to do the conversion. @@ -171,8 +169,7 @@ Note that, when you set a priority, any existing rules will renumber themselves ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,6 +179,9 @@ Accept wildcard characters: False ``` ### -Translation + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The regular expression pattern that will be applied to the number to convert it to E.164 format. The default value is +$. @@ -190,8 +190,25 @@ This prefixes the number with a plus sign (+). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -201,13 +218,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -221,13 +240,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationRule#Decorated The `Set-CsAddressBookNormalizationRule` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationRule#Decorated object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsAddressBookNormalizationRule` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookNormalizationRule#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsAdminRole.md b/skype/skype-ps/SkypeForBusiness/Set-CsAdminRole.md similarity index 91% rename from skype/skype-ps/skype/Set-CsAdminRole.md rename to skype/skype-ps/SkypeForBusiness/Set-CsAdminRole.md index 844768e6e6..1a7349bed1 100644 --- a/skype/skype-ps/skype/Set-CsAdminRole.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAdminRole.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csadminrole applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsAdminRole -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csadminrole +schema: 2.0.0 +title: Set-CsAdminRole --- # Set-CsAdminRole @@ -92,7 +93,7 @@ After the custom role has been created, you can then use the `Set-CsAdminRole` c ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsAdminRole -Identity "RedmondVoiceAdministrators" -UserScopes @{Add="OU:ou=Portland,dc=litwareinc,dc=com"} ``` @@ -102,7 +103,7 @@ To do this, the command includes the UserScopes parameter and the following para This syntax adds the OU with the distinguished name "ou=Portland,dc=litwareinc,dc=com" to the OUs already in the UserScopes property. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsAdminRole -Identity "RedmondVoiceAdministrators" -UserScopes @{Remove="OU:ou=Portland,dc=litwareinc,dc=com"} ``` @@ -112,7 +113,7 @@ To do this, the command includes the UserScopes parameter and the following para This syntax deletes the OU with the distinguished name "ou=Portland,dc=litwareinc,dc=com" from the collection of OUs already in the UserScopes property. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Set-CsAdminRole -Identity "RedmondVoiceAdministrators" -ConfigScopes @{Add="site:Redmond"} ``` @@ -122,7 +123,7 @@ To do this, the command includes the ConfigScopes parameter and the following pa This syntax adds the Redmond site to any items already in the ConfigScopes property. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Set-CsAdminRole -Identity "RedmondVoiceAdministrators" -ConfigScopes @{Remove="site:Redmond"} ``` @@ -138,25 +139,45 @@ Set-CsAdminRole -Identity "RedmondVoiceAdministrators" -ConfigScopes @{Replace=" ## PARAMETERS -### -Identity -Unique identifier for the RBAC role to be modified. -The Identity for an RBAC role must be the same as the SamAccountName for the Active Directory universal security group associated with that role. -For example, the help desk role has an Identity equal to CsHelpDesk; CsHelpDesk is also the SamAccountName of the Active Directory security group associated with that role. +### -Cmdlets + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify the cmdlets that will be available to users who hold the RBAC role. +For example, to provide access to just one cmdlet (the `Export-CsArchivingData` cmdlet) use syntax like this: + +`-Cmdlets "Export-CsArchivingData"` + +The preceding syntax replaces all the items currently stored in the Cmdlets property with the single item `Export-CsArchivingData`. +If you want to add the `Export-CsArchivingData` cmdlet to the cmdlets already stored in that property, use this syntax instead: + +`-Cmdlets @{Add="Export-CsArchivingData"}` + +Multiple cmdlets can be added by separated the cmdlet names using commas: + +`-Cmdlets @{Add="Export-CsArchivingData","Invoke-CsArchivingDatabasePurge"}` + +To remove a cmdlet from a role, use this syntax: + +`-Cmdlets @{Remove="Export-CsArchivingData"}` + ```yaml -Type: String +Type: System.Management.Automation.PSListModifier`1[Microsoft.Rtc.Management.WritableConfig.Settings.Roles.CmdletType] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` ### -ConfigScopes + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Limits the scope of the cmdlet to configuration settings within the specified site. To limit the cmdlet scope to a single site, use syntax similar to this: `-ConfigScopes site:Redmond`. Multiple sites can be specified by using a comma-separated list: `-ConfigScopes "site:Redmond, "site:Dublin"`. @@ -173,8 +194,7 @@ You must specify a value for either (or both) the ConfigScopes and UserScopes pr ```yaml Type: System.Management.Automation.PSListModifier`1[Microsoft.Rtc.Management.Core.ConfigScope] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -183,20 +203,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserScopes -Limits the scope of the cmdlet to user management activities within the specified OU. -To limit the cmdlet scope to a single OU, use syntax similar to this: `-UserScopes "OU:ou=Redmond,dc=litwareinc,dc=com"`. -Multiple OUs can be specified by using a comma-separated list: `-UserScopes "OU:ou=Redmond,dc=litwareinc,dc=com", "OU:ou=Dublin,dc=litwareinc,dc=com"`. -To add new scopes (or remove existing scopes) from a role, use the Windows PowerShell list modifiers syntax. -For details, see the Examples section in this Help topic. +### -Force -You must specify a value for either (or both) the ConfigScopes and UserScopes properties. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Rtc.Management.Core.UserScope] +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -205,30 +221,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the RBAC role to be modified. +The Identity for an RBAC role must be the same as the SamAccountName for the Active Directory universal security group associated with that role. +For example, the help desk role has an Identity equal to CsHelpDesk; CsHelpDesk is also the SamAccountName of the Active Directory security group associated with that role. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -ScriptModules + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a function within a Windows PowerShell script that will then be available to users who hold the new RBAC role. +For example, this syntax provides access to a function named Reset in a script named UpdateDatabase.ps1 : + +`-ScriptCmdlets "UpdateDatabase.ps1:Reset"` + +The preceding command replaces any scripts currently stored in the ScriptCmdlets property with the Reset function and the UpdateDatabase.ps1 script. +To add this script/function to items currently stored in the ScriptCmdlets property use this syntax: + +`-ScriptCmdlets @{Add="UpdateDatabase.ps1:Reset"}` + +To remove a script/function use this syntax: + +`-ScriptCmdlets @{Add="UpdateDatabase.ps1:Reset"}` + +You can delete all the ScriptCmdlets assigned to a role by using this syntax: + +`-ScriptCmdlets $Null` ```yaml -Type: SwitchParameter +Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -237,14 +275,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -UserScopes + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Limits the scope of the cmdlet to user management activities within the specified OU. +To limit the cmdlet scope to a single OU, use syntax similar to this: `-UserScopes "OU:ou=Redmond,dc=litwareinc,dc=com"`. +Multiple OUs can be specified by using a comma-separated list: `-UserScopes "OU:ou=Redmond,dc=litwareinc,dc=com", "OU:ou=Dublin,dc=litwareinc,dc=com"`. +To add new scopes (or remove existing scopes) from a role, use the Windows PowerShell list modifiers syntax. +For details, see the Examples section in this Help topic. + +You must specify a value for either (or both) the ConfigScopes and UserScopes properties. ```yaml -Type: SwitchParameter +Type: System.Management.Automation.PSListModifier`1[Microsoft.Rtc.Management.Core.UserScope] Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -253,31 +299,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Cmdlets -Enables you to specify the cmdlets that will be available to users who hold the RBAC role. -For example, to provide access to just one cmdlet (the `Export-CsArchivingData` cmdlet) use syntax like this: - -`-Cmdlets "Export-CsArchivingData"` - -The preceding syntax replaces all the items currently stored in the Cmdlets property with the single item `Export-CsArchivingData`. -If you want to add the `Export-CsArchivingData` cmdlet to the cmdlets already stored in that property, use this syntax instead: - -`-Cmdlets @{Add="Export-CsArchivingData"}` - -Multiple cmdlets can be added by separated the cmdlet names using commas: - -`-Cmdlets @{Add="Export-CsArchivingData","Invoke-CsArchivingDatabasePurge"}` +### -Confirm -To remove a cmdlet from a role, use this syntax: - -`-Cmdlets @{Remove="Export-CsArchivingData"}` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml -Type: System.Management.Automation.PSListModifier`1[Microsoft.Rtc.Management.WritableConfig.Settings.Roles.CmdletType] +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -286,30 +317,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ScriptModules -Enables you to specify a function within a Windows PowerShell script that will then be available to users who hold the new RBAC role. -For example, this syntax provides access to a function named Reset in a script named UpdateDatabase.ps1 : - -`-ScriptCmdlets "UpdateDatabase.ps1:Reset"` - -The preceding command replaces any scripts currently stored in the ScriptCmdlets property with the Reset function and the UpdateDatabase.ps1 script. -To add this script/function to items currently stored in the ScriptCmdlets property use this syntax: - -`-ScriptCmdlets @{Add="UpdateDatabase.ps1:Reset"}` - -To remove a script/function use this syntax: +### -WhatIf -`-ScriptCmdlets @{Add="UpdateDatabase.ps1:Reset"}` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You can delete all the ScriptCmdlets assigned to a role by using this syntax: - -`-ScriptCmdlets $Null` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: System.Management.Automation.PSListModifier`1[System.String] +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -323,12 +340,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### None The `Set-CsAdminRole` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Roles.Role object. diff --git a/skype/skype-ps/skype/Set-CsAllowedDomain.md b/skype/skype-ps/SkypeForBusiness/Set-CsAllowedDomain.md similarity index 88% rename from skype/skype-ps/skype/Set-CsAllowedDomain.md rename to skype/skype-ps/SkypeForBusiness/Set-CsAllowedDomain.md index 09d21b4f92..b3d401bdaa 100644 --- a/skype/skype-ps/skype/Set-CsAllowedDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAllowedDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csalloweddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsAllowedDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csalloweddomain +schema: 2.0.0 +title: Set-CsAllowedDomain --- # Set-CsAllowedDomain @@ -53,7 +54,7 @@ The `Set-CsAllowedDomain` cmdlet provides a way for you to modify property value ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsAllowedDomain -Identity fabrikam.com -Comment "Contact: Ken Myer (kenmyer@fabrikam.com)" ``` @@ -62,7 +63,7 @@ The command shown in Example 1 modifies the Comment property for the allowed dom This is done by including the Comment parameter and the appropriate parameter value: "Contact: Ken Myer (kenmyer@fabrikam.com)". -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsAllowedDomain -Filter *fabrikam* | Set-CsAllowedDomain -Comment "Contact: Ken Myer (kenmyer@fabrikam.com)" ``` @@ -74,7 +75,7 @@ The filter value "*fabrikam*" instructs the `Get-CsAllowedDomain` cmdlet to retu The filtered collection is then piped to the `Set-CsAllowedDomain` cmdlet, which modifies for Comment property. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsAllowedDomain | Where-Object {$_.Comment -eq $Null} | Set-CsAllowedDomain -Comment "Need contact information." ``` @@ -85,7 +86,7 @@ This collection is then piped to the `Where-Object` cmdlet, which picks out thos That filtered collection is then piped to the `Set-CsAllowedDomain` cmdlet, which modifies the Comment property for each item in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsAllowedDomain | Where-Object {$_.Comment -eq $Null} | Set-CsAllowedDomain -Comment "Need contact information." ``` @@ -98,7 +99,47 @@ That filtered collection is then piped to `Set-CsAllowedDomain`, which modifies ## PARAMETERS +### -Comment + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Optional string value that provides additional information about the domain being modified. +For example, you might add a Comment that provides contact information for the federated domain. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the allowed domain for which the property values are being modified. For example: @@ -107,8 +148,7 @@ For example: ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -118,13 +158,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -133,24 +175,10 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Comment -Optional string value that provides additional information about the domain being modified. -For example, you might add a Comment that provides contact information for the federated domain. +### -MarkForMonitoring -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -MarkForMonitoring Indicates whether the federation connection between your domain and the remote domain will be monitored by Monitoring Server. By default, MarkForMonitoring is set to False, meaning that the connection will not be monitored. @@ -160,8 +188,7 @@ This property has been deprecated and should be ignored. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -171,14 +198,16 @@ Accept wildcard characters: False ``` ### -ProxyFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (for example, proxy-server.fabrikam.com) of the SIP proxy server deployed in the domain being added to the allowed list. This property is optional: if it is not specified then DNS SRV discovery procedures will be used to determine the location of the SIP proxy server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -187,30 +216,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -VerificationLevel -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Indicates how (or if) messages sent from a domain are verified to ensure that they were sent from that domain. +The VerificationLevel must be set to one of the following values: -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +AlwaysVerifiable. +All messages purportedly sent from this domain will be accepted. +If a verification header is not found in the message it will be added by Skype for Business Server 2015. + +AlwaysUnverifiable. +All messages purportedly sent from a domain are considered unverified. +They will be delivered only if they were sent from a person who is on the recipient's Contacts list. +For example, if Ken Myer is on your Contacts list you will be able to receive messages from him. +If David Longmire is not on your Contacts list then you will not be able to receive messages from him. +Note that Skype for Business users can manually override this setting, thereby allowing themselves to receive messages people not on their Contacts list. + +UseSourceVerification. +Uses the verification header added to the message by the public provider. +If the verification information is missing the message will be rejected. +This is the default value. ```yaml -Type: SwitchParameter +Type: VerificationLevelType Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -220,13 +252,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -235,31 +269,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VerificationLevel -Indicates how (or if) messages sent from a domain are verified to ensure that they were sent from that domain. -The VerificationLevel must be set to one of the following values: - -AlwaysVerifiable. -All messages purportedly sent from this domain will be accepted. -If a verification header is not found in the message it will be added by Skype for Business Server 2015. +### -WhatIf -AlwaysUnverifiable. -All messages purportedly sent from a domain are considered unverified. -They will be delivered only if they were sent from a person who is on the recipient's Contacts list. -For example, if Ken Myer is on your Contacts list you will be able to receive messages from him. -If David Longmire is not on your Contacts list then you will not be able to receive messages from him. -Note that Skype for Business users can manually override this setting, thereby allowing themselves to receive messages people not on their Contacts list. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -UseSourceVerification. -Uses the verification header added to the message by the public provider. -If the verification information is missing the message will be rejected. -This is the default value. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: VerificationLevelType +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -273,13 +292,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Edge.AllowedDomain object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.AllowedDomain + The `Set-CsAllowedDomain` cmdlet accepts pipelined instances of the allowed domain object. ## OUTPUTS -### +### None The `Set-CsAllowedDomain` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.AllowedDomain object. diff --git a/skype/skype-ps/skype/Set-CsAnalogDevice.md b/skype/skype-ps/SkypeForBusiness/Set-CsAnalogDevice.md similarity index 83% rename from skype/skype-ps/skype/Set-CsAnalogDevice.md rename to skype/skype-ps/SkypeForBusiness/Set-CsAnalogDevice.md index 5c9cadbf2c..ed974a7588 100644 --- a/skype/skype-ps/skype/Set-CsAnalogDevice.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAnalogDevice.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csanalogdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsAnalogDevice -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csanalogdevice +schema: 2.0.0 +title: Set-CsAnalogDevice --- # Set-CsAnalogDevice @@ -42,7 +43,7 @@ For example, you can change the contact's Active Directory display name or the l ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsAnalogDevice -Identity "CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com" -LineUri "TEL:+14255551298" ``` @@ -50,7 +51,7 @@ Set-CsAnalogDevice -Identity "CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmo Example 1 changes the value of the LineUri property for the analog device that has the Identity CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsAnalogDevice -Filter {Gateway -eq "192.168.0.240"} | Set-CsAnalogDevice -Gateway "192.168.1.100" ``` @@ -62,34 +63,35 @@ This filtered collection is then piped to the `Set-CsAnalogDevice` cmdlet, which ## PARAMETERS -### -Identity -Unique identifier for the analog device being modified. -Analog devices are identified by using the Active Directory distinguished name (DN) of the associated contact object. -By default, analog devices use a GUID (globally unique identifier) as their common name, which means devices will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. -This means you might find it easier to modify analog devices by using the `Get-CsAnalogDevice` cmdlet to return the analog devices objects and then piping those objects to the `Set-CsAnalogDevice` cmdlet. +### -AnalogFax +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Set to True ($True) if the analog device is a fax machine. +Set to False ($False) if the device is not a fax machine. ```yaml -Type: UserIdParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Gateway -IP address of the PSTN gateway to be used by the analog device. +### -DisplayName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Configures the Active Directory display name of the analog device. ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -98,15 +100,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AnalogFax -Set to True ($True) if the analog device is a fax machine. -Set to False ($False) if the device is not a fax machine. +### -DisplayNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Phone number as displayed in Skype for Business. +The DisplayNumber property can be formatted any way you prefer; for example 1-800-555-1234; 1-(800)-555-1234; 1.800.555.1234; etc. + ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -115,17 +120,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LineURI -Phone number for the analog device. -The line URI should be specified by using the E.164 format, and be prefixed by the "TEL:" prefix. -For example: TEL:+14255551297. -Any extension number should be added to the end of the line URI; for example: TEL:+14255551297;ext=51297. +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to connect to the specified domain controller in order to modify contact information. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-mcs-001) or its fully qualified domain name (FQDN) (for example, atl-mcs-001.litwareinc.com). ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,17 +139,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipAddress -Unique identifier that allows the analog device to communicate with SIP devices such as Skype for Business Server. -The SIP address must be prefaced by the prefix "sip:". -For example: sip:bldg14lobby@litwareinc.com. +### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True) the analog device can be used with Skype for Business. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: CsEnabled Required: False Position: Named @@ -153,14 +158,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayName -Configures the Active Directory display name of the analog device. +### -EnterpriseVoiceEnabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether the contact object for the analog device has been enabled for Enterprise Voice, the VoIP solution offered by Microsoft. +With Enterprise Voice, telephone calls can be made using the Internet rather than using the standard telephone network. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -169,16 +177,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayNumber -Phone number as displayed in Skype for Business. -The DisplayNumber property can be formatted any way you prefer; for example 1-800-555-1234; 1-(800)-555-1234; 1.800.555.1234; etc. +### -ExchangeArchivingPolicy + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates where the contact's instant messaging sessions are archived. +Allowed values are: + +Uninitialized + +UseLyncArchivingPolicy + +ArchivingToExchange + +NoArchiving ```yaml -Type: String +Type: ExchangeArchivingPolicyOptionsEnum Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -187,15 +205,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to connect to the specified domain controller in order to modify contact information. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-mcs-001) or its fully qualified domain name (FQDN) (for example, atl-mcs-001.litwareinc.com). +### -Gateway + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +IP address of the PSTN gateway to be used by the analog device. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -204,31 +223,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnterpriseVoiceEnabled -Indicates whether the contact object for the analog device has been enabled for Enterprise Voice, the VoIP solution offered by Microsoft. -With Enterprise Voice, telephone calls can be made using the Internet rather than using the standard telephone network. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the analog device being modified. +Analog devices are identified by using the Active Directory distinguished name (DN) of the associated contact object. +By default, analog devices use a GUID (globally unique identifier) as their common name, which means devices will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. +This means you might find it easier to modify analog devices by using the `Get-CsAnalogDevice` cmdlet to return the analog devices objects and then piping those objects to the `Set-CsAnalogDevice` cmdlet. + ```yaml -Type: Boolean +Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -PassThru -Returns an object representing the common area phone. +### -LineURI + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Phone number for the analog device. +The line URI should be specified by using the E.164 format, and be prefixed by the "TEL:" prefix. +For example: TEL:+14255551297. +Any extension number should be added to the end of the line URI; for example: TEL:+14255551297;ext=51297. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -237,14 +266,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns an object representing the common area phone. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -253,14 +284,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -SipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier that allows the analog device to communicate with SIP devices such as Skype for Business Server. +The SIP address must be prefaced by the prefix "sip:". +For example: sip:bldg14lobby@litwareinc.com. + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -269,15 +305,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Enabled -When set to True ($True) the analog device can be used with Skype for Business. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: CsEnabled -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -286,24 +323,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExchangeArchivingPolicy -Indicates where the contact's instant messaging sessions are archived. -Allowed values are: - -Uninitialized - -UseLyncArchivingPolicy - -ArchivingToExchange +### -WhatIf -NoArchiving +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: ExchangeArchivingPolicyOptionsEnum +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -317,13 +346,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.ADConnect.Schema.OCSADAnalogDeviceContact object. +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADAnalogDeviceContact + The `Set-CsAnalogDevice` cmdlet accepts pipelined instances of the analog device object. ## OUTPUTS -### +### None By default, the `Set-CsAnalogDevice` cmdlet does not return any objects or values. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADAnalogDeviceContact object. diff --git a/skype/skype-ps/skype/Set-CsAnnouncement.md b/skype/skype-ps/SkypeForBusiness/Set-CsAnnouncement.md similarity index 86% rename from skype/skype-ps/skype/Set-CsAnnouncement.md rename to skype/skype-ps/SkypeForBusiness/Set-CsAnnouncement.md index 7ed8e2878a..1863bd0ebf 100644 --- a/skype/skype-ps/skype/Set-CsAnnouncement.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAnnouncement.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csannouncement applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsAnnouncement -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csannouncement +schema: 2.0.0 +title: Set-CsAnnouncement --- # Set-CsAnnouncement @@ -44,7 +45,7 @@ This cmdlet modifies these announcement settings. ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Get-CsAnnouncement | Where-Object {$_.Name -eq "Help Desk Announcement"} | Set-CsAnnouncement -AudioFilePrompt "helpdesk.wav" ``` @@ -57,7 +58,7 @@ In turn, that announcement is then piped to the `Set-CsAnnouncement` cmdlet, whi Note that if this announcement already has a TextToSpeechPrompt value assigned to it, this command will generate a warning that the TextToSpeechPrompt value will be ignored. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsAnnouncement | Where-Object {$_.Name -eq "Help Desk Announcement"} | Set-CsAnnouncement -TextToSpeechPrompt $Null ``` @@ -68,7 +69,7 @@ This collection is then piped to the `Where-Object` cmdlet, which selects the an This announcement is then piped to the `Set-CsAnnouncement` cmdlet, which sets the TextToSpeechPrompt property to a null value ($Null). -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsAnnouncement | Where-Object {$_.Name -eq "Help Desk Announcement"} | Set-CsAnnouncement -TargetUri "sip:kmyer@litwareinc.com;opaque=app:voicemail" ``` @@ -81,92 +82,103 @@ This announcement is then piped to the `Set-CsAnnouncement` cmdlet, which sets t ## PARAMETERS -### -Identity -A unique identifier for the Announcement. -This value will always be in the format \/\, where serviceID is the Identity of the Application Server running the Announcement service and GUID is a globally unique identifier associated with these announcement settings. -For example: ApplicationServer:redmond.litwareinc.com/bef5fa3b-3c97-4af0-abe7-611deee7616c. +### -AudioFilePrompt -Because GUIDs can be difficult to enter correctly at the command line, you'll most likely retrieve announcements by using the `Get-CsAnnouncement` cmdlet and pipe them to the `Set-CsAnnouncement` cmdlet for modification. -(For details, see the Examples section.) +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The name of the audio file to be played for the announcement. +Audio files are stored in the File Store. +To save an audio file to the File Store, use the `Import-CsAnnouncementFile` cmdlet. + +Valid file types: WAV and WMA ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -A reference to the Announcement object you want to change. -This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.AnnouncementServiceSettings.Announcement, which can be retrieved by calling the `Get-CsAnnouncement` cmdlet. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -Enter a value for this parameter to change the name of the announcement. -Names must be unique within a service. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier for the Announcement. +This value will always be in the format \/\, where serviceID is the Identity of the Application Server running the Announcement service and GUID is a globally unique identifier associated with these announcement settings. +For example: ApplicationServer:redmond.litwareinc.com/bef5fa3b-3c97-4af0-abe7-611deee7616c. + +Because GUIDs can be difficult to enter correctly at the command line, you'll most likely retrieve announcements by using the `Get-CsAnnouncement` cmdlet and pipe them to the `Set-CsAnnouncement` cmdlet for modification. +(For details, see the Examples section.) ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AudioFilePrompt -The name of the audio file to be played for the announcement. -Audio files are stored in the File Store. -To save an audio file to the File Store, use the `Import-CsAnnouncementFile` cmdlet. +### -Instance -Valid file types: WAV and WMA +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A reference to the Announcement object you want to change. +This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.AnnouncementServiceSettings.Announcement, which can be retrieved by calling the `Get-CsAnnouncement` cmdlet. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -TextToSpeechPrompt -A text-to-speech (TTS) prompt. -This is a string that will be converted to audio and played as the announcement. +### -Language + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The language in which the TTS prompt will be played. +If a value is entered for TextToSpeechPrompt this parameter is required. + +Values are entered as a string representing the language and locale to be used. +The following is a list of valid values, followed by the language and locale in parentheses: ca-ES (Catalan, Spain); da-DK (Danish, Denmark); de-DE (German, Germany); en-AU (English, Australia); en-CA (English, Canada); en-GB (English, United Kingdom); en-IN (English, India); en-US (English, United States); es-ES (Spanish, Spain); es-MX (Spanish, Mexico); fi-FI (Finnish, Finland); fr-CA (French, Canada); fr-FR (French, France); it-IT (Italian, Italy); ja-JP (Japanese, Japan); ko-KR (Korean, Korea); nb-NO (Norwegian, Bokmal, Norway); nl-NL (Dutch, Netherlands); pl-PL (Polish, Poland); pt-BR (Portuguese, Brazil); pt-PT (Portuguese, Portugal); ru-RU (Russian, Russia); sv-SE (Swedish, Sweden); zh-CN (Chinese, People's Republic of China); zh-HK (Chinese, Hong Kong SAR); zh-TW (Chinese, Taiwan) -If both AudioFilePrompt and TextToSpeechPrompt are specified for a single announcement, you will receive a warning that the audio file will take precedence and the TTS prompt will be ignored. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,19 +187,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Language -The language in which the TTS prompt will be played. -If a value is entered for TextToSpeechPrompt this parameter is required. +### -Name -Values are entered as a string representing the language and locale to be used. -The following is a list of valid values, followed by the language and locale in parentheses: ca-ES (Catalan, Spain); da-DK (Danish, Denmark); de-DE (German, Germany); en-AU (English, Australia); en-CA (English, Canada); en-GB (English, United Kingdom); en-IN (English, India); en-US (English, United States); es-ES (Spanish, Spain); es-MX (Spanish, Mexico); fi-FI (Finnish, Finland); fr-CA (French, Canada); fr-FR (French, France); it-IT (Italian, Italy); ja-JP (Japanese, Japan); ko-KR (Korean, Korea); nb-NO (Norwegian, Bokmal, Norway); nl-NL (Dutch, Netherlands); pl-PL (Polish, Poland); pt-BR (Portuguese, Brazil); pt-PT (Portuguese, Portugal); ru-RU (Russian, Russia); sv-SE (Swedish, Sweden); zh-CN (Chinese, People's Republic of China); zh-HK (Chinese, Hong Kong SAR); zh-TW (Chinese, Taiwan) +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Enter a value for this parameter to change the name of the announcement. +Names must be unique within a service. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -197,6 +207,9 @@ Accept wildcard characters: False ``` ### -TargetUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The URI to which the caller will be transferred after the announcement has been played. This value must be a SIP address entered in the format sip: followed by the SIP address. For example, sip:kmyer@litwareinc.com. @@ -205,8 +218,7 @@ Note that the SIP address can also be a telephone number or voice mail, for exam ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -215,14 +227,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -TextToSpeechPrompt + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A text-to-speech (TTS) prompt. +This is a string that will be converted to audio and played as the announcement. + +If both AudioFilePrompt and TextToSpeechPrompt are specified for a single announcement, you will receive a warning that the audio file will take precedence and the TTS prompt will be ignored. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -231,14 +248,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -247,14 +266,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -268,13 +289,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.AnnouncementServiceSettings.Announcement object. +### Microsoft.Rtc.Management.WritableConfig.Settings.AnnouncementServiceSettings.Announcement + Accepts pipelined input of announcement objects. ## OUTPUTS -### +### None The `Set-CsAnnouncement` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AnnouncementServiceSettings.Announcement object. diff --git a/skype/skype-ps/skype/Set-CsApplicationServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsApplicationServer.md similarity index 80% rename from skype/skype-ps/skype/Set-CsApplicationServer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsApplicationServer.md index 0d12488539..37b94986aa 100644 --- a/skype/skype-ps/skype/Set-CsApplicationServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsApplicationServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csapplicationserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsApplicationServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csapplicationserver +schema: 2.0.0 +title: Set-CsApplicationServer --- # Set-CsApplicationServer @@ -40,7 +41,7 @@ Note that any time you change ports you will then need to restart the correspond ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsApplicationServer -Identity "ApplicationServer:atl-cs-001.litwareinc.com" -CasSipPort 5074 ``` @@ -48,7 +49,7 @@ Set-CsApplicationServer -Identity "ApplicationServer:atl-cs-001.litwareinc.com" The command shown in Example 1 configures the SIP port for the Conferencing Announcement application on the Application Server ApplicationServer:atl-cs-001.litwareinc.com to 5074. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsApplicationServer -Identity "ApplicationServer:atl-cs-001.litwareinc.com" -AudioPortStart 49500 -AudioPortCount 5500 ``` @@ -57,7 +58,7 @@ Example 2 configures audio ports for the Application Server ApplicationServer:at In this example, the starting audio port is set to 49500 and a total of 5500 ports are set aside for audio traffic. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsService -ApplicationServer | ForEach-Object {Set-CsApplicationServer -Identity $_.Identity -CasSipPort 5074} ``` @@ -69,35 +70,17 @@ This collection is then piped to the `ForEach-Object` cmdlet, which takes each s ## PARAMETERS -### -Identity -Service location of the Application Server to be modified. -For example: `-Identity "ApplicationServer:atl-cs-001.litwareinc.com"`. - -Note that you can leave off the prefix "ApplicationServer:" when specifying an Application server. -For example: `-Identity "atl-cs-001.litwareinc.com"`. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -ApplicationDatabase -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -ApplicationDatabase Service location of the Application database. For example: `-ApplicationDatabase "ApplicationDatabase:atl-cs-001.litwareinc.com"`. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -107,6 +90,9 @@ Accept wildcard characters: False ``` ### -AppSharingPortCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Total number of ports allocated for application sharing. The actual ports to be opened will start with the value configured for AppSharingPortStart and continue through the number of ports specified for AppSharingPortCount. For example, if the AppSharingPortStart is set to 60000 and the AppSharingPortCount is set to 100 then ports 60000 through 60099 will be used for application sharing. @@ -114,8 +100,7 @@ For example, if the AppSharingPortStart is set to 60000 and the AppSharingPortCo ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -125,14 +110,16 @@ Accept wildcard characters: False ``` ### -AppSharingPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + First port in the range of ports allocated for application sharing. For example: `-AppSharingPortStart 60000`. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -142,13 +129,15 @@ Accept wildcard characters: False ``` ### -AtsSipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for the Audio Test service. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,6 +147,9 @@ Accept wildcard characters: False ``` ### -AudioPortCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Total number of ports allocated for sending and receiving audio traffic. The actual ports to be opened will start with the value configured for AudioPortStart and continue through the number of ports specified for AudioPortCount. For example, if the AudioPortStart is set to 60000 and the AudioPortCount is set to 100, then ports 60000 through 60099 will be used for audio traffic. @@ -165,8 +157,7 @@ For example, if the AudioPortStart is set to 60000 and the AudioPortCount is set ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -176,14 +167,16 @@ Accept wildcard characters: False ``` ### -AudioPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + First port in the range of ports allocated for sending and receiving audio traffic. For example: `-AudioPortStart 60000`. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -193,13 +186,15 @@ Accept wildcard characters: False ``` ### -CaaSipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Conferencing Attendant application, used when connecting users to a dial-in conference. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -209,13 +204,15 @@ Accept wildcard characters: False ``` ### -CasSipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Conferencing Announcement application, used to play announcements (for example, "Ken Myer is now exiting") during a conference. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,14 +222,16 @@ Accept wildcard characters: False ``` ### -CpsSipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Call Park service. The Call Park service enables you to place a call on hold from one telephone, then have that call retrieved from a different phone. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -241,15 +240,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PdpSipPort -SIP port used by the Policy Decision Point Server. -The Policy Decision Point Server is used for bandwidth management. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: UInt16 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -258,14 +258,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PdpTurnPort -Turn traffic port used by the Policy Decision Point Server. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the Application Server to be modified. +For example: `-Identity "ApplicationServer:atl-cs-001.litwareinc.com"`. + +Note that you can leave off the prefix "ApplicationServer:" when specifying an Application server. +For example: `-Identity "atl-cs-001.litwareinc.com"`. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -PdpSipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP port used by the Policy Decision Point Server. +The Policy Decision Point Server is used for bandwidth management. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -274,15 +299,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RgsSipPort -SIP port used by the Response Group application. -The Response Group application provides a way to direct incoming phone calls to a specific group of people, such as an organization's support team. +### -PdpTurnPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Turn traffic port used by the Policy Decision Point Server. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -291,14 +317,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RgsWcfMtlsPort -Port used for Windows Communication Foundation (WCF) mutual TLS (MTLS) traffic used by the Response Group application. +### -Registrar + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the Registrar associated with the Policy Decision Point Server. + ```yaml -Type: UInt16 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -307,16 +336,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VideoPortCount -Total number of ports allocated for sending and receiving video traffic. -The actual ports to be opened will start with the value configured for VideoPortStart and continue through the number of ports specified for VideoPortCount. -For example, if the VideoPortStart is set to 60000 and the VideoPortCount is set to 100, then ports 60000 through 60099 will be used for video traffic. +### -RgsSipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP port used by the Response Group application. +The Response Group application provides a way to direct incoming phone calls to a specific group of people, such as an organization's support team. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -325,15 +355,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VideoPortStart -First port in the range of ports allocated for sending and receiving video traffic. -For example `-VideoPortStart 60000`. +### -RgsWcfMtlsPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Port used for Windows Communication Foundation (WCF) mutual TLS (MTLS) traffic used by the Response Group application. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -342,14 +373,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -VideoPortCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Total number of ports allocated for sending and receiving video traffic. +The actual ports to be opened will start with the value configured for VideoPortStart and continue through the number of ports specified for VideoPortCount. +For example, if the VideoPortStart is set to 60000 and the VideoPortCount is set to 100, then ports 60000 through 60099 will be used for video traffic. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -358,14 +393,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -VideoPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +First port in the range of ports allocated for sending and receiving video traffic. +For example `-VideoPortStart 60000`. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -375,13 +413,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -390,15 +430,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Registrar -Fully qualified domain name of the Registrar associated with the Policy Decision Point Server. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -412,13 +453,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsApplicationServer` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsApplicationServer` cmdlet does not return any values or objects. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayApplicationServer object. diff --git a/skype/skype-ps/skype/Set-CsArchivingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsArchivingConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Set-CsArchivingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsArchivingConfiguration.md index f3a3c69100..e6278cc0dc 100644 --- a/skype/skype-ps/skype/Set-CsArchivingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsArchivingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csarchivingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsArchivingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csarchivingconfiguration +schema: 2.0.0 +title: Set-CsArchivingConfiguration --- # Set-CsArchivingConfiguration @@ -56,7 +57,7 @@ Either way, you can use the `Set-CsArchivingConfiguration` cmdlet to modify the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsArchivingConfiguration -Identity site:Redmond -ArchiveDuplicateMessages $False -KeepArchivingDataForDays 30 ``` @@ -66,7 +67,7 @@ First, the command sets the ArchiveDuplicateMessages property to False; this pre The command also uses the KeepArchivingDataForDays parameter to instruct the server to keep instant messages for 30 days. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsArchivingConfiguration -Filter "site:*" | Set-CsArchivingConfiguration -ArchiveDuplicateMessages $False -KeepArchivingDataForDays 30 ``` @@ -76,7 +77,7 @@ To carry out this task, the command first uses the `Get-CsArchivingConfiguration The filtered collection is then piped to the `Set-CsArchivingConfiguration` cmdlet, which modifies the two property values for each item in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsArchivingConfiguration | Where-Object {$_.EnableArchiving -eq "ImAndWebConf"} | Set-CsArchivingConfiguration -EnableArchiving "ImOnly" ``` @@ -89,47 +90,10 @@ The filtered collection is then piped to the `Set-CsArchivingConfiguration` cmdl ## PARAMETERS -### -Identity -Represents the unique identifier of the collection of archiving configuration settings to be modified. -To modify the global settings, either leave out this parameter or use the following syntax: `-Identity global`. -To modify settings at the site scope, use the prefix "site:" followed by the site name. -For example: `-Identity "site:Redmond"`. - -To modify settings assigned to an individual Registrar pool use syntax similar to this: - -`-Identity "service:Registrar:atl-cs-001.litwareinc.com"` - - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -ArchiveDuplicateMessages -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ArchiveDuplicateMessages Specifies how "cross-pool" instant messages should be archived. Consider a simple example: Ken Myer (with an account in Pool 1) sends an instant message to Pilar Ackerman, who has an account in Pool 2. Pilar, in turn, sends a reply to Ken's instant message. @@ -139,8 +103,7 @@ If ArchiveDuplicateMessages is set to True (the default value), the transcript w ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,14 +113,16 @@ Accept wildcard characters: False ``` ### -BlockOnArchiveFailure + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If True, then the IM service will be suspended any time instant messages cannot be archived. If set to False (the default value), IM will continue even if instant messages cannot be archived. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,6 +132,9 @@ Accept wildcard characters: False ``` ### -CachePurgingInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates how often (in hours) the system is purged of transcripts where none of the participants have been enabled for archiving. By design, all group IM sessions and conferencing sessions are recorded when they take place. At the specified interval, the system determines whether any of the participants in these sessions have been enabled for archiving. @@ -179,8 +147,7 @@ The default value is 24. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -190,6 +157,9 @@ Accept wildcard characters: False ``` ### -EnableArchiving + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates which items (if any) are saved to the archiving database. Valid values are: @@ -206,8 +176,29 @@ Both IM and web conferencing sessions are archived to the database. ```yaml Type: EnableArchiving Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableExchangeArchiving + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, Skype for Business Server instant message and conferencing transcripts are stored in Exchange rather than a separate SQL Server database. +Note that if you enable Exchange archiving then users will be managed by the Exchange archiving policies instead of Skype for Business Server archiving policies. + +The default value is False. + + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -217,6 +208,9 @@ Accept wildcard characters: False ``` ### -EnablePurging + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If True, then archived instant messages will periodically be removed from the database, provided that these instant messages: 1) are older than the value specified in the KeepArchivingDataForDays property; or 2) have been exported and marked for deletion. If False, instant messages will not automatically be deleted from the database. @@ -224,8 +218,7 @@ If False, instant messages will not automatically be deleted from the database. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -234,17 +227,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -KeepArchivingDataForDays -Number of days (between 1 and 2562) that archived instant messages are kept in the database before being automatically deleted. -The default value is 14. +### -Force -This property takes effect only if EnablePurging has been set to True. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: UInt32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -253,37 +245,63 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PurgeExportedArchivesOnly -If True, then the system will only purge instant messages that have been exported (and, as a result, have been marked for deletion). -Instant messages that have not been exported will remain in the database, even if those instant messages are older than the value specified by the KeepArchivingDataForDays property. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Represents the unique identifier of the collection of archiving configuration settings to be modified. +To modify the global settings, either leave out this parameter or use the following syntax: `-Identity global`. +To modify settings at the site scope, use the prefix "site:" followed by the site name. +For example: `-Identity "site:Redmond"`. + +To modify settings assigned to an individual Registrar pool use syntax similar to this: + +`-Identity "service:Registrar:atl-cs-001.litwareinc.com"` + ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PurgeHourOfDay -Indicates the time of day when expired records are deleted from the archiving database. -The time of day is specified using a 24-hour clock, with 0 representing midnight (12:00 AM) and 23 representing 11:00 PM. -Note that you can only specify the hour of the day. -This means that you can schedule purging to take place at 4:00 AM but you cannot schedule it to take place at, for instance, 4:30 AM or 4:15 AM. -The default value is 2 (2:00 AM). +### -Instance -Database purging takes place only if the EnablePurging property is set to True. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -KeepArchivingDataForDays + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Number of days (between 1 and 2562) that archived instant messages are kept in the database before being automatically deleted. +The default value is 14. + +This property takes effect only if EnablePurging has been set to True. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -292,14 +310,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -PurgeExportedArchivesOnly + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, then the system will only purge instant messages that have been exported (and, as a result, have been marked for deletion). +Instant messages that have not been exported will remain in the database, even if those instant messages are older than the value specified by the KeepArchivingDataForDays property. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -308,14 +329,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -PurgeHourOfDay + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the time of day when expired records are deleted from the archiving database. +The time of day is specified using a 24-hour clock, with 0 representing midnight (12:00 AM) and 23 representing 11:00 PM. +Note that you can only specify the hour of the day. +This means that you can schedule purging to take place at 4:00 AM but you cannot schedule it to take place at, for instance, 4:30 AM or 4:15 AM. +The default value is 2 (2:00 AM). + +Database purging takes place only if the EnablePurging property is set to True. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -325,13 +354,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -340,18 +371,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableExchangeArchiving -When set to True, Skype for Business Server instant message and conferencing transcripts are stored in Exchange rather than a separate SQL Server database. -Note that if you enable Exchange archiving then users will be managed by the Exchange archiving policies instead of Skype for Business Server archiving policies. +### -WhatIf -The default value is False. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -365,13 +394,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings + The `Set-CsArchivingConfiguration` cmdlet accepts pipelined input of archiving configuration objects. ## OUTPUTS -### +### None The `Set-CsArchivingConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Archiving.ArchivingSettings object. diff --git a/skype/skype-ps/skype/Set-CsArchivingPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsArchivingPolicy.md similarity index 87% rename from skype/skype-ps/skype/Set-CsArchivingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsArchivingPolicy.md index f4e73c3195..7c29b9f75a 100644 --- a/skype/skype-ps/skype/Set-CsArchivingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsArchivingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csarchivingpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsArchivingPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csarchivingpolicy +schema: 2.0.0 +title: Set-CsArchivingPolicy --- # Set-CsArchivingPolicy @@ -55,7 +56,7 @@ The `Set-CsArchivingPolicy` cmdlet enables you to modify the property values for ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsArchivingPolicy -Identity global -ArchiveInternal $True ``` @@ -64,7 +65,7 @@ In this example, the `Set-CsArchivingPolicy` cmdlet is used to modify the global In this case, the ArchiveInternal property is set to True. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsArchivingPolicy | Set-CsArchivingPolicy -ArchiveInternal $True ``` @@ -77,46 +78,10 @@ That collection is then piped to the `Set-CsArchivingPolicy` cmdlet, which sets ## PARAMETERS -### -Identity -Unique identifier for the archiving policy to be modified. -Archiving policies can be configured at the global, site, or per-user scopes. -To modify the global policy, use this syntax: `-Identity global`. -To modify a site policy, use syntax similar to this: `-Identity site:Redmond`. -To modify a per-user policy, use syntax similar to this: `-Identity SalesArchivingPolicy`. -If this parameter is not specified, then the global policy will be modified. - -Wildcards are not allowed when specifying an Identity. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -ArchiveExternal -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ArchiveExternal Indicates whether external IM sessions are archived. (An external IM session is one in which at least one of the participants is an unauthenticated user who does not have an Active Directory account within your organization.) The default value is False, which means that IM sessions that include external users are not archived. @@ -124,8 +89,7 @@ Indicates whether external IM sessions are archived. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,14 +99,16 @@ Accept wildcard characters: False ``` ### -ArchiveInternal + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether internal IM sessions are archived. (An internal IM session is one in which all the participants are authenticated users who have Active Directory accounts within your organization.) The default value is False, which means that internal IM sessions are not archived. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -152,14 +118,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to provide additional text regarding the policy. For example, the Description property might be used to detail which users the policy should be applied to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -169,13 +137,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,39 +154,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the archiving policy to be modified. +Archiving policies can be configured at the global, site, or per-user scopes. +To modify the global policy, use this syntax: `-Identity global`. +To modify a site policy, use syntax similar to this: `-Identity site:Redmond`. +To modify a per-user policy, use syntax similar to this: `-Identity SalesArchivingPolicy`. +If this parameter is not specified, then the global policy will be modified. + +Wildcards are not allowed when specifying an Identity. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the archiving policy is being modified. For example: @@ -229,8 +213,43 @@ You can return the tenant ID for each of your Skype for Business Online tenants ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -244,13 +263,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.IM.IMArchivingPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.IM.IMArchivingPolicy + The `Remove-CsArchivingPolicy` cmdlet accepts pipelined input of archiving policy objects. ## OUTPUTS -### +### None The `Set-CsArchivingPolicy` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Policy.IM.IMArchivingPolicy object. diff --git a/skype/skype-ps/skype/Set-CsArchivingServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsArchivingServer.md similarity index 87% rename from skype/skype-ps/skype/Set-CsArchivingServer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsArchivingServer.md index 8d31fba3a6..671d19d6f0 100644 --- a/skype/skype-ps/skype/Set-CsArchivingServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsArchivingServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csarchivingserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsArchivingServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csarchivingserver +schema: 2.0.0 +title: Set-CsArchivingServer --- # Set-CsArchivingServer @@ -36,7 +37,7 @@ However, if a hardware failure or other problem should occur, you can point Arch ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsArchivingServer -Identity "ArchivingServer:atl-cs-001.litwareinc.com" -ArchivingDatabase "ArchivingDatabase:atl-sql-001.litwareinc.com" ``` @@ -47,39 +48,36 @@ In this example, the new database is located at ArchivingDatabase:atl-sql-001.li ## PARAMETERS -### -Identity -Service location of the Archiving Server instance to be modified. -For example: `-Identity ArchivingServer:atl-cs-001.litwareinc.com`. -You can retrieve the service location for all your Archiving servers by running this command: +### -ArchivingDatabase -`Get-CsService -ArchivingServer | Select-Object Identity` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that you can leave off the prefix "ArchivingServer:" when specifying an Archiving server. -For example: `-Identity "atl-cs-001.litwareinc.com"`. +Service location where the new Archiving database is located. +For example: `-ArchivingDatabase ArchivingDatabase:atl-sql-001.litwareinc.com`. +Make sure you use the service location and not the SQL Server path when specifying the database location. ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ArchivingDatabase -Service location where the new Archiving database is located. -For example: `-ArchivingDatabase ArchivingDatabase:atl-sql-001.litwareinc.com`. -Make sure you use the service location and not the SQL Server path when specifying the database location. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -88,30 +86,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the Archiving Server instance to be modified. +For example: `-Identity ArchivingServer:atl-cs-001.litwareinc.com`. +You can retrieve the service location for all your Archiving servers by running this command: + +`Get-CsService -ArchivingServer | Select-Object Identity` + +Note that you can leave off the prefix "ArchivingServer:" when specifying an Archiving server. +For example: `-Identity "atl-cs-001.litwareinc.com"`. ```yaml -Type: SwitchParameter +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -120,14 +129,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -141,13 +152,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsArchivingServer` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsArchivingServer` cmdlet does not return any objects or values. Instead, the cmdlet modifies instances of the Microsoft.Rtc.Management.Xds.DisplayArchivingServer object. diff --git a/skype/skype-ps/skype/Set-CsAudioTestServiceApplication.md b/skype/skype-ps/SkypeForBusiness/Set-CsAudioTestServiceApplication.md similarity index 82% rename from skype/skype-ps/skype/Set-CsAudioTestServiceApplication.md rename to skype/skype-ps/SkypeForBusiness/Set-CsAudioTestServiceApplication.md index bb891a7b26..6091220223 100644 --- a/skype/skype-ps/skype/Set-CsAudioTestServiceApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAudioTestServiceApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csaudiotestserviceapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsAudioTestServiceApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csaudiotestserviceapplication +schema: 2.0.0 +title: Set-CsAudioTestServiceApplication --- # Set-CsAudioTestServiceApplication @@ -43,7 +44,7 @@ Administrators can also use the `Set-CsAudioTestServiceApplication` cmdlet to mo ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsAudioTestServiceApplication -Identity "sip:RedmondAudioTest@litwareinc.com" -PrimaryLanguage "en-US" ``` @@ -52,7 +53,7 @@ In Example 1, the primary language for the Audio Test service contact sip:Redmon English (en-US). -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsAudioTestServiceApplication -Identity "sip:RedmondAudioTest@litwareinc.com" -PrimaryLanguage $Null ``` @@ -61,7 +62,7 @@ Example 2 clears the value of the PrimaryLanguage property for the Audio Test se This is done by including the PrimaryLanguage parameter and setting the parameter value to $Null. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsAudioTestServiceApplication | Set-CsAudioTestServiceApplication -PrimaryLanguage "en-US" ``` @@ -75,32 +76,16 @@ English (en-Us) to the PrimaryLanguage property for each contact in the collecti ## PARAMETERS -### -Identity -SIP address of the audio test service contact to be modified. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +### -DisplayName -### -Enabled -Indicates whether or not the contact object has been enabled for Skype for Business Server. -If you set this value to False ($False), the contact will no longer be able to log on to Skype for Business Server; setting this value to True ($True) re-enables the contact's logon privileges. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Active Directory display name of the contact object. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: CsEnabled -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -109,14 +94,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayName -Active Directory display name of the contact object. +### -DisplayNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Although a valid property, DisplayNumber is not actually used with the Audio Test service. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -125,14 +112,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayNumber -Although a valid property, DisplayNumber is not actually used with the Audio Test service. +### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not the contact object has been enabled for Skype for Business Server. +If you set this value to False ($False), the contact will no longer be able to log on to Skype for Business Server; setting this value to True ($True) re-enables the contact's logon privileges. + ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: CsEnabled Required: False Position: Named @@ -142,14 +133,16 @@ Accept wildcard characters: False ``` ### -EnabledForFederation + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether this contact is available to users from a federated domain. If set to False, only users within your organization will have access to the contact. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -159,14 +152,16 @@ Accept wildcard characters: False ``` ### -EnterpriseVoiceEnabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the contact object has been enabled for Enterprise Voice, which is the Microsoft implementation of Voice over Internet Protocol (VoIP). With Enterprise Voice, users can use make telephone calls by using the Internet rather than by using the standard telephone network. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,19 +170,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PrimaryLanguage -Primary language used for the audio test service. -The language must be configured using one of the allowed language codes; for example, en-US for U.S. -English; fr-FR for French; etc. -To return a list of the available language codes, type the following command at the Windows PowerShell prompt: +### -ExchangeArchivingPolicy + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates where the contact's instant messaging sessions are archived. +Allowed values are: + +Uninitialized + +UseLyncArchivingPolicy + +ArchivingToExchange + +NoArchiving -`Get-CsDialInConferencingLanguageList | Select-Object -ExpandProperty Languages`. ```yaml -Type: String +Type: ExchangeArchivingPolicyOptionsEnum Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -196,32 +198,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SecondaryLanguages -Although a valid property, SecondaryLanguages is not actually used with the Audio Test service. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address of the audio test service contact to be modified. ```yaml -Type: Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.String] +Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -SipAddress -This parameter is currently disabled. -You cannot change the SIP address using `Set-CsAudioTestServiceApplication`. +### -LineURI +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Although a valid property, LineUri is not actually used with the Audio Test service. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -230,15 +234,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -Indicates the type of test contact being deployed. -By default, contacts are listed as Automaton, which means they can interact with callers. +### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to pass a user object through the pipeline that represents the user being assigned the policy. +By default, the `Set-CsAudioTestServiceApplication` cmdlet does not pass objects through the pipeline. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -247,15 +253,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a user object through the pipeline that represents the user being assigned the policy. -By default, the `Set-CsAudioTestServiceApplication` cmdlet does not pass objects through the pipeline. +### -PrimaryLanguage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Primary language used for the audio test service. +The language must be configured using one of the allowed language codes; for example, en-US for U.S. +English; fr-FR for French; etc. +To return a list of the available language codes, type the following command at the Windows PowerShell prompt: + +`Get-CsDialInConferencingLanguageList | Select-Object -ExpandProperty Languages`. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -264,14 +276,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SecondaryLanguages + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Although a valid property, SecondaryLanguages is not actually used with the Audio Test service. ```yaml -Type: SwitchParameter +Type: Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.String] Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -280,14 +294,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -SipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is currently disabled. +You cannot change the SIP address using `Set-CsAudioTestServiceApplication`. + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -296,14 +314,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LineURI -Although a valid property, LineUri is not actually used with the Audio Test service. +### -Type + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the type of test contact being deployed. +By default, contacts are listed as Automaton, which means they can interact with callers. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -312,24 +333,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExchangeArchivingPolicy -Indicates where the contact's instant messaging sessions are archived. -Allowed values are: +### -Confirm -Uninitialized +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -UseLyncArchivingPolicy +Prompts you for confirmation before executing the command. -ArchivingToExchange +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf -NoArchiving +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: ExchangeArchivingPolicyOptionsEnum +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -343,12 +374,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact The `Set-CsAudioTestServiceApplication` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact object. ## OUTPUTS -### +### None The `Set-CsAudioTestServiceApplication` cmdlet does not return any objects or values. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsAuthConfig.md b/skype/skype-ps/SkypeForBusiness/Set-CsAuthConfig.md similarity index 96% rename from skype/skype-ps/skype/Set-CsAuthConfig.md rename to skype/skype-ps/SkypeForBusiness/Set-CsAuthConfig.md index 3e47cfbe63..a55ea42f1c 100644 --- a/skype/skype-ps/skype/Set-CsAuthConfig.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAuthConfig.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csauthconfig applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsAuthConfig -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csauthconfig +schema: 2.0.0 +title: Set-CsAuthConfig --- # Set-CsAuthConfig @@ -60,29 +61,16 @@ This example blocks NTLM externally and MA internally. It forces all external cl ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Pool -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2019 -### -Pool {{Fill Pool Description}} ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: 0 Default value: None @@ -91,6 +79,9 @@ Accept wildcard characters: False ``` ### -Scenario + +> Applicable: Skype for Business Server 2019 + {{Fill Scenario Description}} ```yaml @@ -98,7 +89,6 @@ Type: AuthConfigScenario Parameter Sets: (All) Aliases: Accepted values: Custom, AllowAllExternallyAndInternally, BlockWindowsAuthExternally, BlockWindowsAuthExternallyAndInternally, BlockWindowsAuthExternalyAndModernAuthInternally, BlockModernAuthInternally -Applicable: Skype for Business Server 2019 Required: True Position: 1 Default value: None @@ -106,7 +96,27 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Skype for Business Server 2019 + +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 +``` + ### -WhatIf + +> Applicable: Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -114,7 +124,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None diff --git a/skype/skype-ps/skype/Set-CsAutodiscoverConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsAutodiscoverConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Set-CsAutodiscoverConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsAutodiscoverConfiguration.md index 19027a504c..4dbafeae17 100644 --- a/skype/skype-ps/skype/Set-CsAutodiscoverConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsAutodiscoverConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csautodiscoverconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsAutodiscoverConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csautodiscoverconfiguration +schema: 2.0.0 +title: Set-CsAutodiscoverConfiguration --- # Set-CsAutodiscoverConfiguration @@ -60,7 +61,7 @@ From there, you can use the `Set-CsAutoDiscoverConfiguration` cmdlet to add or r ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $Link1 = New-CsWebLink -Token "Fabrikam" -Href "https://LyncDiscover.fabrikam.com" @@ -73,7 +74,7 @@ In the second command, the `Set-CsAutoDiscoverConfiguration` cmdlet is used to a This is done by using the WebLinks parameter and the parameter value @{Add=$Link1}. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $Link1 = Get-CsAutoDiscoverConfiguration -Identity "site:Redmond" | Select-Object -ExpandProperty WebLinks | Where-Object {$_.Token -eq "Fabrikam"} @@ -91,7 +92,7 @@ After that the second command in the example uses the `Set-CsAutoDiscoverConfigu To do this, the command uses the WebLinks parameter and the parameter value @{Remove=$Link1}. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $Link2 = New-CsWebLink -Token "Contoso" -Href "https://LyncDiscover.contoso.com" @@ -104,7 +105,7 @@ The second command then uses the `Set-CsAutoDiscoverConfiguration` cmdlet and th To do this, the command uses the Replace method instead of the Add or Remove method. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Set-CsAutoDiscoverConfiguration -Identity "site:Redmond" -WebLinks $Null ``` @@ -116,14 +117,16 @@ In turn, that deletes any URLs previously assigned to that property. ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. +### -EnableCertificateProvisioningServiceUrl + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), the Certificate Provisioning Service URL is included in Autodiscover Service responses. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,13 +137,14 @@ Accept wildcard characters: False ### -EnableCORS +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If set to True, Cross-Origin Resource Sharing is enabled. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -149,15 +153,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnableCORS + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True, Cross-Origin Resource Sharing is enabled. + +```yaml +Type: Boolean +Position: Named +Parameter Sets: (All) +Aliases: +Required: False +Position: Named +Default value: False +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ExternalSipClientAccessFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the server that is used for external client access. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,13 +191,15 @@ Accept wildcard characters: False ``` ### -ExternalSipClientAccessPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for eternal client access. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -183,13 +209,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -199,6 +227,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of Autodiscover configuration settings to be modified. To modify to the global collection, use this syntax: @@ -214,8 +245,7 @@ If this parameter is not specified, then the `Set-CsAutoDiscoverConfiguration` c ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -225,13 +255,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -241,14 +273,16 @@ Accept wildcard characters: False ``` ### -WebLinks + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Collection of Autodiscover URLs. These URLs must be created by using the `New-CsWebLink` cmdlet. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -257,30 +291,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EnableCertificateProvisioningServiceUrl -When set to True (the default value), the Certificate Provisioning Service URL is included in Autodiscover Service responses. +Prompts you for confirmation before executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -289,19 +309,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableCORS +### -WhatIf -If set to True, Cross-Origin Resource Sharing is enabled. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean -Position: Named +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi + Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -311,13 +332,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WriteableConfig.Settings.AutoDiscoverConfiguration.AutoDiscoverConfiguration The `Set-CsAutoDiscoverConfiguration` cmdlet accepts pipelined input of the Microsoft.Rtc.Management.WriteableConfig.Settings.AutoDiscoverConfiguration.AutoDiscoverConfiguration object. ## OUTPUTS -### -None. +### None The `Set-CsAutoDiscoverConfiguration` cmdlet modifies instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.AutoDiscoverConfiguration.AutoDiscoverConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsBackupServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsBackupServiceConfiguration.md similarity index 84% rename from skype/skype-ps/skype/Set-CsBackupServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsBackupServiceConfiguration.md index dec80abb43..ff3bc82614 100644 --- a/skype/skype-ps/skype/Set-CsBackupServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsBackupServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csbackupserviceconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsBackupServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csbackupserviceconfiguration +schema: 2.0.0 +title: Set-CsBackupServiceConfiguration --- # Set-CsBackupServiceConfiguration @@ -46,7 +47,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsBackupServiceConfiguration -Identity "global" -AuthorizedUniversalGroups "Schema Admins" ``` @@ -54,7 +55,7 @@ Set-CsBackupServiceConfiguration -Identity "global" -AuthorizedUniversalGroups " The command shown in Example 1 assigns the Active Directory security group Schema Admins to the AuthorizedUniversalGroups property for the global collection of backup service settings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsBackupServiceConfiguration -Identity "global" -MaxConcurrentCalls 12 ``` @@ -62,7 +63,7 @@ Set-CsBackupServiceConfiguration -Identity "global" -MaxConcurrentCalls 12 In Example 2, the MaxConcurrentCalls property of the global collection of backup service settings is set to 12. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsBackupServiceConfiguration -Identity "global" -SyncInterval "00:10:00" ``` @@ -74,14 +75,16 @@ In this example, SyncInterval is set to 10 minutes: 00 hours : 10 minutes : 00 s ## PARAMETERS ### -AuthorizedLocalAccounts + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Names of the local users/local groups that are authorized to run the backup service. The default value is Network Service. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -91,14 +94,16 @@ Accept wildcard characters: False ``` ### -AuthorizedUniversalGroups + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Names of the universal groups authorized to run the backup service. The default value is Schema admins. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -107,30 +112,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -EnableRgsBackupService + +> Applicable: Skype for Business Server 2019 + +Indicates whether the backup service for RGS has been enabled or not. If it is set to true RGSBackupService will start syncing RGS data on paired pools ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` + ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -140,6 +149,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the backup service configuration settings. Because you can only have a single, global instance of these settings, you do not need to specify an Identity when calling the `Set-CsBackupServiceConfiguration` cmdlet. If you prefer, however, you can use the following syntax to reference the global settings: @@ -150,8 +162,7 @@ If you prefer, however, you can use the following syntax to reference the global ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -161,13 +172,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -177,14 +190,16 @@ Accept wildcard characters: False ``` ### -MaxBatchesPerCmsSync + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum number of batches that the CMS backup module will export during each export cycle. The default value is 500. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -194,14 +209,16 @@ Accept wildcard characters: False ``` ### -MaxBatchesPerUserStoreSync + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum number of batches that the User Store backup module will export during each export cycle. The default value is 500. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -211,14 +228,16 @@ Accept wildcard characters: False ``` ### -MaxConcurrentCalls + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum number of Windows Communication Foundation (WCF) calls that can be made to the backup service at the same time. The default value is 10. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -228,14 +247,16 @@ Accept wildcard characters: False ``` ### -MaxDataConfPackageSizeKB + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum size of the data package (in kilobytes) that the Data Conference module will export during each export cycle. The default value is 102400. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -244,17 +265,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SyncInterval -Specifies the amount of time that the service waits before synchronizing a pool with its backup pool. -The default value is 2 minutes (00:02:00, or 00 hours, 02 minutes, 00 seconds). -The SyncInterval can be configured to any value between 5 seconds (00:00:05) and 3 hours (03:00:00), inclusive. +### -MaxHighPriQueuePercentagePerUserStoreSync + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +PARAMVALUE: Int32 ```yaml -Type: TimeSpan +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -263,14 +283,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SyncInterval + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the amount of time that the service waits before synchronizing a pool with its backup pool. +The default value is 2 minutes (00:02:00, or 00 hours, 02 minutes, 00 seconds). +The SyncInterval can be configured to any value between 5 seconds (00:00:05) and 3 hours (03:00:00), inclusive. + ```yaml -Type: SwitchParameter +Type: TimeSpan Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -279,14 +304,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxHighPriQueuePercentagePerUserStoreSync -PARAMVALUE: Int32 +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -295,34 +322,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableRgsBackupService -Indicates whether the backup service for RGS has been enabled or not. If it is set to true RGSBackupService will start syncing RGS data on paired pools +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2019 +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.Rtc.Management.WritableConfig.Settings.BackupService.BackupServiceConfiguration The `Set-CsBackupServiceConfiguration` cmdlet accepts piped instances of the Microsoft.Rtc.Management.WritableConfig.Settings.BackupService.BackupServiceConfiguration object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsBackupServiceConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.BackupService.BackupServiceConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsBandwidthPolicyServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsBandwidthPolicyServiceConfiguration.md similarity index 84% rename from skype/skype-ps/skype/Set-CsBandwidthPolicyServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsBandwidthPolicyServiceConfiguration.md index cc5fd68c6b..22c68028d3 100644 --- a/skype/skype-ps/skype/Set-CsBandwidthPolicyServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsBandwidthPolicyServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csbandwidthpolicyserviceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsBandwidthPolicyServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csbandwidthpolicyserviceconfiguration +schema: 2.0.0 +title: Set-CsBandwidthPolicyServiceConfiguration --- # Set-CsBandwidthPolicyServiceConfiguration @@ -42,7 +43,7 @@ This cmdlet modifies an existing bandwidth policy service configuration. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsBandwidthPolicyServiceConfiguration -Identity site:Redmond -EnableLogging $true -MaxTokenLifetime 3:00:00 -LogCleanUpInterval 5.00:00:00 ``` @@ -57,15 +58,53 @@ Finally, the LogCleanUpInterval parameter receives a value of 5.00:00:00, which ## PARAMETERS +### -EnableLogging + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Set this parameter to True to generate CAC failure and link status logs related to the bandwidth policy service. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the configuration you want to change. This identifier will consist of the scope (for the global configuration) or the scope and name (for a site-level configuration, such as site:Redmond). ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -75,14 +114,16 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A reference to a bandwidth policy service configuration object. This object must be of type BandwidthPolicyServiceConfiguration, which can be retrieved by calling the `Get-CsBandwidthPolicyServiceConfiguration` cmdlet. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -91,23 +132,10 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -EnableLogging -Set this parameter to True to generate CAC failure and link status logs related to the bandwidth policy service. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -LogCleanUpInterval -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -LogCleanUpInterval The period of time after which CAC failure and link status logs will be removed. This value must be within the range 1 day through 60 days. @@ -117,8 +145,7 @@ For example, 20 days would be 20.00:00:00. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,6 +155,9 @@ Accept wildcard characters: False ``` ### -MaxLogFileSizeMb + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum size the log file is allowed to reach. The value for this parameter must be a positive number and specifies the file size in megabytes. For example, to allow the log file to reach a maximum size of 10 megabytes, enter the value 10. @@ -135,8 +165,7 @@ For example, to allow the log file to reach a maximum size of 10 megabytes, ente ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -146,6 +175,9 @@ Accept wildcard characters: False ``` ### -MaxTokenLifetime + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum amount of time the token issued by the Bandwidth Policy Authentication service will exist. This value must be in the range 1 hour through 24 hours. @@ -155,8 +187,7 @@ For example, the value for 12 hours would be 12:00:00. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -165,14 +196,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -182,29 +215,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -218,13 +237,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.BandwidthPolicyServiceConfiguration.BandwidthPolicyServiceConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.BandwidthPolicyServiceConfiguration.BandwidthPolicyServiceConfiguration + Accepts pipelined input of bandwidth policy service configuration objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.BandwidthPolicyServiceConfiguration.BandwidthPolicyServiceConfiguration. diff --git a/skype/skype-ps/skype/Set-CsBlockedDomain.md b/skype/skype-ps/SkypeForBusiness/Set-CsBlockedDomain.md similarity index 88% rename from skype/skype-ps/skype/Set-CsBlockedDomain.md rename to skype/skype-ps/SkypeForBusiness/Set-CsBlockedDomain.md index 15662712d0..2d172726d4 100644 --- a/skype/skype-ps/skype/Set-CsBlockedDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsBlockedDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csblockeddomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsBlockedDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csblockeddomain +schema: 2.0.0 +title: Set-CsBlockedDomain --- # Set-CsBlockedDomain @@ -51,7 +52,7 @@ If you need to change the Comment property for any domain on the list of blocked ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsBlockedDomain -Identity fabrikam.com -Comment "Block this domain pending legal review." ``` @@ -60,7 +61,7 @@ The command shown in Example 1 modifies the Comment for the blocked domain with In this example, the Comment parameter is included along with the parameter value, "Block this domain pending legal review." -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsBlockedDomain | Set-CsBlockedDomain -Comment "Block this domain pending legal review." ``` @@ -70,7 +71,7 @@ To do this, the command first calls the `Get-CsBlockedDomain` cmdlet, which retu That collection is then piped to the `Set-CsBlockedDomain` cmdlet, which proceeds to modify the Comment property for each domain in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsBlockedDomain | Where-Object {$_.Comment -eq $Null} | Set-CsBlockedDomain -Comment "Block this domain pending legal review." ``` @@ -83,80 +84,90 @@ The filtered collection is then piped to the `Set-CsBlockedDomain` cmdlet, which ## PARAMETERS -### -Identity -Fully qualified domain name (FQDN) of the blocked domain for which the Comment property is being modified. -For example: fabrikam.com +### -Comment + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to provide additional information about the domain being modified. +For example, you might add a Comment that indicates why the domain has been placed on the blocked list. ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Comment -Enables you to provide additional information about the domain being modified. -For example, you might add a Comment that indicates why the domain has been placed on the blocked list. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the blocked domain for which the Comment property is being modified. +For example: fabrikam.com ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -165,14 +176,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -186,13 +199,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Edge.BlockedDomain object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.BlockedDomain + The `Set-CsBlockedDomain` cmdlet accepts pipelined instances of the blocked domain object. ## OUTPUTS -### +### None The `Set-CsBlockedDomain` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.BlockedDomain object. diff --git a/skype/skype-ps/skype/Set-CsBroadcastMeetingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsBroadcastMeetingConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Set-CsBroadcastMeetingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsBroadcastMeetingConfiguration.md index 62a74c0304..9365c7a479 100644 --- a/skype/skype-ps/skype/Set-CsBroadcastMeetingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsBroadcastMeetingConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csbroadcastmeetingconfiguration applicable: Skype for Business Online -title: Set-CsBroadcastMeetingConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/set-csbroadcastmeetingconfiguration +schema: 2.0.0 +title: Set-CsBroadcastMeetingConfiguration --- # Set-CsBroadcastMeetingConfiguration @@ -58,7 +60,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsBroadcastMeetingConfiguration -Identity Global -EnableAnonymousBroadcastMeeting $true -EnableBroadcastMeetingRecording $true ``` @@ -66,7 +68,7 @@ Set-CsBroadcastMeetingConfiguration -Identity Global -EnableAnonymousBroadcastMe This example sets the global configuration to enable unauthenticated attendees and recorded meetings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsBroadcastMeetingConfiguration -EnableSdnProviderForBroadcastMeeting $true -SdnProviderName "SDNCo" -SdnLicenseId 24030-38291-39042-2048-253904 -SdnApiTemplateUrl "https://api.SDNCo.com/template?auth={0}" -SdnFallbackAttendeeThresholdCountForBroadcastMeeting 1000 ``` @@ -74,7 +76,7 @@ Set-CsBroadcastMeetingConfiguration -EnableSdnProviderForBroadcastMeeting $true This example enables Software Defined Network (SDN) management of broadcast meetings and provides all the required and optional settings to enable SDN support. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsBroadcastMeetingConfiguration -SdnFallbackAttendeeThresholdCountForBroadcastMeeting 500 ``` @@ -84,50 +86,17 @@ This example adjusts the broadcast meeting configuration to set the number of me ## PARAMETERS -### -SdnApiTemplateUrl -Specifies the Software Defined Network (SDN) provider's HTTP API endpoint. -This information is provided to you by the SDN provider. -This parameter is only required if EnableSdnProviderForBroadcastMeeting is set to $true. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SdnProviderName -Specifies the Software Defined Network (SDN) provider's name. -This parameter is only required if EnableSdnProviderForBroadcastMeeting is set to $true. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +### -BroadcastMeetingSupportUrl -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Online -### -BroadcastMeetingSupportUrl Specifies a URL where broadcast meeting attendees can find support information or FAQs specific to that meeting. The URL will be displayed during the broadcast meeting. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -136,23 +105,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +### -EnableAnonymousBroadcastMeeting -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Online -### -EnableAnonymousBroadcastMeeting Specifies whether non-authenticated attendees are allowed to join and view the web-based portion of the meeting. Valid input for this parameter is $true or $false. The default value is $true. @@ -160,8 +116,7 @@ The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -171,6 +126,9 @@ Accept wildcard characters: False ``` ### -EnableBroadcastMeeting + +> Applicable: Skype for Business Online + Specifies whether broadcast meetings are enabled. Valid input for this parameter is $true or $false. The default value is $false. @@ -178,8 +136,7 @@ The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -189,6 +146,9 @@ Accept wildcard characters: False ``` ### -EnableBroadcastMeetingRecording + +> Applicable: Skype for Business Online + Specifies whether broadcast meetings can be recorded at the server level. Valid input for this parameter is $true or $false. The default value is $true. @@ -196,8 +156,7 @@ The default value is $true. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -207,14 +166,16 @@ Accept wildcard characters: False ``` ### -EnableOpenBroadcastMeeting + +> Applicable: Skype for Business Online + Specifies if the organizer is allowed to create broadcast meetings that allows anyone in the organizer's organization to attend. The default and only setting is $true. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -224,14 +185,16 @@ Accept wildcard characters: False ``` ### -EnableSdnProviderForBroadcastMeeting + +> Applicable: Skype for Business Online + If set to $true, broadcast meeting streams are enabled to take advantage of the network and bandwidth management capabilities of your Software Defined Network (SDN) provider. The default is $false. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -241,14 +204,16 @@ Accept wildcard characters: False ``` ### -EnableTechPreviewFeatures + +> Applicable: Skype for Business Online + Set to $true to enable use of features available in a technical preview program. Set to $false to disable the technical preview features. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -258,6 +223,9 @@ Accept wildcard characters: False ``` ### -EnforceBroadcastMeetingRecording + +> Applicable: Skype for Business Online + Specifies whether all meetings will be recorded. Valid input for this parameter is $true or $false. The default value is $false. @@ -265,8 +233,7 @@ The default value is $false. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -276,6 +243,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Online + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -283,8 +253,7 @@ If the Force switch isn't provided in the command, you're prompted for administr ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -294,13 +263,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 2 @@ -310,13 +281,35 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Online + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SdnApiTemplateUrl + +> Applicable: Skype for Business Online + +Specifies the Software Defined Network (SDN) provider's HTTP API endpoint. +This information is provided to you by the SDN provider. +This parameter is only required if EnableSdnProviderForBroadcastMeeting is set to $true. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -326,6 +319,9 @@ Accept wildcard characters: False ``` ### -SdnApiToken + +> Applicable: Skype for Business Online + Specifies the Software Defined Network (SDN) provider's authentication token which is required to use their SDN license. This is required by some SDN providers who will give you the required token. This parameter is only required if EnableSdnProviderForBroadcastMeeting is set to $true. @@ -333,8 +329,7 @@ This parameter is only required if EnableSdnProviderForBroadcastMeeting is set t ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -344,6 +339,9 @@ Accept wildcard characters: False ``` ### -SdnAzureSubscriptionId + +> Applicable: Skype for Business Online + Specifies your Microsoft Azure subscription id which is required by some providers to access the Software Defined Network (SDN) provider's services. The SdnAzureSubscriptionId parameter is not currently supported. @@ -351,8 +349,7 @@ The SdnAzureSubscriptionId parameter is not currently supported. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -362,6 +359,9 @@ Accept wildcard characters: False ``` ### -SdnFallbackAttendeeThresholdCountForBroadcastMeeting + +> Applicable: Skype for Business Online + Specifies the number of broadcast meeting attendees that are allowed to fallback from a Software Defined Network (SDN) connection to the standard content delivery network. If this number is exceeded, additional meeting attendees who are not able to use the SDN service will not be allowed to join the meeting. @@ -370,8 +370,7 @@ The SdnFallbackAttendeeThresholdCountForBroadcastMeeting parameter is not curren ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -381,6 +380,9 @@ Accept wildcard characters: False ``` ### -SdnLicenseId + +> Applicable: Skype for Business Online + Specifies the Software Defined Network (SDN) license identifier. This is required and provided by some SDN providers. This parameter is only required if EnableSdnProviderForBroadcastMeeting is set to $true. @@ -388,8 +390,26 @@ This parameter is only required if EnableSdnProviderForBroadcastMeeting is set t ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SdnProviderName + +> Applicable: Skype for Business Online + +Specifies the Software Defined Network (SDN) provider's name. +This parameter is only required if EnableSdnProviderForBroadcastMeeting is set to $true. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -399,13 +419,33 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Online + +The Confirm switch causes the command to pause processing and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -415,6 +455,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -422,7 +465,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named @@ -436,13 +478,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None +### None ## OUTPUTS -### -None +### None ## NOTES diff --git a/skype/skype-ps/skype/Set-CsBusyOptions.md b/skype/skype-ps/SkypeForBusiness/Set-CsBusyOptions.md similarity index 88% rename from skype/skype-ps/skype/Set-CsBusyOptions.md rename to skype/skype-ps/SkypeForBusiness/Set-CsBusyOptions.md index 5743b4b153..c8fab683d8 100644 --- a/skype/skype-ps/skype/Set-CsBusyOptions.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsBusyOptions.md @@ -1,12 +1,12 @@ --- +author: hirenshah1 external help file: Microsoft.Rtc.Management.dll-help.xml -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsBusyOptions -schema: 2.0.0 +Locale: en-US manager: rogupta -author: hirenshah1 +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +schema: 2.0.0 +title: Set-CsBusyOptions --- # Set-CsBusyOptions @@ -40,14 +40,14 @@ For more information about how to enable Busy Options in your organization, see ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsBusyOptions -Identity "Ken Myer" -ActionType BusyOnBusy ``` This cmdlet configures busy options for the user "Ken Myer". In this configuration, any call to "Ken Myer" will return a busy signal when he is already in a call. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsBusyOptions -Identity "Chrystal Velasquez" -ActionType VoicemailOnBusy ``` @@ -57,6 +57,9 @@ This cmdlet configures busy options for the user "Chrystal Velasquez". In this c ## PARAMETERS ### -ActionType + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + There are two Action Type options: * BusyOnBusy - In which new incoming calls will be rejected with a busy signal if the user is busy. @@ -66,9 +69,8 @@ There are two Action Type options: ```yaml Type: ActionType Parameter Sets: (All) -Aliases: +Aliases: Accepted values: BusyOnBusy, VoicemailOnBusy -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -77,23 +79,10 @@ 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 -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Identity -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Identity Indicates the Identity of the user account to be modified. User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. You can use the asterisk (\*) wildcard character when using the display name as the user Identity. For example, the Identity "*Smith" returns all the users who have a display name that ends with the string value "Smith". @@ -101,8 +90,7 @@ You can use the asterisk (\*) wildcard character when using the display name as ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 0 @@ -112,13 +100,33 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + 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: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -128,6 +136,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -135,7 +146,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -149,14 +159,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Bob.Cmdlets.ActionType object. +### Microsoft.Rtc.Management.Bob.Cmdlets.ActionType + Microsoft.Rtc.Management.AD.UserIdParameter object. ## OUTPUTS -### -Microsoft.Rtc.Management.Bob.Cmdlets.ActionType object. +### Microsoft.Rtc.Management.Bob.Cmdlets.ActionType + Microsoft.Rtc.Management.AD.UserIdParameter object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsCallParkOrbit.md b/skype/skype-ps/SkypeForBusiness/Set-CsCallParkOrbit.md similarity index 87% rename from skype/skype-ps/skype/Set-CsCallParkOrbit.md rename to skype/skype-ps/SkypeForBusiness/Set-CsCallParkOrbit.md index 1962bcc635..6dd2b2cc87 100644 --- a/skype/skype-ps/skype/Set-CsCallParkOrbit.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCallParkOrbit.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cscallparkorbit applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsCallParkOrbit -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cscallparkorbit +schema: 2.0.0 +title: Set-CsCallParkOrbit --- # Set-CsCallParkOrbit @@ -41,7 +42,7 @@ The new range of numbers must be unique among all call park orbits defined withi ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsCallParkOrbit -Identity "Redmond CPO 1" -NumberRangeStart 500 -NumberRangeEnd 699 ``` @@ -50,7 +51,7 @@ This example changes the range of numbers for the call park orbit named "Redmond All values within this range must be unique among all call park orbit ranges within the organization. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsCallParkOrbit -Identity "Redmond CPO 2" -NumberRangeStart "*7000" -NumberRangeEnd "*7100" ``` @@ -63,15 +64,54 @@ If these values begin with a * or # (the only non-numeric values allowed) you mu ## PARAMETERS +### -CallParkService + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The fully qualified domain name (FQDN) or service ID of the Application service that hosts the Call Park application. +All calls parked to numbers within the range specified by the NumberRangeStart and NumberRangeEnd parameters will be routed to this server or pool. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: CallParkServerFqdn + +Required: False +Position: 5 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the call park orbit range to be modified. If the Identity includes spaces, this value must be included within double quotes. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -81,14 +121,16 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. This object must be of type DisplayCallParkOrbit, which can be retrieved by calling the `Get-CsCallParkOrbit` cmdlet. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -97,24 +139,39 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -CallParkService -The fully qualified domain name (FQDN) or service ID of the Application service that hosts the Call Park application. -All calls parked to numbers within the range specified by the NumberRangeStart and NumberRangeEnd parameters will be routed to this server or pool. +### -NumberRangeEnd + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The last number in the range for this call park orbit. +The value must be greater than or equal to the NumberRangeStart. +The value must also be the same length as the value of the NumberRangeStart. +For example, if NumberRangeStart is set to 100, NumberRangeEnd cannot be set to 1001. +In addition, if the NumberRangeStart begins with a * or #, then NumberRangeEnd must begin with the same character. + +Valid values: Must match the regular expression string (\[\*|#\]?\[1-9\]\d{0,7})|(\[1-9\]\d{0,8}). +This means that the value must be a string beginning with either the character * or # or a number 1 through 9 (the first character cannot be a zero). +If the first character is * or # the following character must be a number 1 through 9 (it cannot be a zero). +Subsequent characters can be any number 0 through 9 up to seven additional characters. +(For example, "#6000", "*92000", and "*95551212".) If the first character is not * or #, the first character must be a number 1 through 9 (it cannot be zero), followed by up to eight characters, each a number 0 through 9. +(For example, 915551212;41212;300.) ```yaml Type: String Parameter Sets: (All) -Aliases: CallParkServerFqdn -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 5 +Position: 4 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -NumberRangeStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The first number in the range for this call park orbit. The value must be less than or equal to the NumberRangeEnd. The value must also be the same length as the value of the NumberRangeEnd. @@ -130,8 +187,7 @@ If the first character is not * or #, the first character must be a number 1 thr ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 3 @@ -140,57 +196,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NumberRangeEnd -The last number in the range for this call park orbit. -The value must be greater than or equal to the NumberRangeStart. -The value must also be the same length as the value of the NumberRangeStart. -For example, if NumberRangeStart is set to 100, NumberRangeEnd cannot be set to 1001. -In addition, if the NumberRangeStart begins with a * or #, then NumberRangeEnd must begin with the same character. +### -Type -Valid values: Must match the regular expression string (\[\*|#\]?\[1-9\]\d{0,7})|(\[1-9\]\d{0,8}). -This means that the value must be a string beginning with either the character * or # or a number 1 through 9 (the first character cannot be a zero). -If the first character is * or # the following character must be a number 1 through 9 (it cannot be a zero). -Subsequent characters can be any number 0 through 9 up to seven additional characters. -(For example, "#6000", "*92000", and "*95551212".) If the first character is not * or #, the first character must be a number 1 through 9 (it cannot be zero), followed by up to eight characters, each a number 0 through 9. -(For example, 915551212;41212;300.) +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Specifies the type of call park orbit. +Skype for Business Server allows for two different types of call park orbits: -Required: False -Position: 4 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +CallPark. +This is the standard call park orbit, in which a user places a call on hold and then can retrieve that call from any phone by dialing the specified call park number. +CallPark is the default orbit type and will be used if the Type parameter is not specified. -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +GroupPickup. +With group pickup, users can answer any incoming call that is made to any member of their call pickup group. +Call pickup groups are configured by administrators. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +To specify a call park orbit type, use syntax similar to this: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +`-Type GroupPickup` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +This parameter was introduced in the February 2013 release of Lync Server 2013. ```yaml -Type: SwitchParameter +Type: OrbitType Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -200,13 +230,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -215,29 +247,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -Specifies the type of call park orbit. -Skype for Business Server allows for two different types of call park orbits: - -CallPark. -This is the standard call park orbit, in which a user places a call on hold and then can retrieve that call from any phone by dialing the specified call park number. -CallPark is the default orbit type and will be used if the Type parameter is not specified. - -GroupPickup. -With group pickup, users can answer any incoming call that is made to any member of their call pickup group. -Call pickup groups are configured by administrators. - -To specify a call park orbit type, use syntax similar to this: +### -WhatIf -`-Type GroupPickup` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -This parameter was introduced in the February 2013 release of Lync Server 2013. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: OrbitType +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -251,13 +270,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Voice.Helpers.DisplayCallParkOrbit object. +### Microsoft.Rtc.Management.Voice.Helpers.DisplayCallParkOrbit + Accepts pipelined input of call park orbit objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.Helpers.DisplayCallParkOrbit This cmdlet modifies an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayCallParkOrbit. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsCallParkServiceMusicOnHoldFile.md b/skype/skype-ps/SkypeForBusiness/Set-CsCallParkServiceMusicOnHoldFile.md similarity index 88% rename from skype/skype-ps/skype/Set-CsCallParkServiceMusicOnHoldFile.md rename to skype/skype-ps/SkypeForBusiness/Set-CsCallParkServiceMusicOnHoldFile.md index 81af567605..1f34daf009 100644 --- a/skype/skype-ps/skype/Set-CsCallParkServiceMusicOnHoldFile.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCallParkServiceMusicOnHoldFile.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cscallparkservicemusiconholdfile applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsCallParkServiceMusicOnHoldFile -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cscallparkservicemusiconholdfile +schema: 2.0.0 +title: Set-CsCallParkServiceMusicOnHoldFile --- # Set-CsCallParkServiceMusicOnHoldFile @@ -43,7 +44,7 @@ Audio files must be in the following format: Windows Media Audio 9, 44 kHz, 16 b ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $a = [System.IO.File]::ReadAllBytes('C:\MoHFiles\soothingmusic.wma') @@ -61,23 +62,10 @@ We then pass the audio file contents that we read into variable $a to the Conten ## PARAMETERS -### -Service -The ID of the service where the Call Park service resides; for example, ApplicationServer:pool0.litwareinc.com. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Content -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Content The contents of the audio file in byte format. A valid value for this parameter requires you to read the file to a byte-encoded object using the following syntax: `([System.IO.File]::ReadAllBytes('\'))`. You can use this command as the parameter value, or you can write the output to a variable (`$data = [System.IO.File]::ReadAllBytes('\')`) and use the variable as the parameter value (`$data`). @@ -85,8 +73,7 @@ A valid value for this parameter requires you to read the file to a byte-encoded ```yaml Type: Byte[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -96,13 +83,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -111,30 +100,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Service + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The ID of the service where the Call Park service resides; for example, ApplicationServer:pool0.litwareinc.com. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -148,13 +159,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Byte\[\]. +### Sysetm.Byte[] Accepts pipelined input of a byte array containing the music on hold file. ## OUTPUTS -### +### None This cmdlet does not return a value. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsCallViaWorkPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsCallViaWorkPolicy.md similarity index 86% rename from skype/skype-ps/skype/Set-CsCallViaWorkPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsCallViaWorkPolicy.md index 5177db6710..683f8f3a8a 100644 --- a/skype/skype-ps/skype/Set-CsCallViaWorkPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCallViaWorkPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cscallviaworkpolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsCallViaWorkPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cscallviaworkpolicy +schema: 2.0.0 +title: Set-CsCallViaWorkPolicy --- # Set-CsCallViaWorkPolicy @@ -35,7 +36,7 @@ Use this cmdlet to modify an existing call via work policy that enables and mana ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsCallViaWorkPolicy -Identity Site:Redmond -Enabled $true -AdminCallbackNumber +14258881234 -UseAdminCallbackNumber $true ``` @@ -46,6 +47,9 @@ This example enables the existing call via work policy of the Redmond site and e ## PARAMETERS ### -AdminCallbackNumber + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the number that will be called during the call back to the Skype for Business user before placing the external call. Typically this is the user's desk phone. If you want the user be able to change the callback number, use the UseAdminCallbackNumber switch. @@ -55,8 +59,7 @@ For instance, "12068881234" or "+12068881234". ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -65,31 +68,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Enabled -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Enabled If true ($True) the policy is enabled. The default at policy creation is false ($False). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -99,13 +88,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error messages and completes the cmdlet operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -115,6 +106,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the unique identifier assigned to the policy when it was created. Call via work policies can be assigned at the global, site, or per-user scope. @@ -127,8 +121,7 @@ Per-user syntax: `-Identity CallviaWorkStandard` ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -138,13 +131,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -154,13 +149,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -170,6 +167,9 @@ Accept wildcard characters: False ``` ### -UseAdminCallbackNumber + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + If true ($True), the number specified in the AdminCallbackNumber is the only number that will be used for the callback to the user, or first leg, of the outbound call. If false ($False), the user has the opportunity to change the callback number through the client. The user might choose to change the call back number to a conference room or home number. @@ -177,8 +177,25 @@ The user might choose to change the call back number to a conference room or hom ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -188,13 +205,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -208,15 +227,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Input Types - -None. +### None ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Set-CsCceApplianceConfigurationReplicationStatus.md b/skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceConfigurationReplicationStatus.md similarity index 89% rename from skype/skype-ps/skype/Set-CsCceApplianceConfigurationReplicationStatus.md rename to skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceConfigurationReplicationStatus.md index 4d556a212d..1d3c31da75 100644 --- a/skype/skype-ps/skype/Set-CsCceApplianceConfigurationReplicationStatus.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceConfigurationReplicationStatus.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cscceapplianceconfigurationreplicationstatus applicable: Skype for Business Online -title: Set-CsCceApplianceConfigurationReplicationStatus -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/set-cscceapplianceconfigurationreplicationstatus +schema: 2.0.0 +title: Set-CsCceApplianceConfigurationReplicationStatus --- # Set-CsCceApplianceConfigurationReplicationStatus @@ -36,7 +38,7 @@ Set-CsCceApplianceConfigurationReplicationStatus [-Identity] {{ Add example code here }} ``` @@ -45,30 +47,16 @@ PS C:\> {{ Add example code here }} ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Online -### -Force {{Fill Force Description}} ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -78,13 +66,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + {{Fill Identity Description}} ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 1 @@ -94,13 +84,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Online + {{Fill Instance Description}} ```yaml Type: PSObject Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -110,13 +102,33 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + {{Fill Tenant Description}} ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Online + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -126,6 +138,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -133,7 +148,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/Set-CsCceApplianceDeploymentStatus.md b/skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceDeploymentStatus.md similarity index 87% rename from skype/skype-ps/skype/Set-CsCceApplianceDeploymentStatus.md rename to skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceDeploymentStatus.md index 1ca389b8ab..2719f835d2 100644 --- a/skype/skype-ps/skype/Set-CsCceApplianceDeploymentStatus.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceDeploymentStatus.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cscceappliancedeploymentstatus applicable: Skype for Business Online -title: Set-CsCceApplianceDeploymentStatus -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/set-cscceappliancedeploymentstatus +schema: 2.0.0 +title: Set-CsCceApplianceDeploymentStatus --- # Set-CsCceApplianceDeploymentStatus @@ -40,7 +42,7 @@ Provide the detailed description here. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Insert example commands for example 1. ``` @@ -51,13 +53,15 @@ Insert descriptive text for example 1. ## PARAMETERS ### -Action + +> Applicable: Skype for Business Online + PARAMVALUE: Deploy | BitsUpdate | OsUpdate | Remove ```yaml Type: HybridPstnApplianceAction Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -66,30 +70,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -PARAMVALUE: XdsGlobalRelativeIdentity +### -Error -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +> Applicable: Skype for Business Online -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Status -PARAMVALUE: Started | Finished | Error +PARAMVALUE: String ```yaml -Type: HybridPstnApplianceActionStatus +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -98,14 +88,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -Force + +> Applicable: Skype for Business Online + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -114,30 +106,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Error -PARAMVALUE: String +### -Identity + +> Applicable: Skype for Business Online + +PARAMVALUE: XdsGlobalRelativeIdentity ```yaml -Type: String +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -PARAMVALUE: SwitchParameter +### -Instance + +> Applicable: Skype for Business Online + +PARAMVALUE: PSObject ```yaml -Type: SwitchParameter +Type: PSObject Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -146,14 +142,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -PARAMVALUE: PSObject +### -Status + +> Applicable: Skype for Business Online + +PARAMVALUE: Started | Finished | Error ```yaml -Type: PSObject +Type: HybridPstnApplianceActionStatus Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -163,13 +161,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + PARAMVALUE: Guid ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -179,13 +179,33 @@ Accept wildcard characters: False ``` ### -Version + +> Applicable: Skype for Business Online + PARAMVALUE: String ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Online + +PARAMVALUE: SwitchParameter + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -195,13 +215,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/Set-CsCceApplianceStatus.md b/skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceStatus.md similarity index 87% rename from skype/skype-ps/skype/Set-CsCceApplianceStatus.md rename to skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceStatus.md index 634a66015e..6d00652fe7 100644 --- a/skype/skype-ps/skype/Set-CsCceApplianceStatus.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCceApplianceStatus.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cscceappliancestatus applicable: Skype for Business Online -title: Set-CsCceApplianceStatus -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/set-cscceappliancestatus +schema: 2.0.0 +title: Set-CsCceApplianceStatus --- # Set-CsCceApplianceStatus @@ -38,7 +40,7 @@ Provide the detailed description here. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Insert example commands for example 1. ``` @@ -48,30 +50,34 @@ Insert descriptive text for example 1. ## PARAMETERS -### -Identity -PARAMVALUE: XdsGlobalRelativeIdentity +### -Error + +> Applicable: Skype for Business Online + +PARAMVALUE: String ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Status -PARAMVALUE: None | Running | Maintenance | Error +### -Force + +> Applicable: Skype for Business Online + +PARAMVALUE: SwitchParameter ```yaml -Type: HybridPstnApplianceRunningStatus +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -80,30 +86,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -PARAMVALUE: SwitchParameter +### -Identity + +> Applicable: Skype for Business Online + +PARAMVALUE: XdsGlobalRelativeIdentity ```yaml -Type: SwitchParameter +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Error -PARAMVALUE: String +### -Instance + +> Applicable: Skype for Business Online + +PARAMVALUE: PSObject ```yaml -Type: String +Type: PSObject Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -112,14 +122,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -PARAMVALUE: SwitchParameter +### -Status + +> Applicable: Skype for Business Online + +PARAMVALUE: None | Running | Maintenance | Error ```yaml -Type: SwitchParameter +Type: HybridPstnApplianceRunningStatus Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -128,14 +140,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -PARAMVALUE: PSObject +### -Tenant + +> Applicable: Skype for Business Online + +PARAMVALUE: Guid ```yaml -Type: PSObject +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -144,14 +158,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -PARAMVALUE: Guid +### -Version + +> Applicable: Skype for Business Online + +{{Fill Version Description}} ```yaml -Type: Guid +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -160,14 +176,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf +### -Confirm + +> Applicable: Skype for Business Online + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -176,14 +194,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Version -{{Fill Version Description}} +### -WhatIf + +> Applicable: Skype for Business Online + +PARAMVALUE: SwitchParameter ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Set-CsCdrConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsCdrConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Set-CsCdrConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsCdrConfiguration.md index adac626963..88ca491349 100644 --- a/skype/skype-ps/skype/Set-CsCdrConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCdrConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cscdrconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsCdrConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cscdrconfiguration +schema: 2.0.0 +title: Set-CsCdrConfiguration --- # Set-CsCdrConfiguration @@ -24,7 +25,7 @@ This cmdlet was introduced in Lync Server 2010. ### Identity ``` Set-CsCdrConfiguration [[-Identity] ] [-EnableCDR ] [-EnablePurging ] - [-KeepCallDetailForDays ] [-KeepErrorReportForDays ] [-PurgeHourOfDay ] + [-KeepCallDetailForDays ] [-KeepErrorReportForDays ] [-PurgeHourOfDay ] [-EnableUdcLite ] [-Force] [-WhatIf] [-Confirm] [] ``` @@ -52,7 +53,7 @@ Changes such as these can be made by using the `Set-CsCdrConfiguration` cmdlet. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsCdrConfiguration -Identity site:Redmond -PurgeHourOfDay 23 ``` @@ -62,7 +63,7 @@ In this case the time is set to 23 (11:00 P.M. on a 24-hour clock). The Identity parameter is used to ensure that these changes are only made to the CDR settings that have the Identity site:Redmond. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsCdrConfiguration | Set-CsCdrConfiguration -PurgeHourOfDay 23 ``` @@ -73,7 +74,7 @@ To do this, the command first calls the `Get-CsCdrConfiguration` cmdlet without This collection is then piped to the `Set-CsCdrConfiguration` cmdlet, which takes each item in the collection and changes the value of the PurgeHourOfDay property to 11:00 PM (23). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsCdrConfiguration -Filter "site:*"| Set-CsCdrConfiguration -PurgeHourOfDay 23 ``` @@ -86,53 +87,52 @@ The filtered collection is then piped to the `Set-CsCdrConfiguration` cmdlet, wh ## PARAMETERS -### -Identity -Unique identifier assigned to the collection of CDR configuration settings. -To refer to the global settings, use this syntax: `-Identity global`. -To refer to a collection configured at the site scope, use syntax similar to this: `-Identity site:Redmond`. -Note that you cannot use wildcard characters when specifying an Identity. +### -EnableCDR -If this parameter is omitted then the `Set-CsCdrConfiguration` cmdlet will modify the global settings. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Indicates whether or not CDR is enabled. +The default value is True. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -EnablePurging + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not CDR records will periodically be deleted from the CDR database. +If True (the default value), records will be deleted after the time period specified by the properties KeepCallDetailForDays (for CDR records) and KeepErrorReportForDays (for CDR errors). +If False, CDR records will be maintained indefinitely. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableCDR -Indicates whether or not CDR is enabled. -The default value is True. +### -EnableUdcLite +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,16 +141,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnablePurging -Indicates whether or not CDR records will periodically be deleted from the CDR database. -If True (the default value), records will be deleted after the time period specified by the properties KeepCallDetailForDays (for CDR records) and KeepErrorReportForDays (for CDR errors). -If False, CDR records will be maintained indefinitely. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -159,7 +159,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier assigned to the collection of CDR configuration settings. +To refer to the global settings, use this syntax: `-Identity global`. +To refer to a collection configured at the site scope, use syntax similar to this: `-Identity site:Redmond`. +Note that you cannot use wildcard characters when specifying an Identity. + +If this parameter is omitted then the `Set-CsCdrConfiguration` cmdlet will modify the global settings. + + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -KeepCallDetailForDays + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the number of days that CDR records will be kept in the CDR database; any records older than the specified number of days will automatically be deleted. (Note that purging will take only place if the EnablePurging property has been set to true.) @@ -169,8 +214,7 @@ The default value is 60. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -180,6 +224,9 @@ Accept wildcard characters: False ``` ### -KeepErrorReportForDays + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the number of days that CDR error reports are kept; any reports older than the specified number of days will automatically be deleted. CDR error reports are diagnostic reports uploaded by client applications such as Skype for Business. @@ -190,8 +237,7 @@ The default value is 60. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -201,6 +247,9 @@ Accept wildcard characters: False ``` ### -PurgeHourOfDay + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the local time of day when expired records are deleted from the CDR database. The time of day is specified using a 24-hour clock, with 0 representing midnight (12:00 A.M.) and 23 representing 11:00 P.M. Note that you can only specify the hour of the day; that means that you can schedule purging to take place at 4:00 A.M., but you cannot schedule it to take place at 4:30 A.M. @@ -213,8 +262,7 @@ Database purging takes place only if the EnablePurging property is set to True. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -223,29 +271,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableUdcLite -This parameter is reserved for internal Microsoft use. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -255,29 +290,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -291,13 +312,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.CallDetailRecording.CdrSettings. +### Microsoft.Rtc.Management.WritableConfig.Settings.CallDetailRecording.CdrSettings The `Set-CsCdrConfiguration` cmdlet accepts pipelined input of call detail recording configuration objects. ## OUTPUTS -### +### None The `Set-CsCdrConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CallDetailRecording.CDRSettings object. diff --git a/skype/skype-ps/skype/Set-CsCertificate.md b/skype/skype-ps/SkypeForBusiness/Set-CsCertificate.md similarity index 78% rename from skype/skype-ps/skype/Set-CsCertificate.md rename to skype/skype-ps/SkypeForBusiness/Set-CsCertificate.md index a88a78863d..63db43849f 100644 --- a/skype/skype-ps/skype/Set-CsCertificate.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCertificate.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cscertificate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsCertificate -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cscertificate +schema: 2.0.0 +title: Set-CsCertificate --- # Set-CsCertificate @@ -50,7 +51,7 @@ To identify certificates available for assignment, use the `Get-CsCertificate` c ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsCertificate -Type WebServicesExternal -Thumbprint "B142918E463981A76503828BB1278391B716280987B" ``` @@ -58,7 +59,7 @@ Set-CsCertificate -Type WebServicesExternal -Thumbprint "B142918E463981A76503828 The command shown in Example 1 assigns the certificate with the Thumbprint B142918E463981A76503828BB1278391B716280987B to the WebServicesExternal role on the local computer. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsCertificate -Type Default, WebServicesInternal, WebServicesExternal -Thumbprint "B142918E463981A76503828BB1278391B716280987B" ``` @@ -68,15 +69,19 @@ Example 2 assigns the assigns the certificate with the Thumbprint B142918E463981 ## PARAMETERS -### -NetportId -Reserved for future use. -This parameter is for certificates dedicated to a specific port, a scenario not yet supported by Lync Server. +### -EffectiveDate + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Date and time when the certificate can first be used. +For example, to configure a certificate for first use at 8:00 AM on July 31, 2012 use this syntax on a server running under the US English Region and Language settings: + +`-EffectiveDate "7/31/2012 8:00 AM"` ```yaml -Type: String -Parameter Sets: CertificateReference, Thumbprint -Aliases: -Applicable: Lync Server 2010 +Type: DateTime +Parameter Sets: (All) +Aliases: EffectiveTime Required: False Position: Named @@ -85,87 +90,72 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Reference -Object reference to a certificate configured for use with Skype for Business Server. -The following command returns an object reference (the variable $x) representing a certificate with the thumbprint B142918E463981A76503828BB1278391B716280987B: +### -Force -`$x = Get-CsCertificate | Where-Object {$_.Thumbprint -eq "B142918E463981A76503828BB1278391B716280987B"`. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: CertificateReference -Parameter Sets: CertificateReference -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Thumbprint -Unique identifier for the certificate. -A certificate thumbprint looks similar to this: B142918E463981A76503828BB1278391B716280987B. +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to Global, enables the certificate to function at the global scope. +Global certificates will automatically be copied and distributed to the appropriate computers. ```yaml -Type: String -Parameter Sets: Thumbprint -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: CertificateReference, Thumbprint, XdsIdentity +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -Type of certificate being assigned. -Certificate types include, but are not limited to, the following: - -AccessEdgeExternal - -AudioVideoAuthentication - -DataEdgeExternal - -Default - -External - -Internal - -iPhoneAPNService - -iPadAPNService - -MPNService - -PICWebService (Skype for Business Online only) - -ProvisionService (Skype for Business Online only) +### -NetportId -WebServicesExternal +> Applicable: Lync Server 2010 -WebServicesInternal +Reserved for future use. +This parameter is for certificates dedicated to a specific port, a scenario not yet supported by Lync Server. -WsFedTokenTransfer +```yaml +Type: String +Parameter Sets: CertificateReference, Thumbprint +Aliases: -For example, this syntax assigns the Default certificate: `-Type Default`. +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -You can specify multiple types in a single command by separating the certificate types with commas: +### -Password -`-Type Internal,External,Default` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Password for the certificate. ```yaml -Type: CertType[] -Parameter Sets: CertificateReference, Thumbprint -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Path +Aliases: Required: False Position: Named @@ -174,11 +164,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Path + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Full path to the .PFX certificate file. + ```yaml -Type: CertType[] +Type: String Parameter Sets: Path -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -187,23 +182,32 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -Reference + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Object reference to a certificate configured for use with Skype for Business Server. +The following command returns an object reference (the variable $x) representing a certificate with the thumbprint B142918E463981A76503828BB1278391B716280987B: + +`$x = Get-CsCertificate | Where-Object {$_.Thumbprint -eq "B142918E463981A76503828BB1278391B716280987B"`. + ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: CertificateReference +Parameter Sets: CertificateReference +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to record detailed information about the procedures carried out by the `Set-CsCertificate` cmdlet. The parameter value should be the full path to the HTML file to be generated; for example: `-Report C:\Logs\Certificates.html`. If the specified file already exists it will automatically be overwritten with the new information. @@ -212,8 +216,7 @@ If the specified file already exists it will automatically be overwritten with t ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -222,30 +225,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Roll -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Enables you to update the specified certificate at the date and time specified by the EffectiveDate parameter; this enables you to specify a date and time when the new certificate will become the primary certificate. +Note that your command will fail if you specify the Roll parameter without including the EffectiveDate parameter. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -254,28 +244,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -When set to Global, enables the certificate to function at the global scope. -Global certificates will automatically be copied and distributed to the appropriate computers. +### -Thumbprint -```yaml -Type: XdsIdentity -Parameter Sets: CertificateReference, Thumbprint -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Unique identifier for the certificate. +A certificate thumbprint looks similar to this: B142918E463981A76503828BB1278391B716280987B. ```yaml -Type: XdsIdentity -Parameter Sets: Path -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Thumbprint +Aliases: Required: True Position: Named @@ -284,33 +263,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Path -Full path to the .PFX certificate file. +### -Type -```yaml -Type: String -Parameter Sets: Path -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -EffectiveDate -Date and time when the certificate can first be used. -For example, to configure a certificate for first use at 8:00 AM on July 31, 2012 use this syntax on a server running under the US English Region and Language settings: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of certificate being assigned. +Certificate types include, but are not limited to, the following: + +AccessEdgeExternal + +AudioVideoAuthentication + +DataEdgeExternal + +Default + +External + +Internal + +iPhoneAPNService + +iPadAPNService + +MPNService + +PICWebService (Skype for Business Online only) + +ProvisionService (Skype for Business Online only) + +WebServicesExternal + +WebServicesInternal + +WsFedTokenTransfer + +For example, this syntax assigns the Default certificate: `-Type Default`. + +You can specify multiple types in a single command by separating the certificate types with commas: + +`-Type Internal,External,Default` -`-EffectiveDate "7/31/2012 8:00 AM"` ```yaml -Type: DateTime -Parameter Sets: (All) -Aliases: EffectiveTime -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: CertType[] +Parameter Sets: CertificateReference, Thumbprint, Path +Aliases: Required: False Position: Named @@ -319,14 +320,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Password -Password for the certificate. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String -Parameter Sets: Path -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -335,15 +338,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Roll -Enables you to update the specified certificate at the date and time specified by the EffectiveDate parameter; this enables you to specify a date and time when the new certificate will become the primary certificate. -Note that your command will fail if you specify the Roll parameter without including the EffectiveDate parameter. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -357,12 +361,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Deployment.CertificateReference. +### Microsoft.Rtc.Management.Deployment.CertificateReference ## OUTPUTS -### +### None The `Set-CsCertificate` cmdlet does not return any values or objects. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsClientPin.md b/skype/skype-ps/SkypeForBusiness/Set-CsClientPin.md similarity index 90% rename from skype/skype-ps/skype/Set-CsClientPin.md rename to skype/skype-ps/SkypeForBusiness/Set-CsClientPin.md index 186c380a81..a61f23da92 100644 --- a/skype/skype-ps/skype/Set-CsClientPin.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClientPin.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csclientpin applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsClientPin -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csclientpin +schema: 2.0.0 +title: Set-CsClientPin --- # Set-CsClientPin @@ -52,7 +53,7 @@ That means that you will not be able to run the `Set-CsClientPin` cmdlet from a ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsClientPin -Identity "litwareinc\kenmyer" ``` @@ -62,7 +63,7 @@ To assign an auto-generated PIN, leave off the Pin parameter when calling the `S After the command completes, the new PIN assigned to Ken Myer will be displayed on the screen and that information can then be relayed to the user. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsClientPin -Identity "litwareinc\kenmyer" -Pin 18723834 ``` @@ -71,7 +72,7 @@ The command in Example 2 assigns the PIN 18723834 to the user litwareinc\kenmyer You can assign a specific PIN by using the Pin parameter followed by the number to be assigned. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsUser -OU "OU=Finance,DC=litwareinc,DC=com" | Set-CsClientPin ``` @@ -81,7 +82,7 @@ To do this, the `Get-CsUser` cmdlet is used along with the OU parameter to retur That collection is then piped to the `Set-CsClientPin` cmdlet, which generates a new PIN for each user in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsUser | Get-CsClientPinInfo | Where-Object {$_.IsPinSet -eq $False} | Set-CsClientPin ``` @@ -94,7 +95,28 @@ The resulting collection, which contains only users who do not have a PIN, is th ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Identity of the user account for which the PIN should be set. User Identities can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. @@ -105,8 +127,7 @@ For example, the Identity "* Smith" returns all the users who have a display nam ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -116,6 +137,9 @@ Accept wildcard characters: False ``` ### -Pin + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Optional PIN to be assigned to the user. If you do not include the PIN parameter, then Skype for Business Server will randomly generate a PIN and assign it to the user in question. Note that the PIN must adhere to the minimum length and common pattern settings found in the client PIN policy assigned to the user. @@ -124,8 +148,7 @@ Note that the PIN must adhere to the minimum length and common pattern settings ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -134,14 +157,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -151,29 +176,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -187,14 +198,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The `Set-CsClientPin` cmdlet accepts pipelined input of string values representing the Identity of a user account. The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### +### None The `Set-CsClientPin` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.UserPinService.PinInfoDetails object. diff --git a/skype/skype-ps/skype/Set-CsClientPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsClientPolicy.md similarity index 82% rename from skype/skype-ps/skype/Set-CsClientPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsClientPolicy.md index 6af1ef3225..dd169a8c45 100644 --- a/skype/skype-ps/skype/Set-CsClientPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClientPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csclientpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsClientPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/set-csclientpolicy +schema: 2.0.0 +title: Set-CsClientPolicy --- # Set-CsClientPolicy @@ -124,7 +126,7 @@ The following parameters are not applicable to Skype for Business Online: Addres ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsClientPolicy -Identity RedmondClientPolicy -WebServicePollInterval "00:15:00" ``` @@ -133,7 +135,7 @@ The command shown in Example 1 modifies the client policy RedmondClientPolicy. In this example, the WebServicePollInterval property is set to 15 minutes (00 hours: 15 minutes: 00 seconds). -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsClientPolicy -Identity RedmondClientPolicy -DisableEmoticons $True -DisableHtmlIm $True -DisableRTFIm $True ``` @@ -141,7 +143,7 @@ Set-CsClientPolicy -Identity RedmondClientPolicy -DisableEmoticons $True -Disabl In Example 2, three different property values are modified for the client policy RedmondClientPolicy: the properties DisableEmoticons, DisableHtmlIm, and DisableRTFIm are all set to True. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClientPolicy -Filter "*site:*" | Set-CsClientPolicy -DisableEmoticons $True -DisableHtmlIm $True -DisableRTFIm $True ``` @@ -152,7 +154,7 @@ To do this, the command first uses the `Get-CsClientPolicy` cmdlet and the Filte This filtered collection is then piped to the `Set-CsClientPolicy` cmdlet, which takes each policy in the collection and modifies the values of DisableEmoticons, DisableHtmlIm and DisableRTFIm. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsClientPolicy | Where-Object {$_.MaxPhotoSizeKb -gt 10} | Set-CsClientPolicy -MaxPhotoSizeKb 10 ``` @@ -165,43 +167,10 @@ The filtered collection is then piped to the `Set-CsClientPolicy` cmdlet, which ## PARAMETERS -### -Identity -Unique identifier assigned to the new policy. -To reference the global policy, use this syntax: `-Identity global`. -To reference a site policy, use the prefix "site:" and the name of the site as your Identity; for example: `-Identity site:Redmond`. -To reference a per-user policy, use syntax similar to this: `-Identity SalesClientPolicy`. - -```yaml -Type: XdsIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. - - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +### -AddressBookAvailability -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AddressBookAvailability Indicates how users are allowed to access information in the Address Book server (that is, by using the Address Book Web Query service and/or by downloading a copy of the Address Book to their local computer). AddressBookAvailability must be set to one of the following values: @@ -215,8 +184,7 @@ FileDownloadOnly ```yaml Type: AddressBookAvailability Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -226,6 +194,9 @@ Accept wildcard characters: False ``` ### -AttendantSafeTransfer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, Skype for Business Attendant operates in "safe transfer" mode; this means that transferred calls that do not reach the intended recipient will reappear in the incoming area along with a "Failed Transfer" notice. When set to False, transferred calls that fail to reach the intended recipient will not reappear in the incoming area. @@ -233,8 +204,7 @@ When set to False, transferred calls that fail to reach the intended recipient w ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -245,6 +215,8 @@ Accept wildcard characters: False ### -AutoDiscoveryRetryInterval +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + After a failed connection attempt, specifies the amount of time Skype for Business waits before again trying to connect to Skype for Business Server. The AutoDiscoveryRetryInterval can be set to value between 1 second and 60 minutes (1 hour), inclusive. @@ -257,8 +229,7 @@ For example, to set the interval to 25 minutes use this syntax: ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -268,6 +239,9 @@ Accept wildcard characters: False ``` ### -BlockConversationFromFederatedContacts + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, contacts from outside your organization will not be allowed to initiate instant message conversations with any user that this policy applies to. However, outside users will be able to participate in conversations as long the internal user initiates that conversation. When set to False, outside contacts are allowed to send unsolicited instant messages to users in your organization. @@ -276,8 +250,7 @@ When set to False, outside contacts are allowed to send unsolicited instant mess ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -287,6 +260,9 @@ Accept wildcard characters: False ``` ### -CalendarStatePublicationInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the amount of time, in seconds, that Skype for Business waits before retrieving calendar information from Outlook and adding this data to your presence information. For example, to set the CalendarStatePublicationInterval to 10 minutes (600 seconds) use this syntax: @@ -297,8 +273,7 @@ For example, to set the CalendarStatePublicationInterval to 10 minutes (600 seco ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -308,6 +283,9 @@ Accept wildcard characters: False ``` ### -ConferenceIMIdleTimeout + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the number of minutes that a user can remain in an instant messaging session without either sending or receiving an instant message. The ConferenceIMIdleTimeout must be less than or equal to 1 hour and must be specified using the format hours:minutes:seconds. @@ -319,8 +297,7 @@ For example, this syntax sets the timeout value to 45 minutes: ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -330,6 +307,9 @@ Accept wildcard characters: False ``` ### -CustomizedHelpUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + URL for custom Skype for Business help set up by an organization. This parameter has been deprecated for use with Skype for Business Server. @@ -339,8 +319,7 @@ Customized help will not be available unless you also set EnableEnterpriseCustom ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -350,6 +329,9 @@ Accept wildcard characters: False ``` ### -CustomLinkInErrorMessages + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + URL for the website that can be added to error messages that appear in Skype for Business. If a URL is specified, that URL will appear at the bottom of any error message that occurs in Skype for Business. Users can then click that link and be taken to a custom website that contains additional information, troubleshooting tips, etc. @@ -358,8 +340,7 @@ Users can then click that link and be taken to a custom website that contains ad ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -369,6 +350,9 @@ Accept wildcard characters: False ``` ### -CustomStateUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the location of the XML file used to add custom presence states to Skype for Business. (Skype for Business allows up to four custom presence states in addition to the built-in states such as Available, Busy and Do Not Disturb.) The location of the XML file should be specified using the HTTPS protocol. @@ -376,8 +360,7 @@ Specifies the location of the XML file used to add custom presence states to Sky ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -387,6 +370,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Allows administrators to provide additional information about a policy. For example, the Description might indicate the users that the policy should be assigned to. @@ -394,8 +380,7 @@ For example, the Description might indicate the users that the policy should be ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -405,6 +390,9 @@ Accept wildcard characters: False ``` ### -DGRefreshInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the amount of time Skype for Business waits before automatically refreshing the membership list of any distribution group that has been "expanded" in the Contacts list. (Expanding a distribution group means displaying all the members in that group.) DGRefreshInterval can be set to any integer value between 30 seconds and 28,800 seconds (8 hours), inclusive. The default value is 28,800 seconds. @@ -413,8 +401,7 @@ The default value is 28,800 seconds. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -424,6 +411,9 @@ Accept wildcard characters: False ``` ### -DisableCalendarPresence + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, calendar data taken from Outlook will not be included in your presence information. When set to False, calendar data will be included in your presence information. For example, free/busy information will be reported in your contact card; likewise, your status will automatically be set to Busy any time Outlook shows that you are in a meeting. @@ -432,8 +422,7 @@ For example, free/busy information will be reported in your contact card; likewi ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -443,6 +432,9 @@ Accept wildcard characters: False ``` ### -DisableContactCardOrganizationTab + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, the contact card organization tab is not visible within the Skype for Business user interface. When set to False, the contact card organization tab is available in Skype for Business. @@ -450,8 +442,7 @@ When set to False, the contact card organization tab is available in Skype for B ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -461,6 +452,9 @@ Accept wildcard characters: False ``` ### -DisableEmailComparisonCheck + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, Skype for Business will not attempt to verify that any currently running instance of Outlook belongs to the same user running Skype for Business; for example, the software will not verify that both Outlook and Skype for Business are running under Ken Myer's user account. Instead, it will be assumed that the two applications are running under the same account and, in turn, will include contact and calendar data in Outlook with Skype for Business. @@ -471,8 +465,7 @@ If the SMTP addresses do not match then contact and calendar data in Outlook wil ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -482,6 +475,9 @@ Accept wildcard characters: False ``` ### -DisableEmoticons + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, users will not be able to send or receive emoticons in their instant messages; instead they will be see the text equivalent of those emoticons. For example, instead of seeing a graphical "smiley face" users will see the text equivalent: @@ -493,8 +489,7 @@ When set to False users will be able to include emoticons in their instant messa ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -504,6 +499,9 @@ Accept wildcard characters: False ``` ### -DisableFederatedPromptDisplayName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, any notification dialog generated when you are added to a federated user's Contacts list will use the federated user's SIP address (for example, sip:kenmyer@fabrikam.com). When set to False, the notification dialog will use the federated user's display name (for example, Ken Myer) instead. @@ -511,8 +509,7 @@ When set to False, the notification dialog will use the federated user's display ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -522,6 +519,9 @@ Accept wildcard characters: False ``` ### -DisableFeedsTab + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, the activity feeds tab will not be displayed in Skype for Business. When set to False, the feeds tab will be available within Skype for Business. @@ -529,8 +529,7 @@ When set to False, the feeds tab will be available within Skype for Business. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -540,6 +539,9 @@ Accept wildcard characters: False ``` ### -DisableFreeBusyInfo + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, free/busy information retrieved from Microsoft Outlook will not be displayed in your contact card. When set to False, free/busy information is displayed in your contact card. For example, your contact card might include a note similar to this: @@ -550,8 +552,7 @@ Calendar: Free until 2:00 PM ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -561,6 +562,9 @@ Accept wildcard characters: False ``` ### -DisableHandsetOnLockedMachine + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, users will not be able to use their Polycom handset if the computer that the handset is connected to is locked. To use the handset, users will first have to unlock the computer. @@ -570,8 +574,7 @@ When set to False, users will be allowed to use their handset even if the comput ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -581,6 +584,9 @@ Accept wildcard characters: False ``` ### -DisableHtmlIm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, any HTML text copied from a webpage will be converted to plain text when pasted into an instant message. When set to False, HTML formatting (such as font size and color, drop-down lists and buttons, etc.) will be retained when pasted into an instant message. @@ -593,8 +599,7 @@ This setting is equivalent to the Office Communications Server 2007 R2 Group Pol ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -604,6 +609,9 @@ Accept wildcard characters: False ``` ### -DisableICE + +> Applicable: Lync Server 2010 + When set to True, Lync 2010 will not use the Interactive Connectivity Establishment (ICE) protocol to traverse firewalls and network address translation (NAT) devices; this effectively prevents users from making Lync 2010 calls across the Internet. When set to False, Lync 2010 will use the ICE protocol to enable Lync 2010 calls to traverse firewalls and (NAT) devices. @@ -612,8 +620,7 @@ This setting is equivalent to the Office Communications Server 2007 R2 Group Pol ```yaml Type: Boolean Parameter Sets: Identity, Instance -Aliases: -Applicable: Lync Server 2010 +Aliases: Required: False Position: Named @@ -623,6 +630,9 @@ Accept wildcard characters: False ``` ### -DisableInkIM + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, users will not be allowed to receive instant messages containing Tablet PC ink. (Ink is a technology that enables you to insert handwritten notes into a document.) When set to False, users will be allowed to receive messages that contain Table PC ink. @@ -630,8 +640,28 @@ When set to True, users will not be allowed to receive instant messages containi ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisableMeetingSubjectAndLocation + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to False, detailed information about a meeting -- namely, the meeting subject and the location where the meeting is being held -- will be displayed as a tooltip when you view free/busy information in a contact card. +When set to True, this detailed information will not be displayed. +To completely prevent the display of meeting-related information you should also set DisableCalendarPresence to True. + + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -641,6 +671,9 @@ Accept wildcard characters: False ``` ### -DisableOneNote12Integration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, the ability to start OneNote from within Skype for Business (and the ability to automatically link instant message sessions and OneNote notes) is disabled. When set to False, the option Take Notes Using One Note is enabled in Skype for Business. In addition, if you locate an instant message transcript in Microsoft Outlook's Conversation History you can retrieve any OneNote notes associated with that conversation just by clicking the Edit conversation notes button. @@ -649,8 +682,7 @@ In addition, if you locate an instant message transcript in Microsoft Outlook's ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -660,6 +692,9 @@ Accept wildcard characters: False ``` ### -DisableOnlineContextualSearch + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, disables the Find Previous Conversations menu option that appears when you right-click a user in your Contacts list. (This option enables you to search the Outlook Conversation History folder for previous instant messaging sessions involving the user in question.) When set to False, the Find Previous Conversations option will be available when you right-click a user in your Contacts list. @@ -672,8 +707,7 @@ Cached searches are not affected by this setting. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -683,6 +717,9 @@ Accept wildcard characters: False ``` ### -DisablePhonePresence + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, Skype for Business does not take phone calls into consideration when determining your current status. When set to False, phone calls are taken into consideration when determining your status. For example, any time you are on the phone your status will automatically be set to Busy. @@ -691,8 +728,7 @@ For example, any time you are on the phone your status will automatically be set ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -702,6 +738,9 @@ Accept wildcard characters: False ``` ### -DisablePICPromptDisplayName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, any notification dialog box generated when you are added to the Contacts list of a user with an account on a public instant messaging service such as MSN will display that person's SIP address (for example, sip:kenmyer@litwareinc.com). When set to False, the notification dialog box will use the person's display name (for example, Ken Myer) instead. @@ -709,8 +748,7 @@ When set to False, the notification dialog box will use the person's display nam ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -720,6 +758,9 @@ Accept wildcard characters: False ``` ### -DisablePoorDeviceWarnings + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, Skype for Business will not issue warnings (upon startup, in the Tuning Wizard, in the Conversation window, etc.) if an audio or video device is not working correctly. When set to False, these warnings will be issued. @@ -727,8 +768,7 @@ When set to False, these warnings will be issued. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -738,14 +778,16 @@ Accept wildcard characters: False ``` ### -DisablePoorNetworkWarnings + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, Skype for Business will not display warnings about poor network quality. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -755,6 +797,9 @@ Accept wildcard characters: False ``` ### -DisablePresenceNote + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, any Out of Office message you configure in Outlook will not be displayed as part of your presence information. When set to False, your Out of Office message will be displayed any time a user holds the mouse over your name in their Contacts list. @@ -762,8 +807,7 @@ When set to False, your Out of Office message will be displayed any time a user ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -773,6 +817,9 @@ Accept wildcard characters: False ``` ### -DisableRTFIM + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When both this setting and the DisableHtmlIm settings are set to True, prevents rich text formatting (for example, different fonts, font sizes and font colors) from being used in instant messages; instead, all messages sent and received will be converted to plain text format. When set to False, rich text formatting will be allowed in instant messages. @@ -780,8 +827,7 @@ When set to False, rich text formatting will be allowed in instant messages. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -791,6 +837,9 @@ Accept wildcard characters: False ``` ### -DisableSavingIM + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, the options for saving an instant message session are removed from the menu bar in the Skype for Business Conversation window. When set to False, these options are available in the Conversation window. @@ -801,8 +850,7 @@ However, it does not prevent users from copying all the text in a transcript to ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -812,6 +860,9 @@ Accept wildcard characters: False ``` ### -DisplayPhoto + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether or not photos (of both the user and his or her contacts) will be displayed in Skype for Business. Valid settings are: @@ -827,8 +878,7 @@ The default value is AllPhotos. ```yaml Type: DisplayPhoto Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -838,6 +888,9 @@ Accept wildcard characters: False ``` ### -EnableAppearOffline + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True an additional presence state -- Appear Offline -- is available in Skype for Business. This state makes it appear as though the user is offline; however, he or she will actually be online and available to answer phone calls, respond to instant messages, etc. When set to False, the Appear Offline presence state will not be available in Skype for Business. @@ -846,8 +899,7 @@ When set to False, the Appear Offline presence state will not be available in Sk ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -857,6 +909,9 @@ Accept wildcard characters: False ``` ### -EnableCallLogAutoArchiving + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, information about your incoming and outgoing phone calls is automatically saved to the Conversation History folder in Outlook. (The actual call itself is not recorded. What is recorded is information such as who took part in the call; the length of the call and whether this was an incoming or an outgoing call.) When set to False, this information is not saved to Outlook. @@ -865,8 +920,25 @@ What is recorded is information such as who took part in the call; the length of ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableClientAutoPopulateWithTeam + +> Applicable: Skype for Business Online + +When set to true, allows a user's Skype client to be autopopulated with members of his or her immediate team. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -876,6 +948,9 @@ Accept wildcard characters: False ``` ### -EnableClientMusicOnHold + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, music will be played any time a caller is placed on hold. When set to False, music will not be played any time a caller is placed on hold. The default value is False. @@ -884,8 +959,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -895,6 +969,9 @@ Accept wildcard characters: False ``` ### -EnableConversationWindowTabs + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, supplemental information related to an instant messaging session will be displayed in a separate browser window. When set to False, supplemental information will not be displayed in a separate browser window. @@ -905,8 +982,7 @@ This parameter has been deprecated for use with Skype for Business Server. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -916,6 +992,9 @@ Accept wildcard characters: False ``` ### -EnableEnterpriseCustomizedHelp + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, users who click the Help menu in Skype for Business will be given custom help set up by the organization. When set to False, users who click the Help menu will be given the default product help. @@ -925,8 +1004,7 @@ This parameter has been deprecated for use with Skype for Business Server. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -936,6 +1014,9 @@ Accept wildcard characters: False ``` ### -EnableEventLogging + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, detailed information about Skype for Business will be recorded in the Application event log. When set to False, only major events (such as the failure to connect to Skype for Business Server) are recorded in the event log. @@ -943,8 +1024,25 @@ When set to False, only major events (such as the failure to connect to Skype fo ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableExchangeContactsFolder + +> Applicable: Skype for Business Online + +When set to false, this allows admins to hide Skype for Business contacts from showing up in users' Outlook and Outlook on the Web clients. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -954,14 +1052,16 @@ Accept wildcard characters: False ``` ### -EnableExchangeContactSync + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True (the default value) Skype for Business creates a corresponding personal contact in Outlook for each person on a user's Skype for Business Contacts list. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -971,14 +1071,16 @@ Accept wildcard characters: False ``` ### -EnableExchangeDelegateSync + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, a user that has been configured in Outlook will be allowed to schedule online Lync Calendar meetings for that user (this happens via Lync UCMAPI delegation, without the need of the Enterprise Voice feature). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -988,6 +1090,9 @@ Accept wildcard characters: False ``` ### -EnableFullScreenVideo + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, this parameter does two things: 1) enables full-screen video (with the correct aspect ratio) for Skype for Business calls and 2) disables video preview for Skype for Business calls. When set to False then full-screen video is not available in Skype for Business, but video preview is available. @@ -995,8 +1100,7 @@ When set to False then full-screen video is not available in Skype for Business, ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1005,20 +1109,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableHotdesking -When set to True, enables users to log on to a phone running Skype for Business Phone Edition in a shared workspace by using their Skype for Business Server account. -(Among other things, this provides the user access to his or her contacts.) When set to False, users are not allowed to log on to a phone in a shared workspace by using their own credentials. +### -EnableHighPerformanceConferencingAppSharing -Note that this setting applies only to common area (shared workspace) accounts and not to user accounts. -When set to True and applied to a common area account for a phone in a shared workspace, any user will be able to log on to that phone by using his or her credentials. -When set to False, no one will be allowed to log on to that phone. +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, enables better performance in applications (such as CAD/CAM applications) that have a high screen refresh rate. +However, this improved performance will reduce the system resources and network bandwidth available to other applications. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1027,17 +1129,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableIMAutoArchiving -When set to True, a transcript of every instant message session that a user takes part in will be saved to the Conversation History folder in Outlook. -When set to False, these transcripts will not be saved automatically. -(However, users will have the option to manually save instant message transcripts.) +### -EnableHighPerformanceP2PAppSharing + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, allows a peer-to-peer application sharing session to exceed the maximum frame rate of 2.5 frames per second. +The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1046,19 +1149,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSQMData -When EnableSQMData is set to True, the user will not automatically be enrolled in the Customer Experience Improvement Program. -However, Skype for Business will provide the user with the option to join the program. +### -EnableHotdesking -When set to False, the user will not be enrolled in the Customer Experience Improvement Program. -In addition, Skype for Business will not give users the option of joining the program. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, enables users to log on to a phone running Skype for Business Phone Edition in a shared workspace by using their Skype for Business Server account. +(Among other things, this provides the user access to his or her contacts.) When set to False, users are not allowed to log on to a phone in a shared workspace by using their own credentials. + +Note that this setting applies only to common area (shared workspace) accounts and not to user accounts. +When set to True and applied to a common area account for a phone in a shared workspace, any user will be able to log on to that phone by using his or her credentials. +When set to False, no one will be allowed to log on to that phone. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1067,17 +1173,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableTracing -When set to True, software tracing will be enabled in Skype for Business; when set to False software tracing will be disabled. -Software tracing involves keeping an extremely detailed record of everything that a program does (including tracking API calls). -As such tracing is mostly useful to developers and to application support personnel. +### -EnableIMAutoArchiving + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, a transcript of every instant message session that a user takes part in will be saved to the Conversation History folder in Outlook. +When set to False, these transcripts will not be saved automatically. +(However, users will have the option to manually save instant message transcripts.) ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1086,16 +1194,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableUnencryptedFileTransfer -When set to True, users will be allowed to exchange files with external users whose instant messaging software does not support encrypted file transfers. -When set to False, users will only be able to exchange files with external users who have software that supports encrypted file transfers. +### -EnableMediaRedirection + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True) allows audio and video streams to be separated from other network traffic; in turn, this allows client devices to do encoding and decoding of audio and video locally. +Media redirection typically results in lower bandwidth usage, higher server scalability and a more-optimal user experience compared to similar techniques such as device remoting or codec compression. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1104,19 +1214,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableVOIPCallDefault -When set to True, a Skype for Business call will be placed any time a user employs the click-to-call feature. +### -EnableMeetingEngagement -This policy setting only affects the initial state of the click-to-call feature. -If the user modifies the value of the click-to-call setting then the user-selected value will override this policy setting. -After a user has modified the click-to-call setting that setting will remain in use and will not be affected by the EnableVOIPCallDefault policy. +> Applicable: Skype for Business Online +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1125,16 +1232,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExcludedContactFolders -Indicates which Outlook contact folders (if any) should not be searched any time Skype for Business searches for new contacts. -Multiple folders can be specified by separating the folder names using semicolons; for example: `-ExcludedContactFolders "SenderPhotoContacts;OtherContacts"`. +### -EnableNotificationForNewSubscribers + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True you will receive notification any time you are added to someone else's Contacts list. +In addition, the notification dialog box will provide options for you to add that person to your Contacts list, or to block them from viewing your presence information. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1143,23 +1252,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HotdeskingTimeout -Timeout interval for a user logged on to a "hot-desk" phone. -(A hot-desk phone is a phone running Skype for Business Phone Edition that is located in a shared workspace and that users can log on to using their Skype for Business Server account.) The hot-desk timeout specifies the number of minutes that can elapse before a user is automatically logged off of a hot-desk phone. -When specifying a hot desking timeout you must use the format hours:minutes:seconds. -For example, this syntax sets the hot desking timeout interval to 45 minutes: - -`-HotdeskingTimeout 00:45:00` +### -EnableOnlineFeedback -Note that this policy setting applies only to common area phones and not to users. -The default value is 5 minutes (00:05:00), and the minimum value is 30 seconds (00:00:30). +> Applicable: Skype for Business Online +When set to true, allows users to provide feedback through the "help->report a problem" menu options in the client. ```yaml -Type: TimeSpan +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1168,21 +1270,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IMWarning -When configured, the specified message appears in the Conversation window each time a user takes part in an instant messaging session. -For example, if IMWarning is set to "All information is the property of Litwareinc" then that message will appear in the Conversation window each time a user takes part in an instant messaging session. +### -EnableOnlineFeedbackScreenshots -Your warning message should be limited to 256 characters, and can only contain plain text. -You cannot use any formatting (such as boldface or italics) and you cannot clickable URLs within the text. - -If set to a null value ($Null) then no message appears in the Conversation window. +> Applicable: Skype for Business Online +When set to true, allows users to provide screenshots of their clients when reporting problems. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1191,24 +1288,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MAPIPollInterval +### -EnableServerConversationHistory -> [!IMPORTANT] -> This parameter has been deprecated for use with Skype for Business Server. +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -For users of Microsoft Exchange Server 2003, MAPIPollInterval specifies how often Skype for Business retrieves calendar data from the Exchange public folders. -MAPIPollInterval can be set to any value between 1 second and 1 hour; inclusive. -To configure the MAPI poll interval, use the format hours:minutes:seconds. -For example, this command sets the MAPI poll interval to 45 minutes: +When set to True ($True), allows conversation histories, missed call notifications, and missed IM notifications to be stored on the server instead of in client mailboxes. +This makes it easier for users to retrieve that information from a mobile device. -`-MapiPollInterval 00:45:00` +The default value is False ($False). ```yaml -Type: TimeSpan +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1217,17 +1310,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaximumDGsAllowedInContactList -Indicates the maximum number of distribution groups that a user can configure as a contact. -MaximumDGsAllowedInContactList can be set to any integer value between 0 and 64, inclusive. -The default value is 10. +### -EnableSkypeUI + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True), this parameter allows administrators to enable the Skype for Business user interface instead of the Lync interface for the Skype for Business client. ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1236,17 +1329,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaximumNumberOfContacts -Indicates the maximum number of contacts a user is allowed to have. -The maximum contacts can be set to any integer value between 0 and 1000, inclusive. -When set to 0, that prevents the user from having any contacts. +### -EnableSQMData + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When EnableSQMData is set to True, the user will not automatically be enrolled in the Customer Experience Improvement Program. +However, Skype for Business will provide the user with the option to join the program. + +When set to False, the user will not be enrolled in the Customer Experience Improvement Program. +In addition, Skype for Business will not give users the option of joining the program. ```yaml -Type: UInt16 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1255,17 +1352,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MusicOnHoldAudioFile -Path to the audio file to be played when a caller is placed on hold. -If a value is configured for this property then music on hold will be enabled and users will not be allowed to disable the feature. -If no value is configured for this property then users can specify their own music on hold file, assuming that EnableClientMusicOnHold is set to True. +### -EnableTracing + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, software tracing will be enabled in Skype for Business; when set to False software tracing will be disabled. +Software tracing involves keeping an extremely detailed record of everything that a program does (including tracking API calls). +As such tracing is mostly useful to developers and to application support personnel. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1274,26 +1373,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -P2PAppSharingEncryption -Indicates whether or not desktop and application sharing data exchanged during a peer-to-peer conversation is encrypted. -Allowed values are: - -Supported. -Desktop and application sharing data will be encrypted, if possible. +### -EnableUnencryptedFileTransfer -Enforced. -Desktop and application sharing data must be encrypted. -If the data cannot be encrypted then desktop and application sharing will not be enabled for the conversation. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -NotSupported. -Desktop and application sharing data will not be encrypted. +When set to True, users will be allowed to exchange files with external users whose instant messaging software does not support encrypted file transfers. +When set to False, users will only be able to exchange files with external users who have software that supports encrypted file transfers. ```yaml -Type: P2PAppSharingEncryption +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1302,16 +1393,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PlayAbbreviatedDialTone -When set to True, a 3-second dial tone will be played any time a Skype for Business-compatible handset is taken off the hook. -(A Skype for Business-compatible handset looks like a standard telephone, but plugs into a USB port on your computer and is used to make Skype for Business calls rather than "regular" phone calls.) When set to False, a 30-second dial tone is played any time a Skype for Business-compatible handset is taken off the hook. +### -EnableURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, hyperlinks embedded in an instant message will be "clickable;" that is, users can click that link and their web browser will open to the specified location. +When set to False, hyperlinks appear in instant messages as plain text. +To navigate to the location, users will need to copy the link text and paste it into their web browser. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1320,23 +1414,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PolicyEntry -Provides a way to add settings not covered by the default parameters. -For example, when testing pre-release versions Microsoft Lync Server 2010 it was possible to add a Send Feedback option to Microsoft Lync 2010. -That was done by using code similar to this: - -`$x = New-CsClientPolicyEntry -Name "OnlineFeedbackURL" -Value "https://www.litwareinc.com/feedback"` - -`Set-CsClientPolicy -Identity global -PolicyEntry @{Add=$x}` +### -EnableViewBasedSubscriptionMode -For more details and examples, see the `New-CsClientPolicyEntry` cmdlet help topic. +> Applicable: Skype for Business Online +This parameter is reserved for internal Microsoft use. ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1345,40 +1432,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchPrefixFlags -Represents the Address Book attributes that should be used any time a user searches for a new contact. -The search prefix flags are constructed as a binary number such as 11101111, in which a 1 indicates that the attribute should be searched and a 0 indicates that the attribute should not be searched. -The attributes in the binary value are (from right to left): - -Primary email address - -Email alias - -All email addresses - -Company - -Display name - -First name +### -EnableVOIPCallDefault -Last name +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -The binary value 1110111 means that all attributes should be searched except attribute 4: Company. -To search only display name, first name, and last name you would construct this value: - -1110000 +When set to True, a Skype for Business call will be placed any time a user employs the click-to-call feature. -After the binary value has been constructed it must then be converted to a decimal value before being assigned to SearchPrefixFlags. -To convert a binary number to a decimal number you can use the following Windows PowerShell command: +This policy setting only affects the initial state of the click-to-call feature. +If the user modifies the value of the click-to-call setting then the user-selected value will override this policy setting. +After a user has modified the click-to-call setting that setting will remain in use and will not be affected by the EnableVOIPCallDefault policy. -`[Convert]::ToInt32("1110111", 2)` ```yaml -Type: UInt16 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1387,21 +1455,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowManagePrivacyRelationships -When set to True, shows the Relationships option in the Lync Contacts list window. -When set to False, hides the Relationships option. +### -ExcludedContactFolders -Note that this setting applies only to Lync 2010. -Skype for Business will not show these relationships even if ShowManagePrivacyRelationships has been set to True. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -The default value is False. +Indicates which Outlook contact folders (if any) should not be searched any time Skype for Business searches for new contacts. +Multiple folders can be specified by separating the folder names using semicolons; for example: `-ExcludedContactFolders "SenderPhotoContacts;OtherContacts"`. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1410,15 +1475,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowRecentContacts -This parameter has no effect on the client. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1427,16 +1494,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowSharepointPhotoEditLink -If set to True, Skype for Business will include a link that enables users to edit the personal photo stored on SharePoint. -The default value is False, which means that Skype for Business will not include a link to SharePoint. +### -HelpEnvironment + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to "Office 365", the Office 365 client help documentation for Skype for Business will be shown to users rather than the on-premises help shown by default. +You can either set HelpEnvironment to "Office 365" or to a null value ($Null). +If set to a null value (the default value) then the on-premises help will be shown to users. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1445,21 +1515,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SPSearchCenterExternalURL -External URL for the SharePoint site used for keyword searches (also known as expert searches). -This URL will appear at the bottom of any keyword search results that appear in Skype for Business. -If the user clicks this URL, his or her web browser will open up to the SharePoint site, giving the user the opportunity to conduct searches using SharePoint's search capabilities. -(SharePoint offers more search options than Skype for Business does.) +### -HotdeskingTimeout -SPSearchCenterExternalURL represents the URL for external users; that is, for users logging on from outside the organization's firewall. -The parameter SPSearchCenterInternalURL is for users who log on from inside the firewall. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Timeout interval for a user logged on to a "hot-desk" phone. +(A hot-desk phone is a phone running Skype for Business Phone Edition that is located in a shared workspace and that users can log on to using their Skype for Business Server account.) The hot-desk timeout specifies the number of minutes that can elapse before a user is automatically logged off of a hot-desk phone. +When specifying a hot desking timeout you must use the format hours:minutes:seconds. +For example, this syntax sets the hot desking timeout interval to 45 minutes: + +`-HotdeskingTimeout 00:45:00` + +Note that this policy setting applies only to common area phones and not to users. +The default value is 5 minutes (00:05:00), and the minimum value is 30 seconds (00:00:30). ```yaml -Type: String +Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1468,39 +1542,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SPSearchCenterInternalURL -Internal URL for the SharePoint site used for keyword searches (also known as expert searches). -This URL will appear at the bottom of any keyword search results that appear in Skype for Business. -If the user clicks this URL, his or her web browser will open up to the SharePoint site, giving the user the opportunity to conduct searches using SharePoint's search capabilities. -(SharePoint offers more search options than Skype for Business does.) +### -Identity -SPSearchCenterInternalURL represents the URL for internal users; that is, for users logging on from inside the organization's firewall. -The parameter SPSearchCenterExternalURL is for users who log on from outside the firewall. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Unique identifier assigned to the new policy. +To reference the global policy, use this syntax: `-Identity global`. +To reference a site policy, use the prefix "site:" and the name of the site as your Identity; for example: `-Identity site:Redmond`. +To reference a per-user policy, use syntax similar to this: `-Identity SalesClientPolicy`. ```yaml -Type: String +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SPSearchExternalURL -External URL for the SharePoint site used for keyword searches (also known as expert searches). -Skype for Business will use the SharePoint site located at this URL any time an external user (that is, a user who has accessed the system from outside the organization's firewall) conducts a keyword search. +### -IMLatencyErrorThreshold + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +If IM latency is greater than the threshold value (in milliseconds), the client will submit a CER. ```yaml -Type: String +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1509,16 +1582,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SPSearchInternalURL -Internal URL for the SharePoint site used for keyword searches (also known as expert searches). -Skype for Business will use the SharePoint site located at this URL any time an internal user (that is, a user who has logged on from inside the organization's firewall) conducts a keyword search. +### -IMLatencySpinnerDelay + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Amount of time, in milliseconds, to wait before showing the spinner in the client when IM message delivery is delayed. ```yaml -Type: String +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1527,16 +1601,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TabURL -Specifies the location of the XML file used to create custom tabs located at the bottom of the Skype for Business Contacts list window. -This parameter has been deprecated for use with Skype for Business Server. +### -IMWarning + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When configured, the specified message appears in the Conversation window each time a user takes part in an instant messaging session. +For example, if IMWarning is set to "All information is the property of Litwareinc" then that message will appear in the Conversation window each time a user takes part in an instant messaging session. + +Your warning message should be limited to 256 characters, and can only contain plain text. +You cannot use any formatting (such as boldface or italics) and you cannot clickable URLs within the text. + +If set to a null value ($Null) then no message appears in the Conversation window. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1545,40 +1626,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WebServicePollInterval -For users of Microsoft Exchange Server 2007 and later versions of the product, WebServicePollInterval specifies how often Skype for Business retrieves calendar data from Microsoft Exchange Server Web Services. -WebServicePollInterval can be set to any value between 1 second and 1 hour; inclusive. -To configure the Web Service poll interval, use the format hours:minutes:seconds. -For example, this command sets the Web Service poll interval to 45 minutes: +### -Instance -`-WebServicePollInterval 00:45:00` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Note that this setting does not apply to users whose email account is on Exchange 2003. -For those users, calendar retrieval is managed using MAPIPollInterval. +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -MAPIPollInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +> [!IMPORTANT] +> This parameter has been deprecated for use with Skype for Business Server. + +For users of Microsoft Exchange Server 2003, MAPIPollInterval specifies how often Skype for Business retrieves calendar data from the Exchange public folders. +MAPIPollInterval can be set to any value between 1 second and 1 hour; inclusive. +To configure the MAPI poll interval, use the format hours:minutes:seconds. +For example, this command sets the MAPI poll interval to 45 minutes: + +`-MapiPollInterval 00:45:00` ```yaml -Type: SwitchParameter +Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1587,15 +1672,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MaximumDGsAllowedInContactList + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum number of distribution groups that a user can configure as a contact. +MaximumDGsAllowedInContactList can be set to any integer value between 0 and 64, inclusive. +The default value is 10. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1604,15 +1693,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -MaximumNumberOfContacts + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum number of contacts a user is allowed to have. +The maximum contacts can be set to any integer value between 0 and 1000, inclusive. +When set to 0, that prevents the user from having any contacts. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1621,17 +1714,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableMeetingSubjectAndLocation -When set to False, detailed information about a meeting -- namely, the meeting subject and the location where the meeting is being held -- will be displayed as a tooltip when you view free/busy information in a contact card. -When set to True, this detailed information will not be displayed. -To completely prevent the display of meeting-related information you should also set DisableCalendarPresence to True. +### -MaxPhotoSizeKB + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum size (in kilobytes) for photos displayed in Skype for Business. + +The default value is 30 kilobytes. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1640,16 +1735,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableNotificationForNewSubscribers -When set to True you will receive notification any time you are added to someone else's Contacts list. -In addition, the notification dialog box will provide options for you to add that person to your Contacts list, or to block them from viewing your presence information. +### -MusicOnHoldAudioFile + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Path to the audio file to be played when a caller is placed on hold. +If a value is configured for this property then music on hold will be enabled and users will not be allowed to disable the feature. +If no value is configured for this property then users can specify their own music on hold file, assuming that EnableClientMusicOnHold is set to True. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1658,17 +1756,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableURL -When set to True, hyperlinks embedded in an instant message will be "clickable;" that is, users can click that link and their web browser will open to the specified location. -When set to False, hyperlinks appear in instant messages as plain text. -To navigate to the location, users will need to copy the link text and paste it into their web browser. +### -P2PAppSharingEncryption + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not desktop and application sharing data exchanged during a peer-to-peer conversation is encrypted. +Allowed values are: + +Supported. +Desktop and application sharing data will be encrypted, if possible. + +Enforced. +Desktop and application sharing data must be encrypted. +If the data cannot be encrypted then desktop and application sharing will not be enabled for the conversation. + +NotSupported. +Desktop and application sharing data will not be encrypted. ```yaml -Type: Boolean +Type: P2PAppSharingEncryption Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1677,17 +1786,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxPhotoSizeKB -Indicates the maximum size (in kilobytes) for photos displayed in Skype for Business. +### -PlayAbbreviatedDialTone -The default value is 30 kilobytes. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, a 3-second dial tone will be played any time a Skype for Business-compatible handset is taken off the hook. +(A Skype for Business-compatible handset looks like a standard telephone, but plugs into a USB port on your computer and is used to make Skype for Business calls rather than "regular" phone calls.) When set to False, a 30-second dial tone is played any time a Skype for Business-compatible handset is taken off the hook. ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1696,16 +1806,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMediaRedirection -When set to True ($True) allows audio and video streams to be separated from other network traffic; in turn, this allows client devices to do encoding and decoding of audio and video locally. -Media redirection typically results in lower bandwidth usage, higher server scalability and a more-optimal user experience compared to similar techniques such as device remoting or codec compression. +### -PolicyEntry + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Provides a way to add settings not covered by the default parameters. +For example, when testing pre-release versions Microsoft Lync Server 2010 it was possible to add a Send Feedback option to Microsoft Lync 2010. +That was done by using code similar to this: + +`$x = New-CsClientPolicyEntry -Name "OnlineFeedbackURL" -Value "https://www.litwareinc.com/feedback"` + +`Set-CsClientPolicy -Identity global -PolicyEntry @{Add=$x}` + +For more details and examples, see the `New-CsClientPolicyEntry` cmdlet help topic. ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1714,17 +1833,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HelpEnvironment -When set to "Office 365", the Office 365 client help documentation for Skype for Business will be shown to users rather than the on-premises help shown by default. -You can either set HelpEnvironment to "Office 365" or to a null value ($Null). -If set to a null value (the default value) then the on-premises help will be shown to users. +### -PublicationBatchDelay +> Applicable: Skype for Business Online + +This parameter is reserved for internal Microsoft use. ```yaml -Type: String +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1733,24 +1851,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TracingLevel -Enables Administrators to manage event tracing and logging in Skype for Business. -Allowed values are: - -Off - Tracing is disabled and the user cannot change this setting. - -Light - Minimal tracing is performed, and the user cannot change this setting. +### -RateMyCallAllowCustomUserFeedback -Full - Verbose tracing is performed, and the user cannot change this setting. +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -By default TracingLevel is set to Light. +When set to True ($True), enables a text box for users to type feedback when prompted. ```yaml -Type: TracingLevel +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1759,15 +1870,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableClientAutoPopulateWithTeam +### -RateMyCallDisplayPercentage + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +The RateMyCallDisplayPercentage setting adjusts how often users are prompted for feedback, ranging from 0 to 100. +The default value is 10, meaning that users will get prompted for feedback 10% of the time after they finish a call. +Setting this to 0 means users will never get prompted. +When set to 100, users will get prompted after every call. -When set to true, allows a user's Skype client to be autopopulated with members of his or her immediate team. ```yaml -Type: Boolean +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -1776,15 +1892,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableExchangeContactsFolder +### -RequireContentPin -When set to false, this allows admins to hide Skype for Business contacts from showing up in users' Outlook and Outlook on the Web clients. +> Applicable: Skype for Business Online + +This parameter is reserved for internal Microsoft use. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -1793,16 +1910,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableHighPerformanceConferencingAppSharing -When set to True, enables better performance in applications (such as CAD/CAM applications) that have a high screen refresh rate. -However, this improved performance will reduce the system resources and network bandwidth available to other applications. +### -SearchPrefixFlags + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Represents the Address Book attributes that should be used any time a user searches for a new contact. +The search prefix flags are constructed as a binary number such as 11101111, in which a 1 indicates that the attribute should be searched and a 0 indicates that the attribute should not be searched. +The attributes in the binary value are (from right to left): + +Primary email address + +Email alias + +All email addresses + +Company + +Display name +First name + +Last name + +The binary value 1110111 means that all attributes should be searched except attribute 4: Company. +To search only display name, first name, and last name you would construct this value: + +1110000 + +After the binary value has been constructed it must then be converted to a decimal value before being assigned to SearchPrefixFlags. +To convert a binary number to a decimal number you can use the following Windows PowerShell command: + +`[Convert]::ToInt32("1110111", 2)` ```yaml -Type: Boolean +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1811,17 +1954,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableHighPerformanceP2PAppSharing +### -ShowManagePrivacyRelationships + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, shows the Relationships option in the Lync Contacts list window. +When set to False, hides the Relationships option. + +Note that this setting applies only to Lync 2010. +Skype for Business will not show these relationships even if ShowManagePrivacyRelationships has been set to True. -When set to True, allows a peer-to-peer application sharing session to exceed the maximum frame rate of 2.5 frames per second. The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1830,14 +1979,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMeetingEngagement -This parameter is reserved for internal Microsoft use. +### -ShowRecentContacts + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter has no effect on the client. + ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -1846,15 +1998,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOnlineFeedback +### -ShowSharepointPhotoEditLink + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True, Skype for Business will include a link that enables users to edit the personal photo stored on SharePoint. +The default value is False, which means that Skype for Business will not include a link to SharePoint. -When set to true, allows users to provide feedback through the "help->report a problem" menu options in the client. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -1863,15 +2018,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOnlineFeedbackScreenshots +### -SPSearchCenterExternalURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +External URL for the SharePoint site used for keyword searches (also known as expert searches). +This URL will appear at the bottom of any keyword search results that appear in Skype for Business. +If the user clicks this URL, his or her web browser will open up to the SharePoint site, giving the user the opportunity to conduct searches using SharePoint's search capabilities. +(SharePoint offers more search options than Skype for Business does.) + +SPSearchCenterExternalURL represents the URL for external users; that is, for users logging on from outside the organization's firewall. +The parameter SPSearchCenterInternalURL is for users who log on from inside the firewall. -When set to true, allows users to provide screenshots of their clients when reporting problems. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -1880,18 +2043,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableServerConversationHistory -When set to True ($True), allows conversation histories, missed call notifications, and missed IM notifications to be stored on the server instead of in client mailboxes. -This makes it easier for users to retrieve that information from a mobile device. +### -SPSearchCenterInternalURL -The default value is False ($False). +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Internal URL for the SharePoint site used for keyword searches (also known as expert searches). +This URL will appear at the bottom of any keyword search results that appear in Skype for Business. +If the user clicks this URL, his or her web browser will open up to the SharePoint site, giving the user the opportunity to conduct searches using SharePoint's search capabilities. +(SharePoint offers more search options than Skype for Business does.) + +SPSearchCenterInternalURL represents the URL for internal users; that is, for users logging on from inside the organization's firewall. +The parameter SPSearchCenterExternalURL is for users who log on from outside the firewall. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1900,15 +2068,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSkypeUI -When set to True ($True), this parameter allows administrators to enable the Skype for Business user interface instead of the Lync interface for the Skype for Business client. +### -SPSearchExternalURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +External URL for the SharePoint site used for keyword searches (also known as expert searches). +Skype for Business will use the SharePoint site located at this URL any time an external user (that is, a user who has accessed the system from outside the organization's firewall) conducts a keyword search. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1917,14 +2088,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableViewBasedSubscriptionMode -This parameter is reserved for internal Microsoft use. +### -SPSearchInternalURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Internal URL for the SharePoint site used for keyword searches (also known as expert searches). +Skype for Business will use the SharePoint site located at this URL any time an internal user (that is, a user who has logged on from inside the organization's firewall) conducts a keyword search. + ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -1933,15 +2108,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IMLatencyErrorThreshold -If IM latency is greater than the threshold value (in milliseconds), the client will submit a CER. +### -SupportModernFilePicker +> Applicable: Skype for Business Online + +This parameter is reserved for internal Microsoft use. ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1950,15 +2126,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IMLatencySpinnerDelay -Amount of time, in milliseconds, to wait before showing the spinner in the client when IM message delivery is delayed. +### -TabURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the location of the XML file used to create custom tabs located at the bottom of the Skype for Business Contacts list window. +This parameter has been deprecated for use with Skype for Business Server. ```yaml -Type: UInt32 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1967,14 +2146,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PublicationBatchDelay +### -TelemetryTier + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml -Type: UInt32 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -1983,35 +2164,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RateMyCallAllowCustomUserFeedback -When set to True ($True), enables a text box for users to type feedback when prompted. +### -Tenant +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the client policy is being modified. +For example: -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` -### -RateMyCallDisplayPercentage -The RateMyCallDisplayPercentage setting adjusts how often users are prompted for feedback, ranging from 0 to 100. -The default value is 10, meaning that users will get prompted for feedback 10% of the time after they finish a call. -Setting this to 0 means users will never get prompted. -When set to 100, users will get prompted after every call. +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: UInt16 +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -2020,14 +2190,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequireContentPin -This parameter is reserved for internal Microsoft use. +### -TracingLevel + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables Administrators to manage event tracing and logging in Skype for Business. +Allowed values are: + +Off - Tracing is disabled and the user cannot change this setting. + +Light - Minimal tracing is performed, and the user cannot change this setting. + +Full - Verbose tracing is performed, and the user cannot change this setting. + +By default TracingLevel is set to Light. + ```yaml -Type: String +Type: TracingLevel Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -2036,14 +2218,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SupportModernFilePicker -This parameter is reserved for internal Microsoft use. +### -WebServicePollInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +For users of Microsoft Exchange Server 2007 and later versions of the product, WebServicePollInterval specifies how often Skype for Business retrieves calendar data from Microsoft Exchange Server Web Services. +WebServicePollInterval can be set to any value between 1 second and 1 hour; inclusive. +To configure the Web Service poll interval, use the format hours:minutes:seconds. +For example, this command sets the Web Service poll interval to 45 minutes: + +`-WebServicePollInterval 00:45:00` + +Note that this setting does not apply to users whose email account is on Exchange 2003. +For those users, calendar retrieval is managed using MAPIPollInterval. + ```yaml -Type: Boolean +Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -2052,14 +2245,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TelemetryTier -This parameter is reserved for internal Microsoft use. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -2068,22 +2264,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the client policy is being modified. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -2097,13 +2288,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Client.ClientPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Client.ClientPolicy + The `Set-CsClientPolicy` cmdlet accepts pipelined instances of the client policy object. ## OUTPUTS -### +### None The `Set-CsClientPolicy` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Client.ClientPolicy object. diff --git a/skype/skype-ps/skype/Set-CsClientVersionConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsClientVersionConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Set-CsClientVersionConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsClientVersionConfiguration.md index c7a71cdaca..54c43429bb 100644 --- a/skype/skype-ps/skype/Set-CsClientVersionConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClientVersionConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csclientversionconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsClientVersionConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csclientversionconfiguration +schema: 2.0.0 +title: Set-CsClientVersionConfiguration --- # Set-CsClientVersionConfiguration @@ -54,7 +55,7 @@ The technology relies on self-reporting from client applications and does not at ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsClientVersionConfiguration -Identity site:Redmond -Enabled $False ``` @@ -63,7 +64,7 @@ In Example 1, the `Set-CsClientVersionConfiguration` cmdlet is used to modify th In this case, the Enabled parameter is set to False in order to disable the client version configuration settings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClientVersionConfiguration | Set-CsClientVersionConfiguration -DefaultURL "https://litwareinc.com/csclients" ``` @@ -73,7 +74,7 @@ To do this, the command first calls the `Get-CsClientVersionConfiguration` cmdle That information is then piped to the `Set-CsClientVersionConfiguration` cmdlet, which sets the value of the DefaultUrl for each configuration collection to https://litwareinc.com/csclients. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClientVersionConfiguration | Where-Object {$_.DefaultAction -eq "Block"} | Set-CsClientVersionConfiguration -DefaultAction "BlockWithUrl" -DefaultURL "https://litwareinc.com/csclients" ``` @@ -86,44 +87,10 @@ In turn, that filtered collection is then piped to the `Set-CsClientVersionConfi ## PARAMETERS -### -Identity -Represents the unique identifier of the client version configuration settings to be modified. -To modify the global settings, use syntax like this: `-Identity global`. -To modify settings assigned to the site scope, use syntax similar to this: `"site:Redmond"`. - -If this parameter is not included, the `Set-CsClientVersionConfiguration` cmdlet will automatically configure the global settings. - - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -DefaultAction -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -DefaultAction Indicates the action to be taken if a user tries to log on from a client application with a version number that cannot be found in the appropriate client version policy. DefaultAction must be set to one of the following values: @@ -149,8 +116,26 @@ When the Enabled property is set to False, then no client version filtering of a ```yaml Type: DefaultAction Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DefaultURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the URL of the webpage where users can download an approved client application. +If specified and if the DefaultAction is set to BlockWithURL, this URL will appear in the "Access denied" message box displayed any time a user tries to log on from an unsupported client application. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -160,6 +145,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether client version filtering is enabled or disabled. If the Enabled property is True, then the server will check the version number of each client application that attempts to log on; the server will then allow or deny access based on the appropriate client version policy. If the Enabled property is False, then any client application capable of logging on will be allowed to log on. @@ -167,8 +155,7 @@ If the Enabled property is False, then any client application capable of logging ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -178,13 +165,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -193,30 +182,57 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Represents the unique identifier of the client version configuration settings to be modified. +To modify the global settings, use syntax like this: `-Identity global`. +To modify settings assigned to the site scope, use syntax similar to this: `"site:Redmond"`. + +If this parameter is not included, the `Set-CsClientVersionConfiguration` cmdlet will automatically configure the global settings. + ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -225,15 +241,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DefaultURL -Specifies the URL of the webpage where users can download an approved client application. -If specified and if the DefaultAction is set to BlockWithURL, this URL will appear in the "Access denied" message box displayed any time a user tries to log on from an unsupported client application. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -247,13 +264,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionConfiguration + The `Set-CsClientVersionConfiguration` cmdlet accepts pipelined instances of the client version configuration object. ## OUTPUTS -### +### None The `Set-CsClientVersionConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionConfiguration object. diff --git a/skype/skype-ps/skype/Set-CsClientVersionPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsClientVersionPolicy.md similarity index 89% rename from skype/skype-ps/skype/Set-CsClientVersionPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsClientVersionPolicy.md index dfff66f31a..74a4988f97 100644 --- a/skype/skype-ps/skype/Set-CsClientVersionPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClientVersionPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csclientversionpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsClientVersionPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csclientversionpolicy +schema: 2.0.0 +title: Set-CsClientVersionPolicy --- # Set-CsClientVersionPolicy @@ -60,7 +61,7 @@ Client version policies enforced in your organization do not override the client ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsClientVersionPolicy -Identity site:Redmond -Rules $Null @@ -80,7 +81,47 @@ This effectively copies all the rules from the site:Dublin policy and adds them ## PARAMETERS +### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to provide explanatory information about a policy. +For example, you might provide information describing the users that the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the policy to be modified. To modify the global policy, use this syntax: `-Identity global`. To modify a policy configured at the site scope, use syntax similar to this: `-Identity "site:Redmond"`. @@ -96,8 +137,7 @@ If this parameter is not included, then the `Set-CsClientVersionPolicy` cmdlet w ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -107,13 +147,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,31 +164,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Description -Enables you to provide explanatory information about a policy. -For example, you might provide information describing the users that the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Rules -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Rules Collection of individual client policy rules that have been assigned to the policy. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -155,30 +182,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the client version policy is being modified. +For example: -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -188,13 +208,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -203,21 +225,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the client version policy is being modified. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -231,13 +248,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionPolicy + The `Set-CsClientVersionPolicy` cmdlet accepts pipelined instances of the client version policy object. ## OUTPUTS -### +### None The `Set-CsClientVersionPolicy` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.ClientVersionPolicy object. diff --git a/skype/skype-ps/skype/Set-CsClientVersionPolicyRule.md b/skype/skype-ps/SkypeForBusiness/Set-CsClientVersionPolicyRule.md similarity index 86% rename from skype/skype-ps/skype/Set-CsClientVersionPolicyRule.md rename to skype/skype-ps/SkypeForBusiness/Set-CsClientVersionPolicyRule.md index b9933740d1..577a00ab02 100644 --- a/skype/skype-ps/skype/Set-CsClientVersionPolicyRule.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClientVersionPolicyRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csclientversionpolicyrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsClientVersionPolicyRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csclientversionpolicyrule +schema: 2.0.0 +title: Set-CsClientVersionPolicyRule --- # Set-CsClientVersionPolicyRule @@ -81,7 +82,7 @@ Client version policies enforced in your organization do not override the client ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsClientVersionPolicyRule -Identity site:Redmond/74ba9211-8610-42f9-91ba-846cdee98820 -Enabled $False ``` @@ -90,7 +91,7 @@ The command shown in Example 1 disables the client version policy rule that has To disable the rule, the command includes the Enabled parameter and the parameter value $False. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsClientVersionPolicyRule -Filter "site:Redmond*" | Set-CsClientVersionPolicyRule -Description "Client policy rules for Redmond" ``` @@ -100,7 +101,7 @@ To do this, the command first calls the `Get-CsClientVersionPolicyRule` cmdlet a This collection is then piped to the `Set-CsClientVersionPolicyRule` cmdlet, which assigns the Description "Client policy rules for Redmond" to each item in that collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsClientVersionPolicyRule | Where-Object {$_.UserAgent -eq "UCCP"} | Set-CsClientVersionPolicyRule -Action "Block" ``` @@ -113,41 +114,10 @@ This filtered collection is then piped to the `Set-CsClientVersionPolicyRule` cm ## PARAMETERS -### -Identity -Unique identifier for the client version policy rule to be modified. -The Identity of a client version rule consists of the scope where the rule has been configured plus a globally unique identifier (GUID). -That means that a rule will have an Identity similar to this: site:Redmond/1987d3c2-4544-489d-bbe3-59f79f530a83. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Action -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Action Action to be taken any time the rule is triggered (that is, any time someone attempts to log on by using the specified software). Valid values are: @@ -173,8 +143,7 @@ The user can then try to log on by using the new client application. ```yaml Type: Action Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,14 +153,16 @@ Accept wildcard characters: False ``` ### -ActionUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URL where users can download the latest version of Lync. This property is required if the Action is set to BlockWithUrl or AllowWithUrl. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -201,6 +172,9 @@ Accept wildcard characters: False ``` ### -BuildNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Build number of the software. For example, if your copy of Communicator is version 2.0.6362.111, then the BuildNumber is 6362. Build numbers represent internal versions of the software during the development process, and help to ensure that you are using the final release version as opposed to a pre-release version. @@ -208,8 +182,7 @@ Build numbers represent internal versions of the software during the development ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -219,6 +192,9 @@ Accept wildcard characters: False ``` ### -CompareOp + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Comparison operator used to determine if the client software attempting to log on was released before, after, or at the same time as the version specified in the rule. Valid values are: @@ -237,8 +213,7 @@ LEQ (less than or equal to) ```yaml Type: CompareOp Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -248,14 +223,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to provide additional information about the client version rule. For example, the Description might include information about who to contact if you believe the rule should be changed. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -265,6 +242,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether or not the client version rule is to be used. If the Enabled property is set to False the rule will be ignored any time a user attempts to log on with the specified software. The default value is True. @@ -272,8 +252,25 @@ The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -282,7 +279,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the client version policy rule to be modified. +The Identity of a client version rule consists of the scope where the rule has been configured plus a globally unique identifier (GUID). +That means that a rule will have an Identity similar to this: site:Redmond/1987d3c2-4544-489d-bbe3-59f79f530a83. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -MajorVersion + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Major version of the software. For example, if your copy of Communicator is version 2.0.6362.111, then the MajorVersion is 2. Major versions equate to primary releases of the software. @@ -290,8 +328,7 @@ Major versions equate to primary releases of the software. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -301,6 +338,9 @@ Accept wildcard characters: False ``` ### -MinorVersion + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Minor version of the software. For example, if your copy of Communicator is version 2.0.6362.111, then the MinorVersion is 0. Minor versions equate to interim releases of the software. @@ -308,8 +348,7 @@ Minor versions equate to interim releases of the software. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -319,6 +358,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Relative priority of the rule. Rules are processed in priority order, with the rule with priority 0 being processed first, the rule with priority 1 being processed second, and so on. If you assign a priority already in use, the new rule will use that priority and other rules will be renumbered accordingly. @@ -326,8 +368,7 @@ If you assign a priority already in use, the new rule will use that priority and ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -337,6 +378,9 @@ Accept wildcard characters: False ``` ### -QfeNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Quick fix engineering number of the software. For example, if your copy of Communicator is version 2.0.6362.111, then the QfeNumber is 111. QFE numbers represent planned updates to an application that are made available after the software's official release. @@ -344,8 +388,7 @@ QFE numbers represent planned updates to an application that are made available ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -354,32 +397,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserAgent -Designator used to identify the software client. -For example, OC is the user agent designation for Communicator. -The `Get-CsClientVersionConfiguration` cmdlet provides corresponding friendly names for each user agent designation. +### -Tenant -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the client version policy rule is being modified. +For example: -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -388,14 +422,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -UserAgent + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Designator used to identify the software client. +For example, OC is the user agent designation for Communicator. +The `Get-CsClientVersionConfiguration` cmdlet provides corresponding friendly names for each user agent designation. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -404,14 +442,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -UserAgentFullName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to provide a friendly name for the user agent. +For example, instead of relying on the user agent UCCP to identify the agent administrators might spell the name out in full: Microsoft Unified Communications Client. + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -420,16 +462,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserAgentFullName -Enables administrators to provide a friendly name for the user agent. -For example, instead of relying on the user agent UCCP to identify the agent administrators might spell the name out in full: Microsoft Unified Communications Client. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -438,21 +480,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the client version policy rule is being modified. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -466,14 +503,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.Rule object. +### Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.Rule + The `Set-CsClientVersionPolicyRule` cmdlet accepts pipelined instances of the client version rule object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsClientVersionPolicyRule` cmdlet modifies instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ClientVersion.Rule object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsCloudCallDataConnector.md b/skype/skype-ps/SkypeForBusiness/Set-CsCloudCallDataConnector.md similarity index 92% rename from skype/skype-ps/skype/Set-CsCloudCallDataConnector.md rename to skype/skype-ps/SkypeForBusiness/Set-CsCloudCallDataConnector.md index d15bbdcaf8..32ca4d6200 100644 --- a/skype/skype-ps/skype/Set-CsCloudCallDataConnector.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCloudCallDataConnector.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cscloudcalldataconnector applicable: Skype for Business Server 2019 -title: Set-CsCloudCallDataConnector -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cscloudcalldataconnector +schema: 2.0.0 +title: Set-CsCloudCallDataConnector --- # Set-CsCloudCallDataConnector @@ -45,29 +46,16 @@ Example showing the scenario when we aren't piping the output from online cmdlet ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -Force -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2019 -### -Force Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -76,13 +64,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet, rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -91,13 +81,15 @@ Accept wildcard characters: False ``` ### -TenantId + +> Applicable: Skype for Business Server 2019 + Office 365 TenantID of your tenant. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -106,13 +98,15 @@ Accept wildcard characters: False ``` ### -Token + +> Applicable: Skype for Business Server 2019 + Data ingestion token for CloudCallDataConnector telemetry endpoint. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -120,7 +114,27 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Skype for Business Server 2019 + +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 +``` + ### -WhatIf + +> Applicable: Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -128,7 +142,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None diff --git a/skype/skype-ps/skype/Set-CsCloudCallDataConnectorConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsCloudCallDataConnectorConfiguration.md similarity index 95% rename from skype/skype-ps/skype/Set-CsCloudCallDataConnectorConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsCloudCallDataConnectorConfiguration.md index 021a5cf3e8..255daa0874 100644 --- a/skype/skype-ps/skype/Set-CsCloudCallDataConnectorConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCloudCallDataConnectorConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-Help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cscloudcalldataconnectorconfiguration applicable: Skype for Business Server 2019 -title: Set-CsCloudCallDataConnectorConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cscloudcalldataconnectorconfiguration +schema: 2.0.0 +title: Set-CsCloudCallDataConnectorConfiguration --- # Set-CsCloudCallDataConnectorConfiguration @@ -69,13 +70,15 @@ The filtered collection is then piped to the `Set-CsCloudCallDataConnectorConfig ## PARAMETERS ### -EnableCallDataConnector + +> Applicable: Skype for Business Server 2019 + Enables upload of call data. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -84,13 +87,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -99,13 +104,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2019 + Represents the unique identifier to be assigned to the new collection of CloudCallDataConnector configuration settings. Because you can only create new collections at the site scope, the Identity will always be the prefix "site:" followed by the site name; for example, "site:Redmond". ```yaml Type: XdsIdentity Parameter Sets: Identity Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: 1 Default value: None @@ -114,13 +121,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet, rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -129,6 +138,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -136,7 +148,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None diff --git a/skype/skype-ps/skype/Set-CsClsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsClsConfiguration.md similarity index 84% rename from skype/skype-ps/skype/Set-CsClsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsClsConfiguration.md index ac2b5e0018..4250a9135c 100644 --- a/skype/skype-ps/skype/Set-CsClsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csclsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsClsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csclsconfiguration +schema: 2.0.0 +title: Set-CsClsConfiguration --- # Set-CsClsConfiguration @@ -64,7 +65,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsClsConfiguration -Identity "global" -EtlRolloverFileSizeMB 40 ``` @@ -72,7 +73,7 @@ Set-CsClsConfiguration -Identity "global" -EtlRolloverFileSizeMB 40 In Example 1, the global collection of centralized logging configuration settings is modified to set the maximum size of an ETL file to 40 megabytes. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClsConfiguration | Set-CsClsConfiguration -EtlRolloverFileSizeMB 40 ``` @@ -85,6 +86,9 @@ That collection is then piped to the `Set-CsClsConfiguration` cmdlet, which chan ## PARAMETERS ### -CacheFileLocalFolders + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + One or more full paths to the local folders where the cache files will be stored. The default value is %TEMP%\Tracing. If more than one path is specified, then separate them with semi-colons. @@ -92,8 +96,7 @@ If more than one path is specified, then separate them with semi-colons. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -103,14 +106,16 @@ Accept wildcard characters: False ``` ### -CacheFileLocalMaxDiskUsage + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum amount of disk space (percentage) that can be used for the cache files. The default value is 80. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -120,14 +125,16 @@ Accept wildcard characters: False ``` ### -CacheFileLocalRetentionPeriod + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum number of days that cache files are retained locally. The default value is 14. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -137,14 +144,16 @@ Accept wildcard characters: False ``` ### -CacheFileNetworkFolder + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Full UNC path to the network cache folder. There is no default value. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -154,6 +163,9 @@ Accept wildcard characters: False ``` ### -ComponentThrottleLimit + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum rate at which a component is allowed to generate trace records before its tracing is throttled. The default value is 5000 trace calls per second. @@ -162,8 +174,7 @@ The default value is 5000. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -173,14 +184,16 @@ Accept wildcard characters: False ``` ### -ComponentThrottleSample + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum number of times the ComponentThrottleLimit can be exceeded within a one minute interval. The default value is 3. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -189,23 +202,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -ETLEnoughFreeSpaceInDiskInBytes + +> Applicable: Skype for Business Server 2019 + +Enough free disk space to make purge stop due low free disk space. +If disk size reaches this size, purge stops. ```yaml -Type: SwitchParameter +Type: Int64 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named -Default value: None +Default value: 4000000000 Accept pipeline input: False Accept wildcard characters: False ``` +### -ETLEnoughQuotaInBytes + +> Applicable: Skype for Business Server 2019 + +Enough ETL usage quota to make purge stop due max quota condition reached + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 250000000000 +Accept pipeline input: False +Accept wildcard characters: False +``` + + ### -EtlFileFolder + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Full path to the folder where the event log trace files will be stored. The default value is %TEMP%\Tracing. Note that %TEMP% is evaluated in the contents of the CLS Service so it actual expands to %WINDIR%\ServiceProfiles\NetworkService\AppData\Local @@ -213,8 +251,7 @@ Note that %TEMP% is evaluated in the contents of the CLS Service so it actual ex ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -224,14 +261,16 @@ Accept wildcard characters: False ``` ### -EtlFileRolloverMinutes + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum amount of time (in minutes) that can elapse before a new event log trace file is created. (This new file will be created even if the existing trace file has not reached the specified rollover size.) The default value is 60. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -241,14 +280,16 @@ Accept wildcard characters: False ``` ### -EtlFileRolloverSizeMB + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum size (in megabytes) that at event trace log file can reach before a new file is created. The default value is 20. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -257,14 +298,89 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ETLMaxQuotaInBytes + +> Applicable: Skype for Business Server 2019 + +Max allowed quota used by ETL files before purge starts + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 400000000000 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ETLMaxRetentionInDays + +> Applicable: Skype for Business Server 2019 + +Maximum retention time in days for ETL files + +```yaml +Type: UInt32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 14 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ETLMinFreeSpaceInDiskInBytes + +> Applicable: Skype for Business Server 2019 + +Minimum allowed free disk space to have on the ETL folder drive. +If disk reaches this size and ETL Folder size is more than ETLMinQuotaInBytes, Purge executes. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 2000000000 +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ETLMinQuotaInBytes + +> Applicable: Skype for Business Server 2019 + +Min quota allowed for ETL files, even if disk size is less than ETLMinFreeSpaceInDiskInBytes. + +```yaml +Type: Int64 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: 3221225472 +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -274,6 +390,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the centralized logging configuration settings to be modified. To refer to the global settings, use this syntax: @@ -288,8 +407,7 @@ You cannot use wildcards when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -299,13 +417,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -315,6 +435,9 @@ Accept wildcard characters: False ``` ### -MinimumClsAgentServiceVersion + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the minimum version of the centralized logging service agent to be used when logging data; any computers with an agent version lower than the minimum value will be excluded from the logging operations. The default value is 6, representing Skype for Business Server. This parameter is intended for use with Skype for Business Online. @@ -323,8 +446,7 @@ This parameter is intended for use with Skype for Business Online. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -333,18 +455,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Regions -Collection of regions defined for the centralized logging configuration settings. -Regions are defined using the `New-CsClsRegion` cmdlet. +### -NetworkUsagePacketSize -This parameter is intended for use with Skype for Business Online. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Packet size (in kilobytes) for transmitting agent search results and copying cache files over the network. +The default value is 64 KB. ```yaml -Type: PSListModifier +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -353,15 +474,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Scenarios -Collection of components/situations that can be traced using centralized logging. -Scenarios are managed using the CsClsScenario cmdlets. +### -NetworkUsageThreshold + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Bandwidth usage threshold (in MB per second) for transmitting agent search results and copying cache files over the network. +The default value is 10. ```yaml -Type: PSListModifier +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -370,15 +493,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SearchTerms -Collection of terms that help determine the personally identifiable information available to technical support personnel who search the centralized logging files. -Search terms are managed using the CsClsSearchTerm cmdlets. +### -Regions + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Collection of regions defined for the centralized logging configuration settings. +Regions are defined using the `New-CsClsRegion` cmdlet. + +This parameter is intended for use with Skype for Business Online. + ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -387,17 +515,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SecurityGroups -Security groups who are allowed to access the log files. +### -Scenarios -This parameter is intended for use with Skype for Business Online. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Collection of components/situations that can be traced using centralized logging. +Scenarios are managed using the CsClsScenario cmdlets. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -406,24 +534,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TmfFileSearchPath -Search path for TMF (trace message format) files. -TMF files convert binary trace messages to a human-readable format. -This should be a UNC or DFC path, to allow it to be accessible from multiple computers. -If the path is not UNC or DFC, every machine any reference to a local folder path must contain all needed TMX files. -Local file paths will work, but must be maintained. - -There's no need to set the location C:\Program Files\Common Files\Skype for Business Server 2015\Tracing\ because every ClsAgent will automatically check this location. +### -SearchTerms -Do not set CacheFileLocalFolders to the same value as TmfFileSearchPath. -Any .tmx files found in the CacheFileLocalFolders path will be deleted. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Collection of terms that help determine the personally identifiable information available to technical support personnel who search the centralized logging files. +Search terms are managed using the CsClsSearchTerm cmdlets. ```yaml -Type: String +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -432,31 +553,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SecurityGroups -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Security groups who are allowed to access the log files. + +This parameter is intended for use with Skype for Business Online. -### -NetworkUsagePacketSize -Packet size (in kilobytes) for transmitting agent search results and copying cache files over the network. -The default value is 64 KB. ```yaml -Type: UInt32 +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -465,31 +574,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkUsageThreshold -Bandwidth usage threshold (in MB per second) for transmitting agent search results and copying cache files over the network. -The default value is 10. +### -TmfFileSearchPath -```yaml -Type: UInt32 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Search path for TMF (trace message format) files. +TMF files convert binary trace messages to a human-readable format. +This should be a UNC or DFC path, to allow it to be accessible from multiple computers. +If the path is not UNC or DFC, every machine any reference to a local folder path must contain all needed TMX files. +Local file paths will work, but must be maintained. + +There's no need to set the location C:\Program Files\Common Files\Skype for Business Server 2015\Tracing\ because every ClsAgent will automatically check this location. + +Do not set CacheFileLocalFolders to the same value as TmfFileSearchPath. +Any .tmx files found in the CacheFileLocalFolders path will be deleted. -### -Version -This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -498,101 +602,56 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ETLMinFreeSpaceInDiskInBytes -Minimum allowed free disk space to have on the ETL folder drive. -If disk reaches this size and ETL Folder size is more than ETLMinQuotaInBytes, Purge executes. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2019 +### -Version -Required: False -Position: Named -Default value: 2000000000 -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -ETLEnoughFreeSpaceInDiskInBytes -Enough free disk space to make purge stop due low free disk space. -If disk size reaches this size, purge stops. +This parameter is reserved for internal Microsoft use. ```yaml -Type: Int64 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2019 +Aliases: Required: False Position: Named -Default value: 4000000000 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ETLMinQuotaInBytes -Min quota allowed for ETL files, even if disk size is less than ETLMinFreeSpaceInDiskInBytes. - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2019 +### -Confirm -Required: False -Position: Named -Default value: 3221225472 -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -ETLMaxQuotaInBytes -Max allowed quota used by ETL files before purge starts +Prompts you for confirmation before executing the command. ```yaml -Type: Int64 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2019 +Aliases: cf Required: False Position: Named -Default value: 400000000000 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ETLEnoughQuotaInBytes -Enough ETL usage quota to make purge stop due max quota condition reached - -```yaml -Type: Int64 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2019 - -Required: False -Position: Named -Default value: 250000000000 -Accept pipeline input: False -Accept wildcard characters: False -``` +### -WhatIf +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -ETLMaxRetentionInDays -Maximum retention time in days for ETL files +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: UInt32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2019 +Aliases: wi Required: False Position: Named -Default value: 14 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -602,13 +661,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.CentralizedLoggingConfiguration The `Set-CsClsConfiguration` cmdlet accepts pipelined instances of the icrosoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.CentralizedLoggingConfiguration object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsClsConfiguration` cmdlet modifies existing instances of the icrosoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.CentralizedLoggingConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsClsRegion.md b/skype/skype-ps/SkypeForBusiness/Set-CsClsRegion.md similarity index 85% rename from skype/skype-ps/skype/Set-CsClsRegion.md rename to skype/skype-ps/SkypeForBusiness/Set-CsClsRegion.md index 89a4dee70b..f577f2afe6 100644 --- a/skype/skype-ps/skype/Set-CsClsRegion.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClsRegion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csclsregion applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsClsRegion -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csclsregion +schema: 2.0.0 +title: Set-CsClsRegion --- # Set-CsClsRegion @@ -47,7 +48,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsClsRegion -Identity "global/US" -SecurityGroupSuffix "USSupport" ``` @@ -57,30 +58,16 @@ The command shown in Example 1 changes the security group suffix for the region ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Force Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -90,6 +77,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the region. Region Identities consist of the centralized logging configuration scope where the region was created plus a unique region name. For example, to refer to a global region named Redmond use this syntax: @@ -99,8 +89,7 @@ For example, to refer to a global region named Redmond use this syntax: ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -110,13 +99,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -126,13 +117,15 @@ Accept wildcard characters: False ``` ### -OtherRegionAccess + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of an additional region that can be accessed by authorized users for this region. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -142,13 +135,15 @@ Accept wildcard characters: False ``` ### -SecurityGroupSuffix + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suffix to be added to the end of the name of any security group that will be authorized for this region. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,14 +153,34 @@ Accept wildcard characters: False ``` ### -Sites + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Sites contained within this region. These correspond to the SideId attribute values in the topology document. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -175,13 +190,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -195,13 +212,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Region#Decorated The `Set-CsClsRegion` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Region#Decorated object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsClsRegion` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Region#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsClsScenario.md b/skype/skype-ps/SkypeForBusiness/Set-CsClsScenario.md similarity index 89% rename from skype/skype-ps/skype/Set-CsClsScenario.md rename to skype/skype-ps/SkypeForBusiness/Set-CsClsScenario.md index 156d2a64db..806484a6eb 100644 --- a/skype/skype-ps/skype/Set-CsClsScenario.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClsScenario.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csclsscenario applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsClsScenario -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csclsscenario +schema: 2.0.0 +title: Set-CsClsScenario --- # Set-CsClsScenario @@ -49,7 +50,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $provider = New-CsClsProvider -Name "WebInfrastructure" -Type "WPP" -Level "Warning" -Flags "All" @@ -62,7 +63,7 @@ The second command in the example then adds this new provider to the scenario si Because the command uses the syntax `@{Add=$provider}` the new provider will be added to the WAC scenario in addition to any other providers already configured for that. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $provider = New-CsClsProvider -Name "WebInfrastructure" -Type "WPP" -Level "Warning" -Flags "All" @@ -76,30 +77,16 @@ This is done by using the syntax `@{Replace=$provider}`. ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Force Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -109,6 +96,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the scenario to be modified. A scenario consists of two parts: the scope where the scenario is configured (that is, the collection of centralized logging configuration settings where the scenario can be found) and the scenario name. For example: @@ -118,8 +108,7 @@ For example: ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -129,13 +118,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -145,6 +136,9 @@ Accept wildcard characters: False ``` ### -Provider + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Logging provider for the scenario. New providers must be created using the `New-CsClsProvider` cmdlet. For example: @@ -154,8 +148,25 @@ For example: ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -165,13 +176,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -185,13 +198,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Scenario#Decorated The `Set-CsClsScenario` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Scenario#Decorated object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsClsScenario` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.Scenario#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsClsSearchTerm.md b/skype/skype-ps/SkypeForBusiness/Set-CsClsSearchTerm.md similarity index 88% rename from skype/skype-ps/skype/Set-CsClsSearchTerm.md rename to skype/skype-ps/SkypeForBusiness/Set-CsClsSearchTerm.md index f3cb33712c..5a6b4be036 100644 --- a/skype/skype-ps/skype/Set-CsClsSearchTerm.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClsSearchTerm.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csclssearchterm applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsClsSearchTerm -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csclssearchterm +schema: 2.0.0 +title: Set-CsClsSearchTerm --- # Set-CsClsSearchTerm @@ -49,7 +50,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsClsSearchTerm -Identity "site:Redmond/IP" -Inserts "ItemURI" ``` @@ -60,30 +61,16 @@ In this example, a single Insert is configured: ItemURI. ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Force Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -93,6 +80,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the search term to be modified. A search term consists of two parts: the scope where the term is configured (that is, the collection of centralized logging configuration settings where the term can be found) and the term name. For example: @@ -104,8 +94,7 @@ You cannot use wildcards when specifying the Identity. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -115,6 +104,9 @@ Accept wildcard characters: False ``` ### -Inserts + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specify how personally identifiable information is masked when viewing the log files. For example, the Insert "ItemURI" indicates that user URI information should be masked. As a result, a user URI such as sip:kenmyer@litwareinc.com will appear as a generic URI that hides the user name but preserve the domain name: @@ -126,8 +118,7 @@ Inserts mask such things as user names and computer names; phone numbers; and IP ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -137,13 +128,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -152,14 +145,34 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -173,13 +186,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.SearchTerm#Decorated The `Set-CsClsSearchTerm` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.SearchTerm#Decorated object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsClsSearchTerm` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.SearchTerm#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsClsSecurityGroup.md b/skype/skype-ps/SkypeForBusiness/Set-CsClsSecurityGroup.md similarity index 89% rename from skype/skype-ps/skype/Set-CsClsSecurityGroup.md rename to skype/skype-ps/SkypeForBusiness/Set-CsClsSecurityGroup.md index a0d8f37e29..85c3266d10 100644 --- a/skype/skype-ps/skype/Set-CsClsSecurityGroup.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsClsSecurityGroup.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csclssecuritygroup applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsClsSecurityGroup -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csclssecuritygroup +schema: 2.0.0 +title: Set-CsClsSecurityGroup --- # Set-CsClsSecurityGroup @@ -47,7 +48,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsClsSecurityGroup -Identity "global/HelpDesk" -AccessLevel "Tier3" ``` @@ -56,7 +57,7 @@ The command shown in Example 1 modifies the centralized logging security group t In this example, the AccessLevel property is set to Tier3. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsClsSecurityGroup -Filter "global/*" | Set-CsClsSecurityGroup-AccessLevel "Tier3" ``` @@ -66,7 +67,7 @@ To do this, the command first calls the `Get-CsClsSecurityGroup` cmdlet along wi Those groups are then piped to the `Set-CsClsSecurityGroup` cmdlet, which sets the AccessLevel property of each group to Tier3. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsClsSecurityGroup | Where-Object {$_.AccessLevel -eq "GlobalAccess"} | Set-CsClsSecurityGroup -AccessLevel "Tier3" ``` @@ -80,6 +81,9 @@ In turn, those groups are piped to the `Set-CsClsSecurityGroup` cmdlet, which ta ## PARAMETERS ### -AccessLevel + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + String value specifying the access level assigned to the group. Access levels are assigned by administrators and used to categorize security groups. For example: @@ -93,8 +97,7 @@ Currently the only values that have meaning are "Tier3", "Tier2", "Product", "Op ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -103,30 +106,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Force Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -136,6 +125,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the centralized logging security group to be modified. A security group identity consists of the scope where the group was created followed by the group name. For example, to modify a group named HelpDesk created at the global scope, use the following syntax: @@ -145,8 +137,7 @@ For example, to modify a group named HelpDesk created at the global scope, use t ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -156,13 +147,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -171,14 +164,34 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -192,13 +205,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.SecurityGroup#Decorated The `Set-CsClsSecurityGroup` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.SecurityGroup#Decorated object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsClsSecurityGroup` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.CentralizedLogging.SecurityGroup#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsCommonAreaPhone.md b/skype/skype-ps/SkypeForBusiness/Set-CsCommonAreaPhone.md similarity index 87% rename from skype/skype-ps/skype/Set-CsCommonAreaPhone.md rename to skype/skype-ps/SkypeForBusiness/Set-CsCommonAreaPhone.md index 0339c1c04d..a1aecb8556 100644 --- a/skype/skype-ps/skype/Set-CsCommonAreaPhone.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCommonAreaPhone.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cscommonareaphone applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsCommonAreaPhone -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cscommonareaphone +schema: 2.0.0 +title: Set-CsCommonAreaPhone --- # Set-CsCommonAreaPhone @@ -53,7 +54,7 @@ See the help topic for the `Set-CsClientPolicy` cmdlet for more information. ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Get-CsCommonAreaPhone -Filter {LineUri -eq "tel:+14255556710"} | Set-CsCommonAreaPhone -DisplayName "Employee Lounge" ``` @@ -63,7 +64,7 @@ To do this, the `Get-CsCommonAreaPhone` cmdlet is first called along with the Fi The returned object is then piped to the `Set-CsCommonAreaPhone` cmdlet, which sets the value of the DisplayName property to "Employee Lounge". -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsCommonAreaPhone | Set-CsCommonAreaPhone -Enabled $True ``` @@ -73,7 +74,7 @@ To carry out this task, the command calls the `Get-CsCommonAreaPhone` cmdlet wit This collection is then piped to the `Set-CsCommonAreaPhone` cmdlet, which takes each item in the collection and sets the Enabled property to True. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsCommonAreaPhone -Filter {Description -eq $Null} | Set-CsCommonAreaPhone -Description "Common area phone" ``` @@ -85,55 +86,17 @@ This filtered collection is then piped to the `Set-CsCommonAreaPhone` cmdlet, wh ## PARAMETERS -### -Identity -Unique identifier for the common area phone. -Common area phones are identified using the Active Directory distinguished name of the associated contact object. -By default, common area phones use a globally unique identifier (GUID) as their common name; that means phones will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. -Because of that you might find it easier to retrieve common area phones by using the `Get-CsCommonAreaPhone` cmdlet, and then piping the returned objects to the `Set-CsCommonAreaPhone` cmdlet. - - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Enabled -Indicates whether or not the contact object for the common area phone has been enabled for Skype for Business Server. - -If you disable a contact by using the Enabled parameter, the information associated with that account (including assigned policies and whether or not the contact is enabled for Enterprise Voice, remote call control and/or voice mail integration) is retained. -If you later re-enable the account by using the Enabled parameter, the associated account information will be restored. - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: CsEnabled -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Description -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Description Enables you to modify the Active Directory description attribute for the common area phone. This provides a way to supply additional information about the phone; for example, you might provide details about who to contact in case of problems with the phone. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -143,13 +106,15 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to modify the Active Directory display name of the common area phone. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -159,6 +124,9 @@ Accept wildcard characters: False ``` ### -DisplayNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Phone number as displayed in Skype for Business. The DisplayNumber property can be formatted any way you prefer; for example 1-800-555-1234; 1-(800)-555-1234; 1.800.555.1234 and so on. When choosing a display number, keep in mind that this number will be shown on the display screen of the common area phone only if the number can be normalized. @@ -168,8 +136,7 @@ When choosing a display number, keep in mind that this number will be shown on t ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,14 +146,16 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to modify contact information. To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-mcs-001) or its fully qualified domain name (FQDN); for example: atl-mcs-001.litwareinc.com. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -195,15 +164,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnterpriseVoiceEnabled -Indicates whether the contact object for the common area phone has been enabled for Enterprise Voice, the Voice over Internet Protocol (VoIP) solution offered by Microsoft. -With Enterprise Voice, telephone calls can be made using the Internet rather than using the standard telephone network. +### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not the contact object for the common area phone has been enabled for Skype for Business Server. + +If you disable a contact by using the Enabled parameter, the information associated with that account (including assigned policies and whether or not the contact is enabled for Enterprise Voice, remote call control and/or voice mail integration) is retained. +If you later re-enable the account by using the Enabled parameter, the associated account information will be restored. + ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: CsEnabled Required: False Position: Named @@ -212,17 +186,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipAddress -Unique identifier that allows the common area phone to communicate with SIP devices such as Skype for Business. -The SIP address must be prefaced by the prefix sip: and include a valid SIP domain. -For example: sip:bldg14lobby@litwareinc.com. +### -EnterpriseVoiceEnabled +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether the contact object for the common area phone has been enabled for Enterprise Voice, the Voice over Internet Protocol (VoIP) solution offered by Microsoft. +With Enterprise Voice, telephone calls can be made using the Internet rather than using the standard telephone network. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -231,14 +205,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Returns an object representing the common area phone. +### -ExchangeArchivingPolicy + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates where the contact's instant messaging sessions are archived. +Allowed values are: + +Uninitialized + +UseLyncArchivingPolicy + +ArchivingToExchange + +NoArchiving + ```yaml -Type: SwitchParameter +Type: ExchangeArchivingPolicyOptionsEnum Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -247,14 +233,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the common area phone. +Common area phones are identified using the Active Directory distinguished name of the associated contact object. +By default, common area phones use a globally unique identifier (GUID) as their common name; that means phones will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. +Because of that you might find it easier to retrieve common area phones by using the `Get-CsCommonAreaPhone` cmdlet, and then piping the returned objects to the `Set-CsCommonAreaPhone` cmdlet. + ```yaml -Type: SwitchParameter +Type: UserIdParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -LineURI + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Phone number for the common area phone. +The line Uniform Resource Identifier (URI) should be specified using the E.164 format and be prefixed by the "TEL:" prefix. +For example: TEL:+14255551297. +Any extension number should be added to the end of the line URI; for example: TEL:+14255551297;ext=51297. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -263,14 +276,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Returns an object representing the common area phone. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -279,17 +294,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LineURI -Phone number for the common area phone. -The line Uniform Resource Identifier (URI) should be specified using the E.164 format and be prefixed by the "TEL:" prefix. -For example: TEL:+14255551297. -Any extension number should be added to the end of the line URI; for example: TEL:+14255551297;ext=51297. +### -SipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier that allows the common area phone to communicate with SIP devices such as Skype for Business. +The SIP address must be prefaced by the prefix sip: and include a valid SIP domain. +For example: sip:bldg14lobby@litwareinc.com. + ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -298,24 +315,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExchangeArchivingPolicy -Indicates where the contact's instant messaging sessions are archived. -Allowed values are: +### -Confirm -Uninitialized +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -UseLyncArchivingPolicy +Prompts you for confirmation before executing the command. -ArchivingToExchange +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf -NoArchiving +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: ExchangeArchivingPolicyOptionsEnum +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -329,12 +356,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact object. +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact + ## OUTPUTS -### +### None By default, the `Set-CsCommonAreaPhone` cmdlet does not return any objects or values. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADCommonAreaPhoneContact object. diff --git a/skype/skype-ps/skype/Set-CsConferenceDisclaimer.md b/skype/skype-ps/SkypeForBusiness/Set-CsConferenceDisclaimer.md similarity index 83% rename from skype/skype-ps/skype/Set-CsConferenceDisclaimer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsConferenceDisclaimer.md index 161abd1d7d..388fa4825f 100644 --- a/skype/skype-ps/skype/Set-CsConferenceDisclaimer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsConferenceDisclaimer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csconferencedisclaimer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsConferenceDisclaimer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csconferencedisclaimer +schema: 2.0.0 +title: Set-CsConferenceDisclaimer --- # Set-CsConferenceDisclaimer @@ -44,7 +45,7 @@ The `Set-CsConferenceDisclaimer` cmdlet enables you to modify the conference dis ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsConferenceDisclaimer -Header "Litwareinc.com Online Conference" -Body "Important note: Conferencing proceedings are recorded and archived." ``` @@ -55,49 +56,52 @@ Because you can have only one such disclaimer, you do not need to specify the Id ## PARAMETERS -### -Identity -Unique Identity of the conference disclaimer. -Because you can only have a single, global instance of the conference disclaimer, you do not need to specify an Identity when calling the `Set-CsConferenceDisclaimer` cmdlet. -However, you can use the following syntax to reference the global disclaimer: `-Identity global`. +### -Body + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Contents of the conference disclaimer. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Body -Contents of the conference disclaimer. +### -Header + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Title given the conference disclaimer. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -106,46 +110,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Header -Title given the conference disclaimer. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique Identity of the conference disclaimer. +Because you can only have a single, global instance of the conference disclaimer, you do not need to specify an Identity when calling the `Set-CsConferenceDisclaimer` cmdlet. +However, you can use the following syntax to reference the global disclaimer: `-Identity global`. + ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -154,14 +167,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -175,13 +190,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConferenceDisclaimer object. +### Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConferenceDisclaimer + The `Set-CsConferenceDisclaimer` cmdlet accepts pipelined input of conference disclaimer objects. ## OUTPUTS -### +### None The `Set-CsConferenceDisclaimer` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConferenceDisclaimer object. diff --git a/skype/skype-ps/skype/Set-CsConferenceServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsConferenceServer.md similarity index 81% rename from skype/skype-ps/skype/Set-CsConferenceServer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsConferenceServer.md index b10649feaa..921e54ed8d 100644 --- a/skype/skype-ps/skype/Set-CsConferenceServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsConferenceServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csconferenceserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsConferenceServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csconferenceserver +schema: 2.0.0 +title: Set-CsConferenceServer --- # Set-CsConferenceServer @@ -36,7 +37,7 @@ You can also use the `Set-CsConferenceServer` cmdlet to associate a given server ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsConferenceServer -Identity "ConferencingServer:atl-cs-001.litwareinc.com" -ImSipPort 5075 ``` @@ -45,7 +46,7 @@ The command shown in Example 1 modifies the instant messaging SIP port for the C In this example, the port is changed to 5075. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsService -ConferencingServer | ForEach-Object {Set-CsConferenceServer -Identity $_.Identity -ImSipPort 5075} ``` @@ -57,36 +58,18 @@ That collection is then piped to the `ForEach-Object` cmdlet, which runs the `Se ## PARAMETERS -### -Identity -Service location of the Conference Server to be modified. -For example: `-Identity "ConferencingServer:atl-cs-001.litwareinc.com"`. - -Note that you can leave off the prefix "ConferencingServer:" when specifying a Conference Server. -For example: `-Identity "atl-cs-001.litwareinc.com"`. - - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AppSharingPortCount -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AppSharingSipPort -SIP port used to listen for requests for application sharing. -The ports actually used for application sharing are configured using AppSharingPortStart and AppSharingPortCount. +Total number of ports allocated for application sharing. +The actual ports to be opened will start with the value configured for AppSharingPortStart and continue through the number of ports specified for AppSharingPortCount. +For example, if the AppSharingPortStart is set to 60000 and the AppSharingPortCount is set to 100, then ports 60000 through 60099 will be used for application sharing. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -95,16 +78,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AppSharingPortCount -Total number of ports allocated for application sharing. -The actual ports to be opened will start with the value configured for AppSharingPortStart and continue through the number of ports specified for AppSharingPortCount. -For example, if the AppSharingPortStart is set to 60000 and the AppSharingPortCount is set to 100, then ports 60000 through 60099 will be used for application sharing. +### -AppSharingPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +First port in the range of media ports allocated for application sharing. +For example: `-AppSharingPortStart 60000`. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -113,15 +97,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AppSharingPortStart -First port in the range of media ports allocated for application sharing. -For example: `-AppSharingPortStart 60000`. +### -AppSharingSipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP port used to listen for requests for application sharing. +The ports actually used for application sharing are configured using AppSharingPortStart and AppSharingPortCount. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,6 +117,9 @@ Accept wildcard characters: False ``` ### -AudioPortCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Total number of ports allocated for sending and receiving audio traffic. The actual ports to be opened will start with the value configured for AudioPortStart and continue through the number of ports specified for AudioPortCount. For example, if the AudioPortStart is set to 60000 and the AudioPortCount is set to 100, then ports 60000 through 60099 will be used for audio traffic. @@ -138,8 +127,7 @@ For example, if the AudioPortStart is set to 60000 and the AudioPortCount is set ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -149,14 +137,16 @@ Accept wildcard characters: False ``` ### -AudioPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + First port in the range of media ports allocated for sending and receiving audio traffic. For example: `-AudioPortStart 60000`. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -166,14 +156,16 @@ Accept wildcard characters: False ``` ### -AudioVideoSipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used to listen for incoming requests for audio and video service. The ports actually used for audio and video traffic are configured using AudioPortCount, AudioPortStart, VideoPortCount and VideoPortStart. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -183,13 +175,15 @@ Accept wildcard characters: False ``` ### -DataPsomPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Data port used by the Persistent Shared Object Model (PSOM) protocol. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -199,14 +193,34 @@ Accept wildcard characters: False ``` ### -EdgeServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service location of the Edge Server to be associated with the Conference Server. For example: `-EdgeServer "EdgeServer:atl-edge-001.litwareinc.com"`. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -215,14 +229,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the Conference Server to be modified. +For example: `-Identity "ConferencingServer:atl-cs-001.litwareinc.com"`. + +Note that you can leave off the prefix "ConferencingServer:" when specifying a Conference Server. +For example: `-Identity "atl-cs-001.litwareinc.com"`. + + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ImSipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for instant messaging traffic. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -232,13 +271,15 @@ Accept wildcard characters: False ``` ### -MeetingPsomPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for the Persistent Shared Object Model (PSOM) protocol, a Microsoft protocol used for conferences. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -248,13 +289,15 @@ Accept wildcard characters: False ``` ### -PhoneSipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for telephony traffic. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -264,6 +307,9 @@ Accept wildcard characters: False ``` ### -VideoPortCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Total number of ports allocated for sending and receiving video traffic. The actual ports to be opened will start with the value configured for VideoPortStart and continue through the number of ports specified for VideoPortCount. For example, if the VideoPortStart is set to 60000 and the VideoPortCount is set to 100, then ports 60000 through 60099 will be used for video traffic. @@ -271,8 +317,7 @@ For example, if the VideoPortStart is set to 60000 and the VideoPortCount is set ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -282,14 +327,16 @@ Accept wildcard characters: False ``` ### -VideoPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + First port in the range of ports allocated for sending and receiving video traffic. For example: `-VideoPortStart 60000`. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -298,14 +345,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -315,29 +364,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -351,13 +386,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsConferenceServer` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsConferenceServer` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayConferenceServer object. diff --git a/skype/skype-ps/skype/Set-CsConferencingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsConferencingConfiguration.md similarity index 84% rename from skype/skype-ps/skype/Set-CsConferencingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsConferencingConfiguration.md index 6af69082b4..cab42bd8de 100644 --- a/skype/skype-ps/skype/Set-CsConferencingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsConferencingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csconferencingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsConferencingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csconferencingconfiguration +schema: 2.0.0 +title: Set-CsConferencingConfiguration --- # Set-CsConferencingConfiguration @@ -68,7 +69,7 @@ After these custom settings have been created, you can modify any of them (or mo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsConferencingConfiguration -Identity global -Organization Litwareinc ``` @@ -77,7 +78,7 @@ In Example 1, the `Set-CsConferencingConfiguration` cmdlet modifies the global i This is done by including the Organization parameter followed by the organization name: Litwareinc. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsConferencingConfiguration | Set-CsConferencingConfiguration -Organization Litwareinc ``` @@ -87,7 +88,7 @@ To do this the command first uses the `Get-CsConferencingConfiguration` cmdlet t This collection is then piped to the `Set-CsConferencingConfiguration` cmdlet, which takes each item in the collection and changes the value of the Organization property to Litwareinc. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsConferencingConfiguration -Filter site:* | Set-CsConferencingConfiguration -MaxContentStorageMb 50 ``` @@ -97,7 +98,7 @@ To do this, the command first calls the `Get-CsConferencingConfiguration` cmdlet The filtered collection is then piped to the `Set-CsConferencingConfiguration` cmdlet, which changes the MaxContentStorageMb property value for each item in the collection to 50. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsConferencingConfiguration | Where-Object {$_.MaxContentStorageMb -gt 100} | Set-CsConferencingConfiguration -MaxContentStorageMB 100 ``` @@ -108,7 +109,7 @@ This collection is then piped to the `Where-Object` cmdlet, which picks out thos This filtered collection is then piped to the `Set-CsConferencingConfiguration` cmdlet, which takes each item in the collection and sets the value of the MaxContentStorageMb property to 100. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Set-CsConferencingConfiguration -Identity site:Redmond -ContentGracePeriod "22:00:00" ``` @@ -116,7 +117,7 @@ Set-CsConferencingConfiguration -Identity site:Redmond -ContentGracePeriod "22:0 Example 5 retrieves the conferencing configuration settings for the Redmond site (-Identity site:Redmond) and modifies the value of the ContentGracePeriod property, setting the grace period to 22 hours (22 hours: 00 minutes: 00 seconds). -### -------------------------- Example 6 -------------------------- +### Example 6 ``` Get-CsConferencingConfiguration | Where-Object {$_.Organization -ne "Fabrikam"} | Set-CsConferencingConfiguration -Organization Litwareinc ``` @@ -129,46 +130,10 @@ The filtered collection is then piped to the `Set-CsConferencingConfiguration` c ## PARAMETERS -### -Identity -Unique identifier for the collection of conferencing configuration settings to be modified. -To refer to the global collection, use this syntax: `-Identity global`. -To refer to a collection configured at the site scope, use syntax similar to this: `-Identity "site:Redmond"`. -To refer to a collection at the service scope, use syntax like the following: `-Identity "service:ConferencingServer:atl-cs-001.litwareinc.com"`. -The Web Conferencing service is the only service that can host these configuration settings. - -If this parameter is not specified, then the `Set-CsConferencingConfiguration` cmdlet will automatically modify the global settings. - - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -ClientAppSharingPort -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -ClientAppSharingPort Represents the starting port number used for application sharing. The ClientAppSharingPort must be a value port number between 1024 and 65535, inclusive. The default value is 5350. @@ -176,8 +141,7 @@ The default value is 5350. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -187,6 +151,9 @@ Accept wildcard characters: False ``` ### -ClientAppSharingPortRange + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the total number of ports available for application sharing. (The default value is 40.) To determine the actual ports used for application sharing, use this value and the ClientAppSharingPort value. For example, if ClientAppSharingPort is set to 5350 and ClientAppSharingPortRange is set to 3, then the following 3 ports are available for application sharing: 5350; 5351; 5352. @@ -194,8 +161,7 @@ For example, if ClientAppSharingPort is set to 5350 and ClientAppSharingPortRang ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -205,6 +171,9 @@ Accept wildcard characters: False ``` ### -ClientAudioPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the starting port number used for client audio. The ClientAudioPort must be a value port number between 1024 and 65535, inclusive. The default value is 5350. @@ -212,8 +181,7 @@ The default value is 5350. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -223,6 +191,9 @@ Accept wildcard characters: False ``` ### -ClientAudioPortRange + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the total number of ports available for client audio. (The default value is 40.) To determine the actual ports used for client audio, use this value and the ClientAudioPort value. For example, if ClientAudioPort is set to 5350 and ClientAudioPortRange is set to 3, then the following three ports are available for client audio: 5350; 5351; 5352. @@ -230,8 +201,7 @@ For example, if ClientAudioPort is set to 5350 and ClientAudioPortRange is set t ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -241,6 +211,9 @@ Accept wildcard characters: False ``` ### -ClientFileTransferPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the starting port number used for file transfers. The ClientFileTransferPort must be a value port number between 1024 and 65535, inclusive. The default value is 5350. @@ -248,8 +221,7 @@ The default value is 5350. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -259,6 +231,9 @@ Accept wildcard characters: False ``` ### -ClientFileTransferPortRange + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the total number of ports available for file transfers. (The default value is 40.) To determine the actual ports used for file transfers, use this value and the ClientFileTransferPort value. For example, if ClientFileTransferPort is set to 5350 and ClientFileTransferPortRange is set to 3, then the following three ports are available for file transfers: 5350; 5351; 5352. @@ -266,8 +241,7 @@ For example, if ClientFileTransferPort is set to 5350 and ClientFileTransferPort ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -277,6 +251,9 @@ Accept wildcard characters: False ``` ### -ClientMediaPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the starting port number used for client media. Use this parameter for Microsoft Office Communicator 2007 R2 clients. The ClientMediaPort must be a value port number between 1024 and 65535, inclusive. @@ -286,8 +263,7 @@ The default value is 5350. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -297,6 +273,9 @@ Accept wildcard characters: False ``` ### -ClientMediaPortRange + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the total number of ports available for client media. (The default value is 40.) Use this parameter for Office Communicator 2007 R2 clients. To determine the actual ports used for client media, use this value and the ClientMediaPort value. @@ -306,8 +285,7 @@ For example, if ClientMediaPort is set to 5350 and ClientMediaPortRange is set t ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -317,14 +295,16 @@ Accept wildcard characters: False ``` ### -ClientMediaPortRangeEnabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, clients will use the specified port range for media traffic. When set to False (the default value) any available port (from port 1024 through port 65535) will be used to accommodate media traffic. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -334,6 +314,9 @@ Accept wildcard characters: False ``` ### -ClientSipDynamicPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the starting port number used for SIP traffic. The ClientSipDynamicPort must be a value port number between 1024 and 65535, inclusive. The default value is 7100. @@ -341,8 +324,7 @@ The default value is 7100. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -352,6 +334,9 @@ Accept wildcard characters: False ``` ### -ClientSipDynamicPortRange + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the total number of ports available for SIP traffic. (The default value is 3.) To determine the actual ports used for SIP traffic, use this value and the ClientSipDynamicPort value. For example, if ClientSipDynamicPort is set to 7100 and ClientSipDynamicPortRange is set to 3, then the following 3 ports are available for client media: 7100; 7101; 7102. @@ -359,8 +344,7 @@ For example, if ClientSipDynamicPort is set to 7100 and ClientSipDynamicPortRang ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -370,6 +354,9 @@ Accept wildcard characters: False ``` ### -ClientVideoPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the starting port number used for client video. The ClientVideoPort must be a value port number between 1024 and 65535, inclusive. The default value is 5350. @@ -377,8 +364,7 @@ The default value is 5350. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -388,6 +374,9 @@ Accept wildcard characters: False ``` ### -ClientVideoPortRange + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the total number of ports available for client video. (The default value is 40.) To determine the actual ports used for client video, use this value and the ClientVideoPort value. For example, if ClientVideoPort is set to 5350 and ClientVideoPortRange is set to 3, then the following three ports are available for client video: 5350; 5351; 5352. @@ -395,8 +384,43 @@ For example, if ClientVideoPort is set to 5350 and ClientVideoPortRange is set t ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudPollServicePrimaryUrl + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not currently used with Skype for Business Server. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CloudPollServiceSecondaryUrl + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not currently used with Skype for Business Server. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -406,6 +430,9 @@ Accept wildcard characters: False ``` ### -ConsoleDownloadExternalUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URL where external users can download a supported client such as Skype for Business. Note that this setting applies only to legacy clients (such as Microsoft Office Communicator 2007 R2) that are logging on to a Skype for Business Server pool. @@ -413,8 +440,7 @@ Note that this setting applies only to legacy clients (such as Microsoft Office ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -424,6 +450,9 @@ Accept wildcard characters: False ``` ### -ConsoleDownloadInternalUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URL where internal users can download a supported client such as Skype for Business. Note that this setting applies only to legacy clients (such as Microsoft Office Communicator 2007 R2) that are logging on to a Skype for Business Server pool. @@ -431,8 +460,7 @@ Note that this setting applies only to legacy clients (such as Microsoft Office ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -442,6 +470,9 @@ Accept wildcard characters: False ``` ### -ContentGracePeriod + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates how long conference content will remain on the server following the end of the conference. The ContentGracePeriod must be specified using the format Days.Hours:Minutes:Seconds. For example, to set the content grace period to 30 days, use this syntax: `-ContentGracePeriod 30.00:00:00`. @@ -453,8 +484,7 @@ The default value is 15 days (15.00:00:00). ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -463,30 +493,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HelpdeskExternalUrl -URL where external users who click Help during a conference will be directed. +### -EncryptArchivedData + +> Applicable: Skype for Business Server 2019 + +Boolean flag to turn on/off encryption for a conference's archived attachments. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -HelpdeskInternalUrl -URL where internal users who click Help during a conference will be directed. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -495,16 +529,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxBandwidthPerAppSharingServiceMb -Indicates the maximum amount of bandwidth (in megabytes) set aside for the Application Sharing Conferencing service. -MaxBandwidthPerAppSharingServiceMb can be set to any integer value between 50 and 100000, inclusive. -The default value is 375 megabytes. +### -HelpdeskExternalUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL where external users who click Help during a conference will be directed. ```yaml -Type: UInt64 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -513,16 +547,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxContentStorageMb -Maximum amount of file space (in megabytes) allowed for the storage of meeting content. -MaxContentStorageMb can be set to any integer value between 50 and 1024 (1 gigabyte), inclusive. -The default value is 500 megabytes. +### -HelpdeskInternalUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL where internal users who click Help during a conference will be directed. ```yaml -Type: UInt16 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -531,46 +565,61 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Organization -Name of the organization hosting the conference. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the collection of conferencing configuration settings to be modified. +To refer to the global collection, use this syntax: `-Identity global`. +To refer to a collection configured at the site scope, use syntax similar to this: `-Identity "site:Redmond"`. +To refer to a collection at the service scope, use syntax like the following: `-Identity "service:ConferencingServer:atl-cs-001.litwareinc.com"`. +The Web Conferencing service is the only service that can host these configuration settings. + +If this parameter is not specified, then the `Set-CsConferencingConfiguration` cmdlet will automatically modify the global settings. + ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MaxBandwidthPerAppSharingServiceMb + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum amount of bandwidth (in megabytes) set aside for the Application Sharing Conferencing service. +MaxBandwidthPerAppSharingServiceMb can be set to any integer value between 50 and 100000, inclusive. +The default value is 375 megabytes. ```yaml -Type: SwitchParameter +Type: UInt64 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -579,14 +628,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -MaxContentStorageMb + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Maximum amount of file space (in megabytes) allowed for the storage of meeting content. +MaxContentStorageMb can be set to any integer value between 50 and 1024 (1 gigabyte), inclusive. +The default value is 500 megabytes. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -596,6 +649,9 @@ Accept wildcard characters: False ``` ### -MaxUploadFileSizeMb + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Maximum total size of the files (including handouts and PowerPoint slides) that can be used in a given conference. This setting is typically used when conference content is being archived in Microsoft Exchange Server: by setting a maximum upload file size you can ensure that the content used in the conference (and thus the content which must be archived) does not exceed the maximum file size configured for Microsoft Exchange. The default value is 500 megabytes. @@ -603,8 +659,7 @@ The default value is 500 megabytes. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -613,14 +668,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CloudPollServicePrimaryUrl -This parameter is not currently used with Skype for Business Server. +### -Organization + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the organization hosting the conference. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -629,14 +686,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CloudPollServiceSecondaryUrl -This parameter is not currently used with Skype for Business Server. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -645,18 +704,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EncryptArchivedData -Boolean flag to turn on/off encryption for a conference's archived attachments. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2019 +Aliases: wi Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` @@ -666,13 +727,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConfSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConfSettings + The `Set-CsConferencingConfiguration` cmdlet accepts pipelined instances of the conferencing configuration object. ## OUTPUTS -### +### None The `Set-CsConferencingConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WebConf.ConfSettings object. diff --git a/skype/skype-ps/skype/Set-CsConferencingPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsConferencingPolicy.md similarity index 84% rename from skype/skype-ps/skype/Set-CsConferencingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsConferencingPolicy.md index 96b5bc05d9..19409e1f0a 100644 --- a/skype/skype-ps/skype/Set-CsConferencingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsConferencingPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csconferencingpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsConferencingPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/set-csconferencingpolicy +schema: 2.0.0 +title: Set-CsConferencingPolicy --- # Set-CsConferencingPolicy @@ -87,7 +89,7 @@ The following parameters are not applicable to Skype for Business Online: Applic ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsConferencingPolicy -Identity SalesConferencingPolicy -AllowConferenceRecording $False ``` @@ -96,7 +98,7 @@ The command shown in Example 1 modifies a property value of the conferencing pol To do this, the `Set-CsConferencingPolicy` cmdlet is called along with the Identity parameter and the AllowConferenceRecording parameter. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsConferencingPolicy | Set-CsConferencingPolicy -AllowAnonymousParticipantsInMeetings $False -EnableDialInConferencing $False ``` @@ -106,7 +108,7 @@ To do this, the command first uses the `Get-CsConferencingPolicy` cmdlet to retu That collection is then piped to the `Set-CsConferencingPolicy` cmdlet, which sets the value of both the AllowAnonymousParticipantsInMeetings and EnableDialInConferencing properties to False for each policy in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsConferencingPolicy -Filter "site:*" | Set-CsConferencingPolicy -MaxVideoConferenceResolution CIF ``` @@ -116,7 +118,7 @@ To accomplish this task the command first calls the `Get-CsConferencingPolicy` c This filtered collection is then piped to the `Set-CsConferencingPolicy` cmdlet, which sets the MaxVideoConferenceResolution property for each policy in the collection to "CIF". -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsConferencingPolicy | Where-Object {$_.MaxMeetingSize -gt 100} | Set-CsConferencingPolicy -MaxMeetingSize 100 ``` @@ -129,48 +131,10 @@ The filtered collection is then piped to the `Set-CsConferencingPolicy` cmdlet, ## PARAMETERS -### -Identity -Unique identifier for the conferencing policy to be modified. -Conferencing policies can be configured at the global, site, or per-user scopes. -To modify the global policy, use this syntax: `-Identity global`. -To modify a site policy, use syntax similar to this: `-Identity site:Redmond`. -To modify a per-user policy, use syntax similar to this: `-Identity SalesConferencingPolicy`. - -Note that wildcards are not allowed when specifying an Identity. -If you do not specify an Identity the `Set-CsConferencingPolicy` cmdlet will automatically modify the global conferencing policy. - - -```yaml -Type: XdsIdentity -Parameter Sets: Identity, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. - - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +### -AllowAnnotations -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -AllowAnnotations Indicates whether or not participants are allowed to make on-screen annotations on any content shared during the meeting; in addition, this setting determines whether or not whiteboarding is allowed in the conference. The default value is True. @@ -182,8 +146,7 @@ However, the user can participate in other conferences where annotations are all ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -193,6 +156,9 @@ Accept wildcard characters: False ``` ### -AllowAnonymousParticipantsInMeetings + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether anonymous users are allowed to participate in the meeting. If set to False then only authenticated users (that is, users logged on to your Active Directory Domain Services or the Active Directory of a federated partner) are allowed to attend the meeting. The default value is True. @@ -204,8 +170,7 @@ However, the user can take part in other conferences where anonymous participant ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -215,6 +180,9 @@ Accept wildcard characters: False ``` ### -AllowAnonymousUsersToDialOut + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether or not anonymous users (for example, unauthenticated users) are allowed to join a conference using dial-out phoning. With dial-out phoning the conferencing server will telephone the user; when the user answers the phone, he or she will be joined to the conference. @@ -228,8 +196,7 @@ The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -239,6 +206,9 @@ Accept wildcard characters: False ``` ### -AllowConferenceRecording + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether users are allowed to record the meeting. The default value is False. @@ -247,8 +217,7 @@ This setting applies to all users taking part in the conference. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -258,6 +227,9 @@ Accept wildcard characters: False ``` ### -AllowExternalUserControl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether external users (either anonymous users or federated) are allowed to take control of shared applications or desktops. The default value is False. @@ -268,8 +240,7 @@ That means that some users in a session might be allowed to give up control of a ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -278,18 +249,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowExternalUsersToSaveContent -Indicates whether external users (that is, users not currently logged-on to your network) are allowed to save handouts, slides and other meeting content. -The default value is True. +### -AllowExternalUsersToRecordMeeting + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether external users (either anonymous users or federated users) are allowed to record the meeting. +The default value is False. + +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow external users to record conferences. +However, the user can take part in other conferences where external users are allowed to record meetings. + +Note that this setting takes effect only if the AllowConferenceRecording property is set to True. -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow external users to save content. -However, the user can take part in other conferences where external users are allowed to save content. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -298,18 +274,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowIPAudio -Indicates whether or not computer audio is allowed in the meeting. +### -AllowExternalUsersToSaveContent + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether external users (that is, users not currently logged-on to your network) are allowed to save handouts, slides and other meeting content. The default value is True. -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow IP audio. -However, the user can take part in other conferences where IP audio is allowed. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow external users to save content. +However, the user can take part in other conferences where external users are allowed to save content. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -318,39 +296,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowIPVideo -Indicates whether or not computer video is allowed in the meeting. -The default value is True. +### -AllowFederatedParticipantJoinAsSameEnterprise + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether a federated user will be directly admitted into conference bypassing the lobby. The default value is False. + +If set to False and AllowAnonymousParticipantsInMeetings parameter is also set to False, federated users will be treated as anonymous users and put into lobby. +If set to True and conference admission policy is set to "Anyone from my organization" or openAuthenticated, federated users are treated as company users and admitted into conference directly. +If set to True and conference admission policy is set to "People I Invite" or closedAuthenticated, federated users will be put into the lobby if they were not present in the pre-set invitee list. -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow IP video. -However, the user can take part in other conferences where IP video is allowed. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named -Default value: None +Default value: False Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowParticipantControl -Indicates whether or not meeting participants are allowed to take control of applications or desktops shared during the meeting. -The default value is True. +### -AllowIPAudio -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow participant control. -However, the user can take part in other conferences where participant control is allowed. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not computer audio is allowed in the meeting. +The default value is True. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow IP audio. +However, the user can take part in other conferences where IP audio is allowed. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -359,18 +341,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPolls -Indicates whether or not users are allowed to conduct online polls during a meeting. +### -AllowIPVideo + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not computer video is allowed in the meeting. The default value is True. -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow polls. -However, the user can take part in other conferences where polls are allowed. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow IP video. +However, the user can take part in other conferences where IP video is allowed. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -379,18 +363,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowUserToScheduleMeetingsWithAppSharing -Indicates whether or not users are allowed to organize meetings that include application sharing. -The default value is True. +### -AllowLargeMeetings -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow application sharing. -However, the user can take part in other conferences where application sharing is allowed. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, all online meetings are treated as "large meeting." With a large meeting, restrictions are placed on the number of notifications that are sent to participants as well as the size of the meeting roster that is transmitted by default. + +The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -399,15 +383,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide additional text about the conferencing policy. -For example, the Description might indicate the users the policy should be assigned to. +### -AllowMultiView + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) enables users to schedule conferences that allow multiview; that is, clients can receive multiple video streams during a given conference. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy can include multiview. +However, the user can participate in other conferences where multiview is allowed. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -416,28 +403,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAppDesktopSharing -Indicates whether participants are allowed to share applications (or their desktop) during the course of a meeting. -Allowed values include: - -Desktop. -Users are allowed to share their entire desktop. +### -AllowNonEnterpriseVoiceUsersToDialOut -SingleApplication. -Users are allowed to share a single application. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -None. -Users are not allowed to share applications or their desktop. +Indicates whether or users who have not been enabled for Enterprise Voice are allowed to join a conference using dial-out phoning. +With dial-out phoning the conferencing server will telephone the user; when the user answers the phone, he or she will be joined to the conference. +Note that dial-in conferencing is allowed even when this setting is False. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow users who have not been enabled for Enterprise Voice to join the conference via dial-out phoning. +However, the user can take part in other conferences where users who have not been enabled for Enterprise Voice can join via dial out. -The default value is Desktop. +The default value is False ($False). ```yaml -Type: EnableAppDesktopSharing +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -446,17 +429,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableDataCollaboration -Indicates whether users can organize meetings that include data collaboration activities such as whiteboarding and annotations. +### -AllowOfficeContent + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to False, prevents users from using Office content in their conferences. -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow data collaboration. -However, the user can take part in other conferences where data collaboration is allowed. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -465,20 +448,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableDialInConferencing -This parameter is not available in Skype for Business Online. +### -AllowParticipantControl -Indicates whether users are able to join the meeting by dialing in with a public switched telephone network (PSTN) telephone. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not meeting participants are allowed to take control of applications or desktops shared during the meeting. The default value is True. -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow dial-in conferencing. -However, the user can take part in other conferences where dial-in conferencing is allowed. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow participant control. +However, the user can take part in other conferences where participant control is allowed. + ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -487,18 +471,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableFileTransfer -Indicates whether file transfers to all the meeting participants are allowed during the meeting. +### -AllowPolls + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not users are allowed to conduct online polls during a meeting. The default value is True. -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow file transfers. -However, the user can take part in other conferences where file transfers are allowed. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow polls. +However, the user can take part in other conferences where polls are allowed. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -507,18 +493,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableP2PFileTransfer -Indicates whether peer-to-peer file transfers (that is, file transfers that do not involve all participants) are allowed during the meeting. -The default value is True ($True). +### -AllowQandA + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) the user will be able to include the Questions and Answers Manager in any online conference that he or she organizes. +When set to False, the user will be prohibited from including Questions and Answers Manager in any of his or her conferences. + +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow the use of the Questions and Answers Manager. +However, the user can make use of the Questions and Answers Manager in other conferences where polls are allowed. -This setting is enforced at the per-user level. -That means that one user in a peer-to-peer communication session might be allowed to transfer files while the other user is not. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -527,19 +516,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableP2PRecording -If True, users will be able to record peer-to-peer communication sessions. -The default value is False. +### -AllowSharedNotes -This setting is enforced at the per-user level. -That means that one user in a peer-to-peer communication session might be allowed to record the session while the other user is not. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True (the default value) any open OneNote notebooks linked to the conference will automatically be updated with information such as conference participants and details about content shared during the conference. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -548,19 +534,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableP2PVideo -If True, users will be able to take part in peer-to-peer video communication sessions. -The default value is False. +### -AllowUserToScheduleMeetingsWithAppSharing -This setting is enforced at the per-user level. -That means that one user in a peer-to-peer communication session might be allowed to use video while the other user is not. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Indicates whether or not users are allowed to organize meetings that include application sharing. +The default value is True. + +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow application sharing. +However, the user can take part in other conferences where application sharing is allowed. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -569,23 +556,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxMeetingSize -Indicates the maximum number of people who are allowed to attend a meeting. -After the maximum number of participants has been reached anyone else who tries to join the meeting will be turned away with the notice that the meeting is full. -The number of participants specified in this value can be any 32-bit whole number (any value between 1 and 4,294,967,295), but the recommended size is between 2 and 250, inclusive; the default value is 250. +### -ApplicationSharingMode -250 is the maximum for shared pool deployments, based on Microsoft testing. -For information about supporting meeting with more than 250 participants, see "Microsoft Lync Server 2010 Support for Large Meetings" at https://go.microsoft.com/fwlink/p/?linkId=242073 (https://go.microsoft.com/fwlink/p/?linkId=242073). +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -This setting applies to the user who organizes the conference: no conference created by a user affected by this policy will allow more than the specified number of participants. -However, the user can take part in other conferences where additional participants are allowed. +Determines the protocol used for screen sharing - VbSS vs RDP. This parameter is used only in SfB Server. To disable VbSS, use the value "RDP". ```yaml -Type: UInt32 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -594,23 +575,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxVideoConferenceResolution -Indicates the maximum resolution for meeting video. -Allowed values are: +### -AppSharingBitRateKb -CIF. -Common Intermediate Format (CIF) has a resolution of 352 pixels by 288 pixels. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -VGA. -VGA has a resolution of 640 pixels by 480 pixels. +Bit rate (in kilobits) used for application sharing. +The default value is 50000. -The default value is VGA. ```yaml -Type: MaxVideoConferenceResolution +Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -619,14 +595,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -AudioBitRateKb + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Bit rate (in kilobits) used for audio transmissions. +The audio bit rate can be any whole number between 20 and 200, inclusive; the default value is 200. + +This setting is enforced at the per-user level, and for both conferences and peer-to-peer communication sessions. + ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -635,14 +617,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -CloudRecordingServiceSupport + +> Applicable: Skype for Business Online + +PARAMVALUE: NotSupported | Supported | Required ```yaml -Type: SwitchParameter +Type: CloudRecordingServiceSupport Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -651,14 +635,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to provide additional text about the conferencing policy. +For example, the Description might indicate the users the policy should be assigned to. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -667,21 +654,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowExternalUsersToRecordMeeting -Indicates whether external users (either anonymous users or federated users) are allowed to record the meeting. -The default value is False. - -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow external users to record conferences. -However, the user can take part in other conferences where external users are allowed to record meetings. +### -DisablePowerPointAnnotations -Note that this setting takes effect only if the AllowConferenceRecording property is set to True. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True ($True) users will not be able to add annotations to PowerPoint slides used in a conference. +However (depending on the value of the AllowAnnotations property), users will still have access to other whiteboarding features. +The default value is False, meaning that PowerPoint annotations are allowed. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -690,16 +674,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AppSharingBitRateKb -Bit rate (in kilobits) used for application sharing. -The default value is 50000. +### -EnableAppDesktopSharing + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether participants are allowed to share applications (or their desktop) during the course of a meeting. +Allowed values include: + +Desktop. +Users are allowed to share their entire desktop. +SingleApplication. +Users are allowed to share a single application. + +None. +Users are not allowed to share applications or their desktop. + + + +The default value is Desktop. ```yaml -Type: Int64 +Type: EnableAppDesktopSharing Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -708,18 +706,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AudioBitRateKb -Bit rate (in kilobits) used for audio transmissions. -The audio bit rate can be any whole number between 20 and 200, inclusive; the default value is 200. +### -EnableDataCollaboration -This setting is enforced at the per-user level, and for both conferences and peer-to-peer communication sessions. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether users can organize meetings that include data collaboration activities such as whiteboarding and annotations. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow data collaboration. +However, the user can take part in other conferences where data collaboration is allowed. ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -728,18 +727,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FileTransferBitRateKb -Bit rate (in kilobits) used for file transfers. -The default value is 50000. +### -EnableDialInConferencing -This setting is enforced at the per-user level and for both conferences and peer-to-peer communication sessions. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +This parameter is not available in Skype for Business Online. + +Indicates whether users are able to join the meeting by dialing in with a public switched telephone network (PSTN) telephone. +The default value is True. + +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow dial-in conferencing. +However, the user can take part in other conferences where dial-in conferencing is allowed. ```yaml -Type: Int64 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -748,18 +751,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VideoBitRateKb -Bit rate (in kilobits) used for video transmissions. -The default value is 50000. +### -EnableFileTransfer -This setting is enforced at the per-user level and for both conferences and peer-to-peer communication sessions. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether file transfers to all the meeting participants are allowed during the meeting. +The default value is True. +This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow file transfers. +However, the user can take part in other conferences where file transfers are allowed. ```yaml -Type: Int64 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -768,16 +773,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowLargeMeetings -When set to True, all online meetings are treated as "large meeting." With a large meeting, restrictions are placed on the number of notifications that are sent to participants as well as the size of the meeting roster that is transmitted by default. +### -EnableMultiViewJoin -The default value is False ($False). +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) clients will attempt to join a conference using multiview (which allows the client to receive multiple video streams during the conference). +This parameter will be ignored if multiview is not allowed in the conference being joined. +This setting is enforced at the per-user level and for both conferences and peer-to-peer communication sessions. +That means that some users in a session might be allowed to have multiple video streams while other users in the same conference might not. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -786,16 +794,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowMultiView -When set to True (the default value) enables users to schedule conferences that allow multiview; that is, clients can receive multiple video streams during a given conference. -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy can include multiview. -However, the user can participate in other conferences where multiview is allowed. +### -EnableOnlineMeetingPromptForLyncResources + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, users will be prompted any time they schedule a meeting in Outlook that includes invitees (such as a meeting room) that would benefit from having the meeting held online. +The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -804,22 +813,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowNonEnterpriseVoiceUsersToDialOut -Indicates whether or users who have not been enabled for Enterprise Voice are allowed to join a conference using dial-out phoning. -With dial-out phoning the conferencing server will telephone the user; when the user answers the phone, he or she will be joined to the conference. +### -EnableP2PFileTransfer -Note that dial-in conferencing is allowed even when this setting is False. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow users who have not been enabled for Enterprise Voice to join the conference via dial-out phoning. -However, the user can take part in other conferences where users who have not been enabled for Enterprise Voice can join via dial out. +Indicates whether peer-to-peer file transfers (that is, file transfers that do not involve all participants) are allowed during the meeting. +The default value is True ($True). -The default value is False ($False). +This setting is enforced at the per-user level. +That means that one user in a peer-to-peer communication session might be allowed to transfer files while the other user is not. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -828,14 +835,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSharedNotes -When set to True (the default value) any open OneNote notebooks linked to the conference will automatically be updated with information such as conference participants and details about content shared during the conference. +### -EnableP2PRecording + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, users will be able to record peer-to-peer communication sessions. +The default value is False. + +This setting is enforced at the per-user level. +That means that one user in a peer-to-peer communication session might be allowed to record the session while the other user is not. + ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -844,16 +858,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisablePowerPointAnnotations -When set to True ($True) users will not be able to add annotations to PowerPoint slides used in a conference. -However (depending on the value of the AllowAnnotations property), users will still have access to other whiteboarding features. -The default value is False, meaning that PowerPoint annotations are allowed. +### -EnableP2PVideo + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, users will be able to take part in peer-to-peer video communication sessions. +The default value is False. + +This setting is enforced at the per-user level. +That means that one user in a peer-to-peer communication session might be allowed to use video while the other user is not. + ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -862,17 +881,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMultiViewJoin -When set to True (the default value) clients will attempt to join a conference using multiview (which allows the client to receive multiple video streams during the conference). -This parameter will be ignored if multiview is not allowed in the conference being joined. -This setting is enforced at the per-user level and for both conferences and peer-to-peer communication sessions. -That means that some users in a session might be allowed to have multiple video streams while other users in the same conference might not. +### -EnableReliableConferenceDeletion + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to true, the conference state is removed from all replicas when the user deletes it, to provide instantaneous consistency of distributed conference state. +If set to false, the deleted conference state is eventual and not instantaneous. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -881,16 +900,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TotalReceiveVideoBitRateKb -Indicates the maximum allowed bitrate (in kilobytes per second) for all the video used in a conference; that is, the combined total for all the video streams. -The default value is 50000 kilobits per second. +### -FileTransferBitRateKb + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Bit rate (in kilobits) used for file transfers. +The default value is 50000. + +This setting is enforced at the per-user level and for both conferences and peer-to-peer communication sessions. ```yaml Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -899,57 +922,88 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowFederatedParticipantJoinAsSameEnterprise -Indicates whether a federated user will be directly admitted into conference bypassing the lobby. The default value is False. +### -Force -If set to False and AllowAnonymousParticipantsInMeetings parameter is also set to False, federated users will be treated as anonymous users and put into lobby. -If set to True and conference admission policy is set to "Anyone from my organization" or openAuthenticated, federated users are treated as company users and admitted into conference directly. -If set to True and conference admission policy is set to "People I Invite" or closedAuthenticated, federated users will be put into the lobby if they were not present in the pre-set invitee list. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named -Default value: False +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowOfficeContent -When set to False, prevents users from using Office content in their conferences. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the conferencing policy to be modified. +Conferencing policies can be configured at the global, site, or per-user scopes. +To modify the global policy, use this syntax: `-Identity global`. +To modify a site policy, use syntax similar to this: `-Identity site:Redmond`. +To modify a per-user policy, use syntax similar to this: `-Identity SalesConferencingPolicy`. + +Note that wildcards are not allowed when specifying an Identity. +If you do not specify an Identity the `Set-CsConferencingPolicy` cmdlet will automatically modify the global conferencing policy. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity, (All) +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowQandA -When set to True (the default value) the user will be able to include the Questions and Answers Manager in any online conference that he or she organizes. -When set to False, the user will be prohibited from including Questions and Answers Manager in any of his or her conferences. +### -Instance -This setting applies to the user who organizes the conference: if set to False, no conference created by a user affected by this policy will allow the use of the Questions and Answers Manager. -However, the user can make use of the Questions and Answers Manager in other conferences where polls are allowed. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: Boolean +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -MaxMeetingSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum number of people who are allowed to attend a meeting. +After the maximum number of participants has been reached anyone else who tries to join the meeting will be turned away with the notice that the meeting is full. +The number of participants specified in this value can be any 32-bit whole number (any value between 1 and 4,294,967,295), but the recommended size is between 2 and 250, inclusive; the default value is 250. + +250 is the maximum for shared pool deployments, based on Microsoft testing. +For information about supporting meeting with more than 250 participants, see "Microsoft Lync Server 2010 Support for Large Meetings" at https://go.microsoft.com/fwlink/p/?linkId=242073 (https://go.microsoft.com/fwlink/p/?linkId=242073). + +This setting applies to the user who organizes the conference: no conference created by a user affected by this policy will allow more than the specified number of participants. +However, the user can take part in other conferences where additional participants are allowed. + + +```yaml +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -958,15 +1012,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplicationSharingMode -Determines the protocol used for screen sharing - VbSS vs RDP. This parameter is used only in SfB Server. To disable VbSS, use the value "RDP". +### -MaxVideoConferenceResolution + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum resolution for meeting video. +Allowed values are: + +CIF. +Common Intermediate Format (CIF) has a resolution of 352 pixels by 288 pixels. + +VGA. +VGA has a resolution of 640 pixels by 480 pixels. +The default value is VGA. ```yaml -Type: String +Type: MaxVideoConferenceResolution Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -975,14 +1039,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CloudRecordingServiceSupport -PARAMVALUE: NotSupported | Supported | Required +### -Tenant + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the conferencing policy is being modified. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` + ```yaml -Type: CloudRecordingServiceSupport +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -991,15 +1065,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOnlineMeetingPromptForLyncResources -When set to True, users will be prompted any time they schedule a meeting in Outlook that includes invitees (such as a meeting room) that would benefit from having the meeting held online. -The default value is False. +### -TotalReceiveVideoBitRateKb + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum allowed bitrate (in kilobytes per second) for all the video used in a conference; that is, the combined total for all the video streams. +The default value is 50000 kilobits per second. + ```yaml -Type: Boolean +Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1008,15 +1085,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableReliableConferenceDeletion -When set to true, the conference state is removed from all replicas when the user deletes it, to provide instantaneous consistency of distributed conference state. -If set to false, the deleted conference state is eventual and not instantaneous. +### -VideoBitRateKb + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Bit rate (in kilobits) used for video transmissions. +The default value is 50000. + +This setting is enforced at the per-user level and for both conferences and peer-to-peer communication sessions. + ```yaml -Type: Boolean +Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -1025,22 +1107,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the conferencing policy is being modified. -For example: +### -Confirm -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +Prompts you for confirmation before executing the command. -`Get-CsTenant | Select-Object DisplayName, TenantID` +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -1054,13 +1148,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Meeting.MeetingPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Meeting.MeetingPolicy + The `Set-CsConferencingPolicy` cmdlet accepts pipelined instances of the meeting policy object. ## OUTPUTS -### +### None The `Set-CsConferencingPolicy` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Meeting.MeetingPolicy object. diff --git a/skype/skype-ps/skype/Set-CsConfigurationStoreLocation.md b/skype/skype-ps/SkypeForBusiness/Set-CsConfigurationStoreLocation.md similarity index 84% rename from skype/skype-ps/skype/Set-CsConfigurationStoreLocation.md rename to skype/skype-ps/SkypeForBusiness/Set-CsConfigurationStoreLocation.md index e52a31a523..338c6f9bef 100644 --- a/skype/skype-ps/skype/Set-CsConfigurationStoreLocation.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsConfigurationStoreLocation.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csconfigurationstorelocation applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsConfigurationStoreLocation -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csconfigurationstorelocation +schema: 2.0.0 +title: Set-CsConfigurationStoreLocation --- # Set-CsConfigurationStoreLocation @@ -39,7 +40,7 @@ The cmdlet then sets the store location to the FQDN of that computer. ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsConfigurationStoreLocation -SqlServerFqdn atl-sql-001.litwareinc.com -SqlInstanceName Rtc ``` @@ -48,7 +49,7 @@ The command shown in Example 1 sets the Active Directory service control point f In this example, the SCP points to the computer atl-sql-001.litwareinc.com and to the SQL Server instance Rtc. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsConfigurationStoreLocation -SqlServerFqdn atl-sql-001.litwareinc.com -SqlInstanceName Rtc -Report C:\Logs\Store_Location.html ``` @@ -61,17 +62,18 @@ This log is generated by including the Report parameter followed by the full pat ## PARAMETERS -### -SqlServerFqdn -Fully qualified domain name (FQDN) of the computer where the Central Management store has been installed. -For example: `-SqlServer atl-sql-001.litwareinc.com`. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -79,6 +81,9 @@ Accept wildcard characters: False ``` ### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a domain controller where global settings are stored. If global settings are stored in the Active Directory System container, then this parameter must point to the root domain controller. If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. @@ -86,8 +91,7 @@ If global settings are stored in the Configuration container, then any domain co ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,16 +100,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlInstanceName -Name of the SQL Server instance containing the Skype for Business Server tables and data. +### -MirrorSqlInstanceName + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the SQL Server instance containing the Skype for Business Server mirror database tables and data. For example: `-SqlInstanceName "rtc"`. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -114,18 +120,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipLookup -If this parameter is included then the `Set-CsConfigurationStoreLocation` cmdlet will not verify that the specified computer and the specified instance of SQL Server are available. -Instead, it will simply change the service control point. +### -MirrorSqlServerFqdn -If this parameter is not included then both the specified computer and the specified instance of SQL Server must be available before the SCP will be changed. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Fully qualified domain name (FQDN) of the computer where the Central Management store mirror database has been installed. +For example: `-SqlServer atl-mirror-001.litwareinc.com`. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,14 +139,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: `-Report "C:\Logs\ConfigurationStore.html"` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,15 +158,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: `-Report "C:\Logs\ConfigurationStore.html"` +### -SkipLookup + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If this parameter is included then the `Set-CsConfigurationStoreLocation` cmdlet will not verify that the specified computer and the specified instance of SQL Server are available. +Instead, it will simply change the service control point. + +If this parameter is not included then both the specified computer and the specified instance of SQL Server must be available before the SCP will be changed. + ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,14 +180,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SqlInstanceName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the SQL Server instance containing the Skype for Business Server tables and data. +For example: `-SqlInstanceName "rtc"`. + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -183,32 +200,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -SqlServerFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the computer where the Central Management store has been installed. +For example: `-SqlServer atl-sql-001.litwareinc.com`. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MirrorSqlInstanceName -Name of the SQL Server instance containing the Skype for Business Server mirror database tables and data. -For example: `-SqlInstanceName "rtc"`. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -217,15 +237,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MirrorSqlServerFqdn -Fully qualified domain name (FQDN) of the computer where the Central Management store mirror database has been installed. -For example: `-SqlServer atl-mirror-001.litwareinc.com`. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -239,13 +260,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsConfigurationStoreLocation` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsConfigurationStoreLocation` cmdlet does not return any objects or values. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsConversationHistoryConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsConversationHistoryConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Set-CsConversationHistoryConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsConversationHistoryConfiguration.md index 4852521547..d5a89ad5cf 100644 --- a/skype/skype-ps/skype/Set-CsConversationHistoryConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsConversationHistoryConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csconversationhistoryconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsConversationHistoryConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csconversationhistoryconfiguration +schema: 2.0.0 +title: Set-CsConversationHistoryConfiguration --- # Set-CsConversationHistoryConfiguration @@ -42,7 +43,7 @@ However, the global settings can be modified by using the `Set-CsConversationHis ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsConversationHistoryConfiguration -Identity "global" -EnableServerConversationHistory $True ``` @@ -51,7 +52,7 @@ In Example 1, the EnableServerConversationHistory property is set to True ($True In turn, conversation histories, missed call notifications, and missed IM notifications will be stored on the server rather than in client mailboxes. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsConversationHistoryConfiguration -Identity "global" -CachedUserThreshold 2000000 ``` @@ -62,14 +63,16 @@ The command shown in Example 2 modifies the global collection of conversation hi ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. +### -EnableDisplayNameResolution + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: $true | $false ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -79,14 +82,16 @@ Accept wildcard characters: False ``` ### -EnableServerConversationHistory + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + When set to True ($True), conversation histories and related information will be stored on the server. The default value is False, which means that this information is stored in user mailboxes. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,13 +101,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -112,6 +119,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique Identity of the conversation history configuration settings being modified. Because you can only have a single, global instance of these settings, you do not need to specify an Identity when calling the `Set-CsConversationHistoryConfiguration` cmdlet. However, you can still use the following syntax to reference the global settings: @@ -121,8 +131,7 @@ However, you can still use the following syntax to reference the global settings ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -132,13 +141,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -148,6 +159,9 @@ Accept wildcard characters: False ``` ### -MaxContinuedConversationRetry + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the maximum number of times the Skype for Business Server will search for a previous conversation item from Exchange to create a continued conversation. If the previous conversation is not found in the specified number of attempts, a new conversation is created. Increasing this value will present more continued conversations, but at the cost of decreased performance. @@ -157,8 +171,7 @@ The default value is 3. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,14 +180,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -183,14 +198,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableDisplayNameResolution -PARAMVALUE: $true | $false +### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -204,13 +221,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.ConversationHistory.ConversationHistorySettings `Set-CsConversationHistoryConfiguration` accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ConversationHistory.ConversationHistorySettings object. ## OUTPUTS -### -None. +### None Instead, `Set-CsConversationHistoryConfiguration` modifies instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ConversationHistory.ConversationHistorySettings object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsCpsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsCpsConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Set-CsCpsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsCpsConfiguration.md index ae868b8cba..4acc1ce82e 100644 --- a/skype/skype-ps/skype/Set-CsCpsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsCpsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cscpsconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsCpsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cscpsconfiguration +schema: 2.0.0 +title: Set-CsCpsConfiguration --- # Set-CsCpsConfiguration @@ -46,7 +47,7 @@ In addition, Call Park service can be configured to play music on hold to the ca ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsCpsConfiguration -Identity site:Redmond1 -MaxCallPickupAttempts 2 ``` @@ -55,7 +56,7 @@ The command shown in Example 1 modifies the Call Park service configuration with This is done by including the MaxCallPickupAttempts parameter and setting the parameter value to 2. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsCpsConfiguration | Set-CsCpsConfiguration -MaxCallPickupAttempts 2 ``` @@ -65,7 +66,7 @@ To do this, the `Get-CsCpsConfiguration` cmdlet is used to retrieve a collection This collection is then piped to the `Set-CsCpsConfiguration` cmdlet, which takes each individual item in the collection and sets the value of the MaxCallPickupAttempts property to 2. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsCpsConfiguration -Identity site:Redmond1 -CallPickupTimeoutThreshold 00:00:45 ``` @@ -75,54 +76,60 @@ This example modifies the call park configuration for site Redmond1 by setting t ## PARAMETERS -### -Identity -A unique identifier of the configuration you want to modify. -The Identity specifies the scope at which the configuration is applied, either Global or a specific site (in the format site:\, such as site:Redmond). +### -CallPickupTimeoutThreshold + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The amount of time that will elapse after a call has been parked before it will ring back to the phone on which the call was answered. + +This must be entered in the format hh:mm:ss (hh = hours, mm = minutes, ss = seconds) + +Minimum Value: 10 seconds (00:00:10); Maximum Value: 10 minutes (00:10:00) ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: TimeSpan +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -An object reference to a Call Park service configuration object, of type Microsoft.Rtc.Management.WritableConfig.Settings.CallParkServiceSettings.CallParkServiceSettings. -This object can be retrieved by calling the `Get-CsCpsConfiguration` cmdlet. -The object can then be changed and the changes saved by passing the object back to the `Set-CsCpsConfiguration` cmdlet in this parameter. +### -EnableMusicOnHold + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Determines whether music plays for the caller while a call is parked. + +Skype for Business Server ships with a default Music on Hold file. +You can change this file (thereby changing the music the caller hears while parked) with the `Set-CsCallParkServiceMusicOnHoldFile` cmdlet. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -CallPickupTimeoutThreshold -The amount of time that will elapse after a call has been parked before it will ring back to the phone on which the call was answered. +### -Force -This must be entered in the format hh:mm:ss (hh = hours, mm = minutes, ss = seconds) +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Minimum Value: 10 seconds (00:00:10); Maximum Value: 10 minutes (00:10:00) +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: TimeSpan +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,27 +138,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMusicOnHold -Determines whether music plays for the caller while a call is parked. +### -Identity -Skype for Business Server ships with a default Music on Hold file. -You can change this file (thereby changing the music the caller hears while parked) with the `Set-CsCallParkServiceMusicOnHoldFile` cmdlet. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +A unique identifier of the configuration you want to modify. +The Identity specifies the scope at which the configuration is applied, either Global or a specific site (in the format site:\, such as site:Redmond). ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +An object reference to a Call Park service configuration object, of type Microsoft.Rtc.Management.WritableConfig.Settings.CallParkServiceSettings.CallParkServiceSettings. +This object can be retrieved by calling the `Get-CsCpsConfiguration` cmdlet. +The object can then be changed and the changes saved by passing the object back to the `Set-CsCpsConfiguration` cmdlet in this parameter. + + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -MaxCallPickupAttempts + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number of times a parked call will ring back to the answering phone before giving up and forwarding the call to the fallback Uniform Resource Identifier (URI). The fallback URI is set with the OnTimeoutURI parameter. @@ -160,8 +190,7 @@ Minimum Value: 1; Maximum Value: 10 ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -171,6 +200,9 @@ Accept wildcard characters: False ``` ### -OnTimeoutURI + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The SIP address of the user or Response Group to which unanswered parked calls will be routed. The parked call will be routed after the number of ringbacks defined with the MaxCallPickupAttempts parameter. If that parameter is set to Null, the OnTimeoutURI will be ignored and the parked call will be disconnected after unsuccessful ringback attempts. @@ -181,8 +213,7 @@ For example, sip:rgs1@litwareinc.com. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -191,14 +222,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -208,29 +241,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -244,13 +263,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.CallParkServiceSettings.CallParkServiceSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.CallParkServiceSettings.CallParkServiceSettings + Accepts pipelined input of Call Park service configuration objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.CallParkServiceSettings.CallParkServiceSettings Modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.CallParkServiceSettings.CallParkServiceSettings. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsDeviceUpdateConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsDeviceUpdateConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Set-CsDeviceUpdateConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsDeviceUpdateConfiguration.md index 8f111fabab..57fea410e4 100644 --- a/skype/skype-ps/skype/Set-CsDeviceUpdateConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsDeviceUpdateConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csdeviceupdateconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsDeviceUpdateConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csdeviceupdateconfiguration +schema: 2.0.0 +title: Set-CsDeviceUpdateConfiguration --- # Set-CsDeviceUpdateConfiguration @@ -50,7 +51,7 @@ For example, you can use this cmdlet to change the length of time a log file is ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsDeviceUpdateConfiguration -Identity global -MaxLogFileSize 2048000 -MaxLogCacheLimit 1024000 ``` @@ -59,7 +60,7 @@ Example 1 shows how the `Set-CsDeviceUpdateConfiguration` cmdlet can be used to In this case, two property values are modified: the MaxLogFileSize property is set to 2048000 bytes and the MaxLogCacheLimit property is set to 1024000 bytes. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsDeviceUpdateConfiguration -Identity site:Redmond -LogFlushInterval 00:02:00 ``` @@ -69,7 +70,7 @@ To do this, the Identity parameter is used to specify the settings at the Redmon In this case, the LogFlushInterval is set to 2 minutes (00 hours: 02 minutes: 00 seconds). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsDeviceUpdateConfiguration | Set-CsDeviceUpdateConfiguration -LogCleanUpInterval 14.00:00:00 ``` @@ -79,7 +80,7 @@ To do this, the `Get-CsDeviceUpdateConfiguration` cmdlet is first used to retrie This collection is then piped to the `Set-CsDeviceUpdateConfiguration` cmdlet, which uses the LogCleanUpInterval parameter to set the log clean up interval time for each item in the collection to 14 days (14 days : 00 hours : 00 minutes : 00 seconds). -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsDeviceUpdateConfiguration -Filter "site:*" | Set-CsDeviceUpdateConfiguration -LogCleanUpInterval 20.00:00:00 ``` @@ -89,7 +90,7 @@ In order to do this, the `Get-CsDeviceUpdateConfiguration` cmdlet is used along This filtered collection is then piped to the `Set-CsDeviceUpdateConfiguration` cmdlet, which changes the value of the log cleanup interval for each item in the collection. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsDeviceUpdateConfiguration | Set-CsDeviceUpdateConfiguration -ValidLogFileTypes @{Remove="CELog"} @@ -106,7 +107,28 @@ For example: ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the device update configuration settings to be modified. To refer to the global settings, use this syntax: `-Identity global`. To refer to site settings, use syntax similar to this: `-Identity "site:Redmond"`. @@ -115,8 +137,7 @@ Note that you cannot use wildcards when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -126,13 +147,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -142,6 +165,9 @@ Accept wildcard characters: False ``` ### -LogCleanUpInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the amount of time a device update log file is kept before it is deleted by the system. The value must be entered in the format dd.hh:mm:ss where dd is days, hh is hours, mm is minutes and ss is seconds. @@ -156,8 +182,7 @@ Default: 10.00:00:00 (10 Days) ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,6 +192,9 @@ Accept wildcard characters: False ``` ### -LogCleanUpTimeOfDay + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the time of day when the system checks to see if there are any expired log files that should be deleted. (Expired log files are any files older than the value specified in by the LogCleanupInterval property.) @@ -178,8 +206,7 @@ is represented as 23:52. ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -189,6 +216,9 @@ Accept wildcard characters: False ``` ### -LogFlushInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates how often information stored in the log file cache is written to the actual log file. By default, device update information is not immediately written to the log file; instead, that information is cached in memory until: 1) the log flush time interval has expired or 2) the cache has reached its maximum size. If this value is set to 10 minutes (00:10:00), then information in the cache will be written to the log file every 10 minutes. @@ -205,8 +235,7 @@ Default: 00:05:00 ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -216,6 +245,9 @@ Accept wildcard characters: False ``` ### -MaxLogCacheLimit + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the maximum amount of information (in bytes) that can held in the log file cache before that cache must be cleared and the data written to a log file. By default, log files are "flushed" every 5 minutes. (For details, see the description of the parameter LogFlushInterval.) However, if the cache reaches its maximum size the information in it will automatically be written to a log file (and the cache cleared), even if the log flush interval has not yet expired. @@ -225,8 +257,7 @@ Default: 512000 ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -236,6 +267,9 @@ Accept wildcard characters: False ``` ### -MaxLogFileSize + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the maximum size, in bytes, for an individual log file. When a file reaches the maximum size, the next batch of data is automatically written to a new log file. The old log file will be retained until the log cleanup interval has expired. @@ -245,8 +279,7 @@ Default: 1024000 ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -256,6 +289,9 @@ Accept wildcard characters: False ``` ### -ValidLogFileExtensions + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the valid log file extensions that can be used with the Device Update Web service. This list can be modified; however, there is no reason to modify the list unless you have a Lync Phone Edition compatible device that creates log files that use a different file extension. @@ -265,8 +301,7 @@ Default: .dmp, .clg, .clg2, .bak, .kdmp, .dat, .bin, .cat, .xml, .txt, .hex ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -276,6 +311,9 @@ Accept wildcard characters: False ``` ### -ValidLogFileTypes + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the log file types retained by the device update system. The default file types include the following: @@ -293,8 +331,7 @@ For example, if you do not want to store CELog files then you can remove the CEL ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -303,30 +340,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -336,13 +359,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -356,13 +381,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdateConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdateConfiguration + The `Set-CsDeviceUpdateConfiguration` cmdlet accepts pipelined instances of the device update configuration object. ## OUTPUTS -### +### None The `Set-CsDeviceUpdateConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.DeviceUpdateConfiguration object. diff --git a/skype/skype-ps/skype/Set-CsDiagnosticConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsDiagnosticConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Set-CsDiagnosticConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsDiagnosticConfiguration.md index 505b7d16bb..b013798581 100644 --- a/skype/skype-ps/skype/Set-CsDiagnosticConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsDiagnosticConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csdiagnosticconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsDiagnosticConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csdiagnosticconfiguration +schema: 2.0.0 +title: Set-CsDiagnosticConfiguration --- # Set-CsDiagnosticConfiguration @@ -49,7 +50,7 @@ Filters are used to indicate the domains whose traffic should be logged. ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` $x = New-CsDiagnosticsFilter -Fqdn fabrikam.com -Uri sip:user@fabrikam.com @@ -64,7 +65,7 @@ In command 2, the `Set-CsDiagnosticConfiguration` cmdlet assigns the new filter In this case, any existing values in the Filter property will be replaced by the newly-created filter. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $x = (Get-CsDiagnosticConfiguration -Identity global).Filter @@ -83,7 +84,7 @@ When that's done, the final command in the example uses the `Set-CsDiagnosticCon The net result is that fabrikam.com will be added to any FQDNs already included in the Filter property. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` $x = (Get-CsDiagnosticConfiguration -Identity global).Filter @@ -98,7 +99,7 @@ After that value has been retrieved, the Remove method is used to remove the FQD After the FQDN has been removed, the `Set-CsDiagnosticConfiguration` cmdlet is used write the modified filter (stored in the variable $x) to the global settings. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Set-CsDiagnosticConfiguration -Identity global -Filter $Null ``` @@ -109,96 +110,108 @@ This is done by setting the Filter property to a Null value. ## PARAMETERS -### -Identity -Unique identifier for the diagnostics configuration settings to be modified. -To modify settings configured at the site scope, use syntax similar to this: `-Identity "site:Redmond"`. -To modify the global settings, use this syntax: `-Identity global`. +### -Filter -If this parameter is not specified, then the `Set-CsDiagnosticConfiguration` cmdlet will automatically modify the global settings. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Collection of domains and URIs whose traffic will be logged. +The Filter property consists of three separate items, and must be created using the `New-CsDiagnosticsFilter` cmdlet: + +Fqdn - Collection of domains to be included in the filter. +(More technically, the host portion of a SIP address.) For example a fully qualified domain name (FQDN) might look like this: fabrikam.com. +Alternatively, you can use wildcards to represent multiple domains: *.fabrikam.com. +You can include more than one domain in a single filter. + +Uri - Collection of Uris to be included in the filter. +(The Uri represents the user@host portion of a SIP address.) A URI can consist of any of the following patterns: user@fabrikam.com; user@*; *@fabrikam.com. +You can include multiple Uris in a single filter. + +Enabled - Indicates whether or not the filter should be activated. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Filter +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Filter -Collection of domains and URIs whose traffic will be logged. -The Filter property consists of three separate items, and must be created using the `New-CsDiagnosticsFilter` cmdlet: +### -Identity -Fqdn - Collection of domains to be included in the filter. -(More technically, the host portion of a SIP address.) For example a fully qualified domain name (FQDN) might look like this: fabrikam.com. -Alternatively, you can use wildcards to represent multiple domains: *.fabrikam.com. -You can include more than one domain in a single filter. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Uri - Collection of Uris to be included in the filter. -(The Uri represents the user@host portion of a SIP address.) A URI can consist of any of the following patterns: user@fabrikam.com; user@*; *@fabrikam.com. -You can include multiple Uris in a single filter. +Unique identifier for the diagnostics configuration settings to be modified. +To modify settings configured at the site scope, use syntax similar to this: `-Identity "site:Redmond"`. +To modify the global settings, use this syntax: `-Identity global`. -Enabled - Indicates whether or not the filter should be activated. +If this parameter is not specified, then the `Set-CsDiagnosticConfiguration` cmdlet will automatically modify the global settings. ```yaml -Type: Filter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -LoggingShare -Shared folder where the diagnostic logs can be uploaded. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -LogAllSipHeaders + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to False, only the core SIP headers are recorded in the logs. +Setting this value to False can help reduce the size of the log files. +When set to True, all SIP headers are logged. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -207,14 +220,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -LoggingShare + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Shared folder where the diagnostic logs can be uploaded. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -224,13 +239,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -239,16 +256,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LogAllSipHeaders -When set to False, only the core SIP headers are recorded in the logs. -Setting this value to False can help reduce the size of the log files. -When set to True, all SIP headers are logged. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -262,13 +279,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticFilterSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticFilterSettings + The `Set-CsDiagnosticConfiguration` cmdlet accepts pipelined instances of the diagnostic configuration settings object. ## OUTPUTS -### +### None The `Set-CsDiagnosticConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticFilterSettings object. diff --git a/skype/skype-ps/skype/Set-CsDiagnosticHeaderConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsDiagnosticHeaderConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Set-CsDiagnosticHeaderConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsDiagnosticHeaderConfiguration.md index 4d2cb97630..dd3eb63f62 100644 --- a/skype/skype-ps/skype/Set-CsDiagnosticHeaderConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsDiagnosticHeaderConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csdiagnosticheaderconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsDiagnosticHeaderConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csdiagnosticheaderconfiguration +schema: 2.0.0 +title: Set-CsDiagnosticHeaderConfiguration --- # Set-CsDiagnosticHeaderConfiguration @@ -55,7 +56,7 @@ You can use this cmdlet to enable (or disable) the transmission of diagnostic he ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsDiagnosticHeaderConfiguration -Identity site:Redmond -SendToOutsideUnauthenticatedUsers $True ``` @@ -64,7 +65,7 @@ Example 1 modifies the diagnostic header configuration settings that have the Id In this example, the value of the SendToOutsideUnauthenticatedUsers property is set to True. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsDiagnosticHeaderConfiguration | Set-CsDiagnosticHeaderConfiguration -SendToOutsideUnauthenticatedUsers $True ``` @@ -74,7 +75,7 @@ To do this, the `Get-CsDiagnosticHeaderConfiguration` cmdlet is first called wit This collection is then piped to the `Set-CsDiagnosticHeaderConfiguration` cmdlet, which sets the SendToOutsideUnauthenticatedUsers property of each item in the collection to True. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsDiagnosticHeaderConfiguration | Where-Object {$_.SendToExternalNetworks -eq $True} | Set-CsDiagnosticHeaderConfiguration -SendToOutsideUnauthenticatedUsers $True ``` @@ -87,7 +88,28 @@ That filtered collection is then piped to the `Set-CsDiagnosticHeaderConfigurati ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the diagnostic header configuration settings to be modified. To modify settings configured at the site scope, use syntax similar to this: `-Identity "site:Redmond"`. To modify settings configured at the service scope, use syntax like this: `-Identity "service:EdgeServer:atl-cs-001.litwareinc.com"`. @@ -99,8 +121,7 @@ If this parameter is not specified, then the `Set-CsDiagnosticHeaderConfiguratio ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -110,13 +131,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -126,14 +149,16 @@ Accept wildcard characters: False ``` ### -SendToExternalNetworks + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, diagnostic headers will be attached to messages sent to users on external networks (such as users in a federated domain). The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -142,17 +167,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SendToOutsideUnauthenticatedUsers -When set to True, diagnostic headers will be attached to messages sent to outside users. -Outside users are users who have connected from outside the internal network (for example, through a proxy server) and have not yet been authenticated. +### -SendToExternalNetworksOnServiceEdge +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, diagnostic headers will be attached to messages sent to networks on the service edge. The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -161,30 +186,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -SendToOutsideUnauthenticatedUsers -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +When set to True, diagnostic headers will be attached to messages sent to outside users. +Outside users are users who have connected from outside the internal network (for example, through a proxy server) and have not yet been authenticated. -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +The default value is False. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -194,13 +208,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -209,15 +225,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SendToExternalNetworksOnServiceEdge -When set to True, diagnostic headers will be attached to messages sent to networks on the service edge. -The default value is False. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -231,13 +248,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings + The `Set-CsDiagnosticHeaderConfiguration` cmdlet accepts pipelined instances of the diagnostic header settings object. ## OUTPUTS -### +### None The `Set-CsDiagnosticHeaderConfiguration` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Diagnostics.DiagnosticHeaderSettings object. diff --git a/skype/skype-ps/skype/Set-CsDialInConferencingAccessNumber.md b/skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingAccessNumber.md similarity index 86% rename from skype/skype-ps/skype/Set-CsDialInConferencingAccessNumber.md rename to skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingAccessNumber.md index 01205b59cd..70294ecd01 100644 --- a/skype/skype-ps/skype/Set-CsDialInConferencingAccessNumber.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingAccessNumber.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csdialinconferencingaccessnumber applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsDialInConferencingAccessNumber -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csdialinconferencingaccessnumber +schema: 2.0.0 +title: Set-CsDialInConferencingAccessNumber --- # Set-CsDialInConferencingAccessNumber @@ -59,7 +60,7 @@ In addition, the `Set-CsDialInConferencingAccessNumber` cmdlet enables you to mo ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsDialInConferencingAccessNumber -Identity "sip:RedmondDialIn@litwareinc.com" -DisplayName "Redmond Dial-In Access Number" ``` @@ -68,7 +69,7 @@ The command shown in Example 1 modifies the DisplayName property for the dial-in In this example, the display name is set to "Redmond Dial-In Access Number". -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsDialInConferencingAccessNumber -Identity "sip:RedmondDialIn@litwareinc.com" -Regions "Redmond", "Seattle" ``` @@ -78,7 +79,7 @@ To do this, the Regions parameter is called, followed by the two regions (two st Note that this command will fail unless both the Redmond and Seattle regions have already been defined in dial plans. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsDialInConferencingAccessNumber | Where-Object {$_.PrimaryLanguage -eq "fr-FR"}| Set-CsDialInConferencingAccessNumber -SecondaryLanguages "fr-CA" ``` @@ -89,7 +90,7 @@ That collection is then piped to the `Where-Object` cmdlet, which picks out the This filtered collection is then piped to the `Set-CsDialInConferencingAccessNumber` cmdlet, which sets the value of the SecondaryLanguages property to French Canadian ("fr-CA"). -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsDialInConferencingAccessNumber -Filter {DisplayName -eq "Default DialIn Access Number"} | Set-CsDialInConferencingAccessNumber -DisplayName "Litwareinc Conferencing" ``` @@ -99,7 +100,7 @@ To do this, the command first uses the `Get-CsDialInConferencingAccessNumber` cm That access number is then piped to the `Set-CsDialInConferencingAccessNumber` cmdlet, which changes the display name to Litwareinc Conferencing. -### -------------------------- Example 5 ------------------------ +### Example 5 ``` Get-CsDialInConferencingAccessNumber -Filter {LineUri -eq "TEL:+14255558715"} | Set-CsDialInConferencingAccessNumber -DisplayNumber "1-425-555-1298" -LineUri "tel:+14255551298" ``` @@ -109,7 +110,7 @@ To retrieve the number to be modified, the command first uses the `Get-CsDialInC That access number is then piped to the `Set-CsDialInConferencingAccessNumber` cmdlet, which modifies both the DisplayNumber and LineUri properties of the access number. -### -------------------------- Example 6 ------------------------ +### Example 6 ``` Get-CsDialInConferencingAccessNumber | Where-Object {$_.PrimaryLanguage -ne "en-US"} | Set-CsDialInConferencingAccessNumber -SecondaryLanguages "fr-FR","it-IT" ``` @@ -122,7 +123,7 @@ English (en-US). The filtered collection is then piped to the `Set-CsDialInConferencingAccessNumber` cmdlet, which uses the -SecondaryLanguages parameter to assign each number in the collection the secondary languages French (fr-FR) and Italian (it-IT). -### -------------------------- Example 7 ------------------------ +### Example 7 ``` Get-CsDialInConferencingAccessNumber -Identity ""sip:RedmondDialIn@litwareinc.com"" -Priority 0 -ReorderedRegion Redmond ``` @@ -134,15 +135,56 @@ To set the priority, the Priority parameter is included along with the parameter ## PARAMETERS +### -DisplayName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Active Directory display name for the new contact object. +This is the name that will also be displayed in Skype for Business. + + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DisplayNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Phone number as displayed in meeting invitations and on the Dial-in Conferencing Settings webpage. +The DisplayNumber can be formatted any way you prefer; for example 1-800-555-1234; 1-(800)-555-1234; or 1.800.555.1234. + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address of the contact object that represents the dial-in conferencing number. When specifying the Identity you must include the "sip:" prefix; for example: `-Identity " sip:RedmondDialIn@litwareinc.com"`. ```yaml Type: UserIdParameter Parameter Sets: Reorder, Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -152,13 +194,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: AccessNumber Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -167,16 +211,19 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -DisplayName -Active Directory display name for the new contact object. -This is the name that will also be displayed in Skype for Business. +### -LineUri +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The actual dial-in conferencing phone number. +The LineUri must be specified by using the following syntax: the tel: prefix followed by a plus sign (+) followed by the country/region calling code, area code and phone number. +For example: tel:+18005551234. +Spaces, hyphens, parentheses and other characters are not allowed. ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -185,34 +232,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayNumber -Phone number as displayed in meeting invitations and on the Dial-in Conferencing Settings webpage. -The DisplayNumber can be formatted any way you prefer; for example 1-800-555-1234; 1-(800)-555-1234; or 1.800.555.1234. +### -PassThru -```yaml -Type: String -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Enables you to pass a contact object through the pipeline that represents the modified dial-in conferencing access number. +By default, the `Set-CsDialInConferencingAccessNumber` cmdlet does not pass objects through the pipeline. -### -LineUri -The actual dial-in conferencing phone number. -The LineUri must be specified by using the following syntax: the tel: prefix followed by a plus sign (+) followed by the country/region calling code, area code and phone number. -For example: tel:+18005551234. -Spaces, hyphens, parentheses and other characters are not allowed. ```yaml -Type: String -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -222,6 +253,9 @@ Accept wildcard characters: False ``` ### -PrimaryLanguage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Primary language used for making dial-in conferencing announcements. The language must be configured by using one of the available dial-in conferencing language codes; for example, en-US for U.S. English or fr-FR for French. @@ -233,8 +267,7 @@ To return a list of the available language codes, type the following command at ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -244,6 +277,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to change the order in which dial-in conferencing numbers are presented to users in meeting invitations or when they access the Dial-In Conferencing Settings webpage. Lower numbers are given a higher priority; to have a number appear at the beginning of the list set the priority to 0. Note that if you change the priority of a given number you must also use the ReorderedRegion parameter to indicate the region where the modified priority should take effect. @@ -252,8 +288,7 @@ Note that if you change the priority of a given number you must also use the Reo ```yaml Type: Int32 Parameter Sets: Reorder -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -263,6 +298,9 @@ Accept wildcard characters: False ``` ### -Regions + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Dial plan regions associated with the dial-in number. If a region is not included in at least one dial plan, then it cannot be associated with a dial-in conferencing access number. To specify multiple regions, use a comma-separated list: `-Regions "Northwest", "Southwest"` @@ -270,8 +308,7 @@ To specify multiple regions, use a comma-separated list: `-Regions "Northwest", ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.String] Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -281,14 +318,16 @@ Accept wildcard characters: False ``` ### -ReorderedRegion + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Used with the Priority parameter when changing the priority of a dial-in conferencing number with a region. The ReorderedRegion parameter indicates the region where the priority reordering is to take place; for example: `-ReorderedRegion "Redmond"`. ```yaml Type: String Parameter Sets: Reorder -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -298,13 +337,15 @@ Accept wildcard characters: False ``` ### -ScopeToGlobal + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If present, the dial-in conferencing number will be assigned to the global scope. ```yaml Type: SwitchParameter Parameter Sets: Identity, Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -314,13 +355,15 @@ Accept wildcard characters: False ``` ### -ScopeToSite + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If present, the dial-in conferencing number will be scoped to the site where the contact object's Registrar pool resides. ```yaml Type: SwitchParameter Parameter Sets: Identity, Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -330,6 +373,9 @@ Accept wildcard characters: False ``` ### -SecondaryLanguages + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Optional collection of languages that can also be used for making dial-in conferencing announcements. Secondary languages must be configured as a comma-separated list of language codes; for example, the following syntax sets French Canadian and French as secondary languages; -SecondaryLanguages "fr-CA", "fr-FR". @@ -338,8 +384,7 @@ An access number can be associated with as many as four secondary languages. ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.String] Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -348,30 +393,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -380,16 +411,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass a contact object through the pipeline that represents the modified dial-in conferencing access number. -By default, the `Set-CsDialInConferencingAccessNumber` cmdlet does not pass objects through the pipeline. +### -WhatIf +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -403,13 +434,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Xds.AccessNumber object. +### Microsoft.Rtc.Management.Xds.AccessNumber + The `Set-CsDialInConferencingAccessNumber` cmdlet accepts pipelined input of the access number object. ## OUTPUTS -### +### None The `Set-CsDialInConferencingAccessNumber` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Xds.AccessNumber object. diff --git a/skype/skype-ps/skype/Set-CsDialInConferencingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Set-CsDialInConferencingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingConfiguration.md index 05992d1033..3146403aa9 100644 --- a/skype/skype-ps/skype/Set-CsDialInConferencingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csdialinconferencingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsDialInConferencingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csdialinconferencingconfiguration +schema: 2.0.0 +title: Set-CsDialInConferencingConfiguration --- # Set-CsDialInConferencingConfiguration @@ -47,7 +48,7 @@ In addition, you can modify any of these configuration settings (at either the g ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsDialInConferencingConfiguration -Identity site:Redmond -EntryExitAnnouncementsType "ToneOnly" ``` @@ -56,7 +57,7 @@ The command shown in Example 1 modifies the EntryExitAnnoucements property for t In this case, the EntryExitAnnouncementsType property is set to ToneOnly. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsDialInConferencingConfiguration | Set-CsDialInConferencingConfiguration -EnableNameRecording $True ``` @@ -66,7 +67,7 @@ To do this, the command first uses the `Get-CsDialInConferencingConfiguration` c That collection is then piped to the `Set-CsDialInConferencingConfiguration` cmdlet, which sets the EnableNameRecording property for each item in the collection to True ($True). -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsDialInConferencingConfiguration -Filter "site:*" | Set-CsDialInConferencingConfiguration -EnableNameRecording $True -EntryExitAnnouncementsType "UseNames" ``` @@ -79,51 +80,59 @@ When the command finishes running, all the dial-in conferencing settings configu ## PARAMETERS -### -Identity -Indicates the Identity of the dial-in conferencing configuration settings to be modified. -To refer to the global settings, use this syntax: `-Identity global`. -To refer to site settings, use syntax similar to this: `-Identity site:Redmond`. -Note that you cannot use wildcards when specifying an Identity. +### -AllowAnonymousPstnActivation + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies whether unauthenticated callers can start a meeting if they are the first person to join. +An unauthenticated caller is defined as a participant who joins a meeting over the phone and doesn't provide a PIN when joining the meeting. +$True to allow anonymous activation, otherwise $False. +The default is $False. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -EnableNameRecording + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Determines whether or not users are asked to record their name before entering the conference. +Set to True to enable name recording; set to False to bypass name recording. +The default value is True. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableNameRecording -Determines whether or not users are asked to record their name before entering the conference. -Set to True to enable name recording; set to False to bypass name recording. -The default value is True. +### -EntryExitAnnouncementsEnabledByDefault + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True announcements will be played each time a participant enters or exits a conference. +If set to False (the default value), entry and exit announcements will not be played. + ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,14 +141,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -EntryExitAnnouncementsType + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the action taken by the system any time a participant enters or leaves a conference. +(Announcements are made only if the EntryExitAnnouncementsEnabledByDefault is set to True.) Valid values are: + +UseNames. +The person's name is announced any time her or she enters or leaves a conference (for example, "Ken Myer is exiting the conference"). + +ToneOnly. +A tone is played any time a participant enters or leaves a conference. + +The default value is UseNames. + ```yaml -Type: SwitchParameter +Type: EntryExitAnnouncementsType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -148,14 +169,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -164,58 +187,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the dial-in conferencing configuration settings to be modified. +To refer to the global settings, use this syntax: `-Identity global`. +To refer to site settings, use syntax similar to this: `-Identity site:Redmond`. +Note that you cannot use wildcards when specifying an Identity. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EntryExitAnnouncementsEnabledByDefault -If set to True announcements will be played each time a participant enters or exits a conference. -If set to False (the default value), entry and exit announcements will not be played. +### -Instance +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -EntryExitAnnouncementsType -Indicates the action taken by the system any time a participant enters or leaves a conference. -(Announcements are made only if the EntryExitAnnouncementsEnabledByDefault is set to True.) Valid values are: +### -PinAuthType -UseNames. -The person's name is announced any time her or she enters or leaves a conference (for example, "Ken Myer is exiting the conference"). +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -ToneOnly. -A tone is played any time a participant enters or leaves a conference. +Specifies which users are allowed to use PIN authentication. +Allowed values are: -The default value is UseNames. +Everyone +OrganizerOnly ```yaml -Type: EntryExitAnnouncementsType +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -224,17 +249,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAnonymousPstnActivation -Specifies whether unauthenticated callers can start a meeting if they are the first person to join. -An unauthenticated caller is defined as a participant who joins a meeting over the phone and doesn't provide a PIN when joining the meeting. -$True to allow anonymous activation, otherwise $False. -The default is $False. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -243,19 +267,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PinAuthType -Specifies which users are allowed to use PIN authentication. -Allowed values are: +### -WhatIf -Everyone +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -OrganizerOnly +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -269,13 +290,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingConfiguration + The `Set-CSDialInConferencingConfiguration` cmdlet accepts pipelined instances of the dial-in conferencing configuration object. ## OUTPUTS -### +### None The `Set-CsDialInConferencingConfiguration` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingConfiguration object. diff --git a/skype/skype-ps/skype/Set-CsDialInConferencingDtmfConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingDtmfConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Set-CsDialInConferencingDtmfConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingDtmfConfiguration.md index f9a7d636a3..0a19c1182a 100644 --- a/skype/skype-ps/skype/Set-CsDialInConferencingDtmfConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsDialInConferencingDtmfConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csdialinconferencingdtmfconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsDialInConferencingDtmfConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csdialinconferencingdtmfconfiguration +schema: 2.0.0 +title: Set-CsDialInConferencingDtmfConfiguration --- # Set-CsDialInConferencingDtmfConfiguration @@ -64,7 +65,7 @@ To disable a command, set its value to Null ($Null). ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsDialInConferencingDtmfConfiguration -Identity global -EnableDisableAnnouncementsCommand 4 -AudienceMuteCommand 9 ``` @@ -74,7 +75,7 @@ To do this two different parameters are used: EnableDisableAnnoucementsCommand, Because no Identity is specified, these changes will affect the global DTMF settings. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsDialInConferencingDtmfConfiguration -Identity site:Redmond -EnableDisableAnnouncementsCommand 4 -AudienceMuteCommand 9 ``` @@ -83,7 +84,7 @@ The command shown in Example 2 is a variation of the command shown in the first In this case, however, the changes affect the DTMF settings that have the Identity site:Redmond. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Set-CsDialInConferencingDtmfConfiguration -Identity "site:Redmond" -PrivateRollCallCommand $Null ``` @@ -93,7 +94,7 @@ To disable this command, the PrivateRollCallCommand parameter is included, with This means that no keypad key will be associated with the command, which makes the command unavailable to users. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsDialInConferencingDtmfConfiguration -Filter "site:*" | Set-CsDialInConferencingDtmfConfiguration -PrivateRollCallCommand $Null ``` @@ -105,53 +106,17 @@ This filtered collection is then piped to the `Set-CsDialInConferencingDtmfConfi ## PARAMETERS -### -Identity -Indicates the unique identifier for the collection of DTMF settings you want to modify. -To refer to the global settings, use this syntax: `-Identity global`. -To refer to a collection configured at the site scope, use syntax similar to this: `-Identity site:Redmond`. -Note that you cannot use wildcards when specifying an Identity. - -If this parameter is not specified, then the `Set-CsDialInConferencingDtmfConfiguration` cmdlet will modify the global DTMF settings. - - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AdmitAll -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AdmitAll Indicates the key to be pressed in order to allow all the users in the lobby to immediately join the conference. The default value is 8. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -161,14 +126,16 @@ Accept wildcard characters: False ``` ### -AudienceMuteCommand + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the key a presenter can press to mute everyone else in the conference (that is, everyone other than the presenter will be muted). The default key is 4. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -178,14 +145,16 @@ Accept wildcard characters: False ``` ### -CommandCharacter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the key to be pressed at the beginning of a command. The default key is the asterisk (*); the only other allowed value is the pound key (#). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -195,14 +164,34 @@ Accept wildcard characters: False ``` ### -EnableDisableAnnouncementsCommand + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the key to be pressed to enable or disable announcements each time someone joins or leaves the conference. The default key is 9. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -212,14 +201,16 @@ Accept wildcard characters: False ``` ### -HelpCommand + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the key to be pressed in order to privately play a description of all the DTMF commands. The default key is 1. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -228,7 +219,52 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the unique identifier for the collection of DTMF settings you want to modify. +To refer to the global settings, use this syntax: `-Identity global`. +To refer to a collection configured at the site scope, use syntax similar to this: `-Identity site:Redmond`. +Note that you cannot use wildcards when specifying an Identity. + +If this parameter is not specified, then the `Set-CsDialInConferencingDtmfConfiguration` cmdlet will modify the global DTMF settings. + + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -LockUnlockConferenceCommand + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the key to be pressed to lock or unlock a conference. If a conference is locked then no new participants will be allowed to join that conference, at least not until the conference has been unlocked. The default key is 7. @@ -236,8 +272,7 @@ The default key is 7. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -247,6 +282,9 @@ Accept wildcard characters: False ``` ### -MuteUnmuteCommand + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the key to be pressed to mute or unmute yourself; the same key is used to toggle back and forth between muting and unmuting. The default key is 6. @@ -254,8 +292,7 @@ The default key is 6. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -264,15 +301,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PrivateRollCallCommand -Indicates the key to be pressed to privately play the name of each conference participant. -The default key is 3. +### -OperatorLineUri + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Phone number that the dial-in conferencing auto-attendant will connect a PSTN user to any time that user presses *0 on their telephone keypad. +Pressing *0 is designed to connect dial-in conferencing users to operator assistance. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -281,30 +320,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PrivateRollCallCommand -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +Indicates the key to be pressed to privately play the name of each conference participant. +The default key is 3. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -314,13 +340,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -329,15 +357,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OperatorLineUri -Phone number that the dial-in conferencing auto-attendant will connect a PSTN user to any time that user presses *0 on their telephone keypad. -Pressing *0 is designed to connect dial-in conferencing users to operator assistance. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -351,13 +380,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingDtmfConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingDtmfConfiguration + The `Set-CsDialInConferencingDtmfConfiguration` cmdlet accepts pipelined instances of the dial-in conference DTMF configuration object. ## OUTPUTS -### +### None The `Set-CsDialInConferencingDtmfConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DialInConferencingSettings.DialInConferencingDtmfConfiguration object. diff --git a/skype/skype-ps/skype/Set-CsDialPlan.md b/skype/skype-ps/SkypeForBusiness/Set-CsDialPlan.md similarity index 83% rename from skype/skype-ps/skype/Set-CsDialPlan.md rename to skype/skype-ps/SkypeForBusiness/Set-CsDialPlan.md index f8e44ed1dd..b99503c3d7 100644 --- a/skype/skype-ps/skype/Set-CsDialPlan.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsDialPlan.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csdialplan applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsDialPlan -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csdialplan +schema: 2.0.0 +title: Set-CsDialPlan --- # Set-CsDialPlan @@ -47,7 +48,7 @@ The changes made with those cmdlets will be reflected in the corresponding dial ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsDialPlan -Identity RedmondDialPlan -Description "This plan is for Redmond-based users only." ``` @@ -56,7 +57,7 @@ In Example 1, the `Set-CsDialPlan` cmdlet is used to modify the dial plan with t In this case, the only property being modified is the Description; this modification is performed by specifying the Description parameter followed by the text for the new description. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsDialPlan | Set-CsDialPlan -ExternalAccessPrefix 8 ``` @@ -68,43 +69,46 @@ That collection is then piped to the `Set-CsDialPlan` cmdlet, which assigns the ## PARAMETERS -### -Identity -The unique identifier designating the scope, or, for per-user plans, a name, to identify the dial plan you want to modify. -For example, a site Identity will be in the format site:\, where sitename is the name of the site. -A dial plan at the service scope will be a Registrar or PSTN gateway service, where the Identity value is formatted like this: Registrar:Redmond.litwareinc.com. -A per-user Identity will be a unique string value. +### -City + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not used with this cmdlet. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. -You can retrieve this object reference by calling the `Get-CsDialPlan` cmdlet. +### -CountryCode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not used with this cmdlet. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A description of this dial plan--what it's for, what type of user it applies to, or any other information that will be helpful in identifying the purpose of the dial plan. Maximum characters: 512 @@ -112,8 +116,7 @@ Maximum characters: 512 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -123,6 +126,9 @@ Accept wildcard characters: False ``` ### -DialinConferencingRegion + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name of the region associated with this dial plan. Specify a value for this parameter if the dial plan will be used for dial-in conferencing. This allows the correct access number to be assigned when the conference organizer sets up the conference. @@ -133,8 +139,7 @@ Maximum characters: 512 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -144,6 +149,9 @@ Accept wildcard characters: False ``` ### -ExternalAccessPrefix + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A number (or set of numbers) that designates the call as external to the organization. (For example, to dial an outside line, first press 9.) This prefix will be ignored by the normalization rules, although these rules will be applied to the rest of the number. @@ -155,8 +163,7 @@ This means it must be a value one to four digits in length, each digit being a n ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -165,16 +172,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NormalizationRules -A list of normalization rules that are applied to this dial plan. +### -Force -While this list and these rules can be modified directly with this cmdlet, it is recommended that you create normalization rules with the `New-CsVoiceNormalizationRule` cmdlet, which creates the rule and assigns it to the specified dial plan and modify them with the `Set-CsVoiceNormalizationRule` cmdlet. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts before making changes. ```yaml -Type: PSListModifier +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -183,52 +190,58 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OptimizeDeviceDialing -Setting this parameter to True will apply the prefix in the ExternalAccessPrefix parameter to calls made outside the organization. -This value can be set to True only if a value has been specified for the ExternalAccessPrefix parameter. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier designating the scope, or, for per-user plans, a name, to identify the dial plan you want to modify. +For example, a site Identity will be in the format site:\, where sitename is the name of the site. +A dial plan at the service scope will be a Registrar or PSTN gateway service, where the Identity value is formatted like this: Registrar:Redmond.litwareinc.com. +A per-user Identity will be a unique string value. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SimpleName -A friendly name for the dial plan. -Dial plan names must be unique among all dial plans within a Skype for Business Server deployment. +### -Instance -This string can be up to 256 characters long. -Valid characters are alphabetic or numeric characters, hyphen (-), dot (.), plus (+), underscore (_) and parentheses (()). +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +You can retrieve this object reference by calling the `Get-CsDialPlan` cmdlet. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -State -This parameter is not used with this cmdlet. +### -NormalizationRules + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A list of normalization rules that are applied to this dial plan. + +While this list and these rules can be modified directly with this cmdlet, it is recommended that you create normalization rules with the `New-CsVoiceNormalizationRule` cmdlet, which creates the rule and assigns it to the specified dial plan and modify them with the `Set-CsVoiceNormalizationRule` cmdlet. ```yaml -Type: String +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -237,14 +250,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -City -This parameter is not used with this cmdlet. +### -OptimizeDeviceDialing + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Setting this parameter to True will apply the prefix in the ExternalAccessPrefix parameter to calls made outside the organization. +This value can be set to True only if a value has been specified for the ExternalAccessPrefix parameter. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -253,14 +269,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CountryCode -This parameter is not used with this cmdlet. +### -SimpleName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A friendly name for the dial plan. +Dial plan names must be unique among all dial plans within a Skype for Business Server deployment. + +This string can be up to 256 characters long. +Valid characters are alphabetic or numeric characters, hyphen (-), dot (.), plus (+), underscore (_) and parentheses (()). + ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -269,14 +292,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts before making changes. +### -State + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not used with this cmdlet. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -285,14 +310,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -301,14 +328,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -322,13 +351,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile + Accepts pipelined input of dial plan objects. ## OUTPUTS -### +### None The `Set-CsDialPlan` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile object. diff --git a/skype/skype-ps/skype/Set-CsDirector.md b/skype/skype-ps/SkypeForBusiness/Set-CsDirector.md similarity index 81% rename from skype/skype-ps/skype/Set-CsDirector.md rename to skype/skype-ps/SkypeForBusiness/Set-CsDirector.md index 49d7fa107e..c90c6e320b 100644 --- a/skype/skype-ps/skype/Set-CsDirector.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsDirector.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csdirector applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsDirector -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csdirector +schema: 2.0.0 +title: Set-CsDirector --- # Set-CsDirector @@ -41,7 +42,7 @@ This includes changing such things as the Archiving Server or Edge Server associ ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsDirector -Identity "Director:atl-cs-001.litwareinc.com" -ArchivingServer "ArchivingServer:dublin-cs-001.litwareinc.com" ``` @@ -50,7 +51,7 @@ The command shown in Example 1 changes the Archiving Server associated with the In this example, the Archiving Server is switched to ArchivingServer:dublin-cs-001.litwareinc.com. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsService -Director | ForEach-Object {Set-CsDirector -Identity $_.Identity -SipPort 5072} ``` @@ -63,35 +64,36 @@ In turn, the `ForEach-Object` cmdlet runs the `Set-CsDirector` cmdlet against ea ## PARAMETERS -### -Identity -Service location of the Director to be modified. -For example: `-Identity "Director:atl-cs-001.litwareinc.com"`. +### -ArchivingServer -Note that you can leave off the prefix "Director:" when specifying a Director. -For example: `-Identity "atl-cs-001.litwareinc.com"`. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the Archiving Server to be associated with the Director. +For example: `-ArchivingServer "ArchivingServer:atl-cs-001.litwareinc.com"`. ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ArchivingServer -Service location of the Archiving Server to be associated with the Director. -For example: `-ArchivingServer "ArchivingServer:atl-cs-001.litwareinc.com"`. +### -EdgeServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the Edge Server to be associated with the Director. +For example: `-EdgeServer "EdgeServer:atl-edge-001.litwareinc.com"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -100,15 +102,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EdgeServer -Service location of the Edge Server to be associated with the Director. -For example: `-EdgeServer "EdgeServer:atl-edge-001.litwareinc.com"` +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -117,31 +120,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MonitoringServer -Service location of the Monitoring Server to be associated with the Director. -For example: `-MonitoringServer "MonitoringServer:atl-cs-001.litwareinc.com"`. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the Director to be modified. +For example: `-Identity "Director:atl-cs-001.litwareinc.com"`. + +Note that you can leave off the prefix "Director:" when specifying a Director. +For example: `-Identity "atl-cs-001.litwareinc.com"`. ```yaml -Type: String +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SipPort -Port used for Session Initiation Protocol (SIP) traffic. +### -MirrorMonitoringDatabase + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the mirror monitoring database to be associated with the Director. ```yaml -Type: UInt16 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,14 +160,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WebPort -Port used for communicating with Web Services. +### -MonitoringDatabase + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the monitoring database to be associated with the Director. ```yaml -Type: UInt16 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -166,15 +178,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WebServer -Web Services location of the server to be associated with the Director. -For example: `-WebServer "WebServer:atl-cs-001.litwareinc.com"` +### -MonitoringServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the Monitoring Server to be associated with the Director. +For example: `-MonitoringServer "MonitoringServer:atl-cs-001.litwareinc.com"`. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -183,14 +197,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -SipHealthPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Port used for monitoring server health. + ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -199,14 +216,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Port used for Session Initiation Protocol (SIP) traffic. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -215,14 +234,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -SipServerTcpPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP listening port. +The default value is 5060. + ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -231,15 +254,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipHealthPort -Port used for monitoring server health. +### -WebPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Port used for communicating with Web Services. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -248,16 +272,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipServerTcpPort -SIP listening port. -The default value is 5060. +### -WebServer +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Web Services location of the server to be associated with the Director. +For example: `-WebServer "WebServer:atl-cs-001.litwareinc.com"` ```yaml -Type: UInt16 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -266,14 +291,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MirrorMonitoringDatabase -Service location of the mirror monitoring database to be associated with the Director. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -282,14 +309,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MonitoringDatabase -Service location of the monitoring database to be associated with the Director. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -303,13 +332,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsDirector` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsDirector` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayDirector object. diff --git a/skype/skype-ps/skype/Set-CsEdgeServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsEdgeServer.md similarity index 81% rename from skype/skype-ps/skype/Set-CsEdgeServer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsEdgeServer.md index 5f2b5044cf..9bd35fd2f8 100644 --- a/skype/skype-ps/skype/Set-CsEdgeServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsEdgeServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csedgeserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsEdgeServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csedgeserver +schema: 2.0.0 +title: Set-CsEdgeServer --- # Set-CsEdgeServer @@ -43,7 +44,7 @@ The `Set-CsEdgeServer` cmdlet enables you to modify configuration settings for y ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsEdgeServer -Identity "EdgeServer:atl-edge-001.litwareinc.com" -AccessEdgeInternalSipPort 5062 -AccessEdgeExternalSipPort 5062 ``` @@ -51,7 +52,7 @@ Set-CsEdgeServer -Identity "EdgeServer:atl-edge-001.litwareinc.com" -AccessEdgeI The command shown in Example 1 modifies the internal and external SIP ports for the Edge Server "EdgeServer:atl-edge-001.litwareinc.com". -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsService -EdgeServer | Where-Object {$_.SiteId -eq "site:Redmond"} | ForEach-Object {Set-CsEdgeServer -Identity $_.Identity -AccessEdgeInternalSipPort 5062 -AccessEdgeExternalSipPort 5062} ``` @@ -65,27 +66,10 @@ That cmdlet runs the `Set-CsEdgeServer` cmdlet against each server in the collec ## PARAMETERS -### -Identity -Service location of the Edge Server to be modified. -For example: `-Identity "EdgeServer:atl-edge-001.litwareinc.com"`. - -Note that you can leave off the prefix "EdgeServer:" when specifying an Edge server. -For example: `-Identity "atl-cs-001.litwareinc.com"`. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AccessEdgeClientSipPort -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AccessEdgeClientSipPort Port used for SIP communications between the Edge Server and client devices. The initial value is set in Topology Builder but can be changed by specifying a new value for this parameter. @@ -93,8 +77,7 @@ The initial value is set in Topology Builder but can be changed by specifying a ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -104,14 +87,16 @@ Accept wildcard characters: False ``` ### -AccessEdgeExternalSipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for external SIP traffic. The default value is 5061. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -121,14 +106,16 @@ Accept wildcard characters: False ``` ### -AccessEdgeInternalSipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for internal SIP traffic. The default value is 5061. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,6 +125,9 @@ Accept wildcard characters: False ``` ### -DataPsomClientPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for Persistent Shared Object Model (PSOM) communications between the Edge Server and client devices. The initial value is set in Topology Builder but can be changed by specifying a new value for this parameter. @@ -145,8 +135,7 @@ The initial value is set in Topology Builder but can be changed by specifying a ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -156,13 +145,15 @@ Accept wildcard characters: False ``` ### -DataPsomServerPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for PSOM communications between the Edge Server and other servers. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -171,7 +162,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the Edge Server to be modified. +For example: `-Identity "EdgeServer:atl-edge-001.litwareinc.com"`. + +Note that you can leave off the prefix "EdgeServer:" when specifying an Edge server. +For example: `-Identity "atl-cs-001.litwareinc.com"`. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MediaCommunicationPortCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Total number of ports allocated on the external Edge for media communications. The default value is 10000. @@ -179,8 +213,7 @@ The default value is 10000. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -190,6 +223,9 @@ Accept wildcard characters: False ``` ### -MediaCommunicationPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Starting port number on the external Edge for media communications. The default value is 50000. @@ -197,8 +233,7 @@ The default value is 50000. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -208,14 +243,16 @@ Accept wildcard characters: False ``` ### -MediaRelayAuthEdgePort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for media relay authentication. The default value is 5062. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,6 +262,9 @@ Accept wildcard characters: False ``` ### -MediaRelayExternalTurnTcpPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for external media relay traffic using the Transmission Control Protocol (TCP). The default value is 444 if your Edge server has a single IP address. If your Edge server has multiple IP addresses then the default value is 443. @@ -234,8 +274,7 @@ These values are initially set in Topology Builder but can be changed by specify ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -245,14 +284,16 @@ Accept wildcard characters: False ``` ### -MediaRelayExternalTurnUdpPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for external media relay traffic using the User Datagram Protocol (UDP). The default value is 3478. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -262,14 +303,16 @@ Accept wildcard characters: False ``` ### -MediaRelayInternalTurnTcpPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for internal media relay traffic using TCP. The default value is 443. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -279,14 +322,16 @@ Accept wildcard characters: False ``` ### -MediaRelayInternalTurnUdpPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for internal media relay traffic using UDP. The default value is 3478. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -296,14 +341,16 @@ Accept wildcard characters: False ``` ### -Registrar + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service location of the Registrar to be associated with the Edge Server. For example: `-Registrar "Registrar:atl-cs-001.litwareinc.com"`. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -312,14 +359,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -SkypeSearchProxyPort + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: UInt16 ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -328,30 +377,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -XmppInternalPort -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Port used for internal XMPP traffic. +The extensible Messaging and Presence Protocol (XMPP) is an open-standard communications protocol for exchanging messages using XML. +An allowed partner is an IM and presence provider whose users are allowed to exchange instant messages and presence information with your Skype for Business Server users. +The default value is 5098. -### -Confirm -Prompts you for confirmation before executing the command. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -360,18 +399,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -XmppInternalPort -Port used for internal XMPP traffic. -The extensible Messaging and Presence Protocol (XMPP) is an open-standard communications protocol for exchanging messages using XML. -An allowed partner is an IM and presence provider whose users are allowed to exchange instant messages and presence information with your Skype for Business Server users. -The default value is 5098. +### -XmppListeningPort +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Listening port for XMPP traffic. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -380,14 +417,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -XmppListeningPort -Listening port for XMPP traffic. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: UInt16 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -396,14 +435,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkypeSearchProxyPort -PARAMVALUE: UInt16 +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: UInt16 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -417,13 +458,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsEdgeServer` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsEdgeServer` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayEdgeServer object. diff --git a/skype/skype-ps/skype/Set-CsEnhancedEmergencyServiceDisclaimer.md b/skype/skype-ps/SkypeForBusiness/Set-CsEnhancedEmergencyServiceDisclaimer.md similarity index 84% rename from skype/skype-ps/skype/Set-CsEnhancedEmergencyServiceDisclaimer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsEnhancedEmergencyServiceDisclaimer.md index 25d66021cd..456b77d9ce 100644 --- a/skype/skype-ps/skype/Set-CsEnhancedEmergencyServiceDisclaimer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsEnhancedEmergencyServiceDisclaimer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csenhancedemergencyservicedisclaimer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsEnhancedEmergencyServiceDisclaimer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csenhancedemergencyservicedisclaimer +schema: 2.0.0 +title: Set-CsEnhancedEmergencyServiceDisclaimer --- # Set-CsEnhancedEmergencyServiceDisclaimer @@ -43,7 +44,7 @@ This message will be displayed only if the LocationRequired property of the user ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsEnhancedEmergencyServiceDisclaimer -Body "Warning: If you do not provide a location, emergency services may be delayed in reaching your location should you need to call for help." ``` @@ -54,79 +55,89 @@ This setting can be applied only at the global scope, which is the default for I ## PARAMETERS -### -Identity -This will always be Global. +### -Body + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A string containing information that will be displayed to users who are connected from locations that cannot be resolved by the location mapping (wiremap) who choose not to enter their location manually. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -A reference to an enhanced emergency service disclaimer object. -Must be of type EnhancedEmergencyServiceDisclaimer. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Body -A string containing information that will be displayed to users who are connected from locations that cannot be resolved by the location mapping (wiremap) who choose not to enter their location manually. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This will always be Global. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A reference to an enhanced emergency service disclaimer object. +Must be of type EnhancedEmergencyServiceDisclaimer. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -135,14 +146,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -156,13 +169,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Location.EnhancedEmergencyServiceDisclaimer object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Location.EnhancedEmergencyServiceDisclaimer + Accepts pipelined input of an enhanced emergency service disclaimer object. ## OUTPUTS -### +### None This cmdlet does not return a value or an object. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Location.EnhancedEmergencyServiceDisclaimer. diff --git a/skype/skype-ps/skype/Set-CsExUmContact.md b/skype/skype-ps/SkypeForBusiness/Set-CsExUmContact.md similarity index 84% rename from skype/skype-ps/skype/Set-CsExUmContact.md rename to skype/skype-ps/SkypeForBusiness/Set-CsExUmContact.md index aaee007975..4b2efd1ac3 100644 --- a/skype/skype-ps/skype/Set-CsExUmContact.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsExUmContact.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csexumcontact applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsExUmContact -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csexumcontact +schema: 2.0.0 +title: Set-CsExUmContact --- # Set-CsExUmContact @@ -39,7 +40,7 @@ Simply pipe the output of the `Get-CsExUmContact` cmdlet command to the `Set-CsE ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsExUmContact -Identity sip:exumsa4@fabrikam.com | Set-CsExUmContact -AutoAttendant $True ``` @@ -50,7 +51,7 @@ We first call the `Get-CsExUmContact` cmdlet to retrieve the contact object. That contact is then passed to the `Set-CsExUmContact` cmdlet, where we set its AutoAttendant parameter to True. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsExUmContact -Identity "CN={1bf6208d-2847-45d0-828f-636f14da858b},OU=ExUmContacts,DC=litwareinc,DC=com" -AutoAttendant $True ``` @@ -62,34 +63,17 @@ We then set the AutoAttendant parameter of the contact to True. ## PARAMETERS -### -Identity -The unique identifier of the contact object you want to modify. -Contact identities can be specified using one of four formats: 1) The contact's SIP address; 2) the contact's user principal name (UPN); 3) the contact's domain name and logon name, in the form domain\logon (for example, litwareinc\exum1) and 4) the contact's Active Directory display name (for example, Team Auto Attendant). - -Full data type: Microsoft.Rtc.Management.AD.UserIdParameter - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AutoAttendant -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AutoAttendant Set the parameter to True if the contact object is an Auto Attendant. This parameter is False by default. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -99,14 +83,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A description of this contact. The description is for use by administrators to identify the type of contact (Auto Attendant or Subscriber Access), the location, provider, or any other information that will identify the purpose of each Exchange UM contact. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,6 +102,9 @@ Accept wildcard characters: False ``` ### -DisplayNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The telephone number of the contact. Display numbers for each contact must be unique (no two Exchange UM contacts can have the same display number). Changing this value will also change the value of the LineURI property. @@ -126,8 +115,26 @@ The first digit cannot be zero. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to specify a domain controller. +If no domain controller is specified, the first available will be used. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -137,6 +144,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether or not the contact has been enabled for Skype for Business Server. Setting this parameter to False will disable the contact, and the Auto Attendant or Subscriber Access associated with this contact will no longer function. @@ -148,7 +158,6 @@ If you later re-enable the account using the Enable parameter, the associated ac Type: Boolean Parameter Sets: (All) Aliases: CsEnabled -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -158,14 +167,16 @@ Accept wildcard characters: False ``` ### -EnterpriseVoiceEnabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the contact has been enabled for Enterprise Voice. If this value is set to False, the Auto Attendant or Subscriber Access feature associated with this contact will no longer be available. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -174,21 +185,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipAddress -The SIP address of the contact. -This must be a new address that does not already exist as a user or contact in Active Directory Domain Services. +### -ExchangeArchivingPolicy -Changing this value will also change the SIP address stored in the OtherIpPhone property. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The SipAddress can be used as the Identity value for the `Get-CsExUmContact` cmdlet commands to retrieve specific contacts. -When calling that cmdlet, the new SipAddress will be used; queries for the old SIP address will not return an object. +Indicates where the contact's instant messaging sessions are archived. +Allowed values are: + +Uninitialized + +UseLyncArchivingPolicy + +ArchivingToExchange + +NoArchiving ```yaml -Type: String +Type: ExchangeArchivingPolicyOptionsEnum Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -197,32 +213,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Allows you to specify a domain controller. -If no domain controller is specified, the first available will be used. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the contact object you want to modify. +Contact identities can be specified using one of four formats: 1) The contact's SIP address; 2) the contact's user principal name (UPN); 3) the contact's domain name and logon name, in the form domain\logon (for example, litwareinc\exum1) and 4) the contact's Active Directory display name (for example, Team Auto Attendant). + +Full data type: Microsoft.Rtc.Management.AD.UserIdParameter ```yaml -Type: Fqdn +Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Returns the results of the command. By default, this cmdlet does not generate any output. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -231,14 +253,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The SIP address of the contact. +This must be a new address that does not already exist as a user or contact in Active Directory Domain Services. + +Changing this value will also change the SIP address stored in the OtherIpPhone property. + +The SipAddress can be used as the Identity value for the `Get-CsExUmContact` cmdlet commands to retrieve specific contacts. +When calling that cmdlet, the new SipAddress will be used; queries for the old SIP address will not return an object. + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -248,13 +279,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -263,24 +296,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExchangeArchivingPolicy -Indicates where the contact's instant messaging sessions are archived. -Allowed values are: - -Uninitialized - -UseLyncArchivingPolicy - -ArchivingToExchange +### -WhatIf -NoArchiving +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: ExchangeArchivingPolicyOptionsEnum +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -294,13 +319,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact object. +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact + Accepts pipelined input of Exchange UM contact objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact This cmdlet modifies an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADExUmContact. When the PassThru parameter is used, it also returns an object of this type. diff --git a/skype/skype-ps/skype/Set-CsExternalAccessPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsExternalAccessPolicy.md similarity index 87% rename from skype/skype-ps/skype/Set-CsExternalAccessPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsExternalAccessPolicy.md index 7261e645e0..c9a4befb82 100644 --- a/skype/skype-ps/skype/Set-CsExternalAccessPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsExternalAccessPolicy.md @@ -1,12 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csexternalaccesspolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsExternalAccessPolicy -schema: 2.0.0 author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/set-csexternalaccesspolicy +schema: 2.0.0 +title: Set-CsExternalAccessPolicy --- # Set-CsExternalAccessPolicy @@ -66,7 +68,7 @@ If you would like to grant this capability to all of your users you can call the ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsExternalAccessPolicy -Identity RedmondExternalAccessPolicy -EnableFederationAccess $True ``` @@ -74,7 +76,7 @@ Set-CsExternalAccessPolicy -Identity RedmondExternalAccessPolicy -EnableFederati The command shown in Example 1 modifies the per-user external access policy that has the Identity RedmondExternalAccessPolicy. In this example, the command changes the value of the EnableFederationAccess property to True. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsExternalAccessPolicy | Set-CsExternalAccessPolicy -EnableFederationAccess $True ``` @@ -83,7 +85,7 @@ In Example 2, federation access is enabled for all the external access policies To do this, the command first calls the `Get-CsExternalAccessPolicy` cmdlet without any parameters; this returns a collection of all the external policies currently configured for use. That collection is then piped to the `Set-CsExternalAccessPolicy` cmdlet, which changes the value of the EnableFederationAccess property for each policy in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsExternalAccessPolicy -Filter tag:* | Set-CsExternalAccessPolicy -EnableFederationAccess $True ``` @@ -93,7 +95,7 @@ To carry out this task, the first thing the command does is use the `Get-CsExter (The filter value "tag:*" limits returned data to policies that have an Identity that begins with the string value "tag:". Any policy with an Identity that begins with "tag:" has been configured at the per-user scope.) The filtered collection is then piped to the `Set-CsExternalAccessPolicy` cmdlet, which modifies the EnableFederationAccess property for each policy in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Set-CsExternalAccessPolicy -Identity Global -EnableAcsFederationAccess $false New-CsExternalAccessPolicy -Identity AcsFederationAllowed -EnableAcsFederationAccess $true @@ -101,7 +103,7 @@ New-CsExternalAccessPolicy -Identity AcsFederationAllowed -EnableAcsFederationAc In this example, the Global policy is updated to disallow Teams-ACS federation for all users, then a new external access policy instance is created with Teams-ACS federation enabled and which can be assigned to selected users for which Team-ACS federation will be allowed. -### -------------------------- Example 5 ------------------------ +### Example 5 ``` Set-CsExternalAccessPolicy -Identity Global -EnableAcsFederationAccess $true New-CsExternalAccessPolicy -Identity AcsFederationNotAllowed -EnableAcsFederationAccess $false @@ -111,63 +113,52 @@ In this example, the Global policy is updated to allow Teams-ACS federation for ## PARAMETERS -### -Identity -Unique identifier for the external access policy to be modified. -External access policies can be configured at the global, site, or per-user scopes. -To modify the global policy, use this syntax: `-Identity global`. -To modify a site policy, use syntax similar to this: `-Identity site:Redmond`. -To modify a per-user policy, use syntax similar to this: `-Identity SalesAccessPolicy`. -If this parameter is not specified then the global policy will be modified. +### -Description -Note that wildcards are not allowed when specifying an Identity. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to provide additional text to accompany the policy. +For example, the Description might include information about the users the policy should be assigned to. ```yaml -Type: XdsIdentity +Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -EnableAcsFederationAccess -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Microsoft Teams -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +Indicates whether Teams meeting organized by the user can be joined by users of customer applications built using Azure Communication Services (ACS). This policy setting only applies if ACS Teams federation has been enabled at the tenant level using the cmdlet Set-CsTeamsAcsFederationConfiguration. -### -Description -Enables administrators to provide additional text to accompany the policy. -For example, the Description might include information about the users the policy should be assigned to. +Additionally, Azure Communication Services users would be able to call Microsoft 365 users that have assigned policies with enabled federation. + +To enable for all users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to True. It can be disabled for selected users by assigning them a policy with federation disabled. + +To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 - Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` ### -EnableFederationAccess + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the user is allowed to communicate with people who have SIP accounts with a federated organization. Read [Manage external access in Microsoft Teams](/microsoftteams/manage-external-access) to get more information about the effect of this parameter in Microsoft Teams. The default value is True. @@ -176,7 +167,6 @@ The default value is True. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -185,28 +175,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAcsFederationAccess -Indicates whether Teams meeting organized by the user can be joined by users of customer applications built using Azure Communication Services (ACS). This policy setting only applies if ACS Teams federation has been enabled at the tenant level using the cmdlet Set-CsTeamsAcsFederationConfiguration. - -Additionally, Azure Communication Services users would be able to call Microsoft 365 users that have assigned policies with enabled federation. +### -EnableOutsideAccess -To enable for all users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to True. It can be disabled for selected users by assigning them a policy with federation disabled. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. +Indicates whether the user is allowed to connect to Skype for Business Server over the Internet, without logging on to the organization's internal network. +The default value is False. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Microsoft Teams + Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -EnablePublicCloudAudioVideoAccess + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the user is allowed to conduct audio/video conversations with people who have SIP accounts with a public Internet connectivity provider such as MSN. When set to False, audio and video options in Skype for Business will be disabled any time a user is communicating with a public Internet connectivity contact. The default value is False. @@ -215,7 +206,6 @@ The default value is False. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -225,6 +215,9 @@ Accept wildcard characters: False ``` ### -EnableTeamsConsumerAccess + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + (Microsoft Teams Only) Indicates whether the user is allowed to communicate with people who have who are using Teams with an account that's not managed by an organization. To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. @@ -236,7 +229,6 @@ The default value is True. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -246,6 +238,9 @@ Accept wildcard characters: False ``` ### -EnableTeamsConsumerInbound + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + (Microsoft Teams Only) Indicates whether the user is allowed to be discoverable by people who are using Teams with an account that's not managed by an organization. It also controls if people who have who are using Teams with an account that's not managed by an organization can start the communication with the user. To enable just for a selected set of users, use the Set-CsExternalAccessPolicy cmdlet to update the global policy, setting the value to False. Then assign selected users a policy with federation enabled. @@ -257,7 +252,6 @@ The default value is True. Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -266,14 +260,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -EnableXmppAccess + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether the user is allowed to communicate with users who have SIP accounts with a federated XMPP (Extensible Messaging and Presence Protocol) partner. +The default value is False. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -282,14 +279,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -298,48 +297,66 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the external access policy to be modified. +External access policies can be configured at the global, site, or per-user scopes. +To modify the global policy, use this syntax: `-Identity global`. +To modify a site policy, use syntax similar to this: `-Identity site:Redmond`. +To modify a per-user policy, use syntax similar to this: `-Identity SalesAccessPolicy`. +If this parameter is not specified then the global policy will be modified. + +Note that wildcards are not allowed when specifying an Identity. ```yaml -Type: SwitchParameter +Type: XdsIdentity Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOutsideAccess -Indicates whether the user is allowed to connect to Skype for Business Server over the Internet, without logging on to the organization's internal network. -The default value is False. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: Boolean -Parameter Sets: (All) +Type: PSObject +Parameter Sets: Instance Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -EnableXmppAccess -Indicates whether the user is allowed to communicate with users who have SIP accounts with a federated XMPP (Extensible Messaging and Presence Protocol) partner. -The default value is False. +### -Tenant + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the external access policy is being modified. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -348,21 +365,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the external access policy is being modified. -For example: +### -Confirm -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +Prompts you for confirmation before executing the command. -`Get-CsTenant | Select-Object DisplayName, TenantID` +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -376,13 +406,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy + The `Set-CsExternalAccessPolicy` cmdlet accepts pipelined input of the external access policy object. ## OUTPUTS -### +### None The `Set-CsExternalAccessPolicy` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ExternalAccess.ExternalAccessPolicy object. diff --git a/skype/skype-ps/skype/Set-CsExternalUserCommunicationPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsExternalUserCommunicationPolicy.md similarity index 89% rename from skype/skype-ps/skype/Set-CsExternalUserCommunicationPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsExternalUserCommunicationPolicy.md index 58dfe5fefc..2843a13b45 100644 --- a/skype/skype-ps/skype/Set-CsExternalUserCommunicationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsExternalUserCommunicationPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csexternalusercommunicationpolicy applicable: Skype for Business Online -title: Set-CsExternalUserCommunicationPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/set-csexternalusercommunicationpolicy +schema: 2.0.0 +title: Set-CsExternalUserCommunicationPolicy --- # Set-CsExternalUserCommunicationPolicy @@ -39,7 +41,7 @@ The following parameters are not applicable to Skype for Business Online: AllowP ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` PS C:\> Set-CsExternalUserCommunicationPolicy -Identity BlockExternalP2PFileTransfer -EnableP2PFileTransfer $False ``` @@ -50,13 +52,15 @@ This example modifies an existing policy to block external file transfer. ## PARAMETERS ### -AllowPresenceVisibility + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -66,13 +70,15 @@ Accept wildcard characters: False ``` ### -AllowTitleVisibility + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -81,30 +87,16 @@ 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 -Applicable: Skype for Business Online +### -EnableFileTransfer -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Online -### -EnableFileTransfer This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -114,13 +106,15 @@ Accept wildcard characters: False ``` ### -EnableP2PFileTransfer + +> Applicable: Skype for Business Online + Indicates whether file transfers to Federated partners are allowed. The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -130,13 +124,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Online + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -146,13 +142,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + Unique identifier for the external user communication policy to be modified. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 1 @@ -162,13 +160,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: PSObject Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -178,14 +178,34 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Online + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -195,6 +215,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -202,7 +225,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/Set-CsFIPSConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsFIPSConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Set-CsFIPSConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsFIPSConfiguration.md index 609a96b73c..7e4281cb24 100644 --- a/skype/skype-ps/skype/Set-CsFIPSConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsFIPSConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csfipsconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsFIPSConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csfipsconfiguration +schema: 2.0.0 +title: Set-CsFIPSConfiguration --- # Set-CsFIPSConfiguration @@ -50,7 +51,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsFIPSConfiguration -Identity "global" -RequireFIPSCompliantMedia $True ``` @@ -60,30 +61,16 @@ In Example 1, the RequireFIPSCompliantMedia property of the global FIPS configur ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Force Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -93,6 +80,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique Identity of the FIPS configuration settings to be modified. Because Skype for Business Server only supports a single, global collection of FIPS settings, the only collection that can be modified is the global collection: @@ -104,8 +94,7 @@ If you do not include this parameter the `Set-CsFIPSConfiguration` cmdlet will m ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -115,13 +104,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,6 +122,9 @@ Accept wildcard characters: False ``` ### -RequireFIPSCompliantMedia + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True will Skype for Business Server only allow media sessions with entities that use FIPS compliant algorithms for authentication and authorization. Note that, if you require FIPS compliance, then your users will no longer be able to connect to your system by using a Microsoft Lync Server 2010 A/V Edge server. @@ -142,8 +136,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -153,6 +146,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the FIPS configuration settings are being modified. For example: @@ -166,8 +162,25 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -177,13 +190,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -197,13 +212,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.FIPSConfiguration.FIPSConfiguration The `Set-CsFIPSConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.FIPSConfiguration.FIPSConfiguration object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsFIPSConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.FIPSConfiguration.FIPSConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsFileTransferFilterConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsFileTransferFilterConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Set-CsFileTransferFilterConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsFileTransferFilterConfiguration.md index 711fda67d7..c4b66a58e8 100644 --- a/skype/skype-ps/skype/Set-CsFileTransferFilterConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsFileTransferFilterConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csfiletransferfilterconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsFileTransferFilterConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csfiletransferfilterconfiguration +schema: 2.0.0 +title: Set-CsFileTransferFilterConfiguration --- # Set-CsFileTransferFilterConfiguration @@ -44,7 +45,7 @@ You can also use this cmdlet to change whether or not file transfer filtering is ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsFileTransferFilterConfiguration -Identity site:Redmond -Enabled $False ``` @@ -53,7 +54,7 @@ The command shown in Example 1 disables file transfer filtering for the Redmond To carry out this task, the Enabled parameter is included in the command and is set to $False. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsFileTransferFilterConfiguration -Identity site:Redmond -Extensions @{Add=".ps1"} ``` @@ -65,7 +66,7 @@ To add multiple extensions by using a single command, simply separate the file e Note that you must include the period when specifying a file extension. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsFileTransferFilterConfiguration | Set-CsFileTransferFilterConfiguration -Extensions @{Add=".ps1"} ``` @@ -75,7 +76,7 @@ To do this, the `Get-CsFileTransferFilterConfiguration` cmdlet is first called, That collection is then piped to the `Set-CsFileTransferFilterConfiguration` cmdlet, which adds the .ps1 file extension to each item in the collection. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Set-CsFileTransferFilterConfiguration -Identity site:Redmond -Extensions @{Remove=".ps1"} ``` @@ -84,7 +85,7 @@ In Example 4, the file extension .ps1 is removed from the list of extensions blo This example is identical to Example 3 except that, instead of calling the Add list modifier to add an extension to the list, the Remove list modifier is called to remove an extension from that list. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` $a = Get-CsFileTransferFilterConfiguration -Identity site:Redmond @@ -105,44 +106,10 @@ To make the change to the database, we need to call the `Set-CsFileTransferFilte ## PARAMETERS -### -Identity -Unique identifier of the file transfer configuration you want to modify. -This value will be either global or site:\, where \ is the name of the site to which the settings apply, such as site:Redmond. - -If this parameter is not specified, then the `Set-CsFileTransferFilterConfiguration` cmdlet will, by default, update the global settings. - - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. -This object must be of type FileTransferFilterConfiguration and can be retrieved by calling the `Get-CsFileTransferFilterConfiguration` cmdlet. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Action -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Action Determines the action to be taken if this file transfer filter configuration is enabled. If set to BlockAll then all file transfers will be prohibited, regardless of file extension. If set to Block (the default value) file transfers will be allowed unless the file extension appears as one of the prohibited file types listed in the Extensions property. @@ -152,8 +119,7 @@ To allow unrestricted file transfers (that is, to allow users to exchange any ty ```yaml Type: FileFilterAction Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -163,6 +129,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables or disables file transfer filtering. If this parameter is set to True, files with the specified extensions (or all files, depending on the value of the Action property) cannot be transferred from the client. If this parameter is set to False, any file can be transferred. @@ -172,8 +141,7 @@ Default: True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -183,6 +151,9 @@ Accept wildcard characters: False ``` ### -Extensions + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + List of file extensions that will be blocked. If you attempt to use a Skype for Business Server client to transfer a file that has a file extension matching one of the extensions in this list, that transfer will be blocked and the file will not be transferred. This list is ignored if Action is set to BlockAll (all file transfers are blocked) or if Enabled is set to False (no file transfers are blocked). @@ -195,8 +166,7 @@ By default, the following file extensions are included in the Extensions propert ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -206,13 +176,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -221,30 +193,75 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier of the file transfer configuration you want to modify. +This value will be either global or site:\, where \ is the name of the site to which the settings apply, such as site:Redmond. + +If this parameter is not specified, then the `Set-CsFileTransferFilterConfiguration` cmdlet will, by default, update the global settings. + ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +This object must be of type FileTransferFilterConfiguration and can be retrieved by calling the `Get-CsFileTransferFilterConfiguration` cmdlet. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -258,13 +275,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.FileTransferFilterConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.FileTransferFilterConfiguration + Accepts pipelined input of file transfer filter configuration objects. ## OUTPUTS -### +### None This cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.FileTransferFilterConfiguration object. diff --git a/skype/skype-ps/skype/Set-CsGroupPickupUserOrbit.md b/skype/skype-ps/SkypeForBusiness/Set-CsGroupPickupUserOrbit.md similarity index 87% rename from skype/skype-ps/skype/Set-CsGroupPickupUserOrbit.md rename to skype/skype-ps/SkypeForBusiness/Set-CsGroupPickupUserOrbit.md index 5b56d01e9e..28171a1644 100644 --- a/skype/skype-ps/skype/Set-CsGroupPickupUserOrbit.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsGroupPickupUserOrbit.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csgrouppickupuserorbit applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsGroupPickupUserOrbit -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csgrouppickupuserorbit +schema: 2.0.0 +title: Set-CsGroupPickupUserOrbit --- # Set-CsGroupPickupUserOrbit @@ -27,7 +28,7 @@ This cmdlet will throw an exception if the user is not assigned a group pickup o ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsGroupPickupUserOrbit "Ken Myer" -Orbit "*101" ``` @@ -40,7 +41,28 @@ In this case, the display name "Ken Myer". ## PARAMETERS +### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Orbit + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the new group pickup orbit number to be assigned to the user. The number must be within an orbit pickup range that was created with a type of GroupPickup. For more information on creating call park orbits, see [New-CsCallParkOrbit](https://learn.microsoft.com/powershell/module/skype/New-CsCallParkOrbit). @@ -50,8 +72,7 @@ Values for the Orbit parameter must match the regular expression (\[\*|#\]?\[1-9 ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -61,6 +82,9 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the user whose group pickup orbit number will be modified. Because User is a positional parameter, the -User syntax is not required. The first parameter after the cmdlet is assumed to be the User parameter value. @@ -72,7 +96,6 @@ You can also reference a user account by using the user's Active Directory disti Type: String Parameter Sets: (All) Aliases: DisplayName, SipAddress, Identity -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 1 @@ -82,13 +105,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -97,30 +122,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -134,12 +145,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String This cmdlet supports pipelined input from the `Get-CsUser` cmdlet. ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.Helpers.GroupPickup.DisplayGroupPickupUserOrbit This cmdlet returns an instance of the Microsoft.Rtc.Management.Voice.Helpers.GroupPickup.DisplayGroupPickupUserOrbit object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsHealthMonitoringConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsHealthMonitoringConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Set-CsHealthMonitoringConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsHealthMonitoringConfiguration.md index 6ad6748d7f..55f7b22675 100644 --- a/skype/skype-ps/skype/Set-CsHealthMonitoringConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsHealthMonitoringConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cshealthmonitoringconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsHealthMonitoringConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cshealthmonitoringconfiguration +schema: 2.0.0 +title: Set-CsHealthMonitoringConfiguration --- # Set-CsHealthMonitoringConfiguration @@ -54,7 +55,7 @@ This cmdlet provides a way for you to change either (or both) of the test accoun ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsHealthMonitoringConfiguration -Identity atl-cs-001.litwareinc.com -FirstTestUserSipUri "sip:kenmyer@litwareinc.com" -FirstTestSamAccountName "litwareinc\kenmyer" ``` @@ -63,7 +64,7 @@ The command shown in Example 1 configures the first test user assigned to the he In this example, the SIP address for the new test user is set to sip:kenmyer@litwareinc.com and the SamAccountName for the test user is set to kenmyer. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsHealthMonitoringConfiguration | Set-CsHealthMonitoringConfiguration -FirstTestUserSipUri "sip:kenmyer@litwareinc.com" -FirstTestSamAccountName "litwareinc\kenmyer" ``` @@ -74,7 +75,7 @@ To carry out this task, the command first uses the `Get-CsHealthMonitoringConfig This collection is then piped to the `Set-CsHealthMonitoringConfiguration` cmdlet, which assigns the same first test user SIP address and SamAccountName to each item in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsHealthMonitoringConfiguration | Where-Object {$_.FirstTestUserSipUri -eq "sip:pilar@litwareinc.com"} | Set-CsHealthMonitoringConfiguration -FirstTestUserSipUri "sip:kenmyer@litwareinc.com" -FirstTestSamAccountName "litwareinc\kenmyer" ``` @@ -88,50 +89,57 @@ That filtered collection is then piped to the `Set-CsHealthMonitoringConfigurati ## PARAMETERS -### -Identity -Fully qualified domain name (FQDN) of the pool where the health monitoring configuration settings to be modified have been assigned. -For example: `-Identity atl-cs-001.litwareinc.com`. +### -FirstTestSamAccountName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SamAccountName of the first test user. +The FirstTestSamAccountName must be entered using the format domain\username; for example: + +`-FirstTestSamAccountName litwareinc\kenmyer` ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -FirstTestUserSipUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address of the first test user to be configured for use by this collection of health monitoring settings. +Note that the SIP address must include the sip: prefix. +For example: `-FirstTestUserSipUri "sip:kenmyer@litwareinc.com"`. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -FirstTestSamAccountName -SamAccountName of the first test user. -The FirstTestSamAccountName must be entered using the format domain\username; for example: +### -Force -`-FirstTestSamAccountName litwareinc\kenmyer` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -140,25 +148,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -FirstTestUserSipUri -SIP address of the first test user to be configured for use by this collection of health monitoring settings. -Note that the SIP address must include the sip: prefix. -For example: `-FirstTestUserSipUri "sip:kenmyer@litwareinc.com"`. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the pool where the health monitoring configuration settings to be modified have been assigned. +For example: `-Identity atl-cs-001.litwareinc.com`. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -SecondTestSamAccountName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SamAccountName of the second test user. The SecondTestSamAccountName must be entered using the format domain\username; for example: @@ -167,8 +197,7 @@ The SecondTestSamAccountName must be entered using the format domain\username; f ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -178,6 +207,9 @@ Accept wildcard characters: False ``` ### -SecondTestUserSipUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address of the second test user to be configured for use by this collection of health monitoring settings. Note that the SIP address must include the sip: prefix. For example: `-FirstTestUserSipUri "sip:pilar@litwareinc.com"`. @@ -185,8 +217,7 @@ For example: `-FirstTestUserSipUri "sip:pilar@litwareinc.com"`. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -195,14 +226,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -212,29 +245,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -248,14 +267,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.HealthMonitoring.HealthMonitoringSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.HealthMonitoring.HealthMonitoringSettings + The `Set-CsHealthMonitoringConfiguration` cmdlet accepts pipelined instances of the health monitoring configuration object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsHealthMonitoringConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.HealthMonitoring.HealthMonitoringSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsHostedVoicemailPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsHostedVoicemailPolicy.md similarity index 84% rename from skype/skype-ps/skype/Set-CsHostedVoicemailPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsHostedVoicemailPolicy.md index 812ec3758b..e1c323bb30 100644 --- a/skype/skype-ps/skype/Set-CsHostedVoicemailPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsHostedVoicemailPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cshostedvoicemailpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsHostedVoicemailPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cshostedvoicemailpolicy +schema: 2.0.0 +title: Set-CsHostedVoicemailPolicy --- # Set-CsHostedVoicemailPolicy @@ -42,7 +43,7 @@ You can call the `Get-CsUser` cmdlet and check the HostedVoiceMail property to d ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsHostedVoicemailPolicy -Identity ExRedmond -Destination ExUM.contoso.com ``` @@ -51,7 +52,7 @@ This command modifies the Destination property of a hosted voice mail policy nam It sets the Exchange UM destination for this policy to be at FQDN ExUM.contoso.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $a = (Get-CsHostedVoicemailPolicy -Identity ExRedmond).Organization @@ -70,7 +71,7 @@ The next line uses the += operator to append the assigned string (,corp3.litware Organization is a comma-separated list, so if there's already a value in the list any additional values need to be preceded by a comma.) Finally, in the last line we call the `Set-CsHostedVoicemailPolicy` cmdlet and assign the new Organization string by passing the variable $a to the parameter Organization. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsHostedVoicemailPolicy -Tenant "73d355dd-ce5d-4ab9-bf49-7b822c18dd98" -Destination "ExUM.contoso.com" ``` @@ -80,48 +81,16 @@ The command shown in Example 3 modifies the Destination property of the hosted v ## PARAMETERS -### -Identity -A unique identifier for the hosted voice mail policy you want to modify. -This identifier includes the scope (in the case of global), the scope and site (for a site policy, such as site:Redmond), or the policy name (for a per-user policy, such as HVUserPolicy). - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. -The object must be of type HostedVoicemailPolicy and can be retrieved by calling the `Get-CsHostedVoicemailPolicy` cmdlet. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Description -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Description A friendly description of the policy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,6 +100,9 @@ Accept wildcard characters: False ``` ### -Destination + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The value assigned to this parameter is the fully qualified domain name (FQDN) of the hosted Exchange UM service. Note that the chosen destination must be trusted for routing. @@ -142,8 +114,7 @@ This just means it should be in the form of an FQDN, such as server.litwareinc.c ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -152,15 +123,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Organization -This parameter contains a comma-separated list of the Exchange tenants that contain Skype for Business Server users. -Each tenant must be specified as an FQDN of the tenant on the hosted Exchange Service. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -169,46 +141,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier for the hosted voice mail policy you want to modify. +This identifier includes the scope (in the case of global), the scope and site (for a site policy, such as site:Redmond), or the policy name (for a per-user policy, such as HVUserPolicy). ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +The object must be of type HostedVoicemailPolicy and can be retrieved by calling the `Get-CsHostedVoicemailPolicy` cmdlet. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Organization + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter contains a comma-separated list of the Exchange tenants that contain Skype for Business Server users. +Each tenant must be specified as an FQDN of the tenant on the hosted Exchange Service. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -218,6 +199,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Server 2015 tenant account for which hosted voicemail policy being modified. For example: @@ -233,8 +217,43 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -248,13 +267,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.HostedVoicemailPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.HostedVoicemailPolicy + Accepts pipelined input of hosted voice mail policy objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.HostedVoicemailPolicy This cmdlet modifies an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.HostedVoicemailPolicy ## NOTES diff --git a/skype/skype-ps/skype/Set-CsHostingProvider.md b/skype/skype-ps/SkypeForBusiness/Set-CsHostingProvider.md similarity index 87% rename from skype/skype-ps/skype/Set-CsHostingProvider.md rename to skype/skype-ps/SkypeForBusiness/Set-CsHostingProvider.md index 0e74e387f7..0841bd38c1 100644 --- a/skype/skype-ps/skype/Set-CsHostingProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsHostingProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cshostingprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsHostingProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cshostingprovider +schema: 2.0.0 +title: Set-CsHostingProvider --- # Set-CsHostingProvider @@ -60,7 +61,7 @@ Note that you cannot federate with a hosting provider if your Edge Servers are c ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsHostingProvider -Identity "Fabrikam.com" -VerificationLevel "AlwaysUnverifiable" ``` @@ -69,7 +70,7 @@ Example 1 modifies the hosting provider with the Identity Fabrikam.com. In this example, the VerificationLevel property is set to AlwaysUnverifiable. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsHostingProvider | Set-CsHostingProvider -VerificationLevel "AlwaysUnverifiable" ``` @@ -79,7 +80,7 @@ To do this, `Get-CsHostingProvider` is first used to return a collection of all This collection is then piped to `Set-CsHostingProvider`, which modifies the VerificationLevel property for each provider in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsHostingProvider | Where-Object {$_.EnabledSharedAddressSpace -eq $True -and $_.HostsOCSUsers -eq $True} | Set-CsHostingProvider -EnabledSharedAddressSpace $False -HostsOCSUsers $False ``` @@ -93,40 +94,30 @@ When this is done any hosting providers in the collection will still be enabled ## PARAMETERS -### -Identity -Unique identifier for the hosting provider to be modified. -The Identity might be the FQDN of the hosting provider (for example, fabrikam.com) or perhaps the name of the company providing the services (Fabrikam, Inc.). +### -AutodiscoverUrl -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +URL for the autodiscover service used by a hosting provider that hosts Skype for Business Server accounts. +The autodiscover service enables client applications such as Microsoft Lync Mobile to determine how to access resources such as a user's home pool. -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the network connection between your domain and the hosting provider is enabled. Messages cannot be exchanged between the two organizations until this value is set to True. The default value is False. @@ -134,8 +125,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -145,14 +135,16 @@ Accept wildcard characters: False ``` ### -EnabledSharedAddressSpace + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If True, indicates that the hosting provider is being used in a split domain scenario. The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -161,17 +153,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HostsOCSUsers -If True, indicates that the hosting provider is used to host Skype for Business Server accounts. -If False, that indicates that the provider hosts other account types, such as Microsoft Exchange Server accounts. -The default value is False. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -180,16 +171,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -IsLocal -If True, indicates that the proxy server used by the hosting provider is contained within your own Skype for Business Server topology. +### -HostsOCSUsers + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, indicates that the hosting provider is used to host Skype for Business Server accounts. +If False, that indicates that the provider hosts other account types, such as Microsoft Exchange Server accounts. The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -198,45 +192,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VerificationLevel -Indicates the allowed verification level for messages sent to and from the hosted provider. -The VerificationLevel must be set to one of the following values: +### -Identity -AlwaysVerifiable. -Indicates that all messages sent from the hosting provider are considered verifiable. -That means that no messages from the hosting provider will be rejected. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -AlwaysUnverifiable. -Indicates that all messages sent from the hosting provider are considered unverifiable. -As a result, messages are passed only if the user on the hosting provider is also in your Contacts list. +Unique identifier for the hosting provider to be modified. +The Identity might be the FQDN of the hosting provider (for example, fabrikam.com) or perhaps the name of the company providing the services (Fabrikam, Inc.). -UseSourceVerification. -Relies on the verification level included in messages sent from the hosting provider. -If this level is not specified, then the message will be rejected as being unverifiable. +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: -The default value is AlwaysVerifiable. +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: VerificationLevelType -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -IsLocal + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, indicates that the proxy server used by the hosting provider is contained within your own Skype for Business Server topology. +The default value is False. + ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -245,14 +249,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SipClientPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Port used by the provider for communicating with SIP clients; the default value is 443. +Note that, by default, the SipClientPort is not displayed when you run the `Get-CsHostingProvider` cmdlet. +To see the SipClientPort, use a command similar to this: + +`Get-CsHostingProvider | Select-Object *` ```yaml -Type: SwitchParameter +Type: UInt64 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -261,14 +271,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -VerificationLevel + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the allowed verification level for messages sent to and from the hosted provider. +The VerificationLevel must be set to one of the following values: + +AlwaysVerifiable. +Indicates that all messages sent from the hosting provider are considered verifiable. +That means that no messages from the hosting provider will be rejected. + +AlwaysUnverifiable. +Indicates that all messages sent from the hosting provider are considered unverifiable. +As a result, messages are passed only if the user on the hosting provider is also in your Contacts list. + +UseSourceVerification. +Relies on the verification level included in messages sent from the hosting provider. +If this level is not specified, then the message will be rejected as being unverifiable. + +The default value is AlwaysVerifiable. ```yaml -Type: SwitchParameter +Type: VerificationLevelType Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -277,16 +304,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AutodiscoverUrl -URL for the autodiscover service used by a hosting provider that hosts Skype for Business Server accounts. -The autodiscover service enables client applications such as Microsoft Lync Mobile to determine how to access resources such as a user's home pool. +### -Confirm +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -295,18 +322,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipClientPort -Port used by the provider for communicating with SIP clients; the default value is 443. -Note that, by default, the SipClientPort is not displayed when you run the `Get-CsHostingProvider` cmdlet. -To see the SipClientPort, use a command similar to this: +### -WhatIf -`Get-CsHostingProvider | Select-Object *` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: UInt64 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -320,13 +345,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayHostingProvider object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayHostingProvider + `Set-CsHostingProvider` accepts pipelined instances of the hosting provider object. ## OUTPUTS -### +### None `Set-CsHostingProvider` does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayHostingProvider object. diff --git a/skype/skype-ps/skype/Set-CsHybridApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/Set-CsHybridApplicationEndpoint.md similarity index 86% rename from skype/skype-ps/skype/Set-CsHybridApplicationEndpoint.md rename to skype/skype-ps/SkypeForBusiness/Set-CsHybridApplicationEndpoint.md index 33c98d57dc..56b277fc96 100644 --- a/skype/skype-ps/skype/Set-CsHybridApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsHybridApplicationEndpoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cshybridapplicationendpoint applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsHybridApplicationEndpoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cshybridapplicationendpoint +schema: 2.0.0 +title: Set-CsHybridApplicationEndpoint --- # Set-CsHybridApplicationEndpoint @@ -27,7 +28,7 @@ The `Set-CsHybridApplicationEndpoint` cmdlet enables you to modify the Skype for ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Set-CsHybridApplicationEndpoint -Identity "CN={4f6c99fe-7999-4088-ac4d-e88e0b3d3820},OU=Redmond,DC=litwareinc,DC=com" -DisplayName HybridAppEndpoint1 -LineURI tel:+14255550100 ``` @@ -36,30 +37,16 @@ This example modify the DisplayName and LineURI attributes for the specified hyb ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -DisplayName -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -DisplayName Friendly name for the application endpoint that is being modified. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -69,13 +56,15 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to connect to the specified domain controller in order to retrieve user information. To connect to a particular domain controller, include the DomainController parameter followed by the fully qualified domain name (FQDN) (for example, atl-cs-001.litwareinc.com). ```yaml Type: Fqdn Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -85,13 +74,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The ApplicationId or Client Id for which the endpoint that is being modified. ```yaml Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 0 @@ -101,13 +92,15 @@ Accept wildcard characters: False ``` ### -LineUri + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Valid phone number for the application endpoint that is being modified. (Not currently supported through BOT framework) ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -117,13 +110,33 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + 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: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -133,13 +146,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Set-CsHybridMediationServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsHybridMediationServer.md similarity index 92% rename from skype/skype-ps/skype/Set-CsHybridMediationServer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsHybridMediationServer.md index 22cc44dca7..5e774389d3 100644 --- a/skype/skype-ps/skype/Set-CsHybridMediationServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsHybridMediationServer.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cshybridmediationserver applicable: Skype for Business Online -title: Set-CsHybridMediationServer -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/set-cshybridmediationserver +schema: 2.0.0 +title: Set-CsHybridMediationServer --- # Set-CsHybridMediationServer @@ -34,7 +36,7 @@ Users must be retrieved by their identity and they cannot already have assigned ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsHybridMediationServer -Fqdn users.fabrikam.com -AccessProxyExternalFqdn mediationserver.Contoso.com ``` @@ -45,13 +47,15 @@ This command sets the FQDN of a mediation server. ## PARAMETERS ### -AccessProxyExternalFqdn + +> Applicable: Skype for Business Online + The fully qualified domain name of the Edge server's access proxy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -61,13 +65,15 @@ Accept wildcard characters: False ``` ### -Fqdn + +> Applicable: Skype for Business Online + Specifies the fully qualified domain name of the mediation server that includes the internal Active Directory domain, such as mediationserver.contoso.com ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -77,14 +83,16 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + Specifies the identity of the hybrid public switched telephone network (PSTN) site. For example: `-Identity "SeattlePSTN"`. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 1 @@ -93,14 +101,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. +### -Tenant + +> Applicable: Skype for Business Online + +Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. +For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"`. +You can find your tenant ID by running this command: `Get-CsTenant | Select-Object DisplayName, TenantID` + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online, you do not have to include the Tenant parameter. +The tenant ID will be determined by your connection and credentials. +The Tenant parameter is primarily for use in a hybrid deployment. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -109,20 +125,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Specifies the globally unique identifier (GUID) of your Skype for Business Online tenant account. -For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"`. -You can find your tenant ID by running this command: `Get-CsTenant | Select-Object DisplayName, TenantID` +### -Confirm -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online, you do not have to include the Tenant parameter. -The tenant ID will be determined by your connection and credentials. -The Tenant parameter is primarily for use in a hybrid deployment. +> Applicable: Skype for Business Online + +The Confirm switch causes the command to pause processing and requires confirmation to proceed. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -132,6 +144,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -139,7 +154,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/Set-CsHybridPSTNAppliance.md b/skype/skype-ps/SkypeForBusiness/Set-CsHybridPSTNAppliance.md similarity index 90% rename from skype/skype-ps/skype/Set-CsHybridPSTNAppliance.md rename to skype/skype-ps/SkypeForBusiness/Set-CsHybridPSTNAppliance.md index b3f6d8058f..15bc5ac918 100644 --- a/skype/skype-ps/skype/Set-CsHybridPSTNAppliance.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsHybridPSTNAppliance.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cshybridpstnappliance applicable: Skype for Business Online -title: Set-CsHybridPSTNAppliance -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/set-cshybridpstnappliance +schema: 2.0.0 +title: Set-CsHybridPSTNAppliance --- # Set-CsHybridPSTNAppliance @@ -45,7 +47,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Insert example commands for example 1. ``` @@ -55,30 +57,16 @@ Insert descriptive text for example 1. ## PARAMETERS -### -Identity -PARAMVALUE: XdsGlobalRelativeIdentity - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +### -Force -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Online -### -Confirm PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -87,30 +75,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -PARAMVALUE: SwitchParameter +### -Identity + +> Applicable: Skype for Business Online + +PARAMVALUE: XdsGlobalRelativeIdentity ```yaml -Type: SwitchParameter +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Online + PARAMVALUE: PSObject ```yaml Type: PSObject Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -120,6 +112,9 @@ Accept wildcard characters: False ``` ### -MaintenanceMode + +> Applicable: Skype for Business Online + If set to $True, service resilience detection will be off and no checks for Bits and OS updates will run. This allows administrators to make manual maintenance changes on the host machine. @@ -128,8 +123,7 @@ If set to $False, service resilience detection will be on and checks for Bits an ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -139,13 +133,15 @@ Accept wildcard characters: False ``` ### -MediationServerGruu + +> Applicable: Skype for Business Online + PARAMVALUE: String ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -155,13 +151,33 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + PARAMVALUE: Guid ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Online + +PARAMVALUE: SwitchParameter + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -171,13 +187,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/Set-CsHybridPSTNSite.md b/skype/skype-ps/SkypeForBusiness/Set-CsHybridPSTNSite.md similarity index 91% rename from skype/skype-ps/skype/Set-CsHybridPSTNSite.md rename to skype/skype-ps/SkypeForBusiness/Set-CsHybridPSTNSite.md index 9cc149848a..decfee55af 100644 --- a/skype/skype-ps/skype/Set-CsHybridPSTNSite.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsHybridPSTNSite.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cshybridpstnsite applicable: Skype for Business Online -title: Set-CsHybridPSTNSite -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/set-cshybridpstnsite +schema: 2.0.0 +title: Set-CsHybridPSTNSite --- # Set-CsHybridPSTNSite @@ -43,7 +45,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsHybridPSTNSite -Identity "SeattlePSTN" -EdgeFQDN "Contoso.Denver.Edge.com" -BitsUpdateTimeWindow @{add="FirstWeekend","Night"} -OsUpdateTimeWindow @{add="Weekday"} ``` @@ -53,31 +55,16 @@ This example sets the "SeattlePSTN" site's edge server to "Contoso.Denver.Edge.c ## PARAMETERS -### -Identity -Specifies the identity of the hybrid public switched telephone network (PSTN) site. -For example: `-Identity "SeattlePSTN"`. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +### -BitsUpdateTimeWindow -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Online -### -BitsUpdateTimeWindow Time window for updating Skype for Business Cloud Connector Edition bits on the appliance. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -86,31 +73,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. +### -EdgeFQDN -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +> Applicable: Skype for Business Online -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -EdgeFQDN Specifies the fully qualified domain name of the edge server. For example: `-EdgeFQDN Contoso.Denver.Edge.com` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -120,6 +93,9 @@ Accept wildcard characters: False ``` ### -EnableAutoUpdate + +> Applicable: Skype for Business Online + If set to $true, automatic updates will be turned on for the Skype for Business Cloud Connector Edition appliance. If set to $false, automatic updates will be turned off for the Skype for Business Cloud Connector Edition appliance. The default is $true. @@ -127,8 +103,7 @@ The default is $true. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -138,6 +113,9 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Online + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. @@ -145,8 +123,7 @@ If the Force switch isn't provided in the command, you're prompted for administr ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -155,14 +132,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Skype for Business Online + +Specifies the identity of the hybrid public switched telephone network (PSTN) site. +For example: `-Identity "SeattlePSTN"`. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Instance + +> Applicable: Skype for Business Online + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -172,13 +170,15 @@ Accept wildcard characters: False ``` ### -OsUpdateTimeWindow + +> Applicable: Skype for Business Online + Time window for updating the operating system on the appliance. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -188,6 +188,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Specifies the global unique identifier (GUID) of the Skype for Business Online tenant account on which the cmdlet will operate. For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"`. @@ -200,8 +203,25 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Online + +The Confirm switch causes the command to pause processing and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -211,6 +231,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -218,7 +241,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named @@ -232,13 +254,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Set-CsIPPhonePolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsIPPhonePolicy.md similarity index 83% rename from skype/skype-ps/skype/Set-CsIPPhonePolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsIPPhonePolicy.md index 944e00aac7..69ea1c9542 100644 --- a/skype/skype-ps/skype/Set-CsIPPhonePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsIPPhonePolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csipphonepolicy applicable: Skype for Business Server 2019 -title: Set-CsIPPhonePolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/set-csipphonepolicy +schema: 2.0.0 +title: Set-CsIPPhonePolicy --- # Set-CsIPPhonePolicy @@ -49,14 +51,14 @@ IP phone policies are applied each time a user accesses the system via an IP pho ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsIPPhonePolicy -UserDialTimeoutMS 10000 ``` This example modifies the global IP phone policy UserDialTimeoutMS parameter to 10 seconds (10000 ms). -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsIPPhonePolicy -EnablePowerSaveMode $False -EnableOneTouchVoicemail $False -EnableDeviceUpdate $False ``` @@ -66,15 +68,17 @@ This example sets the EnablePowerSaveMode, EnableOneTouchVoicemail and EnableDev ## PARAMETERS ### -BetterTogetherOverEthernetPairingMode + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + Valid values are: Auto - The phone will get paired with BTOE app Automatically and no need for the user to enter the pairing code. -Manual - The user needs to enter the pairing code manually to pair with the BTOE app. +Manual - The user needs to enter the pairing code manually to pair with the BTOE app. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -83,30 +87,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -DateTimeFormat -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online, Skype for Business Server 2019 +> Applicable: Skype for Business Online, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -DateTimeFormat Specifies the time format to be used. The acceptable values are "24" for a 24 hour time format, or "12" for a 12 hour format. The default is "24". ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,13 +106,15 @@ Accept wildcard characters: False ``` ### -EnableBetterTogetherOverEthernet + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + Specifies whether the Better Together Over Ethernet (BTOE) feature is enabled for users. If $true, and if the BTOE plugin is installed on the IP device, the user can tether the device to a PC and sign in to Skype for Business. The default is $true. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,13 +124,15 @@ Accept wildcard characters: False ``` ### -EnableDeviceUpdate + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + Specifies whether the IP device will be updated by the Skype for Business service. If set to $true, IP devices will get firmware updates from the service, if $false the device will not be updated. The default is $true. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -148,13 +142,15 @@ Accept wildcard characters: False ``` ### -EnableExchangeCalendaring + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + Specifies whether an IP device is enabled to connect to the Exchange Online calendaring service. If $true, users are able to connect to their Exchange calendars. If $false, users will not be able to connect to their calendars. The default is $true. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -164,13 +160,15 @@ Accept wildcard characters: False ``` ### -EnableOneTouchVoicemail + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + Specifies whether the Visual Voicemail feature in Skype for Business Online is enabled. If set to $true, the feature is enabled, otherwise $false. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -180,13 +178,15 @@ Accept wildcard characters: False ``` ### -EnablePowerSaveMode + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + If enabled, phone goes to power saving mode (display turns off) based on values of the PowerSaveDuringOfficeHoursTimeoutMS and PowerSavePostOfficeHoursTimeoutMS parameters. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -196,13 +196,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + The Force switch specifies whether to suppress warning and confirmation messages. It can be useful in scripting to suppress interactive prompts. If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -212,13 +214,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -228,13 +232,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -244,13 +250,15 @@ Accept wildcard characters: False ``` ### -KeyboardLockMaxPinRetry + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + Specifies the maximum number of retries allowed for phone unlock. The default is 5. ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -260,13 +268,15 @@ Accept wildcard characters: False ``` ### -LocalProvisioningServerAddress -Specifies the address of the provisioning server for your organization. + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + +Specifies the address of the provisioning server for your organization. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -276,13 +286,15 @@ Accept wildcard characters: False ``` ### -LocalProvisioningServerPassword -Specifies the password for the provisioning server. + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + +Specifies the password for the provisioning server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -292,13 +304,15 @@ Accept wildcard characters: False ``` ### -LocalProvisioningServerType + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + Specifies the server type for the phone. The default is FTP. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -308,13 +322,15 @@ Accept wildcard characters: False ``` ### -LocalProvisioningServerUser + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + Specifies a username for the provisioning server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -324,13 +340,15 @@ Accept wildcard characters: False ``` ### -PowerSaveDuringOfficeHoursTimeoutMS + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + Specifies the time in milliseconds to wait during office hours before turning on Power Save mode. The default is 900,000. ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -340,13 +358,15 @@ Accept wildcard characters: False ``` ### -PowerSavePostOfficeHoursTimeoutMS + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + Specifies the time in milliseconds to wait after office hours before turning on Power Save mode. The default is 300,000. ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -356,13 +376,15 @@ Accept wildcard characters: False ``` ### -PrioritizedCodecsList + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + Specifies the order in which to prioritize codecs. The default is: "G722_8000;PCMU;PCMA;G729" ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -372,13 +394,15 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -388,13 +412,33 @@ Accept wildcard characters: False ``` ### -UserDialTimeoutMS -Specifies the time in milliseconds to wait in On-Hook mode before dialing out automatically. If a user enters a phone number and does not click Dial, the system will dial the number after the number of milliseconds specified. The default is 5000. + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + +Specifies the time in milliseconds to wait in On-Hook mode before dialing out automatically. If a user enters a phone number and does not click Dial, the system will dial the number after the number of milliseconds specified. The default is 5000. ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -404,6 +448,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online, Skype for Business Server 2019 + System.Management.Automation.SwitchParameter The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -412,7 +459,6 @@ The WhatIf switch causes the command to simulate its results. By using this swit Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online, Skype for Business Server 2019 Required: False Position: Named @@ -426,14 +472,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -System.Management.Automation.PSObject - +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser Microsoft.Rtc.Management.ADConnect.Schema.ADUser ## OUTPUTS -### System.Object +### Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact The `Set-CsIPPhonePolicy` cmdlet does not return a value or object. However, if you include the PassThru parameter, the cmdlet will return instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSUserOrAppContact object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsImConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsImConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Set-CsImConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsImConfiguration.md index d086c199eb..75b5a3c7aa 100644 --- a/skype/skype-ps/skype/Set-CsImConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsImConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csimconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsImConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csimconfiguration +schema: 2.0.0 +title: Set-CsImConfiguration --- # Set-CsImConfiguration @@ -34,7 +35,7 @@ Use the Set-CsImConfiguration cmdlet to modify an existing Instant Messaging (IM ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsImConfiguration -Identity "Site:Redmond" -EnableOfflineIm $false ``` @@ -43,30 +44,16 @@ This example modifies the existing Redmond site IM configuration to disable the ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableOfflineIm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableOfflineIm Enables or disables Offline Instant Messaging. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -76,13 +63,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -92,13 +81,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier specifying the scope and, in some cases the name, of the IM configuration. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 1 @@ -108,13 +99,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. This object must be of type IMConfiguration and can be retrieved by calling the Get-CsImConfiguration cmdlet. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -124,13 +117,33 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -140,13 +153,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Set-CsImFilterConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsImFilterConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Set-CsImFilterConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsImFilterConfiguration.md index cbe1b6db70..86a853473c 100644 --- a/skype/skype-ps/skype/Set-CsImFilterConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsImFilterConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csimfilterconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsImFilterConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csimfilterconfiguration +schema: 2.0.0 +title: Set-CsImFilterConfiguration --- # Set-CsImFilterConfiguration @@ -45,7 +46,7 @@ With this cmdlet you can also update various messages that provide warnings to u ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsImFilterConfiguration -Identity site:Redmond -Enabled $False ``` @@ -54,7 +55,7 @@ The command shown in this example disables URI filtering for the IM filter confi To carry out this task, the Enabled parameter is specified in the call to the `Set-CsImFilterConfiguration` cmdlet with a value of $False. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $x = Get-CsImFilterConfiguration -Identity site:Redmond @@ -70,7 +71,7 @@ This changes the value of the object reference $x. To change the actual configuration itself, line 3 calls the `Set-CsImFilterConfiguration` cmdlet, passing $x as the sole parameter value. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsImFilterConfiguration -Identity site:Redmond -Prefixes @{add="urn:"} ``` @@ -80,7 +81,7 @@ In this command the Prefixes parameter of the `Set-CsImFilterConfiguration` cmdl The add list modifier is used to add this value to the Prefixes list. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Set-CsImFilterConfiguration -Identity site:Redmond -Prefixes @{remove="urn:"} ``` @@ -91,41 +92,10 @@ This example is identical to Example 3 except that rather than calling the add l ## PARAMETERS -### -Identity -The unique identifier of the IM filter configuration settings you want to modify. -This value will either be global or site:\, where \ is the site to which the configuration applies, such as site:Redmond. - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. -This cmdlet accepts an object of type Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration, which can be retrieved by calling the `Get-CsImFilterConfiguration` cmdlet. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Action -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Action The value of this parameter determines the action that will be taken when a hyperlink is included in an instant message: Allow - Hyperlinks are prefixed with an underscore so that the links are no longer active. @@ -141,8 +111,7 @@ If Warn is specified and no WarnMessage is entered, IM filtering is disabled, al ```yaml Type: UrlFilterAction Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -152,14 +121,16 @@ Accept wildcard characters: False ``` ### -AllowMessage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If a value is specified for this parameter, that string is inserted at the beginning of each message containing hyperlinks when the value of the Action property is set to Allow. You can use this message to notify users of things such as the potential dangers of clicking unknown links or your organization's relevant policies and requirements. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -169,6 +140,9 @@ Accept wildcard characters: False ``` ### -BlockFileExtension + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If this parameter is set to True, a hyperlink that contains a file path with an extension specified by the Extensions property defined in the Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.FileTransferFilterConfiguration class (retrieved by calling the `Get-CsFileTransferFilterConfiguration` cmdlet) is blocked and an error message is returned to the sender. If this parameter is set to False, no special check is made for file paths and extensions. @@ -177,8 +151,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -188,6 +161,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables or disables this feature. If this parameter is set to True, instant messages will be scanned for hyperlinks and the rules in this configuration will be applied. If this parameter is set to False, messages will not be checked for hyperlinks. @@ -197,8 +173,25 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -207,7 +200,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the IM filter configuration settings you want to modify. +This value will either be global or site:\, where \ is the site to which the configuration applies, such as site:Redmond. + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -IgnoreLocal + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The value of this parameter controls whether filtering is performed on local Intranet URIs passed in instant messages.If this parameter is set to True, any URI that is defined in the Intranet zone of the local computer is ignored. (The local computer is the Front End Server running the IM Filter application.) If this parameter is set to False, the specified filtering is applied to all hyperlinks. @@ -216,8 +231,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -226,7 +240,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +This cmdlet accepts an object of type Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration, which can be retrieved by calling the `Get-CsImFilterConfiguration` cmdlet. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -Prefixes + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The list of URI prefixes that will be filtered. Any hyperlink included in an instant message with a prefix matching one of the prefixes in this list will be filtered according to the specified settings. @@ -235,8 +271,7 @@ Default: callto:, file:, ftp., ftp:, gopher:, href, http:, https:, ldap:, mailto ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -246,14 +281,16 @@ Accept wildcard characters: False ``` ### -WarnMessage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This parameter contains the warning message that is inserted at the beginning of each instant message that contains hyperlinks when the value of the Action property is set to Warn. Typically this message would be used for such things as stating the potential dangers of clicking unknown links or referring to your organization's relevant policies and requirements. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -262,14 +299,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -279,29 +318,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -315,13 +340,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration + Accepts pipelined input of IM filter configuration objects. ## OUTPUTS -### +### None The `Set-CsImFilterConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ImFilter.ImFilterConfiguration object. diff --git a/skype/skype-ps/skype/Set-CsImTranslationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsImTranslationConfiguration.md similarity index 80% rename from skype/skype-ps/skype/Set-CsImTranslationConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsImTranslationConfiguration.md index 4b9375f9fb..0b81f7662a 100644 --- a/skype/skype-ps/skype/Set-CsImTranslationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsImTranslationConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csimtranslationconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsImTranslationConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csimtranslationconfiguration +schema: 2.0.0 +title: Set-CsImTranslationConfiguration --- # Set-CsImTranslationConfiguration @@ -36,7 +37,7 @@ This cmdlet is reserved for internal Microsoft use. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` This cmdlet is reserved for internal Microsoft use. ``` @@ -47,13 +48,15 @@ This cmdlet is reserved for internal Microsoft use. ## PARAMETERS ### -AccessTokenUri + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -63,13 +66,15 @@ Accept wildcard characters: False ``` ### -ApplicationId + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -79,13 +84,15 @@ Accept wildcard characters: False ``` ### -ClientId + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -95,29 +102,15 @@ Accept wildcard characters: False ``` ### -ClientSecret -This parameter is reserved for internal Microsoft use. -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -127,13 +120,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -143,13 +138,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -159,13 +156,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,13 +174,15 @@ Accept wildcard characters: False ``` ### -ServiceUri + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -191,13 +192,33 @@ Accept wildcard characters: False ``` ### -TranslationType + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -207,13 +228,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Set-CsKerberosAccountAssignment.md b/skype/skype-ps/SkypeForBusiness/Set-CsKerberosAccountAssignment.md similarity index 87% rename from skype/skype-ps/skype/Set-CsKerberosAccountAssignment.md rename to skype/skype-ps/SkypeForBusiness/Set-CsKerberosAccountAssignment.md index 2805bab96e..59b6ee5a24 100644 --- a/skype/skype-ps/skype/Set-CsKerberosAccountAssignment.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsKerberosAccountAssignment.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cskerberosaccountassignment applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsKerberosAccountAssignment -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cskerberosaccountassignment +schema: 2.0.0 +title: Set-CsKerberosAccountAssignment --- # Set-CsKerberosAccountAssignment @@ -50,7 +51,7 @@ To assign an account to a site that currently is not associated with a Kerberos ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsKerberosAccountAssignment -UserAccount "litwareinc\keberostest" -Identity "site:Redmond" @@ -63,52 +64,53 @@ To do this, the first command in the example uses the `Set-CsKerberosAccountAssi ## PARAMETERS -### -Identity -Unique identifier of the site where the Kerberos account was assigned. -(This is the Identity of the site, not of the computer account.) For example: `-Identity "site:Redmond"`. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserAccount -Account name for the account to be assigned, using the format domain_name\user_name. -For example: `-UserAccount "litwareinc\kerberostest"`. -The user name portion of the account (kerberostest) is a NETBIOS name and can contain a maximum of 15 characters. +### -Identity -Note that, despite the name UserAccount, the account is actually a computer account, not a user account. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Unique identifier of the site where the Kerberos account was assigned. +(This is the Identity of the site, not of the computer account.) For example: `-Identity "site:Redmond"`. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -117,14 +119,21 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -UserAccount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Account name for the account to be assigned, using the format domain_name\user_name. +For example: `-UserAccount "litwareinc\kerberostest"`. +The user name portion of the account (kerberostest) is a NETBIOS name and can contain a maximum of 15 characters. + +Note that, despite the name UserAccount, the account is actually a computer account, not a user account. + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -133,14 +142,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -149,14 +160,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -170,13 +183,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.KerberosAccount.KerberosAccountAssignment object. +### Microsoft.Rtc.Management.WritableConfig.Settings.KerberosAccount.KerberosAccountAssignment + The `Set-CsKerberosAccountAssignment` cmdlet accepts pipelined instances of the Kerberos account assignment object. ## OUTPUTS -### +### None The `Set-CsKerberosAccountAssignment` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.KerberosAccount.KerberosAccountAssignment object. diff --git a/skype/skype-ps/skype/Set-CsKerberosAccountPassword.md b/skype/skype-ps/SkypeForBusiness/Set-CsKerberosAccountPassword.md similarity index 86% rename from skype/skype-ps/skype/Set-CsKerberosAccountPassword.md rename to skype/skype-ps/SkypeForBusiness/Set-CsKerberosAccountPassword.md index 53c7a9e3e7..791859bd44 100644 --- a/skype/skype-ps/skype/Set-CsKerberosAccountPassword.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsKerberosAccountPassword.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cskerberosaccountpassword applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsKerberosAccountPassword -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cskerberosaccountpassword +schema: 2.0.0 +title: Set-CsKerberosAccountPassword --- # Set-CsKerberosAccountPassword @@ -50,7 +51,7 @@ In addition, the cmdlet can also use the ToComputer and FromComputer parameters ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsKerberosAccountPassword -UserAccount "litwareinc\kerberostest" ``` @@ -58,7 +59,7 @@ Set-CsKerberosAccountPassword -UserAccount "litwareinc\kerberostest" The command shown in Example 1 sets the password for the Kerberos account litwareinc\kerberostest. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsKerberosAccountPassword -FromComputer "atl-cs-001.litwareinc.com" -ToComputer "dublin-cs-001.litwareinc.com" ``` @@ -68,15 +69,35 @@ In Example 2, the Kerberos account password is copied from the computer atl-cs-0 ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -FromComputer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the computer containing the Kerberos account's password that will be copied to another computer. This parameter cannot be used if you use the UserAccount parameter. ```yaml Type: Fqdn Parameter Sets: ByFqdn -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -85,15 +106,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: `-Report "C:\Logs\SetKerberosPassword.html"`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ToComputer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of the computer where the Kerberos account password will be copied. This parameter cannot be used if you use the UserAccount parameter. ```yaml Type: Fqdn Parameter Sets: ByFqdn -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -103,6 +145,9 @@ Accept wildcard characters: False ``` ### -UserAccount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Account name for the account whose password should be changed. This account name must use the format domain_name\user_name; for example: `-UserAccount "litwareinc\kerberostest"`. @@ -111,8 +156,7 @@ Note that, despite the name UserAccount, the account is actually a computer acco ```yaml Type: String Parameter Sets: ByUser -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -121,31 +165,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Confirm -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: `-Report "C:\Logs\SetKerberosPassword.html"`. +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -155,29 +184,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -191,12 +206,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### None The `Set-CsKerberosAccountPassword` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.KerberosAccount.KerberosAccount object. diff --git a/skype/skype-ps/skype/Set-CsLisLocation.md b/skype/skype-ps/SkypeForBusiness/Set-CsLisLocation.md similarity index 64% rename from skype/skype-ps/skype/Set-CsLisLocation.md rename to skype/skype-ps/SkypeForBusiness/Set-CsLisLocation.md index 61ea6408ff..3d328c4599 100644 --- a/skype/skype-ps/skype/Set-CsLisLocation.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsLisLocation.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cslislocation applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsLisLocation -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cslislocation +schema: 2.0.0 +title: Set-CsLisLocation --- # Set-CsLisLocation @@ -53,7 +54,7 @@ This information can be entered by using the `Set-CsLisPort` cmdlet, the `Set-Cs ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsLisLocation -Location Bldg30NEWing -HouseNumber 1000 -StreetName Main -City Redmond -State WA -Country US ``` @@ -67,7 +68,7 @@ Note that if you run a command with just the parameters shown here you will be p However, you can simply press Enter at each prompt without supplying values and your location will be created. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsLisLocation -Location "Suite 100/Office 20" -CompanyName "Litware, Inc." -HouseNumber 1234 -HouseNumberSuffix "" -PreDirectional "" -StreetName Main -StreetSuffix St -PostDirectional "" -City Redmond -State WA -PostalCode 99999 -Country US ``` @@ -77,7 +78,7 @@ However, in this example the command specifies all the parameters for the cmdlet This will avoid the prompts that will follow the command in Example 1 because this example instead simply sets any values we want to leave blank to empty strings. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $a = Get-CsLisLocation | Where-Object {$_.Location -ceq "Bldg30NEWing"} @@ -102,7 +103,7 @@ If it does, this example will not work. To modify multiple locations at once, see Example 4. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` $a = Get-CsLisLocation | Where-Object {$_.Location -ceq "NorthCampus"} @@ -126,35 +127,18 @@ Simply pipe the results of the `Where-Object` cmdlet command to the `Set-CsLisLo ## PARAMETERS -### -Instance -A reference to a location object. -This object must contain the properties required to create a location. -You can retrieve an object of this type by calling the `Get-CsLisLocation` cmdlet. +### -City +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: PSObject -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -City The location city. Maximum length: 64 characters. ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -163,29 +147,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -CompanyName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 The name of the company at this location. Maximum length: 60 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -194,29 +166,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Country -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Country The country/region this location is in. Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -225,20 +186,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -HouseNumber -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -HouseNumber The house number of the location. For a company this is the number on the street where the company is located. @@ -246,9 +197,8 @@ Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -257,20 +207,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -HouseNumberSuffix -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -HouseNumberSuffix Additional information for the house number, such as 1/2 or A. For example, 1234 1/2 Oak Street or 1234 A Elm Street. @@ -281,9 +221,8 @@ Maximum length: 5 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -292,20 +231,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A reference to a location object. +This object must contain the properties required to create a location. +You can retrieve an object of this type by calling the `Get-CsLisLocation` cmdlet. + ```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: LocationEnumeratedOptionalSet +Aliases: Required: True -Position: Named +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### -Location + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name for this location. Typically this value is the name of a location more specific than the civic address, such as an office number, but it can be any string value. @@ -313,9 +262,8 @@ Maximum length: 20 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -324,29 +272,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PostalCode -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PostalCode The postal code associated with this location. Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -355,20 +292,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PostDirectional -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PostDirectional The directional designation of a street name. For example, NE or NW for Main Street NE or 7th Avenue NW. @@ -376,9 +303,8 @@ Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -387,20 +313,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PreDirectional -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PreDirectional The directional designation for a street name that precedes the name of the street. For example, NE or NW for NE Main Street or NW 7th Avenue. @@ -408,9 +324,8 @@ Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -419,29 +334,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -State -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -State The state or province associated with this location. Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -450,29 +354,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -StreetName -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -StreetName The name of the street for this location. Maximum length: 60 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -481,29 +374,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -StreetSuffix -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -StreetSuffix The type of street designated in a street name, such as Street, Avenue, or Court. Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -512,27 +394,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Confirm -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -541,14 +412,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -562,14 +435,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String Accepts pipelined input of LIS location objects. ## OUTPUTS -### +### None This cmdlet does not return a value or object. -It creates or modifies an object of type System.Management.Automation.PSCustomObject. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsLisPort.md b/skype/skype-ps/SkypeForBusiness/Set-CsLisPort.md similarity index 67% rename from skype/skype-ps/skype/Set-CsLisPort.md rename to skype/skype-ps/SkypeForBusiness/Set-CsLisPort.md index 62814d4f3e..b795a92770 100644 --- a/skype/skype-ps/skype/Set-CsLisPort.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsLisPort.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cslisport applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsLisPort -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cslisport +schema: 2.0.0 +title: Set-CsLisPort --- # Set-CsLisPort @@ -69,7 +70,7 @@ Keep in mind that although a new switch entry will be created, that switch will ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsLisPort -ChassisID 99-99-99-99-99-99 -PortID 4200 -PortIDSubType 1 ``` @@ -89,7 +90,7 @@ That means that if this port were associated with an address (a physical locatio The location will still exist in the location database, but it will not be associated with this port. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsLisPort -ChassisID 99-99-99-99-99-99 -PortID 4200 -PortIdSubType 1 -Location "30/1000" -HouseNumber 1234 -PreDirectional NE -StreetName First -StreetSuffix Avenue -City Redmond -State WA -Country US -PostalCode 99999 ``` @@ -98,7 +99,7 @@ Example 2 updates the port created in Example 1 by adding address information. If the address does not exist in the location database, this cmdlet will create that location. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $a = Get-CsLisPort | Where-Object {$_.ChassisID -eq "99-99-99-99-99-88"} @@ -117,6 +118,9 @@ This cmdlet will take each item in that collection and update it with the values ## PARAMETERS ### -ChassisID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The MAC address of the port's switch. This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab, or as an IP address. If the combination of ChassisID, PortID, and PortIDSubType is unique, a new port location will be created. @@ -125,8 +129,7 @@ If this combination is not unique, the port location with that key combination w ```yaml Type: String Parameter Sets: LocationEnumeratedOptionalSet, PortSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -136,15 +139,17 @@ Accept wildcard characters: False ``` ### -City + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The location city of this port. Maximum length: 64 characters. ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -153,29 +158,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -CompanyName -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -CompanyName The name of the company at this location. Maximum length: 60 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -184,29 +178,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Country -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Country The country/region this port is in. Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -215,27 +198,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Description -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Description A detailed description of this port location. ```yaml Type: String Parameter Sets: LocationEnumeratedOptionalSet, PortSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -245,6 +217,9 @@ Accept wildcard characters: False ``` ### -HouseNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The house number of the location for the port. For a company this is the number on the street where the company is located. @@ -252,9 +227,8 @@ Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -263,20 +237,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -HouseNumberSuffix -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -HouseNumberSuffix Additional information for the house number, such as 1/2 or A. For example, 1234 1/2 Oak Street or 1234 A Elm Street. @@ -287,9 +251,8 @@ Maximum length: 5 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -298,20 +261,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Location -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Location The name for this location. Typically this value is the name of a location more specific than the civic address, such as an office number, but it can be any string value. @@ -319,9 +272,8 @@ Maximum length: 20 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -330,27 +282,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PortID -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PortID The ID of the port associated with this location. ```yaml Type: String Parameter Sets: LocationEnumeratedOptionalSet, PortSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -360,6 +301,9 @@ Accept wildcard characters: False ``` ### -PortIDSubType + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The subtype of the port. This value can be entered as a numeric value or a string, but it must be a valid subtype. Valid subtypes are: @@ -375,8 +319,7 @@ Default: 7 (LocallyAssigned) ```yaml Type: PortIDSubType Parameter Sets: LocationEnumeratedOptionalSet, PortSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -386,15 +329,17 @@ Accept wildcard characters: False ``` ### -PostalCode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The postal code associated with this location. Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -403,20 +348,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PostDirectional -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PostDirectional The directional designation of a street name. For example, NE or NW for Main Street NE or 7th Avenue NW. @@ -424,9 +359,8 @@ Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -435,20 +369,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PreDirectional -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PreDirectional The directional designation for a street name that precedes the name of the street. For example, NE or NW for NE Main Street or NW 7th Avenue. @@ -456,9 +380,8 @@ Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -467,29 +390,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -State -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -State The state or province associated with this location. Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -498,29 +410,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -StreetName -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -StreetName The name of the street for this location. Maximum length: 60 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -529,29 +430,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -StreetSuffix -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -StreetSuffix The type of street designated in a street name, such as Street, Avenue, or Court. Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -560,27 +450,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Confirm -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -589,14 +468,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -610,12 +491,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String Accepts pipelined input of LIS port objects. ## OUTPUTS -### +### None This cmdlet creates or modifies an object of type System.Management.Automation.PSCustomObject. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsLisServiceProvider.md b/skype/skype-ps/SkypeForBusiness/Set-CsLisServiceProvider.md similarity index 87% rename from skype/skype-ps/skype/Set-CsLisServiceProvider.md rename to skype/skype-ps/SkypeForBusiness/Set-CsLisServiceProvider.md index 135b7b925b..09a526cb80 100644 --- a/skype/skype-ps/skype/Set-CsLisServiceProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsLisServiceProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cslisserviceprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsLisServiceProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cslisserviceprovider +schema: 2.0.0 +title: Set-CsLisServiceProvider --- # Set-CsLisServiceProvider @@ -35,7 +36,7 @@ This cmdlet will not succeed unless it can resolve the URL and security informat ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $p = Read-Host -AsSecureString @@ -63,14 +64,16 @@ Finally, we pass the variable $p (which contains the secure string with the web ## PARAMETERS ### -CertFileName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name (and full path) of the certificate file. This file must have a PFX file extension. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -80,14 +83,16 @@ Accept wildcard characters: False ``` ### -Password + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A secure string containing the password needed to access the certificate in the password protected file. Secure strings can be created by using the `ConvertTo-SecureString` cmdlet or the `Read-Host` cmdlet with the AsSecureString parameter. ```yaml Type: SecureString Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -97,13 +102,15 @@ Accept wildcard characters: False ``` ### -ServiceProviderName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name of the E9-1-1 Network Routing Provider. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -113,14 +120,16 @@ Accept wildcard characters: False ``` ### -ValidationServiceUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The URL of the web service. This must be a secure URL, beginning with the prefix https://. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -129,14 +138,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -145,14 +156,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -166,12 +179,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String Accepts pipelined input of Location Information Server (LIS) service provider objects. ## OUTPUTS -### +### None This cmdlet creates or modifies an object of type System.Management.Automation.PSCustomObject. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsLisSubnet.md b/skype/skype-ps/SkypeForBusiness/Set-CsLisSubnet.md similarity index 61% rename from skype/skype-ps/skype/Set-CsLisSubnet.md rename to skype/skype-ps/SkypeForBusiness/Set-CsLisSubnet.md index d8f243e8d0..c676037456 100644 --- a/skype/skype-ps/skype/Set-CsLisSubnet.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsLisSubnet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cslissubnet applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsLisSubnet -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cslissubnet +schema: 2.0.0 +title: Set-CsLisSubnet --- # Set-CsLisSubnet @@ -61,7 +62,7 @@ It is recommended that you be as specific as possible with the location paramete ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsLisSubnet -Subnet 192.10.10.0 ``` @@ -81,33 +82,18 @@ The location will still exist in the location database, but it will not be assoc ## PARAMETERS -### -Subnet -The IP address of the subnet. -This value should be entered as an IPv4 address (digits separated by periods, such as 192.0.2.0). - -```yaml -Type: String -Parameter Sets: LocationEnumeratedOptionalSet, SubnetSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -City -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -City The location city. Maximum length: 64 characters. ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -116,29 +102,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -CompanyName -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -CompanyName The name of the company at this location. Maximum length: 60 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -147,29 +122,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Country -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Country The country/region this location is in. Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -178,27 +142,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Description -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Description A detailed description of this subnet location. ```yaml Type: String Parameter Sets: LocationEnumeratedOptionalSet, SubnetSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -208,6 +161,9 @@ Accept wildcard characters: False ``` ### -HouseNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The house number of the location. For a company this is the number on the street where the company is located. @@ -215,9 +171,8 @@ Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -226,20 +181,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -HouseNumberSuffix -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -HouseNumberSuffix Additional information for the house number, such as 1/2 or A. For example, 1234 1/2 Oak Street or 1234 A Elm Street. @@ -250,9 +195,8 @@ Maximum length: 5 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -261,20 +205,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Location -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Location The name for this location. Typically this value is the name of a location more specific than the civic address, such as an office number, but it can be any string value. @@ -282,9 +216,8 @@ Maximum length: 20 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -293,29 +226,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PostalCode -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PostalCode The postal code associated with this location. Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -324,20 +246,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PostDirectional -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PostDirectional The directional designation of a street name. For example, NE or NW for Main Street NE or 7th Avenue NW. @@ -345,9 +257,8 @@ Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -356,20 +267,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PreDirectional -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PreDirectional The directional designation for a street name that precedes the name of the street. For example, NE or NW for NE Main Street or NW 7th Avenue. @@ -377,9 +278,8 @@ Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -388,29 +288,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -State -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -State The state or province associated with this location. Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -419,29 +308,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -StreetName -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -StreetName The name of the street for this location. Maximum length: 60 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -450,29 +328,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -StreetSuffix -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -StreetSuffix The type of street designated in a street name, such as Street, Avenue, or Court. Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -481,11 +348,17 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` +### -Subnet + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The IP address of the subnet. +This value should be entered as an IPv4 address (digits separated by periods, such as 192.0.2.0). + ```yaml Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, SubnetSet +Aliases: Required: True Position: Named @@ -494,14 +367,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -510,14 +385,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -531,12 +408,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String Accepts pipelined input of LIS subnet objects. ## OUTPUTS -### +### None This cmdlet creates or modifies an object of type System.Management.Automation.PSCustomObject. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsLisSwitch.md b/skype/skype-ps/SkypeForBusiness/Set-CsLisSwitch.md similarity index 64% rename from skype/skype-ps/skype/Set-CsLisSwitch.md rename to skype/skype-ps/SkypeForBusiness/Set-CsLisSwitch.md index 13f563aa57..c80af3b9cf 100644 --- a/skype/skype-ps/skype/Set-CsLisSwitch.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsLisSwitch.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cslisswitch applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsLisSwitch -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cslisswitch +schema: 2.0.0 +title: Set-CsLisSwitch --- # Set-CsLisSwitch @@ -67,7 +68,7 @@ The MACResolverUrl property specifies the URL for a web service that is capable ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsLisSwitch -ChassisID 99-99-99-99-99-99 ``` @@ -85,7 +86,7 @@ That means that if this switch were associated with an address (a physical locat The location will still exist in the location database, but it will not be associated with this switch. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsLisSwitch -ChassisID 99-99-99-99-99-99 -Location "30/1000" -HouseNumber 1234 -PreDirectional NE -StreetName First -StreetSuffix Avenue -City Redmond -State WA -Country US -PostalCode 99999 ``` @@ -97,6 +98,9 @@ Example 2 updates the switch created in Example 1 by adding address information. ## PARAMETERS ### -ChassisID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Media Access Control (MAC) address of the network switch. This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab, or in the form of an IP address. If an entry with the specified ChassisID value does not exist, a new switch location will be created. @@ -105,8 +109,7 @@ If an entry with the specified ChassisID does exist, that entry will be replaced ```yaml Type: String Parameter Sets: LocationEnumeratedOptionalSet, SwitchSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -116,15 +119,17 @@ Accept wildcard characters: False ``` ### -City + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The location city. Maximum length: 64 characters. ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -133,29 +138,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -CompanyName -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -CompanyName The name of the company at this location. Maximum length: 60 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -164,29 +158,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Country -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Country The country/region this location is in. Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -195,27 +178,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Description -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Description A detailed description of this network switch location. ```yaml Type: String Parameter Sets: LocationEnumeratedOptionalSet, SwitchSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,6 +197,9 @@ Accept wildcard characters: False ``` ### -HouseNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The house number of the location. For a company this is the number on the street where the company is located. @@ -232,9 +207,8 @@ Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -243,20 +217,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -HouseNumberSuffix -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -HouseNumberSuffix Additional information for the house number, such as 1/2 or A. For example, 1234 1/2 Oak Street or 1234 A Elm Street. @@ -267,9 +231,8 @@ Maximum length: 5 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -278,20 +241,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Location -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Location The name for this location. Typically this value is the name of a location more specific than the civic address, such as an office number, but it can be any string value. @@ -299,9 +252,8 @@ Maximum length: 20 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -310,29 +262,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PostalCode -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PostalCode The postal code associated with this location. Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -341,20 +282,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PostDirectional -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PostDirectional The directional designation of a street name. For example, NE or NW for Main Street NE or 7th Avenue NW. @@ -362,9 +293,8 @@ Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -373,20 +303,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PreDirectional -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PreDirectional The directional designation for a street name that precedes the name of the street. For example, NE or NW for NE Main Street or NW 7th Avenue. @@ -394,9 +314,8 @@ Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -405,29 +324,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -State -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -State The state or province associated with this location. Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -436,29 +344,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -StreetName -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -StreetName The name of the street for this location. Maximum length: 60 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -467,29 +364,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -StreetSuffix -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -StreetSuffix The type of street designated in a street name, such as Street, Avenue, or Court. Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -498,27 +384,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Confirm -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -527,14 +402,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -548,12 +425,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String Accepts pipelined input of LIS switch objects. ## OUTPUTS -### +### None This cmdlet creates or modifies an object of type System.Management.Automation.PSCustomObject. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsLisWirelessAccessPoint.md b/skype/skype-ps/SkypeForBusiness/Set-CsLisWirelessAccessPoint.md similarity index 62% rename from skype/skype-ps/skype/Set-CsLisWirelessAccessPoint.md rename to skype/skype-ps/SkypeForBusiness/Set-CsLisWirelessAccessPoint.md index 31b0d854db..65f1889ab7 100644 --- a/skype/skype-ps/skype/Set-CsLisWirelessAccessPoint.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsLisWirelessAccessPoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csliswirelessaccesspoint applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsLisWirelessAccessPoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csliswirelessaccesspoint +schema: 2.0.0 +title: Set-CsLisWirelessAccessPoint --- # Set-CsLisWirelessAccessPoint @@ -62,7 +63,7 @@ It is recommended that you be as specific as possible with the location paramete ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsLisWirelessAccessPoint -BSSID 99-99-99-99-99-99 ``` @@ -80,7 +81,7 @@ That means that if this WAP were associated with an address (a physical location The location will still exist in the location database, but it will not be associated with this WAP. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsLisWirelessAccessPoint -BSSID 99-99-99-99-99-99 -Location "30/1000" -HouseNumber 1234 -PreDirectional NE -StreetName First -StreetSuffix Avenue -City Redmond -State WA -Country US -PostalCode 99999 ``` @@ -92,6 +93,9 @@ Example 2 updates the WAP created in Example 1 by adding address information. ## PARAMETERS ### -BSSID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Basic Service Set Identifier (BSSID) of the wireless access point. This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. If an entry with the specified BSSID value does not exist, a new WAP location will be created. @@ -100,8 +104,7 @@ If an entry with the specified BSSID does exist, that entry will be replaced. ```yaml Type: String Parameter Sets: LocationEnumeratedOptionalSet, WAPSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -111,15 +114,17 @@ Accept wildcard characters: False ``` ### -City + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The location city. Maximum length: 64 characters. ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -128,29 +133,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -CompanyName -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -CompanyName The name of the company at this location. Maximum length: 60 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -159,29 +153,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Country -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Country The country/region this location is in. Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -190,27 +173,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Description -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Description A detailed description of this WAP location. ```yaml Type: String Parameter Sets: LocationEnumeratedOptionalSet, WAPSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -220,6 +192,9 @@ Accept wildcard characters: False ``` ### -HouseNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The house number of the location. For a company this is the number on the street where the company is located. @@ -227,9 +202,8 @@ Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -238,20 +212,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -HouseNumberSuffix -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -HouseNumberSuffix Additional information for the house number, such as 1/2 or A. For example, 1234 1/2 Oak Street or 1234 A Elm Street. @@ -262,9 +226,8 @@ Maximum length: 5 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -273,20 +236,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Location -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Location The name for this location. Typically this value is the name of a location more specific than the civic address, such as an office number, but it can be any string value. @@ -294,9 +247,8 @@ Maximum length: 20 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -305,29 +257,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PostalCode -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PostalCode The postal code associated with this location. Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -336,20 +277,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PostDirectional -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PostDirectional The directional designation of a street name. For example, NE or NW for Main Street NE or 7th Avenue NW. @@ -357,9 +288,8 @@ Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -368,20 +298,10 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PreDirectional -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -PreDirectional The directional designation for a street name that precedes the name of the street. For example, NE or NW for NE Main Street or NW 7th Avenue. @@ -389,9 +309,8 @@ Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -400,29 +319,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -State -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -State The state or province associated with this location. Maximum length: 2 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -431,29 +339,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -StreetName -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -StreetName The name of the street for this location. Maximum length: 60 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -462,29 +359,18 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -StreetSuffix -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -StreetSuffix The type of street designated in a street name, such as Street, Avenue, or Court. Maximum length: 10 characters ```yaml Type: String -Parameter Sets: LocationEnumeratedOptionalSet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: LocationEnumeratedOptionalSet, LocationEnumeratedMandatorySet +Aliases: Required: False Position: Named @@ -493,27 +379,16 @@ Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: LocationEnumeratedMandatorySet -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Confirm -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByPropertyName) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -522,14 +397,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -543,12 +420,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String Accepts pipelined input of LIS wireless access point objects. ## OUTPUTS -### +### None This cmdlet creates or modifies an object of type System.Management.Automation.PSCustomObject. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsLocationPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsLocationPolicy.md similarity index 86% rename from skype/skype-ps/skype/Set-CsLocationPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsLocationPolicy.md index 6586f63b11..4c8af2b977 100644 --- a/skype/skype-ps/skype/Set-CsLocationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsLocationPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cslocationpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsLocationPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cslocationpolicy +schema: 2.0.0 +title: Set-CsLocationPolicy --- # Set-CsLocationPolicy @@ -49,7 +50,7 @@ This cmdlet modifies an existing location policy. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsLocationPolicy -Identity site:Redmond -EnhancedEmergencyServicesEnabled $True ``` @@ -58,7 +59,7 @@ This command uses the `Set-CsLocationPolicy` cmdlet to modify the location polic (In other words, it modifies the location policy applied to the Redmond site.) In this case, the command sets the value of the EnhancedEmergencyServicesEnabled property to True, which will enable E9-1-1 functionality for all users connected to (in this case) the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLocationPolicy | Where-Object {$_.ConferenceUri -ne $null} | Set-CsLocationPolicy -ConferenceMode twoway ``` @@ -72,46 +73,10 @@ This collection is then piped to the `Set-CsLocationPolicy` cmdlet, which then m ## PARAMETERS -### -Identity -The unique identifier of the location policy you want to modify. -To modify the global location policy, use a value of Global. -For a policy created at the site scope, this value will be in the form site:\, where site name is the name of a site defined in the Skype for Business Server deployment (for example, site:Redmond). -For a policy created at the per-user scope, this value will simply be the name of the policy, such as Reno. - - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -A reference to a location policy object. -This object must be of type Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationPolicy, which can be retrieved by calling the `Get-CsLocationPolicy` cmdlet. -Retrieve this object, change the properties in memory and then pass the object reference as a value to this parameter to update that location policy. - +### -ConferenceMode -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -ConferenceMode If a value is specified for the ConferenceUri parameter, the ConferenceMode parameter determines whether a third party can participate in the call or can only listen in. Available values are: @@ -123,8 +88,7 @@ Twoway: Third party can listen in and participate in the call between the caller ```yaml Type: ConferenceModeEnum Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,6 +98,9 @@ Accept wildcard characters: False ``` ### -ConferenceUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The SIP Uniform Resource Identifier (URI), in this case the telephone number, of a third party that will be conferenced in to any emergency calls that are made. For example, the company security office could receive a call when an emergency call is made and listen in or participate in that call (depending on the value of the ConferenceMode property). @@ -142,8 +109,7 @@ The string must be from 1 to 256 characters in length and must begin with the pr ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -153,14 +119,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A detailed description of this location. For example, "Building 30, 3rd Floor, Northeast corner". ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -170,6 +138,9 @@ Accept wildcard characters: False ``` ### -EmergencyDialMask + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A number that is dialed that will be translated into the value of the EmergencyDialString property. For example, if EmergencyDialMask has a value of "212" and EmergencyDialString has a value of "911", if a user dials 212 the call will be made to 911. This allows for alternate emergency numbers to be dialed and still have the call reach emergency services (for example, if someone from a country/region with a different emergency number attempts to dial that country/region's number rather than the number for the country/region they're currently in). @@ -187,8 +158,7 @@ Each character must be a digit 0 through 9. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -198,6 +168,9 @@ Accept wildcard characters: False ``` ### -EmergencyDialString + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number that is dialed to reach emergency services. In the United States this value is "911". @@ -206,8 +179,7 @@ The string must be made of the digits 0 through 9 and can be from 1 to 10 charac ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -216,16 +188,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnhancedEmergencyServicesEnabled -Specifies whether the users associated with this policy are enabled for E9-1-1. -Set the value to True to enable E9-1-1, so Skype for Business Server clients will retrieve location information on registration and include that information when an emergency call is made. +### -EmergencyNumbers +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +{{Fill EmergencyNumbers Description}} ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -234,23 +206,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocationRequired -If the client was unable to retrieve a location from the location configuration database, the user can be prompted to manually enter a location. -This parameter accepts the following values: +### -EnhancedEmergencyServiceDisclaimer -- no: The user will not be prompted for a location. When a call is made with no location information, the Emergency Service Provider will answer the call and ask for a location. -- yes: The user will be prompted to input location information when the client registers at a new location. The user can dismiss the prompt without entering any information. If information is entered, a call made to 911 will first be answered by the Emergency Service Provider to verify the location before being routed to the PSAP (that is, the 911 operator). -- disclaimer: This option is the same as yes except that if the user dismisses the prompt disclaimer text will be displayed that can alert the user to the consequences of declining to enter location information. (The disclaimer text must be set by calling the `Set-CsEnhancedEmergencyServiceDisclaimer` cmdlet.) +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -This value is ignored if EnhancedEmergencyServicesEnabled is set to False (the default). -Users will not be prompted for location information. +Text value containing information that will be displayed to users who are connected from locations that cannot be resolved by the location mapping (wiremap) who choose not to enter their location manually. +To remove a service disclaimer from a location policy set this property to a null value: + +`-EnhancedEmergencyServiceDisclaimer $Null` + +Location policies, and the EnhancedEmergencyServiceDisclaimer property, should be used in Skype for Business Server to set disclaimers for the E9-1-1 service. +By using location policies to set these disclaimers, you can create different disclaimers for different locales or different sets of users. ```yaml -Type: LocationRequiredEnum +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -259,23 +231,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NotificationUri -One or more SIP Uniform Resource Identifiers (URIs) to be notified when an emergency call is made. -For example, the company security office could be notified through an instant message whenever an emergency call is made. -If the caller's location is available that location will be included in the notification. +### -EnhancedEmergencyServicesEnabled -Multiple SIP URIs can be included as a comma-separated list. -For example, `-NotificationUri sip:security@litwareinc.com,sip:kmyer@litwareinc.com`. -Note that, with the release of Skype for Business Server distribution lists can now be configured as a notification URI. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The string must be from 1 to 256 characters in length and must begin with the prefix sip:. +Specifies whether the users associated with this policy are enabled for E9-1-1. +Set the value to True to enable E9-1-1, so Skype for Business Server clients will retrieve location information on registration and include that information when an emergency call is made. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -284,19 +251,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PstnUsage -The public switched telephone network (PSTN) usage that will be used to determine which voice route will be used to route 911 calls from clients using this profile. -The route associated with this usage should point to a SIP trunk dedicated to emergency calls. +### -Force -The usage must already exist in the global list of PSTN usages. -Call the `Get-CsPstnUsage` cmdlet to retrieve a list of usages. -To create a new usage, call the `Set-CsPstnUsage` cmdlet. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -305,48 +269,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseLocationForE911Only -Location information can be used by the Skype for Business Server client for various reasons (such as notifying teammates of current location). -Set this value to True to ensure location information is available only for use with an emergency call. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the location policy you want to modify. +To modify the global location policy, use a value of Global. +For a policy created at the site scope, this value will be in the form site:\, where site name is the name of a site defined in the Skype for Business Server deployment (for example, site:Redmond). +For a policy created at the per-user scope, this value will simply be the name of the policy, such as Reno. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A reference to a location policy object. +This object must be of type Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationPolicy, which can be retrieved by calling the `Get-CsLocationPolicy` cmdlet. +Retrieve this object, change the properties in memory and then pass the object reference as a value to this parameter to update that location policy. + ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -LocationRefreshInterval + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the amount of time (in hours) between client requests for Location Information service location update. +The LocationRefreshInterval can be set to any value between 1 and 12; the default value is 4. ```yaml -Type: SwitchParameter +Type: Int64 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -355,14 +331,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -LocationRequired + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If the client was unable to retrieve a location from the location configuration database, the user can be prompted to manually enter a location. +This parameter accepts the following values: + +- no: The user will not be prompted for a location. When a call is made with no location information, the Emergency Service Provider will answer the call and ask for a location. +- yes: The user will be prompted to input location information when the client registers at a new location. The user can dismiss the prompt without entering any information. If information is entered, a call made to 911 will first be answered by the Emergency Service Provider to verify the location before being routed to the PSAP (that is, the 911 operator). +- disclaimer: This option is the same as yes except that if the user dismisses the prompt disclaimer text will be displayed that can alert the user to the consequences of declining to enter location information. (The disclaimer text must be set by calling the `Set-CsEnhancedEmergencyServiceDisclaimer` cmdlet.) + +This value is ignored if EnhancedEmergencyServicesEnabled is set to False (the default). +Users will not be prompted for location information. + ```yaml -Type: SwitchParameter +Type: LocationRequiredEnum Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -371,21 +358,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnhancedEmergencyServiceDisclaimer -Text value containing information that will be displayed to users who are connected from locations that cannot be resolved by the location mapping (wiremap) who choose not to enter their location manually. -To remove a service disclaimer from a location policy set this property to a null value: +### -NotificationUri -`-EnhancedEmergencyServiceDisclaimer $Null` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Location policies, and the EnhancedEmergencyServiceDisclaimer property, should be used in Skype for Business Server to set disclaimers for the E9-1-1 service. -By using location policies to set these disclaimers, you can create different disclaimers for different locales or different sets of users. +One or more SIP Uniform Resource Identifiers (URIs) to be notified when an emergency call is made. +For example, the company security office could be notified through an instant message whenever an emergency call is made. +If the caller's location is available that location will be included in the notification. + +Multiple SIP URIs can be included as a comma-separated list. +For example, `-NotificationUri sip:security@litwareinc.com,sip:kmyer@litwareinc.com`. +Note that, with the release of Skype for Business Server distribution lists can now be configured as a notification URI. + +The string must be from 1 to 256 characters in length and must begin with the prefix sip:. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -394,15 +385,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocationRefreshInterval -Specifies the amount of time (in hours) between client requests for Location Information service location update. -The LocationRefreshInterval can be set to any value between 1 and 12; the default value is 4. +### -PstnUsage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The public switched telephone network (PSTN) usage that will be used to determine which voice route will be used to route 911 calls from clients using this profile. +The route associated with this usage should point to a SIP trunk dedicated to emergency calls. + +The usage must already exist in the global list of PSTN usages. +Call the `Get-CsPstnUsage` cmdlet to retrieve a list of usages. +To create a new usage, call the `Set-CsPstnUsage` cmdlet. ```yaml -Type: Int64 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -412,6 +409,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the location policy is being modified. For example: @@ -424,8 +424,7 @@ You can return the tenant ID for each of your Skype for Business Online tenants ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -434,14 +433,54 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EmergencyNumbers -{{Fill EmergencyNumbers Description}} +### -UseLocationForE911Only + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Location information can be used by the Skype for Business Server client for various reasons (such as notifying teammates of current location). +Set this value to True to ensure location information is available only for use with an emergency call. + ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -455,13 +494,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationPolicy + Accepts pipelined input of location policy objects. ## OUTPUTS -### +### None This cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Location.LocationPolicy object. diff --git a/skype/skype-ps/skype/Set-CsManagementConnection.md b/skype/skype-ps/SkypeForBusiness/Set-CsManagementConnection.md similarity index 89% rename from skype/skype-ps/skype/Set-CsManagementConnection.md rename to skype/skype-ps/SkypeForBusiness/Set-CsManagementConnection.md index 66a2a17e21..01cc75579f 100644 --- a/skype/skype-ps/skype/Set-CsManagementConnection.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsManagementConnection.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csmanagementconnection applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsManagementConnection -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csmanagementconnection +schema: 2.0.0 +title: Set-CsManagementConnection --- # Set-CsManagementConnection @@ -47,7 +48,7 @@ You cannot use the `Set-CsManagementConnection` cmdlet to change the management ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsManagementConnection -StoreProvider Sql -Connection "atl-sql-001.litwareinc.com\rtcbackup" ``` @@ -55,7 +56,7 @@ Set-CsManagementConnection -StoreProvider Sql -Connection "atl-sql-001.litwarein The command shown in Example 1 changes the management connection to the SQL Server instance rtcbackup found on the computer atl-sql-001.litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsManagementConnection -StoreProvider FileSystem -Connection "C:\TestTopology" ``` @@ -66,6 +67,9 @@ In Example 2, the management connection is set to file system and, more specific ## PARAMETERS ### -Connection + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Location information for the SQL Server instance or the file system folder being used as the management connection. For example, if the new management connection is to a SQL Server instance named rtcbackup on the computer atl-sql-001.litwareinc.com then use this syntax: `-Connection "atl-sql-001.litwareinc.com\rtcbackup"`. @@ -77,8 +81,7 @@ If the folder does not exist, the `Set-CsManagementConnection` cmdlet will creat ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 3 @@ -87,7 +90,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -EnableCaching + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True), caching is enabled for the management connection. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -StoreProvider + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the type of back-end store used for configuration information. For example, to store configuration data in SQL Server, set the StoreProvider like this: -StoreProvider Sql. In general, you should not modify the StoreProvider property unless instructed to do so by Microsoft support personnel. @@ -106,8 +130,7 @@ Azure ```yaml Type: StoreProvider Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -116,30 +139,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -148,14 +157,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableCaching -When set to True ($True), caching is enabled for the management connection. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -169,13 +180,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsManagementConnection` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsManagementConnection` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.Store.StoreProvider object. diff --git a/skype/skype-ps/skype/Set-CsManagementServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsManagementServer.md similarity index 85% rename from skype/skype-ps/skype/Set-CsManagementServer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsManagementServer.md index 0d77658545..92a2c18922 100644 --- a/skype/skype-ps/skype/Set-CsManagementServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsManagementServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csmanagementserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsManagementServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csmanagementserver +schema: 2.0.0 +title: Set-CsManagementServer --- # Set-CsManagementServer @@ -33,7 +34,7 @@ The `Set-CsManagementServer` cmdlet enables you to specify the port that the Cen ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsManagementServer -Identity "ManagementServer:atl-cs-001.litwareinc.com" -ReplicationServicePort 5076 ``` @@ -43,7 +44,28 @@ The command shown in Example 1 connects to the Central Management service with t ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the Central Management service. For example: `-Identity "ManagementServer:atl-cs-001.litwareinc.com"`. @@ -53,8 +75,7 @@ For example: `-Identity "atl-cs-001.litwareinc.com"`. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -64,13 +85,15 @@ Accept wildcard characters: False ``` ### -ReplicationServicePort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port number for the replication port used by the Central Management service. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -79,14 +102,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -96,29 +121,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -132,13 +143,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsManagementServer` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsManagementServer` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayManagementServer object. diff --git a/skype/skype-ps/skype/Set-CsMcxConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsMcxConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Set-CsMcxConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsMcxConfiguration.md index 664b12f04d..7044c4642c 100644 --- a/skype/skype-ps/skype/Set-CsMcxConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsMcxConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csmcxconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsMcxConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csmcxconfiguration +schema: 2.0.0 +title: Set-CsMcxConfiguration --- # Set-CsMcxConfiguration @@ -49,7 +50,7 @@ The `Set-CsMcxConfiguration` cmdlet provides a way for administrators to modify ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsMcxConfiguration -Identity site:Redmond -ExposedWebURL External ``` @@ -57,7 +58,7 @@ Set-CsMcxConfiguration -Identity site:Redmond -ExposedWebURL External In Example 1, the ExposedWebURL property for the Mobility Service configuration settings assigned to the Redmond site is set to External. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMcxConfiguration | Set-CsMcxConfiguration -ExposedWebURL External ``` @@ -67,7 +68,7 @@ To do this, the command first uses the `Get-CsMcxConfiguration` cmdlet without a That collection is then piped to the `Set-CsMcxConfiguration`, which sets the ExposedWebURL property for each item in the collection to External. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsMcxConfiguration | Where-Object {$_.SessionShortExpirationInterval -gt 3600} | Set-CsMcxConfiguration -SessionShortExpirationInterval 3600 ``` @@ -80,23 +81,10 @@ This filtered collection is then piped to the `Set-CsMcxConfiguration` cmdlet, w ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -ExposedWebURL -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -ExposedWebURL Indicates whether the URL used by the Autodiscovery Service is accessible to users both inside and outside the organization firewall (External) or only accessible to users inside the firewall (Internal). Allowed values are: Internal or External. @@ -105,8 +93,7 @@ The default value is External. ```yaml Type: ExposedWebURL Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,13 +103,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,6 +121,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the unique identifier of the collection of Mobility Service configuration settings to be modified. To modify the global settings, use the following syntax: @@ -152,8 +144,7 @@ If this parameter is not specified, then the `Set-CsMcxConfiguration` cmdlet wil ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -163,13 +154,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,6 +172,9 @@ Accept wildcard characters: False ``` ### -PushNotificationProxyUri + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URI of a service provider that can forward push notification requests to the Apple Push Notification Service and the Microsoft Push Notification Service. The PushNotificationProxyUri must be in the form of a SIP address; for example: @@ -187,8 +183,7 @@ The PushNotificationProxyUri must be in the form of a SIP address; for example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -198,6 +193,9 @@ Accept wildcard characters: False ``` ### -SessionExpirationInterval + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Length of time, in seconds, of a mobile session for iPhone or Windows Phone users. If Skype for Business is running in the background on these phones, users will receive push notifications as long as the session expiration interval has not expired. @@ -212,8 +210,7 @@ Note that the value of the SessionExpirationInterval property must be greater th ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -223,6 +220,9 @@ Accept wildcard characters: False ``` ### -SessionShortExpirationInterval + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Length of time, in seconds, of a mobile session for Android or Nokia phone users. The mobile device must send a notice to the server indicating that the device is still active before the session timeout is reached. @@ -236,8 +236,25 @@ Note that the value of the SessionExpirationInterval property must be greater th ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -247,13 +264,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -267,14 +286,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WriteableConfig.Settings.McxConfiguration.McxConfiguration object. +### Microsoft.Rtc.Management.WriteableConfig.Settings.McxConfiguration.McxConfiguration + The `Set-CsMcxConfiguration` cmdlet accepts pipelined instances of the McxConfiguration object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsMcxConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.McxConfiguration.McxConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsMediaConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsMediaConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Set-CsMediaConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsMediaConfiguration.md index 17f1f8b8b8..aa6f312534 100644 --- a/skype/skype-ps/skype/Set-CsMediaConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsMediaConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csmediaconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsMediaConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csmediaconfiguration +schema: 2.0.0 +title: Set-CsMediaConfiguration --- # Set-CsMediaConfiguration @@ -69,50 +70,50 @@ Note that this value is not case sensitive; the value was entered as donotsuppor ## PARAMETERS -### -Identity -The unique identifier of the media configuration settings you want to change. -This identifier specifies the scope at which this configuration is applied (global, site, or service). +### -EnableAdaptiveBandWidthEstimation + +> Applicable: Lync Server 2013 + +When set to True (the default value) Microsoft Lync Server will select the bandwidth rate at which to play a video stream. +This selection will be based on such factors as the network congestion and the client's quality of the client's current network connection. This parameter was removed starting Lync Server Cumulative Update 3. ```yaml -Type: XdsIdentity -Parameter Sets: Identity +Type: Boolean +Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -An instance of the Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings object. -You can retrieve this object by calling the `Get-CsMediaConfiguration` cmdlet with a specific Identity. -You can then assign new values to the properties of that object and then save those changes by passing the object to the `Set-CsMediaConfiguration` cmdlet. - +### -EnableAVBundling +This parameter is reserved for internal Microsoft use. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableQoS -QoS monitors the quality of voice signals over a network. When set to True, enables call Quality of Service (QoS) settings. +### -EnableDtls + +> Applicable: Skype for Business Server 2019 + +Enables the use of Datagram Transport Layer Security (DTLS) for ICE ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -121,16 +122,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSiren -By default, the Mediation Server does not negotiate Siren as a possible codec for calls between itself and other clients. -If this setting is True, Siren will be included as a possible codec for use between the Mediation Server and other clients. +### -EnableG722StereoCodec +> Applicable: Lync Server 2013 + +When set to True (the default value) allows the use of the G.722 wideband speech codec. +G.722 is a standard voice codec commonly used with Voice over IP applications; with a sampling rate of 16 KHz G.722 provides higher voice quality and clarity than many other commonly-used speech codecs. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -139,28 +141,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EncryptionLevel -The level of encryption between unified communications devices. - -Valid values: - -SupportEncryption - secure real-time transport protocol (SRTP) will be used if it can be negotiated. - -RequireEncryption - SRTP must be negotiated. - -DoNotSupportEncryption - SRTP must not be used. - -This value is not case sensitive. -(For details, see the Examples in this topic.) +### -EnableH264Codec -Default: RequireEncryption +> Applicable: Lync Server 2013 +When set to True (the default value) allows the use of the H.264/MPEG-4 AVC video codec. +H.264 is a standard codec commonly used for recording, compressing and distributing high-definition video. ```yaml -Type: EncryptionLevel +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -169,27 +160,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxVideoRateAllowed -The maximum rate at which video signals will be transferred at the client endpoints. - -Valid values: Hd720p15M, VGA600K, CIF250K - -Hd720p15M - High definition, with a resolution of 1280 x 720 and aspect ratio 16:9. - -VGA600K - VGA, with a resolution of 640 x 480, 25 fps with the aspect ratio 4:3. - -CIF250K - Common Intermediate Format (CIF) video format, 15 fps with a resolution of 352 x 288. +### -EnableInCallQoS -Note that these values are not case sensitive; values will be converted to appropriate casing when the configuration is created. -(For details, see the Examples in this topic.) +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Default: VGA600K +Enables or disables the ability of Skype for Business clients to send the raw data that's required to generate InCallQuality messages. ```yaml -Type: MaxVideoRateAllowed +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -198,14 +178,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -EnableQoS + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +QoS monitors the quality of voice signals over a network. When set to True, enables call Quality of Service (QoS) settings. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -214,14 +196,13 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -EnableReceiveAgc +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -230,31 +211,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -EnableRtpRtcpMultiplexing + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables or disables the use of RTP/RTCP Multiplexing, if enabled, when negotiating, only one candidate will be used for both RTP and RTCP. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAdaptiveBandWidthEstimation -When set to True (the default value) Microsoft Lync Server will select the bandwidth rate at which to play a video stream. -This selection will be based on such factors as the network congestion and the client's quality of the client's current network connection. This parameter was removed starting Lync Server Cumulative Update 3. +### -EnableRtx +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013 +Aliases: Required: False Position: Named @@ -263,15 +244,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableG722StereoCodec -When set to True (the default value) allows the use of the G.722 wideband speech codec. -G.722 is a standard voice codec commonly used with Voice over IP applications; with a sampling rate of 16 KHz G.722 provides higher voice quality and clarity than many other commonly-used speech codecs. +### -EnableServerFecForVideoInterop + +> Applicable: Skype for Business Server 2019 + +Enables the use of server Forward Error Correction for video interoperability ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013 Required: False Position: Named @@ -280,15 +262,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableH264Codec -When set to True (the default value) allows the use of the H.264/MPEG-4 AVC video codec. -H.264 is a standard codec commonly used for recording, compressing and distributing high-definition video. +### -EnableSilkForAudioVideoConferences + +> Applicable: Skype for Business Server 2019 + +Enables the use of SILK codec for A/V conferences ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013 Required: False Position: Named @@ -297,14 +280,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableInCallQoS -Enables or disables the ability of Skype for Business clients to send the raw data that's required to generate InCallQuality messages. +### -EnableSiren + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +By default, the Mediation Server does not negotiate Siren as a possible codec for calls between itself and other clients. +If this setting is True, Siren will be included as a possible codec for use between the Mediation Server and other clients. + ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -313,30 +300,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableRtpRtcpMultiplexing -Enables or disables the use of RTP/RTCP Multiplexing, if enabled, when negotiating, only one candidate will be used for both RTP and RTCP. +### -EnableVideoBasedSharing + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables the use of Video Based Sharing, for more information, see [Video based Screen Sharing for Skype for Business Server](https://learn.microsoft.com/skypeforbusiness/manage/video-based-screen-sharing) ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -InCallQoSIntervalSeconds -Specifies the interval between call QoS actions. +### -EncryptionLevel + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The level of encryption between unified communications devices. + +Valid values: + +SupportEncryption - secure real-time transport protocol (SRTP) will be used if it can be negotiated. + +RequireEncryption - SRTP must be negotiated. + +DoNotSupportEncryption - SRTP must not be used. + +This value is not case sensitive. +(For details, see the Examples in this topic.) + +Default: RequireEncryption + ```yaml -Type: UInt16 +Type: EncryptionLevel Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -345,14 +350,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableVideoBasedSharing -Enables the use of Video Based Sharing, for more information, see [Video based Screen Sharing for Skype for Business Server](https://learn.microsoft.com/skypeforbusiness/manage/video-based-screen-sharing) +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -361,30 +368,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableDtls -Enables the use of Datagram Transport Layer Security (DTLS) for ICE +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the media configuration settings you want to change. +This identifier specifies the scope at which this configuration is applied (global, site, or service). ```yaml -Type: Boolean -Parameter Sets: (All) +Type: XdsIdentity +Parameter Sets: Identity Aliases: -Applicable: Skype for Business Server 2019 Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSilkForAudioVideoConferences -Enables the use of SILK codec for A/V conferences +### -InCallQoSIntervalSeconds + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the interval between call QoS actions. ```yaml -Type: Boolean +Type: UInt16 Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named @@ -393,30 +405,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableServerFecForVideoInterop -Enables the use of server Forward Error Correction for video interoperability +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +An instance of the Microsoft.Rtc.Management.WritableConfig.Settings.Media.MediaSettings object. +You can retrieve this object by calling the `Get-CsMediaConfiguration` cmdlet with a specific Identity. +You can then assign new values to the properties of that object and then save those changes by passing the object to the `Set-CsMediaConfiguration` cmdlet. + ```yaml -Type: Boolean -Parameter Sets: (All) +Type: PSObject +Parameter Sets: Instance Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -WaitIceCompletedToAddDialOutUser -Waits until ICE negotiation is complete to dial out other people +### -MaxVideoRateAllowed + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The maximum rate at which video signals will be transferred at the client endpoints. + +Valid values: Hd720p15M, VGA600K, CIF250K + +Hd720p15M - High definition, with a resolution of 1280 x 720 and aspect ratio 16:9. + +VGA600K - VGA, with a resolution of 640 x 480, 25 fps with the aspect ratio 4:3. + +CIF250K - Common Intermediate Format (CIF) video format, 15 fps with a resolution of 352 x 288. + +Note that these values are not case sensitive; values will be converted to appropriate casing when the configuration is created. +(For details, see the Examples in this topic.) + +Default: VGA600K ```yaml -Type: Boolean +Type: MaxVideoRateAllowed Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named @@ -425,13 +457,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableRtx -This parameter is reserved for internal Microsoft use. +### -WaitIceCompletedToAddDialOutUser + +> Applicable: Skype for Business Server 2019 + +Waits until ICE negotiation is complete to dial out other people ```yaml Type: Boolean Parameter Sets: (All) -Aliases: +Aliases: Required: False Position: Named @@ -440,13 +475,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAVBundling -This parameter is reserved for internal Microsoft use. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -455,13 +493,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableReceiveAgc -This parameter is reserved for internal Microsoft use. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Set-CsMediationServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsMediationServer.md similarity index 84% rename from skype/skype-ps/skype/Set-CsMediationServer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsMediationServer.md index 35d51973bb..9b0a1170fb 100644 --- a/skype/skype-ps/skype/Set-CsMediationServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsMediationServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csmediationserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsMediationServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csmediationserver +schema: 2.0.0 +title: Set-CsMediationServer --- # Set-CsMediationServer @@ -35,7 +36,7 @@ If necessary, the `Set-CsMediationServer` cmdlet can also be used to associate a ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsMediationServer -Identity "MediationServer:atl-cs-001.litwareinc.com" -SipClientTcpPort 5072 ``` @@ -44,7 +45,7 @@ The command shown in Example 1 sets the SIP gateway TCP listening port to 5072 f After changing the port you will need to restart the Skype for Business Server Mediation service. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsMediationServer -Identity "MediationServer:atl-cs-001.litwareinc.com" -AudioPortStart 60000 -AudioPortCount 1000 ``` @@ -55,27 +56,10 @@ In this example the starting audio port is set to 60000 and the total number of ## PARAMETERS -### -Identity -Service location of the Mediation Server to be modified. -For example: `-Identity "MediationServer:atl-cs-001.litwareinc.com"`. - -Note that you can leave off the prefix "MediationServer:" when specifying a Mediation Server. -For example: `-Identity "atl-cs-001.litwareinc.com"`. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AudioPortCount -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AudioPortCount Total number of ports allocated for sending and receiving audio traffic. The actual ports to be opened will start with the value configured for AudioPortStart and continue through the number of ports specified for AudioPortCount. For example, if the AudioPortStart is set to 60000 and the AudioPortCount is set to 100, then ports 60000 through 60099 inclusive will be used for audio traffic. @@ -95,8 +79,7 @@ Two local ports per network interface, one for RTP traffic and one for RTCP traf ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -106,14 +89,16 @@ Accept wildcard characters: False ``` ### -AudioPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + First port in the range of ports allocated for sending and receiving audio traffic. For example: `-AudioPortStart 60000`. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -123,14 +108,16 @@ Accept wildcard characters: False ``` ### -EdgeServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service identity of the Edge Server to be associated with the Mediation Server. For example: `-EdgeServer "EdgeServer:atl-edge-001.litwareinc.com"`. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,15 +126,57 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the Mediation Server to be modified. +For example: `-Identity "MediationServer:atl-cs-001.litwareinc.com"`. + +Note that you can leave off the prefix "MediationServer:" when specifying a Mediation Server. +For example: `-Identity "atl-cs-001.litwareinc.com"`. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Registrar + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service identity of the Registrar to be associated with the Mediation Server. For example: `-Registrar "Registrar:atl-cs-001.litwareinc.com"`. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -157,6 +186,9 @@ Accept wildcard characters: False ``` ### -SipClientTcpPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Listening port used for communicating with gateway peers using TCP. By default, no TCP port is defined; however, a TCP port with the port number 5068 will automatically be created when a PSTN gateway is created. If you change the SipClientTcpPort you will need to restart the Mediation Server service before the new port will actually be used. @@ -164,8 +196,7 @@ If you change the SipClientTcpPort you will need to restart the Mediation Server ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,6 +206,9 @@ Accept wildcard characters: False ``` ### -SipClientTlsPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Listening port used for communicating with gateway peers using the Transport Layer Security (TLS) protocol. By default, SipClientTlsPort is configured to use port 5067. If you change the SipClientTlsPort you will need to restart the Mediation Server service before the new port will actually be used. @@ -183,8 +217,7 @@ If you change the SipClientTlsPort you will need to restart the Mediation Server ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -194,6 +227,9 @@ Accept wildcard characters: False ``` ### -SipServerPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Listening port used for communicating with Front End Servers. By default, SipServerPort is configured to use port 5070. If you change the SipServerPort, you will need to restart the Mediation Server service before the new port will actually be used. @@ -202,8 +238,7 @@ If you change the SipServerPort, you will need to restart the Mediation Server s ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -212,14 +247,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -229,29 +266,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -265,13 +288,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsMediationServer` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsMediationServer` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayMediationServer object. diff --git a/skype/skype-ps/skype/Set-CsMeetingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsMeetingConfiguration.md similarity index 83% rename from skype/skype-ps/skype/Set-CsMeetingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsMeetingConfiguration.md index 3e3103f124..1bc6789859 100644 --- a/skype/skype-ps/skype/Set-CsMeetingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsMeetingConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csmeetingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsMeetingConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/set-csmeetingconfiguration +schema: 2.0.0 +title: Set-CsMeetingConfiguration --- # Set-CsMeetingConfiguration @@ -57,7 +59,7 @@ The `Set-CsMeetingConfiguration` cmdlet enables you to modify any of the meeting ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsMeetingConfiguration -Identity site:Redmond -DesignateAsPresenter Everyone ``` @@ -65,7 +67,7 @@ Set-CsMeetingConfiguration -Identity site:Redmond -DesignateAsPresenter Everyone The command shown in Example 1 modifies the meeting configuration settings assigned to the Redmond site (-Identity site:Redmond). In this case, the value of the DesignateAsPresenter property is set to Everyone. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsMeetingConfiguration | Set-CsMeetingConfiguration -DesignateAsPresenter Everyone ``` @@ -75,7 +77,7 @@ In this case, however, the value of the DesignateAsPresenter property is modifie To do this, the `Get-CsMeetingConfiguration` cmdlet is called without any parameters in order to return a collection of all the meeting configuration settings currently in use. This collection is then piped to the `Set-CsMeetingConfiguration` cmdlet, which modifies the DesignateAsPresenter property for each item in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsMeetingConfiguration | Where-Object {$_.AdmitAnonymousUsersByDefault -eq $False} | Set-CsMeetingConfiguration -PstnCallersBypassLobby $True ``` @@ -87,51 +89,53 @@ In turn, this filtered collection is piped to the `Set-CsMeetingConfiguration` c ## PARAMETERS -### -Identity -Indicates the unique identifier for the collection of meeting configuration settings you want to modify. -To refer to the global settings, use this syntax: -Identity global. -To refer to a collection configured at the site scope, use syntax similar to this: -Identity "site:Redmond". -Settings configured at the service scope can be referenced using syntax like this: -Identity "service:UserServer:atl-cs-001.litwareinc.com". +### -AdmitAnonymousUsersByDefault -If this parameter is not specified, then the `Set-CsMeetingConfiguration` cmdlet will modify the global settings. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Determines whether meetings will, by default, allow attendance by anonymous users (that is, unauthenticated users). Set this value to True if you would like new meetings to allow for attendance by anonymous users by default. Set this value to False if you would prefer that, by default, new meetings do not allow for attendance by anonymous users. The default value is True. ```yaml -Type: XdsIdentity -Parameter Sets: Identity, (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -AllowCloudRecordingService + +> Applicable: Skype for Business Online + +PARAMVALUE: $true | $false ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -AdmitAnonymousUsersByDefault -Determines whether meetings will, by default, allow attendance by anonymous users (that is, unauthenticated users). Set this value to True if you would like new meetings to allow for attendance by anonymous users by default. Set this value to False if you would prefer that, by default, new meetings do not allow for attendance by anonymous users. The default value is True. +### -AllowConferenceRecording + +> Applicable: Skype for Business Online + +Determines whether or not users are allowed to record conference proceedings. +The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,6 +145,9 @@ Accept wildcard characters: False ``` ### -AssignedConferenceTypeByDefault + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether new meetings will be configured, by default, as public meetings. Set this value to True to use public meetings by default; set this value to False to use private meetings by default. The default value is True. @@ -148,8 +155,25 @@ The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CustomFooterText + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Text to be used on custom meeting invitations. Multiple lines are supported using the Enter key. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -159,16 +183,18 @@ Accept wildcard characters: False ``` ### -DesignateAsPresenter + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates which users (besides the meeting organizer) are automatically designated as presenters when they join a meeting. Valid choices are: None; Company and Everyone. By default, DesignateAsPresenter is set to Company, meaning everyone in your organization will have presenter rights the moment they join a meeting. -Note: When DesignateAsPresenter is set to Everyone, only dynamic meetings will comply with this setting. Static meetings do not allow Everyone to join as a Presenter. +Note: When DesignateAsPresenter is set to Everyone, only dynamic meetings will comply with this setting. Static meetings do not allow Everyone to join as a Presenter. ```yaml Type: DesignateAsPresenter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -178,6 +204,9 @@ Accept wildcard characters: False ``` ### -EnableAssignedConferenceType + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is not available in Skype for Business Online. Indicates whether users are allowed to schedule public meetings. @@ -188,8 +217,7 @@ The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -198,18 +226,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PstnCallersBypassLobby -Indicates whether users dialing in over a public switched telephone network (PSTN) phone line should automatically be admitted to a meeting. -If set to True ($True), PSTN callers will automatically be admitted to the meeting. -If set to False ($False), then PSTN callers will initially be routed to the conference lobby. -At that point, they will have to wait, on hold, until a conference presenter grants them access to the meeting. -The default value is True. +### -EnableMeetingReport + +> Applicable: Skype for Business Online + +PARAMVALUE: $true | $false ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -219,13 +245,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -234,26 +262,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Office 365 tenant account whose meeting configuration settings are being modified. - -For example: - --Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" - -You can return the tenant ID for each of your tenants by running this command: +### -HelpURL -Get-CsTenant | Select-Object DisplayName, TenantID +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. -Instead, the tenant ID will automatically be filled in for you based on your connection information. -The Tenant parameter is primarily for use in a hybrid deployment. +URL to a website where users can obtain assistance on joining the meeting. ```yaml -Type: Guid +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -262,62 +280,57 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Indicates the unique identifier for the collection of meeting configuration settings you want to modify. +To refer to the global settings, use this syntax: -Identity global. +To refer to a collection configured at the site scope, use syntax similar to this: -Identity "site:Redmond". +Settings configured at the service scope can be referenced using syntax like this: -Identity "service:UserServer:atl-cs-001.litwareinc.com". -### -Confirm -Prompts you for confirmation before executing the command. +If this parameter is not specified, then the `Set-CsMeetingConfiguration` cmdlet will modify the global settings. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity, (All) +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomFooterText -Text to be used on custom meeting invitations. Multiple lines are supported using the Enter key. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -HelpURL -URL to a website where users can obtain assistance on joining the meeting. +### -LegalURL + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +URL to a website containing legal information and meeting disclaimers. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -326,14 +339,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LegalURL -URL to a website containing legal information and meeting disclaimers. +### -LogoURL + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +URL for the image to be used on custom meeting invitations. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -342,14 +357,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LogoURL -URL for the image to be used on custom meeting invitations. +### -PstnCallersBypassLobby + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether users dialing in over a public switched telephone network (PSTN) phone line should automatically be admitted to a meeting. +If set to True ($True), PSTN callers will automatically be admitted to the meeting. +If set to False ($False), then PSTN callers will initially be routed to the conference lobby. +At that point, they will have to wait, on hold, until a conference presenter grants them access to the meeting. +The default value is True. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -359,14 +380,16 @@ Accept wildcard characters: False ``` ### -RequireRoomSystemsAuthorization + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True ($True) all users must be authenticated before they can join a meeting using the Skype for Business Room System. The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -375,14 +398,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCloudRecordingService -PARAMVALUE: $true | $false +### -Tenant + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Globally unique identifier (GUID) of the Office 365 tenant account whose meeting configuration settings are being modified. + +For example: + +-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" + +You can return the tenant ID for each of your tenants by running this command: + +Get-CsTenant | Select-Object DisplayName, TenantID + +If you are using a remote session of Windows PowerShell and are connected only to Skype for Business Online you do not have to include the Tenant parameter. +Instead, the tenant ID will automatically be filled in for you based on your connection information. +The Tenant parameter is primarily for use in a hybrid deployment. ```yaml -Type: Boolean +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -391,15 +428,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowConferenceRecording -Determines whether or not users are allowed to record conference proceedings. -The default value is True. +### -UserUriFormatForStUser + +> Applicable: Skype for Business Online + +PARAMVALUE: String ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -408,14 +446,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMeetingReport -PARAMVALUE: $true | $false +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -424,14 +464,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserUriFormatForStUser -PARAMVALUE: String +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: wi Required: False Position: Named @@ -445,13 +487,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.MeetingConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.MeetingConfiguration + The `Set-CsMeetingConfiguration` cmdlet accepts pipelined instances of the meeting configuration object. ## OUTPUTS -### +### None The `Set-CsMeetingConfiguration` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.MeetingConfiguration object. diff --git a/skype/skype-ps/skype/Set-CsMeetingRoom.md b/skype/skype-ps/SkypeForBusiness/Set-CsMeetingRoom.md similarity index 85% rename from skype/skype-ps/skype/Set-CsMeetingRoom.md rename to skype/skype-ps/SkypeForBusiness/Set-CsMeetingRoom.md index c7bc7a6973..7026dc4473 100644 --- a/skype/skype-ps/skype/Set-CsMeetingRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsMeetingRoom.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csmeetingroom applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsMeetingRoom -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/set-csmeetingroom +schema: 2.0.0 +title: Set-CsMeetingRoom --- # Set-CsMeetingRoom @@ -54,7 +56,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsMeetingRoom -Identity "RedmondMeetingRoom" -LineUri "tel:+12065551219" ``` @@ -62,7 +64,7 @@ Set-CsMeetingRoom -Identity "RedmondMeetingRoom" -LineUri "tel:+12065551219" The command show in Example 1 updates the LineUri assigned to the meeting room RedmondMeetingRoom. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsMeetingRoom -Identity "RedmondMeetingRoom" -Enabled $False @@ -77,7 +79,7 @@ To re-enable the room, simply set the Enabled property to True ($True): `Set-CsMeetingRoom -Identity "RedmondMeetingRoom" -Enabled $True` -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsMeetingRoom | Set-CsMeetingRoom -Enabled $False ``` @@ -87,7 +89,7 @@ To do this, the command first calls the `Get-CsMeetingRoom` cmdlet without any p That collection is then piped to the `Set-CsMeetingRoom` cmdlet, which temporarily disables each room in the collection. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsMeetingRoom | Set-CsMeetingRoom -ExchangeArchivingPolicy "UseLyncArchivingPolicy" ``` @@ -99,26 +101,10 @@ That collection is then piped to the `Set-CsMeetingRoom` cmdlet, which uses the ## PARAMETERS -### -Identity -Indicates the Identity of the meeting room to be modified. -Meeting room Identities are typically specified using one of four formats: 1) the room's SIP address; 2) the room's user principal name (UPN); 3) the room's domain name and logon name, in the form domain\logon (for example, litwareinc\room14) and 4) the room's Active Directory display name (for example, Room 14). -You can also reference a room account by using the room's Active Directory distinguished name. - - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +### -AcpInfo -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -AcpInfo Enables you to assign one or more third-party audio conferencing providers to a meeting room. However, it is recommended that you use the `Set-CsUserAcp` cmdlet to assign Audio conferencing providers. @@ -126,8 +112,7 @@ However, it is recommended that you use the `Set-CsUserAcp` cmdlet to assign Aud ```yaml Type: Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[Microsoft.Rtc.Management.ADConnect.Collections.AcpInfo] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -137,6 +122,9 @@ Accept wildcard characters: False ``` ### -AudioVideoDisabled + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the room is allowed to make audio/video (A/V) calls by using Skype for Business. If set to True, the room will largely be restricted to sending and receiving instant messages. @@ -146,8 +134,7 @@ You cannot disable A/V communications if a room is currently enabled for remote ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -156,24 +143,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +### -DomainController -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -DomainController Enables you to connect to the specified domain controller in order to retrieve meeting room information. To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). @@ -181,8 +154,7 @@ To connect to a particular domain controller, include the DomainController param ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -192,6 +164,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether or not the room has been enabled for Skype for Business Server. If you set this value to False, the room will no longer be able to log on to Skype for Business Server; setting this value to True re-enables the meeting room's logon privileges. @@ -205,7 +180,6 @@ When you run `Disable-CsMeetingRoom`, all the Skype for Business Server data ass Type: Boolean Parameter Sets: (All) Aliases: CsEnabled -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -215,6 +189,9 @@ Accept wildcard characters: False ``` ### -EnterpriseVoiceEnabled + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the room has been enabled for Enterprise Voice, which is the Microsoft implementation of Voice over Internet Protocol (VoIP). With Enterprise Voice, rooms can make telephone calls using the Internet rather than using the standard telephone network. @@ -222,8 +199,7 @@ With Enterprise Voice, rooms can make telephone calls using the Internet rather ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -233,6 +209,9 @@ Accept wildcard characters: False ``` ### -ExchangeArchivingPolicy + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates how (and where) the room's instant messaging and conferencing sessions will be archived. Allowed values are: @@ -248,8 +227,7 @@ ArchivingToExchange ```yaml Type: ExchangeArchivingPolicyOptionsEnum Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -259,6 +237,9 @@ Accept wildcard characters: False ``` ### -HostedVoiceMail + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, enables a room's voice mail calls to be routed to a hosted version of Exchange. In addition, setting this option to True enables rooms to directly place a call to another user's voice mail. @@ -266,8 +247,7 @@ In addition, setting this option to True enables rooms to directly place a call ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -276,7 +256,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the meeting room to be modified. +Meeting room Identities are typically specified using one of four formats: 1) the room's SIP address; 2) the room's user principal name (UPN); 3) the room's domain name and logon name, in the form domain\logon (for example, litwareinc\room14) and 4) the room's Active Directory display name (for example, Room 14). +You can also reference a room account by using the room's Active Directory distinguished name. + + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + ### -LineServerURI + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + The URI of the remote call control telephone gateway assigned to the room. The LineServerUri is the gateway URI, prefaced by "sip:". For example: @@ -287,8 +291,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -298,6 +301,9 @@ Accept wildcard characters: False ``` ### -LineURI + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Phone number assigned to the room. The line Uniform Resource Identifier (URI) must be specified using the E.164 format and use the "TEL:" prefix. For example: @@ -312,8 +318,7 @@ Any extension number should be added to the end of the line URI, for example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -323,6 +328,9 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to pass a meeting room object through the pipeline that represents the meeting room being modified. By default, the `Set-CsMeetingRoom` cmdlet does not pass objects through the pipeline. @@ -330,8 +338,7 @@ By default, the `Set-CsMeetingRoom` cmdlet does not pass objects through the pip ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -341,6 +348,9 @@ Accept wildcard characters: False ``` ### -PrivateLine + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Phone number for the room private telephone line. A private line is a phone number that is not published in Active Directory Domain Services (AD DS) and, as a result, is not readily available to other people. In addition, this private line bypasses most in-bound call routing rules; for example, a call to a private line will not be forwarded to a room's delegates. @@ -355,8 +365,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -366,6 +375,9 @@ Accept wildcard characters: False ``` ### -RemoteCallControlTelephonyEnabled + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the room has been enabled for remote call control telephony. When enabled for remote call control, a room can employ Skype for Business Server to answer phone calls made to his or her desk phone. Phone calls can also be made using Skype for Business. @@ -379,8 +391,7 @@ To be enabled for remote call control, a room must also have both a LineUri and ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -390,6 +401,9 @@ Accept wildcard characters: False ``` ### -SipAddress + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier (similar to an email address) that allows the room to communicate using SIP devices such as Skype for Business. The SIP address must use the sip: prefix as well as a valid SIP domain; for example: @@ -399,8 +413,26 @@ The SIP address must use the sip: prefix as well as a valid SIP domain; for exam ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -410,6 +442,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. @@ -417,7 +452,6 @@ Describes what would happen if you executed the command without actually executi Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -431,13 +465,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADMeetingRoom The `Set-CsMeetingRoom` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADMeetingRoom object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsMeetingRoom` cmdlet modifies existing instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADMeetingRoom object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsMobilityPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsMobilityPolicy.md similarity index 85% rename from skype/skype-ps/skype/Set-CsMobilityPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsMobilityPolicy.md index b159325592..c045c58f23 100644 --- a/skype/skype-ps/skype/Set-CsMobilityPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsMobilityPolicy.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csmobilitypolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsMobilityPolicy -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/set-csmobilitypolicy +schema: 2.0.0 +title: Set-CsMobilityPolicy --- # Set-CsMobilityPolicy @@ -72,7 +74,7 @@ The following parameters are not applicable to Skype for Business Online: AllowA ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsMobilityPolicy -Identity "site:Redmond" -EnableOutsideVoice $False ``` @@ -81,7 +83,7 @@ In Example 1, Call via Work is disabled in the mobility policy assigned to the R This is done by setting the EnableOutsideVoice property to False. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsMobilityPolicy -Filter "tag:*" | Set-CsMobilityPolicy -EnableOutsideVoice $False ``` @@ -91,7 +93,7 @@ To carry out this task, the command first calls the `Get-CsMobilityPolicy` cmdle That filtered collection of policies is then piped to the `Set-CsMobilityPolicy` cmdlet, which takes each policy in the collection and sets the EnableOutsideVoice property to False. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsMobilityPolicy | Where-Object {$_.Description -eq $Null} | Set-CsMobilityPolicy -Description "Policy owner: kenmyer@litwareinc.com" ``` @@ -104,15 +106,16 @@ That filtered collection is then piped to the `Set-CsMobilityPolicy` cmdlet, whi ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. +### -AllowAutomaticPstnFallback +> Applicable: Skype for Business Online + +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -121,16 +124,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide additional text to accompany a mobility policy. -For example, the Description might include information about the users the policy should be assigned to. +### -AllowCustomerExperienceImprovementProgram + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) mobile users will be allowed to participate in the Microsoft Customer Experience Improvement Program. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,18 +143,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableIPAudioVideo -When set to False, prohibits the user from making voice over IP (VoIP) calls using the mobile device. -The default value is True, meaning that VoIP calls are allowed. +### -AllowDeviceContactsSync -This parameter was introduced in Lync Server 2013. +> Applicable: Skype for Business Online + +When set to True users will be allowed to sync device contacts on the mobile apps. +More information: [How to disable CallKit integration for Skype for Business iOS](https://learn.microsoft.com/SkypeForBusiness/troubleshoot/server-phone-system/disable-callkit-integration). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -159,15 +163,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMobility -When set to True, users are allowed to use Skype for Business Mobile. +### -AllowExchangeConnectivity + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) users will be allowed to connect to Exchange by using their mobile device. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -176,18 +182,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOutsideVoice -When set to True, enables users to take advantage of Call via Work. -When set to False, users cannot use Call via Work. +### -AllowSaveCallLogs -The default value is True. +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) users will be allowed to save a call log of calls made from or received by their mobile device. + +Note that this setting does not apply to Android devices. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -196,15 +203,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -AllowSaveCredentials + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) users will be allowed to save credentials information (such as passwords) on their mobile device. +This information can then be applied to auto-logon scenarios. + +Note: If a user has AllowSaveCredentials set to False in the CsMobility policy, the Skype for Business App for iOS may sign out automatically when bringing it from the background to the foreground. This is due to the password not being saved anywhere but in the iOS process memory. Once the process is killed by the iOS system, the password will no longer be available, so the user will need to enter it again. However, there is no impact if modern authentication is implemented. + ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -213,66 +226,59 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Unique identifier assigned to the policy when it was created. -Mobility policies can be assigned at the global, site, or per-user scope. -To refer to the global instance, use this syntax: - -`-Identity global` - -To refer to a policy at the site scope, use syntax similar to this: - -`-Identity site:Redmond` +### -AllowSaveIMHistory -To refer to a per-user policy, use syntax similar to this: +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -`-Identity RedmondMobilityPolicy` +When set to True (the default value) users will be allowed to save transcripts of IM and conferencing sessions on their mobile devices. -If you do not specify an Identity, then the `Set-CsMobilityPolicy` cmdlet will modify the global policy. ```yaml -Type: XdsIdentity +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -Description + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to provide additional text to accompany a mobility policy. +For example, the Description might include information about the users the policy should be assigned to. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -RequireWIFIForIPAudio -When set to True, the user can use IP audio in calls made when his or her mobile device is connected to a Wi-Fi network. -That means that the user will only be allowed to make audio calls using Wi-Fi, and will not be able to use the standard cellular phone network. -The default value is False. +### -EnableIPAudioVideo + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to False, prohibits the user from making voice over IP (VoIP) calls using the mobile device. +The default value is True, meaning that VoIP calls are allowed. This parameter was introduced in Lync Server 2013. ```yaml Type: Boolean -Parameter Sets: Identity, Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -281,19 +287,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequireWIFIForIPVideo -When set to True, the user can use IP video only in calls made when their mobile device is connected to a Wi-Fi network. -If the mobile device goes outside of Wi-Fi range, then video calls will be received as audio calls only. -If this property is set to False (the default value) then the user can make or receive IP video calls using either a Wi-Fi or a cellular data connection. +### -EnableMobility -This parameter was introduced in Lync Server 2013. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, users are allowed to use Skype for Business Mobile. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -302,31 +306,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -EnableOutsideVoice +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True, enables users to take advantage of Call via Work. +When set to False, users cannot use Call via Work. -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +The default value is True. -### -AllowAutomaticPstnFallback -This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -335,15 +328,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCustomerExperienceImprovementProgram -When set to True (the default value) mobile users will be allowed to participate in the Microsoft Customer Experience Improvement Program. +### -EnablePushNotifications +> Applicable: Skype for Business Online + +When set to True users will be allowed to receive push notifications on their mobile devices. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -352,16 +346,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowDeviceContactsSync -When set to True users will be allowed to sync device contacts on the mobile apps. +### -EncryptAppData -More information: [How to disable CallKit integration for Skype for Business iOS](https://learn.microsoft.com/SkypeForBusiness/troubleshoot/server-phone-system/disable-callkit-integration). +> Applicable: Skype for Business Online + +When set to True users will be allowed to encrypt data on their mobile apps. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -370,15 +364,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowExchangeConnectivity -When set to True (the default value) users will be allowed to connect to Exchange by using their mobile device. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -387,71 +383,67 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSaveCallLogs -When set to True (the default value) users will be allowed to save a call log of calls made from or received by their mobile device. +### -Identity -Note that this setting does not apply to Android devices. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Unique identifier assigned to the policy when it was created. +Mobility policies can be assigned at the global, site, or per-user scope. +To refer to the global instance, use this syntax: -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +`-Identity global` -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +To refer to a policy at the site scope, use syntax similar to this: -### -AllowSaveCredentials -When set to True (the default value) users will be allowed to save credentials information (such as passwords) on their mobile device. -This information can then be applied to auto-logon scenarios. +`-Identity site:Redmond` -Note: If a user has AllowSaveCredentials set to False in the CsMobility policy, the Skype for Business App for iOS may sign out automatically when bringing it from the background to the foreground. This is due to the password not being saved anywhere but in the iOS process memory. Once the process is killed by the iOS system, the password will no longer be available, so the user will need to enter it again. However, there is no impact if modern authentication is implemented. +To refer to a per-user policy, use syntax similar to this: +`-Identity RedmondMobilityPolicy` +If you do not specify an Identity, then the `Set-CsMobilityPolicy` cmdlet will modify the global policy. ```yaml -Type: Boolean +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSaveIMHistory -When set to True (the default value) users will be allowed to save transcripts of IM and conferencing sessions on their mobile devices. +### -Instance + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -EnablePushNotifications -When set to True users will be allowed to receive push notifications on their mobile devices. +### -RequireIntune + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -460,14 +452,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EncryptAppData -When set to True users will be allowed to encrypt data on their mobile apps. +### -RequireWIFIForIPAudio + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, the user can use IP audio in calls made when his or her mobile device is connected to a Wi-Fi network. +That means that the user will only be allowed to make audio calls using Wi-Fi, and will not be able to use the standard cellular phone network. +The default value is False. + +This parameter was introduced in Lync Server 2013. + ```yaml Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Parameter Sets: Identity, Instance +Aliases: Required: False Position: Named @@ -476,14 +475,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequireIntune -This parameter is reserved for internal Microsoft use. +### -RequireWIFIForIPVideo + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, the user can use IP video only in calls made when their mobile device is connected to a Wi-Fi network. +If the mobile device goes outside of Wi-Fi range, then video calls will be received as audio calls only. +If this property is set to False (the default value) then the user can make or receive IP video calls using either a Wi-Fi or a cellular data connection. + +This parameter was introduced in Lync Server 2013. + ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -493,6 +499,9 @@ Accept wildcard characters: False ``` ### -RequireWiFiForSharing + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, mobile users must use a Wi-Fi connection in order to participate in an application sharing session. When set to False (the default value) mobile users can participate in application sharing by using either a Wi-Fi connection or a cellular (3G/4G) connection. @@ -503,8 +512,7 @@ If this value is set to False, users can use the Options page to modify their sh ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -514,6 +522,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the mobility policy is being modified. For example: @@ -527,8 +538,7 @@ You can return the tenant ID for each of your Skype for Business Online tenants ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -538,7 +548,10 @@ Accept wildcard characters: False ``` ### -VoiceSettings -Controls how audio is connected by a mobile device joining a meeting or a peer-to-peer call. When the Skype for Business client is first run, and the user is enabled for Phone System with a Calling Plan, they are prompted to configure a call back phone number. This number is stored in settings under the **Calls and Meetings** section and will be used based on the value chosen for this parameter. Acceptable values are: + +> Applicable: Skype for Business Online + +Controls how audio is connected by a mobile device joining a meeting or a peer-to-peer call. When the Skype for Business client is first run, and the user is enabled for Phone System with a Calling Plan, they are prompted to configure a call back phone number. This number is stored in settings under the **Calls and Meetings** section and will be used based on the value chosen for this parameter. Acceptable values are: **VoIPAlways:** Wi-Fi will be used when available, otherwise a call back will be performed. @@ -549,8 +562,45 @@ Controls how audio is connected by a mobile device joining a meeting or a peer-t ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -564,14 +614,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WriteableConfig.Policy.Mobility.Mobility. +### Microsoft.Rtc.Management.WriteableConfig.Policy.Mobility.Mobility The `Set-CsMobilityPolicy` cmdlet accepts pipelined instances of the Mobility object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsMobilityPolicy` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WriteableConfig.Policy.Mobility.Mobility object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsMonitoringServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsMonitoringServer.md similarity index 86% rename from skype/skype-ps/skype/Set-CsMonitoringServer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsMonitoringServer.md index 4906331044..82b0bef55c 100644 --- a/skype/skype-ps/skype/Set-CsMonitoringServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsMonitoringServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csmonitoringserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsMonitoringServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csmonitoringserver +schema: 2.0.0 +title: Set-CsMonitoringServer --- # Set-CsMonitoringServer @@ -40,7 +41,7 @@ However, if you do need to change the location of one (or both) of these items, ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsMonitoringServer -Identity "MonitoringServer:atl-cs-001.litwareinc.com" -ReportingUrl "https://atl-cs-001.litwareinc.com/reports" ``` @@ -50,7 +51,28 @@ The command shown in Example 1 configures a new URL for the Monitoring Server re ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service location of the Monitoring Server to be modified. For example: `-Identity "MonitoringServer:atl-cs-001.litwareinc.com"`. You can retrieve the Identity for all of your Monitoring Servers by using this command: @@ -63,8 +85,7 @@ For example: `-Identity "atl-cs-001.litwareinc.com"`. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -74,6 +95,9 @@ Accept wildcard characters: False ``` ### -MonitoringDatabase + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service location for the new Monitoring Server database. For example: `-MonitoringDatabase "MonitoringDatabase:atl-sql-001.litwareinc.com"`. Make sure you use the service location of the database store and not the SQL Server path name. @@ -81,8 +105,7 @@ Make sure you use the service location of the database store and not the SQL Ser ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -92,14 +115,16 @@ Accept wildcard characters: False ``` ### -ReportingUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URL for the Monitoring Server reports. Note that these reports will not be available unless you install SQL Server Reporting Services and the Monitoring Server Report Pack. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -108,14 +133,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -125,29 +152,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -161,13 +174,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsMonitoringServer` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsMonitoringServer` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayMonitoringServer object. diff --git a/skype/skype-ps/skype/Set-CsNetworkBandwidthPolicyProfile.md b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkBandwidthPolicyProfile.md similarity index 88% rename from skype/skype-ps/skype/Set-CsNetworkBandwidthPolicyProfile.md rename to skype/skype-ps/SkypeForBusiness/Set-CsNetworkBandwidthPolicyProfile.md index dffaff9982..4912b16ae6 100644 --- a/skype/skype-ps/skype/Set-CsNetworkBandwidthPolicyProfile.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkBandwidthPolicyProfile.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworkbandwidthpolicyprofile applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsNetworkBandwidthPolicyProfile -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworkbandwidthpolicyprofile +schema: 2.0.0 +title: Set-CsNetworkBandwidthPolicyProfile --- # Set-CsNetworkBandwidthPolicyProfile @@ -43,7 +44,7 @@ If the profile contained a policy to limit video and you set only the AudioBWLim ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsNetworkBandwidthPolicyProfile -Identity LowBWProfile -Description "Policy for links of less than 10MB" ``` @@ -52,7 +53,7 @@ This example modifies the description of the bandwidth policy profile with the i It does this by calling the `Set-CsNetworkBandwidthPolicyProfile` cmdlet with two parameters: Identity, specifying the name of the profile to modify; and Description, specifying the new description of the profile. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsNetworkBandwidthPolicyProfile -Identity LowBWLimit -VideoBWLimit 2500 -VideoBWSessionLimit 300 ``` @@ -64,7 +65,7 @@ This command will add a video profile or update an existing video profile for th Any existing audio profiles will be unaffected. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $bp = New-CsNetworkBWPolicy -BWLimit 5000 -BWSessionLimit 200 -BWPolicyModality video @@ -80,7 +81,7 @@ The BWPolicy parameter is used with a value of $bp. This replaces any existing policies of this profile with the newly created policy we stored in the $bp variable. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` $a = Get-CsNetworkBandwidthPolicyProfile -Identity LowBWProfile @@ -106,7 +107,7 @@ Finally, we call the `Set-CsNetworkBandwidthPolicyProfile` cmdlet to update the We use the Instance parameter, passing a value of $a, which contains our modified profile. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` $ap = New-CsNetworkBWPolicy -BWLimit 2000 -BWSessionLimit 300 -BWPolicyModality audio @@ -129,43 +130,10 @@ Within those curly braces you specify the action you want to take on the list, i ## PARAMETERS -### -Identity -The string value that uniquely identifies the bandwidth policy profile you want to modify. -This is identical to the BWPolicyProfileID property of the profile and can be changed by changing the value of that property. -This is equivalent to a "cut and paste" operation: all properties of the profile remain the same, only the name changes. -However, this value cannot be changed if the profile is assigned to a network site. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -A reference to a bandwidth policy profile object (an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType) that contains the settings you want to use to modify the profile. -This object can be retrieved by calling the `Get-CsNetworkBandwidthPolicyProfile` cmdlet. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AudioBWLimit -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AudioBWLimit The maximum amount of bandwidth to allocate for all audio connections. If a single audio session will cause the audio bandwidth limit to be exceeded, that session will not be allowed to start. @@ -179,8 +147,7 @@ Default: If you supply a value to the AudioBWSessionLimit parameter but not to A ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -190,6 +157,9 @@ Accept wildcard characters: False ``` ### -AudioBWSessionLimit + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum amount of bandwidth to allocate per audio session. Expressed in kbps. Value must be 40 or higher. @@ -201,8 +171,7 @@ Default: If you supply a value to the AudioBWLimit parameter but not to AudioBWS ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -212,6 +181,9 @@ Accept wildcard characters: False ``` ### -BWPolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A list of objects containing bandwidth policy profiles. Each object in the list consists of a bandwidth modality (audio or video), a bandwidth limitation, and a bandwidth session limitation. @@ -223,8 +195,7 @@ Objects of this type can be created by calling the `New-CsNetworkBWPolicy` cmdle ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -234,14 +205,34 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A description of the bandwidth policy profile. For example, you can use this parameter to clarify the expected use of the profile. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -250,7 +241,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The string value that uniquely identifies the bandwidth policy profile you want to modify. +This is identical to the BWPolicyProfileID property of the profile and can be changed by changing the value of that property. +This is equivalent to a "cut and paste" operation: all properties of the profile remain the same, only the name changes. +However, this value cannot be changed if the profile is assigned to a network site. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A reference to a bandwidth policy profile object (an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType) that contains the settings you want to use to modify the profile. +This object can be retrieved by calling the `Get-CsNetworkBandwidthPolicyProfile` cmdlet. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -VideoBWLimit + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum amount of bandwidth to allocate for all video connections. If a single video session will cause the video bandwidth limit to be exceeded, that session will not be allowed to start. @@ -264,8 +298,7 @@ Default: If you supply a value to the VideoBWSessionLimit parameter but not to V ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -275,6 +308,9 @@ Accept wildcard characters: False ``` ### -VideoBWSessionLimit + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum amount of bandwidth to allocate per video session. Expressed in kbps. Value must be 100 or higher. @@ -286,8 +322,7 @@ Default: If you supply a value to the VideoBWLimit parameter but not to VideoBWS ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -296,14 +331,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -313,29 +350,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -349,13 +372,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType + Accepts pipelined input of network bandwidth policy profile objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWPolicyProfileType. diff --git a/skype/skype-ps/skype/Set-CsNetworkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkConfiguration.md similarity index 84% rename from skype/skype-ps/skype/Set-CsNetworkConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsNetworkConfiguration.md index c57f41a6da..1c9dd7d7e4 100644 --- a/skype/skype-ps/skype/Set-CsNetworkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworkconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsNetworkConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworkconfiguration +schema: 2.0.0 +title: Set-CsNetworkConfiguration --- # Set-CsNetworkConfiguration @@ -60,7 +62,7 @@ The following parameters are not applicable to Skype for Business Online: BWPoli ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsNetworkConfiguration -EnableBandwidthPolicyCheck $True ``` @@ -71,52 +73,65 @@ If CAC is already enabled (in other words, if the EnableBandwidthPolicyCheck pro ## PARAMETERS -### -Identity -This value will always be Global. +### -BWPolicyProfiles + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +A collection of all the bandwidth policy profiles that can be assigned to sites, inter-site policies and network region links. +Each bandwidth policy profile contains bandwidth limitations (overall limitations and session limitations) for audio and/or video connections. +A full list of bandwidth policy profiles can be retrieved by calling the `Get-CsNetworkBandwidthPolicyProfile` cmdlet. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSListModifier +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -A reference to a network configuration object. -This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkConfigurationSettings, which can be retrieved by calling the `Get-CsNetworkConfiguration` cmdlet. +### -EnableBandwidthPolicyCheck + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Setting this parameter to True will run a validation check against the entire CAC configuration. +If all validation checks pass, or if you choose to ignore all warnings, CAC will be enabled. +If a validation check does not pass, you can choose to stop the validation and the value of EnableBandwidthPolicyCheck will not change. +You must have region routes defined between each pair of network regions before you running the validation check. + +Setting this value to False will disable CAC. + +Default: False ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -BWPolicyProfiles -A collection of all the bandwidth policy profiles that can be assigned to sites, inter-site policies and network region links. -Each bandwidth policy profile contains bandwidth limitations (overall limitations and session limitations) for audio and/or video connections. -A full list of bandwidth policy profiles can be retrieved by calling the `Get-CsNetworkBandwidthPolicyProfile` cmdlet. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter does not take a value. +If you include this parameter, any changes made to the configuration, including enabling the configuration, will take place with no warnings or validation checks. ```yaml -Type: PSListModifier +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -125,31 +140,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableBandwidthPolicyCheck -Setting this parameter to True will run a validation check against the entire CAC configuration. -If all validation checks pass, or if you choose to ignore all warnings, CAC will be enabled. -If a validation check does not pass, you can choose to stop the validation and the value of EnableBandwidthPolicyCheck will not change. -You must have region routes defined between each pair of network regions before you running the validation check. +### -Identity -Setting this value to False will disable CAC. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Default: False +This value will always be Global. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +A reference to a network configuration object. +This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkConfigurationSettings, which can be retrieved by calling the `Get-CsNetworkConfiguration` cmdlet. + + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -InterNetworkRegionRoutes + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + A collection of all the network region routes defined within the CAC configuration. You can retrieve all the members of this collection by calling the `Get-CsNetworkInterRegionRoute` cmdlet. @@ -157,8 +190,7 @@ You can retrieve all the members of this collection by calling the `Get-CsNetwor ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -168,6 +200,9 @@ Accept wildcard characters: False ``` ### -InterNetworkSitePolicies + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + A collection of network inter-site policies defined within the CAC configuration. You can retrieve all the members of this collection by calling the `Get-CsNetworkInterSitePolicy` cmdlet. @@ -175,8 +210,7 @@ You can retrieve all the members of this collection by calling the `Get-CsNetwor ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -186,6 +220,9 @@ Accept wildcard characters: False ``` ### -MediaBypassSettings + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + A reference to an object that defines the global media bypass settings for the CAC configuration. Setting this value will overwrite all existing media bypass settings. You obtain this object reference by calling the `New-CsNetworkMediaBypassConfiguration` cmdlet and assigning the new configuration settings to a variable. @@ -195,8 +232,7 @@ Pass this variable to the MediaBypassSettings parameter to change the global med ```yaml Type: MediaBypassSettingsType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -206,6 +242,9 @@ Accept wildcard characters: False ``` ### -NetworkRegionLinks + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + A collection of network region links defined within the CAC configuration. Each network region link defines a connection that exists between two regions and any bandwidth limitations that should be applied to connections between those regions. You can retrieve all the members of this collection by calling the `Get-CsNetworkRegionLink` cmdlet. @@ -214,8 +253,7 @@ You can retrieve all the members of this collection by calling the `Get-CsNetwor ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,6 +263,9 @@ Accept wildcard characters: False ``` ### -NetworkRegions + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + A collection of network regions (each of which represents a hub or backbone within the network) defined within the CAC configuration. You can retrieve all the members of this collection by calling the `Get-CsNetworkRegion` cmdlet. @@ -232,8 +273,7 @@ You can retrieve all the members of this collection by calling the `Get-CsNetwor ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -243,6 +283,9 @@ Accept wildcard characters: False ``` ### -NetworkSites + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + A collection of network sites (each of which represents an office or location within a region) defined within the CAC configuration. You can retrieve all the members of this collection by calling the `Get-CsNetworkSite` cmdlet. @@ -250,8 +293,7 @@ You can retrieve all the members of this collection by calling the `Get-CsNetwor ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -261,6 +303,9 @@ Accept wildcard characters: False ``` ### -Subnets + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + A collection of network subnets (each of which associates an endpoint with a site) defined within the CAC configuration. You can retrieve all the members of this collection by calling the `Get-CsNetworkSubnet` cmdlet. @@ -268,8 +313,7 @@ You can retrieve all the members of this collection by calling the `Get-CsNetwor ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -278,33 +322,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -This parameter does not take a value. -If you include this parameter, any changes made to the configuration, including enabling the configuration, will take place with no warnings or validation checks. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### -Tenant -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +> Applicable: Skype for Business Online +{{Fill Tenant Description}} ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -314,6 +341,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. @@ -321,7 +351,6 @@ Prompts you for confirmation before executing the command. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -330,14 +359,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -{{Fill Tenant Description}} +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: wi Required: False Position: Named @@ -351,13 +383,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkConfigurationSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkConfigurationSettings + Accepts pipelined input of a network configuration object. ## OUTPUTS -### +### None The `Set-CsNetworkConfiguration` cmdlet does not return a value or object. Instead, the cmdlet modifies instances of the Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkConfigurationSettings object. diff --git a/skype/skype-ps/skype/Set-CsNetworkInterRegionRoute.md b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkInterRegionRoute.md similarity index 84% rename from skype/skype-ps/skype/Set-CsNetworkInterRegionRoute.md rename to skype/skype-ps/SkypeForBusiness/Set-CsNetworkInterRegionRoute.md index 2c6e2a913f..2fad45e2ce 100644 --- a/skype/skype-ps/skype/Set-CsNetworkInterRegionRoute.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkInterRegionRoute.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworkinterregionroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsNetworkInterRegionRoute -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworkinterregionroute +schema: 2.0.0 +title: Set-CsNetworkInterRegionRoute --- # Set-CsNetworkInterRegionRoute @@ -41,7 +42,7 @@ This cmdlet modifies that route association. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsNetworkInterRegionRoute -Identity NA_APAC_Route -NetworkRegionLinkIDs "NA_SA,SA_APAC" ``` @@ -50,7 +51,7 @@ This example modifies the route NA_APAC_Route by changing the region links that The NetworkRegionLinkIDs parameter is used with a value of "NA_SA,SA_APAC", which replaces any existing links with the two specified in that string. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsNetworkInterRegionRoute -Identity NA_APAC_Route -NetworkRegionLinks @{add="SA_EMEA"} ``` @@ -62,7 +63,7 @@ The syntax @{add=\} adds an element to the list of links. You can also use the syntax @{replace=\} to replace all existing links with those specified by \ (which essentially behaves the same as using NetworkRegionLinkIDs), or the syntax @{remove=\} to remove a link from the list. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsNetworkInterRegionRoute -Identity NA_Route5 -NetworkRegionID2 SouthAmerica -NetworkRegionLinkIDs "NA_SA,SA_APAC" ``` @@ -74,7 +75,28 @@ The NetworkRegionID2 parameter is used to specify the new region and then the Ne ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier for the network region route you want to modify. Network region routes are created only at the global scope, so this identifier does not need to specify a scope. Instead, it contains a string that is a unique name that identifies that route. @@ -82,8 +104,7 @@ Instead, it contains a string that is a unique name that identifies that route. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -93,14 +114,16 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + An object reference to an existing region route. This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkRegionRouteType, which can be retrieved by calling the `Get-CsNetworkInterRegionRoute` cmdlet. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -110,6 +133,9 @@ Accept wildcard characters: False ``` ### -NetworkRegionID1 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Identity (NetworkRegionID) of one of the two regions connected through this route. The value passed to this parameter must be a different region from the value of the NetworkRegionID2 parameter. (In other words, you can't route a region to itself.) In addition, the combination of NetworkRegionID1 and NetworkRegionID2 must be unique (for example, you can't have two routes defined that connect NorthAmerica and EMEA). @@ -117,8 +143,7 @@ The value passed to this parameter must be a different region from the value of ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,6 +153,9 @@ Accept wildcard characters: False ``` ### -NetworkRegionID2 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Identity (NetworkRegionID) of one of the two regions connected through this route. The value passed to this parameter must be a different region from the value of the NetworkRegionID1 parameter. (In other words, you can't route a region to itself.) In addition, the combination of NetworkRegionID1 and NetworkRegionID2 must be unique (for example, you can't have two routes defined that connect NorthAmerica and EMEA). @@ -135,8 +163,7 @@ The value passed to this parameter must be a different region from the value of ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -146,6 +173,9 @@ Accept wildcard characters: False ``` ### -NetworkRegionLinkIDs + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to specify all the links for this route as a string of comma-separated values. The values are the identities (NetworkRegionLinkIDs) of the region links. If you enter values for both NetworkRegionLinkIDs and NetworkRegionLinks, NetworkRegionLinkIDs will be ignored. @@ -154,8 +184,7 @@ Any links modified using this parameter will replace all existing links in the r ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -165,14 +194,16 @@ Accept wildcard characters: False ``` ### -NetworkRegionLinks + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A list object containing the identities (NetworkRegionLinkIDs) of the region links that apply to this route. For this cmdlet, this parameter differs from the NetworkRegionLinkIDs in that in addition to allowing you to replace all existing links for this route, you can also add or remove individual links. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -181,14 +212,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -198,29 +231,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -234,13 +253,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkRegionRouteType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkRegionRouteType + Accepts pipelined input of network interregion route objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkRegionRouteType. diff --git a/skype/skype-ps/skype/Set-CsNetworkInterSitePolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkInterSitePolicy.md similarity index 82% rename from skype/skype-ps/skype/Set-CsNetworkInterSitePolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsNetworkInterSitePolicy.md index 549ddcf054..596067b943 100644 --- a/skype/skype-ps/skype/Set-CsNetworkInterSitePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkInterSitePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworkintersitepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsNetworkInterSitePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworkintersitepolicy +schema: 2.0.0 +title: Set-CsNetworkInterSitePolicy --- # Set-CsNetworkInterSitePolicy @@ -39,7 +40,7 @@ This cmdlet modifies a network inter-site policy that associates a bandwidth lim ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsNetworkInterSitePolicy -Identity Reno_Portland -BWPolicyProfileID HighBWLimits ``` @@ -50,7 +51,47 @@ We use the BWPolicyProfileID parameter to change the bandwidth policy profile as ## PARAMETERS +### -BWPolicyProfileID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity of the bandwidth policy profile that will define the limitations for this site policy. +You can retrieve a list of available profiles by calling the `Get-CsNetworkBandwidthPolicyProfile` cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the network site policy you want to modify. Network site policies are created only at the global scope, so this identifier does not need to specify a scope. Instead, it contains a string that is a unique name that identifies that site policy. @@ -58,8 +99,7 @@ Instead, it contains a string that is a unique name that identifies that site po ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -69,6 +109,9 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + An object reference to a site policy that has been modified in memory. This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkSitePolicyType and can be retrieved by calling the `Get-CsNetworkInterSitePolicy` cmdlet. @@ -76,8 +119,7 @@ This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.Net ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -86,32 +128,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -BWPolicyProfileID -The Identity of the bandwidth policy profile that will define the limitations for this site policy. -You can retrieve a list of available profiles by calling the `Get-CsNetworkBandwidthPolicyProfile` cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -NetworkSiteID1 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -NetworkSiteID1 The Identity (NetworkSiteID) of one of the two sites associated with this policy. The combination of NetworkSiteID1 and NetworkSiteID2 must be unique (for example, you can't have two site policies defined that connect Reno and Portland). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -121,14 +148,16 @@ Accept wildcard characters: False ``` ### -NetworkSiteID2 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Identity (NetworkSiteID) of one of the two sites associated with this policy. The combination of NetworkSiteID1 and NetworkSiteID2 must be unique (for example, you can't have two site policies defined that connect Reno and Portland). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -137,14 +166,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -154,29 +185,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -190,13 +207,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkSitePolicyType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkSitePolicyType + Accepts pipelined input of network inter-site policy objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.InterNetworkSitePolicyType. diff --git a/skype/skype-ps/skype/Set-CsNetworkRegion.md b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkRegion.md similarity index 85% rename from skype/skype-ps/skype/Set-CsNetworkRegion.md rename to skype/skype-ps/SkypeForBusiness/Set-CsNetworkRegion.md index 5262233618..1011d7f7b7 100644 --- a/skype/skype-ps/skype/Set-CsNetworkRegion.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkRegion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworkregion applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsNetworkRegion -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworkregion +schema: 2.0.0 +title: Set-CsNetworkRegion --- # Set-CsNetworkRegion @@ -43,7 +44,7 @@ Use this cmdlet to modify an existing network region, including settings that de ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsNetworkRegion -Identity NorthAmerica -Description "North American Region" ``` @@ -53,7 +54,7 @@ The Description parameter is given a value of "North American Region." If a Desc If no Description had been set, this command sets it. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsNetworkRegion -Identity EMEA -VideoAlternatePath $False ``` @@ -64,7 +65,7 @@ We then specify the VideoAlternatePath parameter, passing the value $False. Setting VideoAlternatePath to False indicates that if adequate bandwidth is not available, the video call will not be routed to an alternate path; instead, it will simply not be completed. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $a = Get-CsNetworkRegion -Identity NorthAmerica @@ -87,42 +88,10 @@ The @{add=} portion of the value adds that item to the collection of BWAlternate ## PARAMETERS -### -Identity -The unique identifier of the network region you want to modify. -The Identity will be in the form of a string that uniquely identifies that region. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -A reference to a network region object. -This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType and can be retrieved by calling the `Get-CsNetworkRegion` cmdlet. - - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AudioAlternatePath -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AudioAlternatePath This parameter determines whether audio calls will be routed through an alternate path if adequate bandwidth does not exist in the primary path. This parameter populates the BWAlternatePaths property. @@ -136,8 +105,7 @@ If any of your calls will be Internet calls, this value must be True, regardless ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -147,6 +115,9 @@ Accept wildcard characters: False ``` ### -BWAlternatePaths + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A list of objects that contain information about whether alternate connection paths are allowed if a media request is unable to complete along the preferred path (for example, if limits on that path have been exceeded). Alternate path objects must be of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.BWAlternatePathType. You can create objects of this type by calling the `New-CsNetworkBWAlternatePath` cmdlet. @@ -154,8 +125,7 @@ You can create objects of this type by calling the `New-CsNetworkBWAlternatePath ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -165,6 +135,9 @@ Accept wildcard characters: False ``` ### -BypassID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A globally unique identifier (GUID). This GUID is used to map network regions to media bypass settings within a CAC or Enhanced 9-1-1 (E9-1-1) network configuration. (Use this BypassID value in the call to the `New-CsNetworkMediaBypassConfiguration` cmdlet.) @@ -178,8 +151,7 @@ You will receive a confirmation prompting you to verify that you want to manuall ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -189,6 +161,9 @@ Accept wildcard characters: False ``` ### -CentralSite + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The central site running the bandwidth policy service. This service must be enabled in order to use CAC. This service runs on the Front End Server or the Standard Edition server. @@ -196,8 +171,7 @@ This service runs on the Front End Server or the Standard Edition server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -207,14 +181,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A string that describes the region. This parameter can be used to provide a more descriptive explanation of what the region is for than can be expressed by the Identity alone. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -223,7 +199,67 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the network region you want to modify. +The Identity will be in the form of a string that uniquely identifies that region. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A reference to a network region object. +This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType and can be retrieved by calling the `Get-CsNetworkRegion` cmdlet. + + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -VideoAlternatePath + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This parameter determines whether video calls will be routed through an alternate path if adequate bandwidth does not exist in the primary path. This parameter populates the BWAlternatePaths property. @@ -237,8 +273,7 @@ If any of your calls will be Internet calls, this value must be True, regardless ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -247,14 +282,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -264,29 +301,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -300,13 +323,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType + Accepts pipelined input of network region objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionType. diff --git a/skype/skype-ps/skype/Set-CsNetworkRegionLink.md b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkRegionLink.md similarity index 82% rename from skype/skype-ps/skype/Set-CsNetworkRegionLink.md rename to skype/skype-ps/SkypeForBusiness/Set-CsNetworkRegionLink.md index c56b65a75a..ef8080fab0 100644 --- a/skype/skype-ps/skype/Set-CsNetworkRegionLink.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkRegionLink.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworkregionlink applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsNetworkRegionLink -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworkregionlink +schema: 2.0.0 +title: Set-CsNetworkRegionLink --- # Set-CsNetworkRegionLink @@ -38,7 +39,7 @@ This cmdlet modifies a link between two regions, allowing you to change the regi ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsNetworkRegionLink -Identity NA_EMEA -BWPolicyProfileID HighBWLimits ``` @@ -51,7 +52,47 @@ This will assign the bandwidth limitations defined in that bandwidth policy prof ## PARAMETERS +### -BWPolicyProfileID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity of the bandwidth policy profile that will define the limitations for this link. +You can retrieve a list of available profiles by calling the `Get-CsNetworkBandwidthPolicyProfile` cmdlet. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier for the network region link you want to modify. Network region links are created only at the global scope, so this identifier does not need to specify a scope. Instead, it contains a string that is a unique name that identifies that link. @@ -59,8 +100,7 @@ Instead, it contains a string that is a unique name that identifies that link. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -70,6 +110,9 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + An object reference to a network region link. This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionLinkType, which can be retrieved by calling the `Get-CsNetworkRegionLink` cmdlet. @@ -77,8 +120,7 @@ This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.Net ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -87,31 +129,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -BWPolicyProfileID -The Identity of the bandwidth policy profile that will define the limitations for this link. -You can retrieve a list of available profiles by calling the `Get-CsNetworkBandwidthPolicyProfile` cmdlet. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -NetworkRegionID1 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -NetworkRegionID1 The Identity (NetworkRegionID) of the region that is linked to the region identified by the NetworkRegionID2 property. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -121,13 +148,15 @@ Accept wildcard characters: False ``` ### -NetworkRegionID2 + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Identity (NetworkRegionID) of the region that is linked to the region identified by the NetworkRegionID1 property. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -136,14 +165,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -153,29 +184,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -189,13 +206,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionLinkType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionLinkType + Accepts pipelined input of network region link objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.NetworkRegionLinkType. diff --git a/skype/skype-ps/skype/Set-CsNetworkSite.md b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkSite.md similarity index 84% rename from skype/skype-ps/skype/Set-CsNetworkSite.md rename to skype/skype-ps/SkypeForBusiness/Set-CsNetworkSite.md index 92a478becd..bc01b681ea 100644 --- a/skype/skype-ps/skype/Set-CsNetworkSite.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkSite.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworksite applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsNetworkSite -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworksite +schema: 2.0.0 +title: Set-CsNetworkSite --- # Set-CsNetworkSite @@ -41,7 +42,7 @@ This can include such things as the region with which the site is associated, th ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsNetworkSite -Identity Vancouver -NetworkRegionID Canada ``` @@ -53,7 +54,7 @@ Because a NetworkRegionID has been supplied but no value has been specified for Any previously-existing bypass ID will be overwritten. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsNetworkSite -Identity Vancouver - BWPolicyProfileID LowBWLimits ``` @@ -66,43 +67,10 @@ The policies associated with that profile will be used for this site. ## PARAMETERS -### -Identity -The unique identifier of the network site you want to modify. -Sites are created only at the global scope, so you do not need to specify a scope. -Instead, you need to specify only the network site ID. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -A reference to a network site object (an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType). -This object can be retrieved by calling the `Get-CsNetworkSite` cmdlet. - +### -BWPolicyProfileID -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -BWPolicyProfileID The Identity of the bandwidth policy profile that will define the limitations for this site. You can retrieve a list of available profiles by calling the `Get-CsNetworkBandwidthPolicyProfile` cmdlet. @@ -111,8 +79,7 @@ If you specify a value for this parameter, you must also specify a value for the ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,6 +89,9 @@ Accept wildcard characters: False ``` ### -BypassID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A globally unique identifier (GUID). This GUID is used to map network sites to media bypass settings within a CAC or E9-1-1 network configuration. (Use this BypassID value in the call to the `New-CsNetworkMediaBypassConfiguration` cmdlet.) @@ -137,8 +107,7 @@ If you manually enter a value, you will receive a confirmation prompt to verify ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -148,14 +117,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A string that describes the site. This parameter can be used to provide a more descriptive explanation of what the site is for or where it is than can be expressed by the Identity alone. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -164,16 +135,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LocationPolicy -The name of the location policy associated with this site. -The location policy assigns specific E9-1-1 settings to the site. -To retrieve a list of location policies, call the `Get-CsLocationPolicy` cmdlet. +### -EnableLocationBasedRouting + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, voice routing will be managed by taking into account the location of both the user placing the call and the user receiving the call. +The default value is False. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,18 +154,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkRegionID -The Identity of the network region that this site is associated with. -This parameter must contain a value if you want to provide a BypassID (either through auto-generation or manually), or if the EnableBandwidthPolicyCheck property of the network configuration is True. -You can retrieve the network configuration settings by calling the `Get-CsNetworkConfiguration` cmdlet. +### -Force -If a BypassID exists on this site already and you don't specify a value for the BypassID parameter, the existing BypassID will be overwritten by an auto-generated BypassID. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -202,46 +172,58 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the network site you want to modify. +Sites are created only at the global scope, so you do not need to specify a scope. +Instead, you need to specify only the network site ID. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A reference to a network site object (an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType). +This object can be retrieved by calling the `Get-CsNetworkSite` cmdlet. + ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -LocationPolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The name of the location policy associated with this site. +The location policy assigns specific E9-1-1 settings to the site. +To retrieve a list of location policies, call the `Get-CsLocationPolicy` cmdlet. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -250,15 +232,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableLocationBasedRouting -When set to True, voice routing will be managed by taking into account the location of both the user placing the call and the user receiving the call. -The default value is False. +### -NetworkRegionID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity of the network region that this site is associated with. +This parameter must contain a value if you want to provide a BypassID (either through auto-generation or manually), or if the EnableBandwidthPolicyCheck property of the network configuration is True. +You can retrieve the network configuration settings by calling the `Get-CsNetworkConfiguration` cmdlet. + +If a BypassID exists on this site already and you don't specify a value for the BypassID parameter, the existing BypassID will be overwritten by an auto-generated BypassID. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -268,6 +255,9 @@ Accept wildcard characters: False ``` ### -VoiceRoutingPolicy + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Per-user voice routing policy to be assigned to the site. For example: @@ -280,8 +270,43 @@ This parameter was introduced in the February, 2013 release of Lync Server 2013. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -295,13 +320,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType + Accepts pipelined input of network site objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.DisplayNetworkSiteType. diff --git a/skype/skype-ps/skype/Set-CsNetworkSubnet.md b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkSubnet.md similarity index 82% rename from skype/skype-ps/skype/Set-CsNetworkSubnet.md rename to skype/skype-ps/SkypeForBusiness/Set-CsNetworkSubnet.md index c12c29f142..ed77bd6d9e 100644 --- a/skype/skype-ps/skype/Set-CsNetworkSubnet.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsNetworkSubnet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworksubnet applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsNetworkSubnet -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csnetworksubnet +schema: 2.0.0 +title: Set-CsNetworkSubnet --- # Set-CsNetworkSubnet @@ -38,7 +39,7 @@ Use this cmdlet to modify the associated network site, change the description of ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsNetworkSubnet -Identity 172.11.15.0 -MaskBits 25 -NetworkSiteID Chicago ``` @@ -47,7 +48,7 @@ This example modifies the subnet with the Identity (the Subnet ID) 172.11.15.0. The subnet is modified with a new MaskBits value (25) and a new NetworkSiteID (Chicago). -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsNetworkSubnet | Where-Object {$_.NetworkSiteID -eq "Vancouver"} | Set-CsNetworkSubnet -NetworkSiteID Chicago ``` @@ -64,15 +65,53 @@ By passing the parameter a value of Chicago, we're instructing the `Set-CsNetwor ## PARAMETERS +### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A description of the subnet being modified. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique subnet ID of the subnet you want to modify. This value will be either an IP address (such as 174.11.12.0) or a URL beginning with http: or https:. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -82,6 +121,9 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A reference to the network subnet object that you want to modify. This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.SubnetType, which can be retrieved by calling the `Get-CsNetworkSubnet` cmdlet. @@ -89,8 +131,7 @@ This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.Net ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -99,30 +140,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Description -A description of the subnet being modified. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -MaskBits -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -MaskBits The bitmask to be applied to the subnet. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,14 +159,16 @@ Accept wildcard characters: False ``` ### -NetworkSiteID + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The site ID of the network site to which this subnet is to be applied. You can retrieve site IDs for your deployment by calling the `Get-CsNetworkSite` cmdlet. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -148,14 +177,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -165,29 +196,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -201,13 +218,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.SubnetType object. +### Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.SubnetType + Accepts pipelined input of network subnet objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.NetworkConfiguration.SubnetType. diff --git a/skype/skype-ps/skype/Set-CsOAuthConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsOAuthConfiguration.md similarity index 83% rename from skype/skype-ps/skype/Set-CsOAuthConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsOAuthConfiguration.md index ad81bf71a0..f9bd2674f3 100644 --- a/skype/skype-ps/skype/Set-CsOAuthConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsOAuthConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csoauthconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsOAuthConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/set-csoauthconfiguration +schema: 2.0.0 +title: Set-CsOAuthConfiguration --- # Set-CsOAuthConfiguration @@ -50,7 +52,7 @@ The following parameters are not applicable to Skype for Business Online: Additi ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOAuthConfiguration -Identity global -Realm "contoso.com" ``` @@ -61,15 +63,80 @@ In this example, the Realm property is set to "contoso.com". ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. +### -AdditionalAudienceUrls +> Applicable: Skype for Business Online + +This parameter is reserved for internal Microsoft use. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -AlternateAudienceUrl + +> Applicable: Skype for Business Online + +This parameter is reserved for internal Microsoft use. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientAdalAuthOverride + +> Applicable: Skype for Business Online + +Enable or disable ADAL (Modern Authentication) for Skype for Business Online in your tenant. Valid values are + +NoOverride, use global OAuth configuration + +Allowed, Enables OAuth for the tenant + +Disallowed, Disables OAuth for the tenant + +For more information, see [Hybrid Modern Authentication overview and prerequisites for using it with on-premises Skype for Business and Exchange servers](https://learn.microsoft.com/office365/enterprise/hybrid-modern-auth-overview) + +```yaml +Type: ClientAdalAuthOverride +Parameter Sets: (All) +Aliases: +Accepted values: NoOverride, Allowed, Disallowed + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -ClientAuthorizationOAuthServerIdentity + +> Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +URI of the OAuth server used for client authentication. + + +```yaml +Type: String +Parameter Sets: Identity, (All) +Aliases: Required: False Position: Named @@ -79,6 +146,9 @@ Accept wildcard characters: False ``` ### -ExchangeAutodiscoverAllowedDomains + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Collection of domains that autodiscover requests can be redirected to. For example: @@ -88,8 +158,7 @@ For example: ```yaml Type: String Parameter Sets: Identity, (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -99,14 +168,16 @@ Accept wildcard characters: False ``` ### -ExchangeAutodiscoverUrl + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + URL for the autodiscovery service used by the Office 365 version of Microsoft Exchange Server. ```yaml Type: String Parameter Sets: Identity, (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,14 +187,16 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -133,6 +206,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Unique Identity of the OAuth configuration settings. Because you can only have a single, global instance of these settings, you do not need to specify an Identity when calling the `Set-CsOAuthConfiguration` cmdlet. You can, however, use the following syntax to reference the global settings: @@ -143,8 +219,7 @@ You can, however, use the following syntax to reference the global settings: ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -154,13 +229,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -170,14 +247,16 @@ Accept wildcard characters: False ``` ### -Realm + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Server-to-server security container. By default, Skype for Business Server uses your default SIP domain as its OAuth realm. ```yaml Type: String Parameter Sets: Identity, (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -187,14 +266,16 @@ Accept wildcard characters: False ``` ### -ServiceName + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) assigned to the OAuth service. ```yaml Type: String Parameter Sets: Identity, (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -204,6 +285,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the OAuth configuration settings are being modified. For example: @@ -217,8 +301,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -227,47 +310,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### -Confirm -### -AdditionalAudienceUrls -This parameter is reserved for internal Microsoft use. +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Prompts you for confirmation before executing the command. -### -AlternateAudienceUrl -This parameter is reserved for internal Microsoft use. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -276,40 +329,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ClientAdalAuthOverride -Enable or disable ADAL (Modern Authentication) for Skype for Business Online in your tenant. Valid values are +### -WhatIf -NoOverride, use global OAuth configuration +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Allowed, Enables OAuth for the tenant - -Disallowed, Disables OAuth for the tenant +Describes what would happen if you executed the command without actually executing the command. -For more information, see [Hybrid Modern Authentication overview and prerequisites for using it with on-premises Skype for Business and Exchange servers](https://learn.microsoft.com/office365/enterprise/hybrid-modern-auth-overview) ```yaml -Type: ClientAdalAuthOverride +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Accepted values: NoOverride, Allowed, Disallowed -Applicable: Skype for Business Online - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ClientAuthorizationOAuthServerIdentity -URI of the OAuth server used for client authentication. - - -```yaml -Type: String -Parameter Sets: Identity, (All) -Aliases: -Applicable: Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -323,13 +353,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.OAuthSettings The `Set-CsOAuthConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.OAuthSettings object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsOAuthConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.OAuthSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsOAuthServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsOAuthServer.md similarity index 85% rename from skype/skype-ps/skype/Set-CsOAuthServer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsOAuthServer.md index 0749b9d100..6542e6b24c 100644 --- a/skype/skype-ps/skype/Set-CsOAuthServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsOAuthServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csoauthserver applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsOAuthServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csoauthserver +schema: 2.0.0 +title: Set-CsOAuthServer --- # Set-CsOAuthServer @@ -40,7 +41,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOAuthServer -Identity "Office 365" -MetadataUrl "https://sts.office365.microsoft.com/metadata/json/1" ``` @@ -50,30 +51,36 @@ The command shown in Example 1 updates the metadata URL for the OAuth Server Off ## PARAMETERS -### -Identity -Friendly (and unique) name used to identify the OAuth server. +### -AcceptSecurityIdentifierInformation + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True), security identifiers (SIDs) can be used for authentication purposes. +The default value is False. ```yaml -Type: XdsGlobalRelativeIdentity +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -AuthorizationUriOverride + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +URI used for OAuth authorization override. +The override prevents authenticated users from being reprompted for their credentials after they have logged on. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -83,13 +90,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -98,14 +107,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Friendly (and unique) name used to identify the OAuth server. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: (All) +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -115,14 +144,16 @@ Accept wildcard characters: False ``` ### -MetadataUrl + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URL where the WS-FederationMetadata for the server is published. Servers use the metadata to agree on the types of tokens that will be exchanged as well the keys that will be used to sign these tokens. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,6 +163,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for the OAuth server being modified. For example: @@ -145,8 +179,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -155,31 +188,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Type -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Type of authentication used by the server. +For example, this syntax configures the server to use Active Directory Federation Services authentication: -### -AcceptSecurityIdentifierInformation -When set to True ($True), security identifiers (SIDs) can be used for authentication purposes. -The default value is False. +`-Type "ADFS"` ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -188,15 +209,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AuthorizationUriOverride -URI used for OAuth authorization override. -The override prevents authenticated users from being reprompted for their credentials after they have logged on. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -205,17 +227,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -Type of authentication used by the server. -For example, this syntax configures the server to use Active Directory Federation Services authentication: +### -WhatIf -`-Type "ADFS"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -229,13 +250,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.OAuthServer#Decorated The `Set-CsOAuthServer` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.OAuthServer#Decorated object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsOAuthServer` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.OAuthServer#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsOutboundCallingNumberTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Set-CsOutboundCallingNumberTranslationRule.md similarity index 86% rename from skype/skype-ps/skype/Set-CsOutboundCallingNumberTranslationRule.md rename to skype/skype-ps/SkypeForBusiness/Set-CsOutboundCallingNumberTranslationRule.md index 02b03a405f..fee61c1917 100644 --- a/skype/skype-ps/skype/Set-CsOutboundCallingNumberTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsOutboundCallingNumberTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csoutboundcallingnumbertranslationrule applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsOutboundCallingNumberTranslationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csoutboundcallingnumbertranslationrule +schema: 2.0.0 +title: Set-CsOutboundCallingNumberTranslationRule --- # Set-CsOutboundCallingNumberTranslationRule @@ -47,7 +48,7 @@ In the Edit Trunk Configuration dialog box, scroll down to the section labeled C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOutboundCallingNumberTranslationRule -Identity "site:Redmond/SevenDigit" -Priority 0 ``` @@ -58,31 +59,17 @@ In this example, the Priority is set to 0. ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Description -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Description Enables administrators to provide additional text to accompany a translation rule. This description can be used to help administrators clearly identify the purpose of the rule. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -92,13 +79,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -108,6 +97,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the translation rule to be modified. The Identity consists of the scope followed by a unique name within each scope. For example: @@ -117,8 +109,7 @@ For example: ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -128,13 +119,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -144,13 +137,15 @@ Accept wildcard characters: False ``` ### -Pattern + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A regular expression representing the number pattern to which the Translation will be applied. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -160,6 +155,9 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Priority assigned to the rule. If a number matches the Pattern of more than one outbound translation rule, rules are applied in priority order. Rules are processed in order of their assigned priority; the first rule to be processed has a priority of 0; the second rule to be processed has a priority of 1; and so on. @@ -167,8 +165,7 @@ Rules are processed in order of their assigned priority; the first rule to be pr ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -178,13 +175,33 @@ Accept wildcard characters: False ``` ### -Translation + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A regular expression that will be applied to the number matching the Pattern to prepare that number for outbound calling. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -194,13 +211,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -214,13 +233,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.CallingNumberTranslationRule#Decorated The `Set-CsOutboundCallingNumberTranslationRule` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.CallingNumberTranslationRule#Decorated object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsOutboundCallingNumberTranslationRule` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.CallingNumberTranslationRule#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsOutboundTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Set-CsOutboundTranslationRule.md similarity index 85% rename from skype/skype-ps/skype/Set-CsOutboundTranslationRule.md rename to skype/skype-ps/SkypeForBusiness/Set-CsOutboundTranslationRule.md index 8840737092..0aa1a4932f 100644 --- a/skype/skype-ps/skype/Set-CsOutboundTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsOutboundTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csoutboundtranslationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsOutboundTranslationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csoutboundtranslationrule +schema: 2.0.0 +title: Set-CsOutboundTranslationRule --- # Set-CsOutboundTranslationRule @@ -48,7 +49,7 @@ Calling the `Set-CsOutboundTranslationRule` cmdlet is the recommended way of cha ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsOutboundTranslationRule -Identity "site:Redmond/Prefix Redmond" -Description "Convert to seven digits" -Pattern '^\+1425(\d{7})$' -Translation '$1' ``` @@ -60,7 +61,7 @@ These values translate an E.164 number (in this case 12 digits beginning with +1 For example, the number +14255551212 would be translated to the number 5551212. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $a = Get-CsOutboundTranslationRule -Identity "site:Redmond/OBR1" @@ -82,7 +83,47 @@ That's because the rule with that Identity no longer exists, it's been replaced ## PARAMETERS +### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A friendly description of the outbound translation rule. +This description can be used to help administrators clearly identify the purpose of the rule. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the outbound translation rule you want to modify. The Identity consists of the scope followed by a unique name within each scope. For example, site:Redmond/OutboundRule1. @@ -90,8 +131,7 @@ For example, site:Redmond/OutboundRule1. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -101,6 +141,9 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + An object reference to an outbound translation rule. This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TranslationRule, which can be retrieved by calling the `Get-CsOutboundTranslationRule` cmdlet. @@ -108,8 +151,7 @@ This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.Tru ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -118,31 +160,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Description -A friendly description of the outbound translation rule. -This description can be used to help administrators clearly identify the purpose of the rule. +### -Pattern -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Pattern A regular expression representing the number pattern to which the Translation will be applied. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -152,14 +179,16 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If a number matches the Pattern of more than one outbound translation rule, rules are applied in priority order. Use this parameter to assign a priority to the rule. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -169,13 +198,15 @@ Accept wildcard characters: False ``` ### -Translation + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A regular expression that will be applied to the number matching the Pattern to prepare that number for outbound routing. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,14 +215,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -201,29 +234,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -237,13 +256,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TranslationRule object. +### Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TranslationRule + Accepts pipelined input of outbound translation rule objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TranslationRule. diff --git a/skype/skype-ps/skype/Set-CsPartnerApplication.md b/skype/skype-ps/SkypeForBusiness/Set-CsPartnerApplication.md similarity index 88% rename from skype/skype-ps/skype/Set-CsPartnerApplication.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPartnerApplication.md index b1273b0d76..96d71f9541 100644 --- a/skype/skype-ps/skype/Set-CsPartnerApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPartnerApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cspartnerapplication applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPartnerApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cspartnerapplication +schema: 2.0.0 +title: Set-CsPartnerApplication --- # Set-CsPartnerApplication @@ -74,7 +75,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsPartnerApplication -Identity "MicrosoftExchange" -Enabled $False ``` @@ -83,7 +84,7 @@ The command shown in Example 1 disables the partner application MicrosoftExchang This is done by setting the Enabled property to False ($False). -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPartnerApplication | ForEach-Object {Set-CsPartnerApplication -Identity $_.Identity -Enabled $False} ``` @@ -95,7 +96,7 @@ In turn, the `ForEach-Object` cmdlet runs the `Set-CsPartnerApplication` cmdlet Doing so disables each of those partner applications. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPartnerApplication | Where-Object {$_.ApplicationTrustLevel -eq "User"} | ForEach-Object {Set-CsPartnerApplication -Identity $_.Identity -Enabled $False} ``` @@ -108,77 +109,91 @@ That filtered collection is then piped to the `ForEach-Object` cmdlet, which use ## PARAMETERS -### -CertificateFileData -Path to a certificate file that can be assigned to the partner application. -For example: +### -AcceptSecurityIdentifierInformation -`-CertificateFileData "C:\Certificates\PartnerApplication.cer"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True), security identifiers (SIDs) can be used for authentication purposes. +The default value is False. ```yaml -Type: String -Parameter Sets: CertificateFileData -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: CertificateFileData, CertificateRawData, Identity, UseOAuthServer, MetadataUrl +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -CertificateRawData -Certificate (in Base64 encoded format) that can be assigned to the partner application. -To read raw data from a certificate and then convert that data to the required format, use commands similar to these: +### -ApplicationTrustLevel -`$x = [System.IO.File]::ReadAllBytes('C:\Certificates\PartnerApplication.cer')` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`$y = [Convert]::ToBase64String($x)` +Specifies the level of trust between Skype for Business Server and the partner application. +Allowed values are: -You can then use this syntax to assign the certificate data stored in the variable $y: +* Full -- The partner application is trusted to represent itself and to impersonate any user in the realm. This is the default value. +* Application -- The partner application is trusted to represent itself within the realm. In order to impersonate a user, it must obtain consent through from a security token server. +* User -- The partner application must obtain consent from a security token server in order to represent a user, and cannot represent itself. + +The default value is Full. -`-CertificateRawData $y` ```yaml -Type: String -Parameter Sets: CertificateRawData -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: ApplicationTrustLevel +Parameter Sets: CertificateFileData, CertificateRawData, Identity, UseOAuthServer, MetadataUrl +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Unique identifier of the partner application. +### -CertificateFileData + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Path to a certificate file that can be assigned to the partner application. For example: -`-Identity "MicrosoftExchange"` +`-CertificateFileData "C:\Certificates\PartnerApplication.cer"` ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: CertificateFileData, CertificateRawData, Identity, UseOAuthServer, MetadataUrl -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: CertificateFileData +Aliases: Required: True -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MetadataUrl -URL of the security token servicer federation metadata that carries the signing keys, the issuer identifier and the issuer endpoint URL. +### -CertificateRawData + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Certificate (in Base64 encoded format) that can be assigned to the partner application. +To read raw data from a certificate and then convert that data to the required format, use commands similar to these: + +`$x = [System.IO.File]::ReadAllBytes('C:\Certificates\PartnerApplication.cer')` + +`$y = [Convert]::ToBase64String($x)` + +You can then use this syntax to assign the certificate data stored in the variable $y: + +`-CertificateRawData $y` ```yaml Type: String -Parameter Sets: MetadataUrl -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: CertificateRawData +Aliases: Required: True Position: Named @@ -187,32 +202,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseOAuthServer -When present, the partner application will use the configured OAuth Server for server-to-server authentication. -When not present, the partner application will use its built-in security token service for server-to-server authentication. +### -Enabled + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, the partner application is available for use with Skype for Business Server. +When set to False the partner application will continue to run, but will not be able to communicate with Skype for Business Server until the Enabled property has been set to True. + ```yaml -Type: SwitchParameter -Parameter Sets: UseOAuthServer -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: CertificateFileData, CertificateRawData, Identity, UseOAuthServer, MetadataUrl +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AcceptSecurityIdentifierInformation -When set to True ($True), security identifiers (SIDs) can be used for authentication purposes. -The default value is False. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean -Parameter Sets: CertificateFileData, CertificateRawData, Identity, UseOAuthServer, MetadataUrl -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -221,72 +240,81 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ApplicationTrustLevel -Specifies the level of trust between Skype for Business Server and the partner application. -Allowed values are: +### -Identity -* Full -- The partner application is trusted to represent itself and to impersonate any user in the realm. This is the default value. -* Application -- The partner application is trusted to represent itself within the realm. In order to impersonate a user, it must obtain consent through from a security token server. -* User -- The partner application must obtain consent from a security token server in order to represent a user, and cannot represent itself. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The default value is Full. +Unique identifier of the partner application. +For example: +`-Identity "MicrosoftExchange"` ```yaml -Type: ApplicationTrustLevel +Type: XdsGlobalRelativeIdentity Parameter Sets: CertificateFileData, CertificateRawData, Identity, UseOAuthServer, MetadataUrl -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Enabled -When set to True, the partner application is available for use with Skype for Business Server. -When set to False the partner application will continue to run, but will not be able to communicate with Skype for Business Server until the Enabled property has been set to True. +### -MetadataUrl + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +URL of the security token servicer federation metadata that carries the signing keys, the issuer identifier and the issuer endpoint URL. ```yaml -Type: Boolean -Parameter Sets: CertificateFileData, CertificateRawData, Identity, UseOAuthServer, MetadataUrl -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: MetadataUrl +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Globally unique identifier (GUID) of the Skype for Business Online tenant account for the partner application being modified. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` + ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Guid +Parameter Sets: CertificateFileData, CertificateRawData, Identity, UseOAuthServer, MetadataUrl +Aliases: Required: False Position: Named @@ -295,38 +323,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -UseOAuthServer + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, the partner application will use the configured OAuth Server for server-to-server authentication. +When not present, the partner application will use its built-in security token service for server-to-server authentication. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: UseOAuthServer +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for the partner application being modified. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` - -You can return the tenant ID for each of your tenants by running this command: +### -Confirm -`Get-CsTenant | Select-Object DisplayName, TenantID` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Prompts you for confirmation before executing the command. ```yaml -Type: Guid -Parameter Sets: CertificateFileData, CertificateRawData, Identity, UseOAuthServer, MetadataUrl -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -336,13 +361,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -356,14 +383,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsPartnerApplication` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None Instead, the `Set-CsPartnerApplication` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SSAuth.PartnerApplication#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsPersistentChatActiveServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatActiveServer.md similarity index 90% rename from skype/skype-ps/skype/Set-CsPersistentChatActiveServer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatActiveServer.md index 6bb38b73c1..8bed65fcff 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatActiveServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatActiveServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatactiveserver applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPersistentChatActiveServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatactiveserver +schema: 2.0.0 +title: Set-CsPersistentChatActiveServer --- # Set-CsPersistentChatActiveServer @@ -48,7 +49,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsPersistentChatActiveServer -Identity "PChatServerCollection" -ActiveServers @{Add="atl-gc-001.litwareinc.com"} ``` @@ -67,7 +68,7 @@ To add the server to the Then run the following cmdlet to add the server, using `Set-CsPersistentChatActiveServer -Identity "PChatServerCollection" -ActiveServers @{Add="atl-gc-001.litwareinc.com"}` -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsPersistentChatActiveServer -Identity "PChatServerCollection" -ActiveServers @{Remove="atl-gc-001.litwareinc.com"} ``` @@ -75,7 +76,7 @@ Set-CsPersistentChatActiveServer -Identity "PChatServerCollection" -ActiveServer Example 2 removes the server atl-gc-001.litwareinc.com from the collection of active Persistent Chat servers. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsPersistentChatActiveServer -Identity "PChatServerCollection" -ActiveServers $Null ``` @@ -87,13 +88,15 @@ Removing all the active servers is typically done in a failback or failover scen ## PARAMETERS ### -ActiveServers + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Collection of fully-qualified domain names representing the active Persistent Chat servers. ```yaml Type: System.Management.Automation.PSListModifier`1[Microsoft.Rtc.Management.Deploy.Fqdn] Parameter Sets: Explicit -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: Named @@ -102,80 +105,90 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Swap -When specified, swaps the active state for all the Persistent Chat servers in the specified pool: active servers will be marked as inactive, and inactive servers will be marked as active. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter -Parameter Sets: Swap -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Unique Identity for the collection of active servers. +Note that you can only have a single collection of Persistent Chat servers. + ```yaml -Type: SwitchParameter +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -Swap + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +When specified, swaps the active state for all the Persistent Chat servers in the specified pool: active servers will be marked as inactive, and inactive servers will be marked as active. ```yaml Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Parameter Sets: Swap +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Unique Identity for the collection of active servers. -Note that you can only have a single collection of Persistent Chat servers. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 +Prompts you for confirmation before executing the command. ```yaml -Type: XdsGlobalRelativeIdentity +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: cf Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -189,14 +202,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsPersistentChatActiveServer` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Set-CsPersistentChatAddin.md b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatAddin.md similarity index 90% rename from skype/skype-ps/skype/Set-CsPersistentChatAddin.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatAddin.md index 57d307c906..232f3f5bbd 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatAddin.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatAddin.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchataddin applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPersistentChatAddin -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchataddin +schema: 2.0.0 +title: Set-CsPersistentChatAddin --- # Set-CsPersistentChatAddin @@ -48,7 +49,7 @@ Skype for Business Server Control Panel: To modify an existing Persistent Chat a ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsPersistentChatAddin -Identity "atl-cs-001.litwareinc.com\ITPersistentChatAddin" -Url "https://atl-cs-001.litwareinc.com/itchat2" ``` @@ -60,6 +61,9 @@ In this case, the URL is changed to `https://atl-cs-001.litwareinc.com/itchat2`. ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the Persistent Chat add-in. The Identity is composed of the fully qualified domain name of the Persistent Chat pool where the add-in is located, a "\" character, and the add-in name. For example: @@ -69,8 +73,7 @@ For example: ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 1 @@ -80,13 +83,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: Addin Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: 1 @@ -95,14 +100,17 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Name + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Friendly name given to the Persistent Chat add-in. +Names must be unique per Persistent Chat pool. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -111,15 +119,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -Friendly name given to the Persistent Chat add-in. -Names must be unique per Persistent Chat pool. +### -Url + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +URL of the Web page to be displayed by the Persistent Chat add-in. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -128,14 +137,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Url -URL of the Web page to be displayed by the Persistent Chat add-in. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: cf Required: False Position: Named @@ -145,13 +156,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -165,13 +178,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.PersistentChat.Cmdlets.AddinObject The `Set-CsPersistentChatAddin` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.AddinObject object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsPersistentChatAddin` cmdlet modifies existing instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.AddinObject object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsPersistentChatCategory.md b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatCategory.md similarity index 91% rename from skype/skype-ps/skype/Set-CsPersistentChatCategory.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatCategory.md index 5398bb8787..396f96ca17 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatCategory.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatCategory.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatcategory applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPersistentChatCategory -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatcategory +schema: 2.0.0 +title: Set-CsPersistentChatCategory --- # Set-CsPersistentChatCategory @@ -56,7 +57,7 @@ Skype for Business Server Control Panel: To modify an existing Persistent Chat c ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsPersistentChatCategory -Identity "atl-cs-001.litwareinc.com\helpdesk" -FileUpload $False ``` @@ -64,7 +65,7 @@ Set-CsPersistentChatCategory -Identity "atl-cs-001.litwareinc.com\helpdesk" -Fil In Example 1, file uploads are disabled for the Persistent Chat category atl-cs-001.litwareinc.com\helpdesk. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatCategory | Set-CsPersistentChatCategory -FileUpload $False ``` @@ -76,42 +77,10 @@ The categories in this collection are then piped to the `Set-CsPersistentChatCat ## PARAMETERS -### -Identity -Unique identifier for the chat room category. -The Identity consists of the Persistent Chat pool were the category is located followed by the category Name; for example: - -`-Identity "atl-gc-001.litwareinc.com\ITChat"` - -```yaml -Type: String -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. - -```yaml -Type: Category -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -AllowedMembers -Required: True -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -AllowedMembers Lists the users who are allowed to access chat rooms within the category. To add a new user to the Members list, use syntax similar to this: @@ -141,8 +110,7 @@ To add all the users in a distribution list, use the Active Directory distinguis ```yaml Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -152,14 +120,16 @@ Accept wildcard characters: False ``` ### -AsObject + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When specified, Active Directory display names are used when adding users to or removing users from the AllowedMembers, DeniedMembers and Creators lists. When not specified, SIP addresses are used when managing these lists. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -169,14 +139,16 @@ Accept wildcard characters: False ``` ### -ChatHistory + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When set to False ($False), the chat history feature will be disabled for the new category. Typically, chat history is only disabled for chat rooms that are used for announcements that are posted once and then never need to be referred to again. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -185,23 +157,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Creators -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +> Applicable: Lync Server 2013, Skype for Business Server 2015 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Creators Lists the users who are allowed to create chat rooms within the category. To add a new user to the Creators list, use syntax similar to this: @@ -231,8 +190,7 @@ To add all the users in a distribution list, use the Active Directory distinguis ```yaml Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -242,6 +200,9 @@ Accept wildcard characters: False ``` ### -DeniedMembers + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Lists the users who are not allowed to access chat rooms within the category. To add a new user to the DeniedMembers list, use syntax similar to this: @@ -271,8 +232,7 @@ To deny access to all the users in a distribution list, use the Active Directory ```yaml Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -282,14 +242,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Additional text accompanying the Persistent Chat category. For example, the Description might explain the purpose of the category and what type of rooms you can expect to find within the category. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -299,13 +261,15 @@ Accept wildcard characters: False ``` ### -FileUpload + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When set to True ($True), allows file uploads to the chat rooms in the category. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -314,15 +278,56 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Unique identifier for the chat room category. +The Identity consists of the Persistent Chat pool were the category is located followed by the category Name; for example: + +`-Identity "atl-gc-001.litwareinc.com\ITChat"` + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +```yaml +Type: Category +Parameter Sets: Instance +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -Invitations + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When set to False ($False), Invitations will be enabled for the category. Among other things, this means that users on the AllowedMembers list will automatically receive an invitation to join a new chat room at the time that new room is created. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -332,14 +337,34 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Name given to the Persistent Chat category. Names must be unique per Persistent Chat pool. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -349,13 +374,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -369,13 +396,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.PersistentChat.Cmdlets.CategoryObject The `Set-CsPersistentChatCategory` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.CategoryObject object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsPersistentChatCategory` cmdlet modifies existing instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.CategoryObject object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsPersistentChatComplianceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatComplianceConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Set-CsPersistentChatComplianceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatComplianceConfiguration.md index 9dabe65046..471869b147 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatComplianceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatComplianceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatcomplianceconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPersistentChatComplianceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatcomplianceconfiguration +schema: 2.0.0 +title: Set-CsPersistentChatComplianceConfiguration --- # Set-CsPersistentChatComplianceConfiguration @@ -52,7 +53,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsPersistentChatComplianceConfiguration -Identity "global" -RunInterval "00:10:00" ``` @@ -60,7 +61,7 @@ Set-CsPersistentChatComplianceConfiguration -Identity "global" -RunInterval "00: Example 1 sets the RunInterval property of the global collection of Persistent Chat compliance configuration settings to 10 minutes: 00 hours : 10 minutes : 00 seconds. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatComplianceConfiguration | Set-CsPersistentChatComplianceConfiguration -RunInterval "00:10:00" ``` @@ -73,14 +74,16 @@ This collection is then piped to the `Set-CsPersistentChatComplianceConfiguratio ## PARAMETERS ### -AdapterName + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Name of the Persistent Chat adapters. Adapters are third-party products that convert the data in the compliance database to a specific format. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -90,14 +93,16 @@ Accept wildcard characters: False ``` ### -AdapterOutputDirectory + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Full path to the folder where adapter data is stored. You must have a separate folder for each adapter. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -107,6 +112,9 @@ Accept wildcard characters: False ``` ### -AdapterType + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Specifies the fully qualified name of a .Net managed type that implements the Microsoft.Rtc.Internal.Chat.Server.Compliance.IComplianceAdapter interface. This adapter is supplied by a third-party or can be set to the internal XML adapter, "Microsoft.Rtc.Internal.Chat.Server.Compliance.XmlAdapter,compliance". @@ -116,8 +124,7 @@ If you do not specify an adapter type Persistent Chat will not save compliance d ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -127,6 +134,9 @@ Accept wildcard characters: False ``` ### -AddChatRoomDetails + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When set to True, additional details about each chat room are provided to the adapter. This has the potential to greatly increase the size of the compliance data. @@ -136,8 +146,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -147,6 +156,9 @@ Accept wildcard characters: False ``` ### -AddUserDetails + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When set to True, additional details about each chat room user are provided to the adapter. This has the potential to greatly increase the size of the compliance data. @@ -156,8 +168,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -166,23 +177,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -CreateFileAttachmentsManifest -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -CreateFileAttachmentsManifest When set to True, additional output files will be created to track file transfers within chat rooms. These files will have the file extension .ATTACH and are placed in the location specified by the AdapterOutputDirectory. @@ -190,8 +188,7 @@ These files will have the file extension .ATTACH and are placed in the location ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -201,14 +198,16 @@ Accept wildcard characters: False ``` ### -CustomConfiguration + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + XSLT transform script that enables Persistent Chat to save compliance data in a custom format of your design. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -218,13 +217,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -234,6 +235,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the Persistent Chat compliance settings to be modified. To modify the global collection, use this syntax: @@ -253,8 +257,7 @@ If this parameter is not included then the `Set-CsPersistentChatComplianceConfig ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 2 @@ -264,13 +267,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -280,14 +285,16 @@ Accept wildcard characters: False ``` ### -OneChatRoomPerOutputFile + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When set to True, separate reports are created for each chat room. The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -297,6 +304,9 @@ Accept wildcard characters: False ``` ### -RunInterval + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Amount of time that the server waits before generating the next output file. The RunInterval must be specified using the format days.hours:minutes:seconds. For example, to specify a RunInterval of 15 minutes (the default value) use this syntax: @@ -308,8 +318,25 @@ The RunInterval can be set to any value between 1 minute (00:01.00) and 30 days ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -319,13 +346,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -339,13 +368,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatComplianceConfiguration The `Set-CsPersistentChatComplianceConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatComplianceConfiguration object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsPersistentChatComplianceConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatComplianceConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsPersistentChatConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatConfiguration.md similarity index 91% rename from skype/skype-ps/skype/Set-CsPersistentChatConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatConfiguration.md index f174447fa0..d7ecc0638f 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2015 -title: Set-CsPersistentChatConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatconfiguration +schema: 2.0.0 +title: Set-CsPersistentChatConfiguration --- # Set-CsPersistentChatConfiguration @@ -48,7 +49,7 @@ Skype for Business Server Control Panel: To modify an existing collection of Per ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsPersistentChatConfiguration -Identity "global" -DefaultChatHistory 100 ``` @@ -56,7 +57,7 @@ Set-CsPersistentChatConfiguration -Identity "global" -DefaultChatHistory 100 The command shown in Example 1 sets the DefaultChatHistory property of the global Persistent Chat configuration settings to 100. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatConfiguration | Set-CsPersistentChatConfiguration -DefaultChatHistory 100 ``` @@ -66,7 +67,7 @@ To carry out this task, the command first uses the `Get-CsPersistentChatConfigur This collection is then piped to the `Set-CsPersistentChatConfiguration` cmdlet, which modifies the DefaultChatHistory property for all the items in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatConfiguration -Filter "site:*" | Set-CsPersistentChatConfiguration -DefaultChatHistory 100 ``` @@ -76,7 +77,7 @@ To do this, the command first calls the `Get-CsPersistentChatConfiguration` cmdl These settings are then piped to the `Set-CsPersistentChatConfiguration` cmdlet, which changes the DefaultChatHistory property for each settings collection to 100. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsPersistentChatConfiguration | Where-Object {$_.DefaultChatHistory -gt 100} | Set-CsPersistentChatConfiguration -DefaultChatHistory 100 ``` @@ -89,23 +90,10 @@ In turn, that filtered collection is piped to the `Set-CsPersistentChatConfigura ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -DefaultChatHistory -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -DefaultChatHistory Default number of chat messages instantly available in a chat room. Note that this value represents only the number of messages immediately available; it does not place a limit on the total amount of messages that can be retrieved. @@ -115,8 +103,7 @@ The default value is 30. ```yaml Type: Int16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -126,13 +113,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -142,6 +131,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the Persistent Chat configuration settings to be modified. To modify a collection of settings configured at the site scope, use syntax similar to this: @@ -161,8 +153,7 @@ If you do not include the Identity parameter the `Set-CsPersistentChatConfigurat ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 2 @@ -172,13 +163,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -188,14 +181,16 @@ Accept wildcard characters: False ``` ### -MaxFileSizeKB + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Maximum size of a file (in kilobytes) that can be uploaded or downloaded by the web service. The default value is 20000 KB. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -205,14 +200,16 @@ Accept wildcard characters: False ``` ### -ParticipantUpdateLimit + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Maximum number of users who can participate in a chat room before the active participant list updates are disabled. The default value is 75. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -222,13 +219,33 @@ Accept wildcard characters: False ``` ### -RoomManagementUrl + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + URL for the Web page administrators can use to manage individual chat rooms. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -238,13 +255,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -258,13 +277,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatConfiguration The `Set-CsPersistentChatConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatConfiguration object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsPersistentChatConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsPersistentChatPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatPolicy.md similarity index 90% rename from skype/skype-ps/skype/Set-CsPersistentChatPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatPolicy.md index 0be410776e..5349c82010 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatpolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPersistentChatPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatpolicy +schema: 2.0.0 +title: Set-CsPersistentChatPolicy --- # Set-CsPersistentChatPolicy @@ -47,7 +48,7 @@ Skype for Business Server Control Panel: To modify an existing Persistent Chat p ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsPersistentChatPolicy | Set-CsPersistentChatPolicy -EnablePersistentChat $True ``` @@ -59,31 +60,17 @@ This collection is then piped to the `Set-CsPersistentChatPolicy` cmdlet, which ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -Description -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -Description Enables administrators to provide explanatory text to accompany the policy. For example, the Description might include information about the users the policy should be assigned to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -93,14 +80,16 @@ Accept wildcard characters: False ``` ### -EnablePersistentChat + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When set to True users affected by the policy will be allowed to use Persistent Chat. When set to False (the default value) users affected by the policy will not be allowed to use Persistent Chat. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -110,13 +99,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -126,6 +117,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identity of the Persistent Chat policy to be modified. To modify the global policy, use this syntax: @@ -145,8 +139,7 @@ If you do not include the Identity parameter the `Set-CsPersistentChatPolicy` cm ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 2 @@ -156,13 +149,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -171,14 +166,23 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Tenant + +> Applicable: Skype for Business Server 2015 + +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the Persistent Chat policy is being modified. +For example: + +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -187,21 +191,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the Persistent Chat policy is being modified. -For example: +### -Confirm -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +Prompts you for confirmation before executing the command. -`Get-CsTenant | Select-Object DisplayName, TenantID` +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015 +Aliases: wi Required: False Position: Named @@ -215,13 +232,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.PersistentChat.PersistentChatPolicy The `Set-CsPersistentChatPolicy` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Policy.PersistentChat.PersistentChatPolicy object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsPersistentChatPolicy` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Policy.PersistentChat.PersistentChatPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsPersistentChatRoom.md b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatRoom.md similarity index 91% rename from skype/skype-ps/skype/Set-CsPersistentChatRoom.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatRoom.md index 0a6014d89c..44a4a8cd0c 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatRoom.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatRoom.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatroom applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPersistentChatRoom -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatroom +schema: 2.0.0 +title: Set-CsPersistentChatRoom --- # Set-CsPersistentChatRoom @@ -56,7 +57,7 @@ Skype for Business Server Control Panel: To modify an existing Persistent Chat c ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsPersistentChatRoom -Identity "atl-cs-001.litwareinc.com\ITChatRoom" -Disabled $True ``` @@ -64,7 +65,7 @@ Set-CsPersistentChatRoom -Identity "atl-cs-001.litwareinc.com\ITChatRoom" -Disab The command shown in Example 1 disables the Persistent Chat chat room with the Identity atl-cs-001.litwareinc.com\ITChatRoom. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPersistentChatRoom -PersistentChatPoolFqdn "atl-cs-001.litwareinc.com" | Set-CsPersistentChatRoom -Disabled $True ``` @@ -74,7 +75,7 @@ This task is performed by first using the `Get-CsPersistentChatRoom` cmdlet and These chat rooms are then piped to the `Set-CsPersistentChatRoom` cmdlet, which sets the Disabled property of each room to True ($True). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPersistentChatRoom | Set-CsPersistentChatRoom -Disabled $True ``` @@ -86,42 +87,10 @@ This collection is then piped to the `Set-CsPersistentChatRoom` cmdlet, which di ## PARAMETERS -### -Identity -Unique Identifier for the Persistent Chat chat room being modified. -The Identity for a chat room consists of the Persistent Chat pool where the room has been configured plus the name of the room; for example: - -`-Identity "atl-gc-001.litwareinc.com\RedmondChatRoom"` - -```yaml -Type: String -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. - -```yaml -Type: ChatRoom -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -Addin -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -Addin Name of the Persistent Chat add-in, if any, associated with the chat room. A Persistent Chat add-in is a customized web page that can be embedded within a Persistent Chat client. Add-ins can be created by using the `New-CsPersistentChatAddin` cmdlet. @@ -129,8 +98,7 @@ Add-ins can be created by using the `New-CsPersistentChatAddin` cmdlet. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -140,14 +108,16 @@ Accept wildcard characters: False ``` ### -AsObject + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When specified, Active Directory display names are used when adding users to or removing users from the Managers or Presenters lists. When not specified, SIP addresses are used when managing these lists. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -157,6 +127,9 @@ Accept wildcard characters: False ``` ### -Category + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Category under which the room is located; for example: `-Category "IT"` @@ -167,8 +140,7 @@ Categories, which are a collection of chat rooms, can be created by using the `N ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -177,30 +149,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -Description -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -Description Enables administrators to provide additional information about the new chat room. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -210,14 +168,16 @@ Accept wildcard characters: False ``` ### -Disabled + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When set to True ($True), the new chat room will be disabled and unavailable for use when it is first created. If this parameter is not used then the new chat room will be enabled and available for immediate use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -227,13 +187,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -242,7 +204,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Unique Identifier for the Persistent Chat chat room being modified. +The Identity for a chat room consists of the Persistent Chat pool where the room has been configured plus the name of the room; for example: + +`-Identity "atl-gc-001.litwareinc.com\RedmondChatRoom"` + +```yaml +Type: String +Parameter Sets: Identity +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +```yaml +Type: ChatRoom +Parameter Sets: Instance +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -Invitations + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Specifies whether or not invitations for the chat room will be inherited from the category. Among other things, this means that users on the Members list will automatically receive an invitation to join a new chat room at the time that new room is created. If set to False, invitations will not be used for the room. @@ -251,8 +255,7 @@ If set to Inherit, the room will use the Invitations setting specified for its C ```yaml Type: ChatRoomInvitations Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -262,6 +265,9 @@ Accept wildcard characters: False ``` ### -Managers + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + List of users allowed to define the membership of the chat room as well as configure other settings for the room. To add a new user to the Managers list, use syntax similar to this: @@ -292,8 +298,7 @@ To make all the users in a distribution list chat room managers, use the Active ```yaml Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -303,6 +308,9 @@ Accept wildcard characters: False ``` ### -Members + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + List of users who are allowed to access the chat room. If the Members property is null then the chat room inherits the membership list from its Persistent Chat category. @@ -334,8 +342,7 @@ To make all the users in a distribution list chat room members, use the Active D ```yaml Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -345,14 +352,16 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Name of the Persistent Chat chat room. Names must be unique per Persistent Chat pool. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -362,6 +371,9 @@ Accept wildcard characters: False ``` ### -Presenters + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + List of users who are allowed to post messages in an auditorium chat room. To add a new user to the Presenters list, use syntax similar to this: @@ -392,8 +404,7 @@ To make all the users in a distribution list chat room presenters, use the Activ ```yaml Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -403,6 +414,9 @@ Accept wildcard characters: False ``` ### -Privacy + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Privacy settings for the chat room. Allowed values are: @@ -413,8 +427,7 @@ Allowed values are: ```yaml Type: ChatRoomPrivacy Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -424,6 +437,9 @@ Accept wildcard characters: False ``` ### -Type + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Specifies whether the chat room is configured as a Normal chat room (where all members can post messages) or an Auditorium (where only presenters can post messages). For example: @@ -434,8 +450,25 @@ The default value is Normal. ```yaml Type: ChatRoomType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -445,13 +478,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -465,13 +500,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.PersistentChat.Cmdlets.ChatRoomObject The `Set-CsPersistentChatRoom` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.ChatRoomObject object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsPersistentChatRoom` cmdlet modifies existing instances of the Microsoft.Rtc.Management.PersistentChat.Cmdlets.ChatRoomObject object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsPersistentChatState.md b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatState.md similarity index 89% rename from skype/skype-ps/skype/Set-CsPersistentChatState.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatState.md index b0d38cefb9..2b1b83f62c 100644 --- a/skype/skype-ps/skype/Set-CsPersistentChatState.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPersistentChatState.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatstate applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPersistentChatState -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cspersistentchatstate +schema: 2.0.0 +title: Set-CsPersistentChatState --- # Set-CsPersistentChatState @@ -43,7 +44,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsPersistentChatState -Identity "PersistentChatServer:atl-gc-001.litwareinc.com" -PoolState "FailedOver" ``` @@ -53,30 +54,16 @@ The command shown in Example 1 sets the pool state for the Persistent Chat serve ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -Force Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -86,6 +73,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Service Identity of the Persistent Chat pool where the new service state will be applied. For example: @@ -94,8 +84,7 @@ For example: ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 2 @@ -105,13 +94,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -121,6 +112,9 @@ Accept wildcard characters: False ``` ### -PoolState + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Current state of the Persistent Chat pool. Valid values are: @@ -132,8 +126,25 @@ The default value is Normal. ```yaml Type: PoolState Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -143,13 +154,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -163,13 +176,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatState The `Set-CsPersistentChatState` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatstate object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsPersistentChatState` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.PersistentChat.PersistentChatState object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsPinPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsPinPolicy.md similarity index 87% rename from skype/skype-ps/skype/Set-CsPinPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPinPolicy.md index 8432fb8fd2..f129fe715e 100644 --- a/skype/skype-ps/skype/Set-CsPinPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPinPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cspinpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPinPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cspinpolicy +schema: 2.0.0 +title: Set-CsPinPolicy --- # Set-CsPinPolicy @@ -45,7 +46,7 @@ PIN policies can be configured at the global, site, and per-user scopes; you can ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsPinPolicy -Identity site:Redmond -MinPasswordLength 10 ``` @@ -54,7 +55,7 @@ Example 1 modifies the PIN policy assigned to the Redmond site. In this case, the command changes the value of the MinPasswordLength property to 10; that means that new PINs will have to contain at least 10 digits. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsPinPolicy -Identity RedmondUsersPinPolicy -MinPasswordLength 10 -AllowCommonPatterns $True ``` @@ -62,7 +63,7 @@ Set-CsPinPolicy -Identity RedmondUsersPinPolicy -MinPasswordLength 10 -AllowComm Example 2 modifies two properties of the per-user PIN policy with the Identity RedmondUsersPinPolicy: it changes the value of the MinPasswordLength and the AllowCommonPatterns properties. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsPinPolicy | Set-CsPinPolicy -MinPasswordLength 10 ``` @@ -72,7 +73,7 @@ To do this, the command first calls the `Get-CsPinPolicy` cmdlet without any par That collection is then piped to the `Set-CsPinPolicy` cmdlet, which modifies the value of the MinPasswordLength property for each policy in the collection. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsPinPolicy | Where-Object {$_.MinPasswordLength -gt 10} | Set-CsPinPolicy -MaximumLogonAttempts 25 ``` @@ -84,7 +85,68 @@ The filtered set of policies is then passed to `Set-CsPinPolicy`, which takes ea ## PARAMETERS +### -AllowCommonPatterns + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not "common patterns" are allowed in PINs. +Common patterns include repeating digits (225577); 4 or more consecutive digits (991234); and PINs that match a user's phone number or extension number. +If set to True common patterns (such as the PIN 123456, which includes consecutive digits) are allowed; if set to False common patterns are not allowed. +The default value is False. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to provide additional text to accompany a PIN policy. +For example, the Description might include information about the users the policy should be assigned to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier assigned to the policy when it was created. PIN policies can be assigned at the global, site, or per-user scope. To refer to the global instance, use this syntax: @@ -105,8 +167,7 @@ If you do not specify an Identity, then the `Set-CsPinPolicy` cmdlet will modify ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -116,13 +177,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,43 +194,10 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -AllowCommonPatterns -Indicates whether or not "common patterns" are allowed in PINs. -Common patterns include repeating digits (225577); 4 or more consecutive digits (991234); and PINs that match a user's phone number or extension number. -If set to True common patterns (such as the PIN 123456, which includes consecutive digits) are allowed; if set to False common patterns are not allowed. -The default value is False. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Description -Enables administrators to provide additional text to accompany a PIN policy. -For example, the Description might include information about the users the policy should be assigned to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -MaximumLogonAttempts -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -MaximumLogonAttempts Indicates the number of sequential logon failures that are allowed before a user's PIN is automatically locked. Logon failures are counted in two different ways: local logon failures and global logon failures. When a user first tries to logon, a new 30 minute observation window starts; each failed logon during that 30 minute window is recorded as both a local logon failure and a global logon failure. @@ -195,8 +225,7 @@ This typically provides the highest level of security. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -206,6 +235,9 @@ Accept wildcard characters: False ``` ### -MinPasswordLength + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The minimum allowed length (that is, the minimum number of digits) in a PIN number. For example, if MinPasswordLength is set to 8, then a PIN of 1259 will be rejected because that PIN only has 4 digits. PIN lengths must have at least 4 digits but no more than 24 digits; the default value is 5. @@ -213,8 +245,7 @@ PIN lengths must have at least 4 digits but no more than 24 digits; the default ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -224,6 +255,9 @@ Accept wildcard characters: False ``` ### -PINHistoryCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates how often users are allowed to reuse the same PIN. For example, if the PINHistoryCount is set to 3, then the first three times users reset their PINs they must use a new PIN; on the fourth reset, they can reuse their first PIN. (And, on the fifth reset, they can use their second PIN, and so on.) The PIN history count can be any whole number between 0 and 20, inclusive; 0 means that users can use the same PIN over and over again. @@ -235,8 +269,7 @@ For example, you cannot set PINLifetime to 30 and leave PINHistoryCount at 0. ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -246,6 +279,9 @@ Accept wildcard characters: False ``` ### -PINLifetime + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the length of time (in days) that a PIN remains valid; after the PIN lifetime expires, users must select a new PIN before they will be allowed to use PIN authentication to gain access to the system. PINLifetime can be set to any whole number between 0 and 999, inclusive; 0 indicates that PINs never expire. By default, the PIN lifetime is set to 0 days. @@ -255,8 +291,7 @@ If you set the PINLifetime to a value greater than 0 then you must also set the ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -265,30 +300,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the PIN policy is being modified. +For example: -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -298,13 +326,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -313,21 +343,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the PIN policy is being modified. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -341,13 +366,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.UserPin.UserPolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.UserPin.UserPolicy + The `Set-CsPinPolicy` cmdlet accepts pipelined input of the PIN policy object. ## OUTPUTS -### +### None The `Set-CsPinPolicy` cmdlet does not return a value or object. Instead, the cmdlet configures one or more instances of the Microsoft.Rtc.Management.WritableConfig.Policy.UserPin.UserPolicy object. diff --git a/skype/skype-ps/skype/Set-CsPlatformServiceSettings.md b/skype/skype-ps/SkypeForBusiness/Set-CsPlatformServiceSettings.md similarity index 84% rename from skype/skype-ps/skype/Set-CsPlatformServiceSettings.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPlatformServiceSettings.md index 9bf4ba1881..96daca9588 100644 --- a/skype/skype-ps/skype/Set-CsPlatformServiceSettings.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPlatformServiceSettings.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csplatformservicesettings applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPlatformServiceSettings -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csplatformservicesettings +schema: 2.0.0 +title: Set-CsPlatformServiceSettings --- # Set-CsPlatformServiceSettings @@ -42,7 +43,7 @@ The `Set-CsPlatformServiceSettings` cmdlet gives you control to enable or disabl ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` PS C:\> Set-CsPlatformServiceSettings -EnableDelegateManagement $False -EnableExternalAccessCheck $True -EnableE911 $False -EnableFil eTransfer $True @@ -52,30 +53,16 @@ This example modifies some parameters for global platform service settings. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableCORS -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableCORS This parameter is reserved for Microsoft internal use only. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -85,13 +72,15 @@ Accept wildcard characters: False ``` ### -EnableDelegateManagement + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables the ability to manage delegates from the Skype for Business on Mac client. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -101,13 +90,15 @@ Accept wildcard characters: False ``` ### -EnableE911 + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Allows Skype for Business on Mac users to call 911. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -117,13 +108,15 @@ Accept wildcard characters: False ``` ### -EnableExternalAccessCheck -Enables administrators to use external access policies to block external access to Skype for Business on Mac users. + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to use external access policies to block external access to Skype for Business on Mac users. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -133,13 +126,15 @@ Accept wildcard characters: False ``` ### -EnableFileTransfer + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables Skype for Business on Mac users send files in peer-to-peer chats. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -149,13 +144,15 @@ Accept wildcard characters: False ``` ### -EnablePushNotifications + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables Skype for Business on Mac clients to use push notifications. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -165,13 +162,15 @@ Accept wildcard characters: False ``` ### -EnableUcwaScopeCheck + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for Microsoft internal use only. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -181,13 +180,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses any confirmation prompts that would otherwise be displayed before testing. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -197,13 +198,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the Platform Service Settings to be modified. ```yaml Type: XdsIdentity Parameter Sets: Identity Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: 1 @@ -213,13 +216,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. You can retrieve this object reference by calling the Get-CsPlatformServiceSettings cmdlet. ```yaml Type: PSObject Parameter Sets: Instance Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -229,13 +234,15 @@ Accept wildcard characters: False ``` ### -MaxRegistrationsPerPublicApplication + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for Microsoft internal use only. ```yaml Type: Int32 Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -245,13 +252,33 @@ Accept wildcard characters: False ``` ### -UseLegacyPushNotifications + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for Microsoft internal use only. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before running the cmdlet. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -261,6 +288,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -268,7 +298,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Set-CsPresenceManagementState.md b/skype/skype-ps/SkypeForBusiness/Set-CsPresenceManagementState.md similarity index 83% rename from skype/skype-ps/skype/Set-CsPresenceManagementState.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPresenceManagementState.md index 863e995fa9..b26d5105c1 100644 --- a/skype/skype-ps/skype/Set-CsPresenceManagementState.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPresenceManagementState.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cspresencemanagementstate applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPresenceManagementState -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cspresencemanagementstate +schema: 2.0.0 +title: Set-CsPresenceManagementState --- # Set-CsPresenceManagementState @@ -33,7 +34,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsPresenceManagementState -Fqdn "atl-mcs-001.litwareinc.com" -NotificationBatchSize 50 ``` @@ -43,30 +44,16 @@ This example set the NotificationBatchSize to 50 on the pool or computer named " ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Force The Force parameter is not implemented for this cmdlet. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -76,6 +63,9 @@ Accept wildcard characters: False ``` ### -Fqdn + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the computer or pool to modify. The computer or pool should be referenced by using its fully qualified domain name (FQDN). For example: `-Fqdn "atl-mcs-001.litwareinc.com"`. @@ -84,8 +74,7 @@ If FQDN is not specified, the settings for the local machine will be modified. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -94,14 +83,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -LimitedNotificationMode + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +{{Fill LimitedNotificationMode Description}} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -ManualOverride + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -110,16 +119,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxPublishersPerBatch -Specifies a general guideline for the number of publishers that are collected before notifications are sent. -Reducing the MaxPublishersPerBatch value reduces database pressure at the expense of longer notification wait time after publishing. -Increasing this value reduces notification wait times during periods of high volume, but increases database and network traffic. +### -MaxHttpMessageSizeKb + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +{{Fill MaxHttpMessageSizeKb Description}} ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,14 +137,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxRemotePublishersPerBatch -PARAMVALUE: UInt32 +### -MaxPublishersPerBatch + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies a general guideline for the number of publishers that are collected before notifications are sent. +Reducing the MaxPublishersPerBatch value reduces database pressure at the expense of longer notification wait time after publishing. +Increasing this value reduces notification wait times during periods of high volume, but increases database and network traffic. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -144,16 +157,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NotificationBatchInterval -Specifies the time in seconds between notification batches. -Reducing the NotificationBatchInterval value increases database and network traffic but improves notification wait times. -Increasing the value increases notification wait times. +### -MaxRemotePublishersPerBatch + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: UInt32 ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,15 +175,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NotificationBatchSize -Specifies the maximum number of messages to send in one batch notification. -This parameters should only be changed if messages are exceeding a maximum message size parameter in your organization. +### -MaxRemoteQueueThreadCount + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +{{Fill MaxRemoteQueueThreadCount Description}} ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,14 +193,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -NotificationBatchInterval + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the time in seconds between notification batches. +Reducing the NotificationBatchInterval value increases database and network traffic but improves notification wait times. +Increasing the value increases notification wait times. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -195,14 +213,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LimitedNotificationMode -{{Fill LimitedNotificationMode Description}} +### -NotificationBatchSize + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the maximum number of messages to send in one batch notification. +This parameters should only be changed if messages are exceeding a maximum message size parameter in your organization. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -211,14 +232,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxHttpMessageSizeKb -{{Fill MaxHttpMessageSizeKb Description}} +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: UInt32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -227,14 +250,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxRemoteQueueThreadCount -{{Fill MaxRemoteQueueThreadCount Description}} +### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: UInt32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -248,13 +273,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Set-CsPresencePolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsPresencePolicy.md similarity index 88% rename from skype/skype-ps/skype/Set-CsPresencePolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPresencePolicy.md index b700f28738..d9a8f70ad2 100644 --- a/skype/skype-ps/skype/Set-CsPresencePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPresencePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cspresencepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPresencePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cspresencepolicy +schema: 2.0.0 +title: Set-CsPresencePolicy --- # Set-CsPresencePolicy @@ -57,7 +58,7 @@ Modifying a presence policy simply means changing the value of the MaxPromptedSu ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsPresencePolicy -Identity "RedmondPresencePolicy" -MaxPromptedSubscriber 300 ``` @@ -66,7 +67,7 @@ The command shown in Example 1 modifies the per-user presence policy RedmondPres In this example, the value of the MaxPromptedSubscriber property is set to 300. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsPresencePolicy | Set-CsPresencePolicy -MaxPromptedSubscriber 300 ``` @@ -76,7 +77,7 @@ To do this, the command first calls the `Get-CsPresencePolicy` cmdlet without an This collection is then piped to the `Set-CsPresencePolicy` cmdlet, which changes the value of the MaxPromptedSubscriber for each policy in the collection to 300. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsPresencePolicy | Where-Object {$_.MaxPromptedSubscriber -gt 300} | Set-CsPresencePolicy -MaxPromptedSubscriber 300 ``` @@ -90,7 +91,48 @@ As a result, no policy will allow more than 300 prompted subscribers, although s ## PARAMETERS +### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables administrators to provide additional text to accompany a presence policy. +For example, the Description might include information about the users the policy should be assigned to. + + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the presence policy to be modified. To modify the global policy, use this syntax: @@ -108,8 +150,7 @@ To modify a per-user policy, use syntax like this: ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -119,13 +160,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,6 +178,9 @@ Accept wildcard characters: False ``` ### -MaxCategorySubscription + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum number of category subscriptions allowed at any one time. A category subscription represents a request for a specific category of information; for example, an application that requests calendar data. @@ -143,8 +189,7 @@ MaxCategorySubscription can be set to any integer value between 0 and 3000; the ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -154,6 +199,9 @@ Accept wildcard characters: False ``` ### -MaxPromptedSubscriber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum number of prompted subscribers a user can have at any one time. By default, any time you are added to another user's Contacts list a notification dialog is displayed informing you of this fact and giving you the chance to do such things as add the person to your own Contacts list or block the person from viewing your presence. Until you take action and dismiss the dialog box, each notification counts as a prompted subscriber. @@ -165,8 +213,7 @@ If you set this value to 0, users will not receive any notifications when they a ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -175,30 +222,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Tenant -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the presence policy is being modified. +For example: -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` + +You can return the tenant ID for each of your Skype for Business Online tenants by running this command: + +`Get-CsTenant | Select-Object DisplayName, TenantID` ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -208,13 +248,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -223,39 +265,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -Enables administrators to provide additional text to accompany a presence policy. -For example, the Description might include information about the users the policy should be assigned to. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Tenant -Globally unique identifier (GUID) of the Skype for Business Online tenant account for whom the presence policy is being modified. -For example: - -`-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"` +### -WhatIf -You can return the tenant ID for each of your Skype for Business Online tenants by running this command: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`Get-CsTenant | Select-Object DisplayName, TenantID` +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -269,13 +288,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Presence.PresencePolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Presence.PresencePolicy + The `Set-CsPresencePolicy` cmdlet accepts pipelined input of the presence policy object. ## OUTPUTS -### +### None The `Set-CsPresencePolicy` cmdlet does not return any values or objects. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Presence.PresencePolicy object. diff --git a/skype/skype-ps/skype/Set-CsPresenceProvider.md b/skype/skype-ps/SkypeForBusiness/Set-CsPresenceProvider.md similarity index 88% rename from skype/skype-ps/skype/Set-CsPresenceProvider.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPresenceProvider.md index 253ee70774..0cdae0e402 100644 --- a/skype/skype-ps/skype/Set-CsPresenceProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPresenceProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cspresenceprovider applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPresenceProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cspresenceprovider +schema: 2.0.0 +title: Set-CsPresenceProvider --- # Set-CsPresenceProvider @@ -42,7 +43,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $x = Get-CsPresenceProvider -Identity "global/contoso.com" @@ -61,30 +62,16 @@ After the FQDN property has been configured, the `Set-CsPresenceProvider` cmdlet ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Force Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -94,6 +81,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the presence provider to be modified. The Identity of a presence provider is composed of two parts: the scope (Parent) where the rule has been applied (for example, service:UserServer:atl-cs-001.litwareinc.com) and the provider Fqdn. To modify a presence provider at the global scope use syntax similar to this: @@ -103,8 +93,7 @@ To modify a presence provider at the global scope use syntax similar to this: ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -114,13 +103,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -129,14 +120,34 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -150,13 +161,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PresenceProvider#Decorated The `Set-CsPresenceProvider` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PresenceProvider#Decorated object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsPresenceProvider` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PresenceProvider#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsPrivacyConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsPrivacyConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Set-CsPrivacyConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPrivacyConfiguration.md index 2cca0f6368..5f0cb258df 100644 --- a/skype/skype-ps/skype/Set-CsPrivacyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPrivacyConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csprivacyconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPrivacyConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/set-csprivacyconfiguration +schema: 2.0.0 +title: Set-CsPrivacyConfiguration --- # Set-CsPrivacyConfiguration @@ -53,7 +55,7 @@ The `Set-CsPrivacyConfiguration` cmdlet enables you to modify any of the privacy ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsPrivacyConfiguration -Identity site:Redmond -EnablePrivacyMode $False -AutoInitiateContacts $True -PublishLocationDataDefault $True -DisplayPublishedPhotoDefault $True ``` @@ -62,7 +64,7 @@ The command shown in Example 1 modifies three property values for the privacy co The three property values modified are AutoInitiateContacts, PublishLocationDataDefault and DisplayPublishedPhotoDefault. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsPrivacyConfiguration | Set-CsPrivacyConfiguration -EnablePrivacyMode $True ``` @@ -72,7 +74,7 @@ To do this, the command first calls the `Get-CsPrivacyConfiguration` cmdlet with This collection is then piped to the `Set-CsPrivacyConfiguration` cmdlet, which takes each item in the collection and sets the EnablePrivacyMode property to True. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsPrivacyConfiguration | Where-Object {$_.EnablePrivacyMode -eq $False} | Set-CsPrivacyConfiguration -AutoInitiateContacts $True -PublishLocationDataDefault $True -DisplayPublishedPhotoDefault $True ``` @@ -85,66 +87,62 @@ The filtered collection is then piped to the `Set-CsPrivacyConfiguration` cmdlet ## PARAMETERS -### -Identity -Unique identifier for the privacy configuration settings to be modified. -To modify the global settings, use this syntax: - -`-Identity global` - -To modify settings configured at the site scope, use syntax similar to this: - -`-Identity site:Redmond` - -To modify settings at the service level, use syntax like this: - -`-Identity service:Redmond-UserServices-1` +### -AutoInitiateContacts -Note that privacy settings can only be applied to the User Server service. -An error will occur if you try to apply these settings to any other service. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -If this parameter is not specified then the global settings will be updated when you call the `Set-CsPrivacyConfiguration` cmdlet. +If True, Skype for Business will automatically add your manager and your direct reports to your Contacts list. +The default value is True. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -DisplayPublishedPhotoDefault + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, the user's photo will automatically be published in Skype for Business. +If False, the user's photo will not be available unless he or she explicitly selects the option Let others see my photo. +The default value is True. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -AutoInitiateContacts -If True, Skype for Business will automatically add your manager and your direct reports to your Contacts list. -The default value is True. +### -EnablePrivacyMode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +If True, gives users the opportunity to enable the advanced privacy mode. +In advanced privacy mode, only people on your Contacts list will be allowed to view your presence information. +If False, your presence information will be available to anyone in your organization. +The default value is False. + +For information about privacy mode in Microsoft Teams, see [User presence in Teams](/microsoftteams/presence-admins). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -153,17 +151,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisplayPublishedPhotoDefault -If True, the user's photo will automatically be published in Skype for Business. -If False, the user's photo will not be available unless he or she explicitly selects the option Let others see my photo. -The default value is True. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -172,55 +170,73 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnablePrivacyMode -If True, gives users the opportunity to enable the advanced privacy mode. -In advanced privacy mode, only people on your Contacts list will be allowed to view your presence information. -If False, your presence information will be available to anyone in your organization. -The default value is False. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the privacy configuration settings to be modified. +To modify the global settings, use this syntax: + +`-Identity global` + +To modify settings configured at the site scope, use syntax similar to this: + +`-Identity site:Redmond` + +To modify settings at the service level, use syntax like this: + +`-Identity service:Redmond-UserServices-1` + +Note that privacy settings can only be applied to the User Server service. +An error will occur if you try to apply these settings to any other service. + +If this parameter is not specified then the global settings will be updated when you call the `Set-CsPrivacyConfiguration` cmdlet. -For information about privacy mode in Microsoft Teams, see [User presence in Teams](/microsoftteams/presence-admins). ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PublishLocationDataDefault -If True, location data will automatically be published in Skype for Business. -If False, location data will not be available unless the user explicitly selects the option Show Contacts My Location. -The default value is True. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -PublishLocationDataDefault + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, location data will automatically be published in Skype for Business. +If False, location data will not be available unless the user explicitly selects the option Show Contacts My Location. +The default value is True. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -229,15 +245,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -246,15 +264,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -268,13 +288,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PrivacyConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PrivacyConfiguration + The `Set-CsPrivacyConfiguration` cmdlet accepts pipelined input of the privacy configuration object. ## OUTPUTS -### +### None The `Set-CsPrivacyConfiguration` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.PrivacyConfiguration object. diff --git a/skype/skype-ps/skype/Set-CsProxyConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsProxyConfiguration.md similarity index 82% rename from skype/skype-ps/skype/Set-CsProxyConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsProxyConfiguration.md index 9d347a53bc..22ecb67e6d 100644 --- a/skype/skype-ps/skype/Set-CsProxyConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsProxyConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csproxyconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsProxyConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csproxyconfiguration +schema: 2.0.0 +title: Set-CsProxyConfiguration --- # Set-CsProxyConfiguration @@ -62,7 +63,7 @@ The `Set-CsProxyConfiguration` cmdlet provides a way for you to modify the prope ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsProxyConfiguration -Identity service:EdgeServer:atl-edge-001.litwareinc.com -AcceptServerCompression $True ``` @@ -71,7 +72,7 @@ In Example 1, all the proxy configuration settings that have the Identity servic This is done by calling the `Set-CsProxyConfiguration` cmdlet and the AcceptServerCompression parameter, and by setting the parameter value to True. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsProxyConfiguration | Where-Object {$_.AcceptServerCompression -eq $True} | Set-CsProxyConfiguration -AcceptClientCompression $True ``` @@ -82,7 +83,7 @@ This collection is then piped to the Where-Object cmdlet, which picks out only t The filtered collection is then piped to the `Set-CsProxyConfiguration` cmdlet, which takes each item in the collection and sets the AcceptClientCompression property to True. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsProxyConfiguration -Filter service:* | Set-CsProxyConfiguration -UseNtlmForClientToProxyAuth $False ``` @@ -94,56 +95,53 @@ The filtered collection is then piped to the `Set-CsProxyConfiguration` cmdlet, ## PARAMETERS -### -Identity -Unique identifier for the proxy server configuration settings to be modified. -To modify the global settings, use this syntax: - -`-Identity global` +### -AcceptClientCompression -To modify settings configured at the service scope, use syntax similar to this: - -`-Identity "service: EdgeServer:atl-edge-001.litwareinc.com"` - -If this parameter is not included, the `Set-CsProxyConfiguration` cmdlet will automatically modify the global settings. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +When set to True (the default value), the proxy server will accept all incoming compression requests from client endpoints. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -AcceptServerCompression + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), the proxy server will accept all incoming compression requests from other servers. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -AcceptClientCompression -When set to True (the default value), the proxy server will accept all incoming compression requests from client endpoints. +### -AllowPartnerPollingSubscribes + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set the True, partner applications are allowed to periodically poll the service for state changes. +The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -152,14 +150,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AcceptServerCompression -When set to True (the default value), the proxy server will accept all incoming compression requests from other servers. +### -DisableNtlmFor2010AndLaterClients + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, users logging on from Skype for Business must use the Kerberos protocol for authentication. +The default value is False. + ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -168,14 +170,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableWhiteSpaceKeepAlive -When set to True (the default value) the proxy server expects clients to periodically send a "whitespace message" (an empty message with no content) to indicate that the connection is still active. +### -DnsCacheRecordCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Maximum number of records that can be maintained in the DNS record cache. +The default value is 3000. + ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,16 +190,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxClientCompressionCount -Indicates the maximum number of client-to-server connections that can be compressed at any given time; additional connections beyond this limit will not be compressed. -The compression count can be set to any integer value between 0 and 65535, inclusive. -The default value is 15000. +### -EnableLoggingAllMessageBodies + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, Skype for Business Server will log the actual content of all instant messages. +For privacy reasons, message content is typically deleted and only information about the communicating endpoints is included in the log files. + +The default value is False. + ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -202,16 +212,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxServerCompressionCount -Indicates the maximum number of server-to-server connections that can be compressed at any given time; additional connections beyond this limit will not be compressed. -The server compression count can be set to any integer value between 0 and 65535, inclusive. -The default value is 1024. +### -EnableWhiteSpaceKeepAlive + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) the proxy server expects clients to periodically send a "whitespace message" (an empty message with no content) to indicate that the connection is still active. ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -220,15 +230,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Realm -Indicates whether or not security credentials are processed by the default proxy server realm (SIP Communication Services) or by a custom realm. -Custom realms must be specified (and created) by using the `New-CsSipProxyCustom` cmdlet. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: IRealmChoice +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -237,47 +248,63 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RequestServerCompression -When set to True (the default value) the proxy server requests that compression be used on all outgoing connections to other servers. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the proxy server configuration settings to be modified. +To modify the global settings, use this syntax: + +`-Identity global` + +To modify settings configured at the service scope, use syntax similar to this: + +`-Identity "service: EdgeServer:atl-edge-001.litwareinc.com"` + +If this parameter is not included, the `Set-CsProxyConfiguration` cmdlet will automatically modify the global settings. + ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TreatAllClientsAsRemote -When set to True, the proxy server functions as if all client connections are external connections that pass through the Edge Server. -The default value is False. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -UseCertificateForClientToProxyAuth -When set to True (the default value), client endpoints will be allowed to use certificates for authentication. +### -LoadBalanceEdgeServers + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When True, software load balancing is employed for requests to Edge Servers. +The default value is True ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -286,16 +313,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseKerberosForClientToProxyAuth -When set to True (the default value), client endpoints will be allowed to use the Kerberos protocol for authentication. -Although Kerberos is a more secure protocol than NTLM, it cannot be used if the client belongs to a different realm than the server. +### -LoadBalanceInternalServers + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +When True, software load balancing is employed for requests to Registrars and other internal servers. +The default value is true ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -304,16 +332,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseNtlmForClientToProxyAuth -When set to True (the default value), client endpoints will be allowed to use the NTLM protocol for authentication. -Although NTLM is a less secure protocol than Kerberos, NTLM can be used if the client belongs to a different domain than the server. -That is not the case with Kerberos authentication. +### -MaxClientCompressionCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum number of client-to-server connections that can be compressed at any given time; additional connections beyond this limit will not be compressed. +The compression count can be set to any integer value between 0 and 65535, inclusive. +The default value is 15000. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -322,14 +352,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -MaxClientMessageBodySizeKb + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The maximum-allowed size (in kilobytes) for the body of a message sent from a client endpoint. +The default value is 128, meaning that messages with a body size larger than 128 KB will be rejected. +The client message body size can be set to any integer value between 64 and 256, inclusive. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -338,14 +372,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MaxKeepAliveInterval + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the amount of time (in minutes) that can elapse before the server verifies that the connection with the client is still valid. +The default value is 20 minutes. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -354,14 +391,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -MaxServerCompressionCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum number of server-to-server connections that can be compressed at any given time; additional connections beyond this limit will not be compressed. +The server compression count can be set to any integer value between 0 and 65535, inclusive. +The default value is 1024. ```yaml -Type: SwitchParameter +Type: UInt32 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -370,16 +411,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DisableNtlmFor2010AndLaterClients -When set to True, users logging on from Skype for Business must use the Kerberos protocol for authentication. -The default value is False. +### -MaxServerMessageBodySizeKb + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +The maximum-allowed size (in kilobytes) for the body of a message sent from another server. +The default value is 5000, meaning that messages with a body size larger than 5000 KB will be rejected. +The server message body size can be set to any integer value between 1000 and 20000, inclusive. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -388,16 +431,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DnsCacheRecordCount -Maximum number of records that can be maintained in the DNS record cache. -The default value is 3000. +### -OutgoingTlsCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Specifies the maximum number of Transport Layer Security (TLS) connections that can be used for each internal server. +The minimum number of TLS connections is 1, and the maximum number is 4. +By default, OutgoingTlsCount is set to 4. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -406,16 +451,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxClientMessageBodySizeKb -The maximum-allowed size (in kilobytes) for the body of a message sent from a client endpoint. -The default value is 128, meaning that messages with a body size larger than 128 KB will be rejected. -The client message body size can be set to any integer value between 64 and 256, inclusive. +### -Realm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not security credentials are processed by the default proxy server realm (SIP Communication Services) or by a custom realm. +Custom realms must be specified (and created) by using the `New-CsSipProxyCustom` cmdlet. ```yaml -Type: UInt32 +Type: IRealmChoice Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -424,16 +470,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxServerMessageBodySizeKb -The maximum-allowed size (in kilobytes) for the body of a message sent from another server. -The default value is 5000, meaning that messages with a body size larger than 5000 KB will be rejected. -The server message body size can be set to any integer value between 1000 and 20000, inclusive. +### -RequestServerCompression + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value) the proxy server requests that compression be used on all outgoing connections to other servers. ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -442,16 +488,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutgoingTlsCount -Specifies the maximum number of Transport Layer Security (TLS) connections that can be used for each internal server. -The minimum number of TLS connections is 1, and the maximum number is 4. -By default, OutgoingTlsCount is set to 4. +### -SpecialConfigurationList + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: String ```yaml -Type: UInt32 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -460,15 +506,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPartnerPollingSubscribes -When set the True, partner applications are allowed to periodically poll the service for state changes. -The default value is False ($False). +### -TestFeatureList + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not currently used by Skype for Business Server. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -477,18 +524,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableLoggingAllMessageBodies -When set to True, Skype for Business Server will log the actual content of all instant messages. -For privacy reasons, message content is typically deleted and only information about the communicating endpoints is included in the log files. +### -TestParameterList -The default value is False. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +This parameter is not currently used by Skype for Business Server. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -497,15 +542,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LoadBalanceEdgeServers -When True, software load balancing is employed for requests to Edge Servers. -The default value is True ($True). +### -TreatAllClientsAsRemote + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, the proxy server functions as if all client connections are external connections that pass through the Edge Server. +The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -514,15 +561,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LoadBalanceInternalServers -When True, software load balancing is employed for requests to Registrars and other internal servers. -The default value is true ($True). +### -UseCertificateForClientToProxyAuth + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), client endpoints will be allowed to use certificates for authentication. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -531,15 +579,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxKeepAliveInterval -Specifies the amount of time (in minutes) that can elapse before the server verifies that the connection with the client is still valid. -The default value is 20 minutes. +### -UseKerberosForClientToProxyAuth + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), client endpoints will be allowed to use the Kerberos protocol for authentication. +Although Kerberos is a more secure protocol than NTLM, it cannot be used if the client belongs to a different realm than the server. + ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -548,14 +599,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SpecialConfigurationList -PARAMVALUE: String +### -UseNtlmForClientToProxyAuth + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), client endpoints will be allowed to use the NTLM protocol for authentication. +Although NTLM is a less secure protocol than Kerberos, NTLM can be used if the client belongs to a different domain than the server. +That is not the case with Kerberos authentication. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -564,14 +619,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TestFeatureList -This parameter is not currently used by Skype for Business Server. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -580,14 +637,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TestParameterList -This parameter is not currently used by Skype for Business Server. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -601,13 +660,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.ProxySettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.ProxySettings + The `Set-CsProxyConfiguration` cmdlet accepts pipelined instances of the proxy settings object. ## OUTPUTS -### +### None The `Set-CsProxyConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.ProxySettings object. diff --git a/skype/skype-ps/skype/Set-CsPstnGateway.md b/skype/skype-ps/SkypeForBusiness/Set-CsPstnGateway.md similarity index 84% rename from skype/skype-ps/skype/Set-CsPstnGateway.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPstnGateway.md index 652c120b20..70c0c10e99 100644 --- a/skype/skype-ps/skype/Set-CsPstnGateway.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPstnGateway.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cspstngateway applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPstnGateway -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cspstngateway +schema: 2.0.0 +title: Set-CsPstnGateway --- # Set-CsPstnGateway @@ -39,7 +40,7 @@ After your PSTN gateways have been installed and configured, they can be managed ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsPstnGateway -Identity "PstnGateway:192.168.0.240" -Default $True ``` @@ -48,7 +49,7 @@ The command shown in Example 1 configures the gateway PstnGateway:192.168.0.240 That means that PstnGateway:192.168.0.240 can be used to handle calls originating from Office Communications Server 2007 R2. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsService -PstnGateway | ForEach-Object {Set-CsPstnGateway -Identity $_.Identity -Routable $True} ``` @@ -61,40 +62,61 @@ The `ForEach-Object` cmdlet runs the `Set-CsPstnGateway` cmdlet against each gat ## PARAMETERS -### -Identity -Service identity of the PSTN gateway to be modified. -For example: +### -AlternateByPassId -`-Identity "PstnGateway:192.168.0.240"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that you can leave off the prefix "PstnGatewayServer:" when specifying a PSTN gateway. -For example: +Globally unique identifier (GUID) representing the alternate bypass ID. +This ID is automatically generated by Skype for Business Server and is used to help eliminate hairpin calls. +Depending on the way you have configured your system, this allows hairpin calls to automatically bypass the Mediation Server without you having to define and associate individual subnets with all your sites and regions. -`-Identity "atl-cs-001.litwareinc.com"` +To do this, you typically need to globally enable bypass to use network configuration sites and regions, then enable bypass on the trunk configuration for your PSTN gateway. + +A hairpin call occurs when an inbound call from the PSTN network is routed back to that network through call forwarding or simultaneous ringing. ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Default + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If set to True, this gateway will handle calls sent from Office Communications Server 2007 R2. There can only be one default gateway in the collection of gateways managed by a single Mediation Server. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -104,14 +126,16 @@ Accept wildcard characters: False ``` ### -GatewaySipClientTcpPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Listening port used for communicating with Mediation Servers by using Transmission Control Protocol (TCP). The default value is 5066. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -121,14 +145,16 @@ Accept wildcard characters: False ``` ### -GatewaySipClientTlsPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Listening port used for communicating with Mediation Servers by using the Transport Layer Security (TLS) protocol. The default value is 5067. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -137,7 +163,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service identity of the PSTN gateway to be modified. +For example: + +`-Identity "PstnGateway:192.168.0.240"` + +Note that you can leave off the prefix "PstnGatewayServer:" when specifying a PSTN gateway. +For example: + +`-Identity "atl-cs-001.litwareinc.com"` + + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -MediationServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service identity of the Mediation Server to be associated with the PSTN gateway. For example: @@ -147,8 +203,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,6 +213,9 @@ Accept wildcard characters: False ``` ### -RepresentativeMediaIP + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + IP address of the media processor associated with the gateway, provided that the processor location is different from the signaling address. Both media bypass and call admission control (CAC) are based on the location of the gateway's media processor; by default, this is the same location as the signaling address. If the two locations differ (for example, with the media processor in a remote site and the signaling peer in the central site) then RepresentativeMediaIP must be configured with the IP address of the media processor. @@ -167,8 +225,7 @@ If you have deployed multiple media processors in the same site, each with its o ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -178,13 +235,15 @@ Accept wildcard characters: False ``` ### -Routable + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If set to True, the gateway can be used in outbound routing routes. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -193,30 +252,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -225,38 +270,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AlternateByPassId -Globally unique identifier (GUID) representing the alternate bypass ID. -This ID is automatically generated by Skype for Business Server and is used to help eliminate hairpin calls. -Depending on the way you have configured your system, this allows hairpin calls to automatically bypass the Mediation Server without you having to define and associate individual subnets with all your sites and regions. - -To do this, you typically need to globally enable bypass to use network configuration sites and regions, then enable bypass on the trunk configuration for your PSTN gateway. - -A hairpin call occurs when an inbound call from the PSTN network is routed back to that network through call forwarding or simultaneous ringing. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### -WhatIf -### -Force -Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -270,13 +293,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Get-CsPstnGateway` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsPstnGateway` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayPstnGateway object. diff --git a/skype/skype-ps/skype/Set-CsPstnUsage.md b/skype/skype-ps/SkypeForBusiness/Set-CsPstnUsage.md similarity index 80% rename from skype/skype-ps/skype/Set-CsPstnUsage.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPstnUsage.md index d588c47094..a090983307 100644 --- a/skype/skype-ps/skype/Set-CsPstnUsage.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPstnUsage.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cspstnusage applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPstnUsage -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cspstnusage +schema: 2.0.0 +title: Set-CsPstnUsage --- # Set-CsPstnUsage @@ -41,7 +42,7 @@ This list is global so it can be used by policies and routes throughout the Skyp ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsPstnUsage -Identity global -Usage @{add="International"} ``` @@ -49,7 +50,7 @@ Set-CsPstnUsage -Identity global -Usage @{add="International"} This command adds the string "International" to the current list of available PSTN usages. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsPstnUsage -Identity global -Usage @{remove="Local"} ``` @@ -57,7 +58,7 @@ Set-CsPstnUsage -Identity global -Usage @{remove="Local"} This command removes the string "Local" from the list of available PSTN usages. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsPstnUsage -Usage @{remove="Local"} ``` @@ -67,7 +68,7 @@ This example shows the command without the Identity parameter specified. The only Identity available to the `Set-CsPstnUsage` cmdlet is the Global identity; omitting the Identity parameter defaults to Global. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Set-CsPstnUsage -Usage @{replace="International","Restricted"} ``` @@ -78,15 +79,35 @@ All previously existing usages are removed. ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The scope at which these settings are applied. The Identity for this cmdlet is always Global. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -96,6 +117,9 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A reference to a PSTN usage object. This object must be of type PstnUsages and can be retrieved by calling the `Get-CsPstnUsage` cmdlet. @@ -103,8 +127,7 @@ This object must be of type PstnUsages and can be retrieved by calling the `Get- ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -114,14 +137,16 @@ Accept wildcard characters: False ``` ### -Usage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Contains a list of allowable usage strings. These entries can be any string value. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -130,14 +155,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -147,29 +174,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -183,13 +196,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.PstnUsages object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.PstnUsages + Accepts pipelined input of PSTN usage objects. ## OUTPUTS -### +### None This cmdlet does not return a value or object. Instead, it configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.PstnUsages object. diff --git a/skype/skype-ps/skype/Set-CsPublicProvider.md b/skype/skype-ps/SkypeForBusiness/Set-CsPublicProvider.md similarity index 88% rename from skype/skype-ps/skype/Set-CsPublicProvider.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPublicProvider.md index 4895b36792..9b4b3593c4 100644 --- a/skype/skype-ps/skype/Set-CsPublicProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPublicProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cspublicprovider applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPublicProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cspublicprovider +schema: 2.0.0 +title: Set-CsPublicProvider --- # Set-CsPublicProvider @@ -48,7 +49,7 @@ After federated relationships have been established, you can then use the `Set-C ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsPublicProvider -Identity "Skype" -VerificationLevel "AlwaysVerifiable" ``` @@ -57,7 +58,7 @@ Example 1 sets the VerificationLevel for the public provider with the Identity S This is done by including the VerificationLevel parameter and the parameter value AlwaysVerifiable. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsPublicProvider | Set-CsPublicProvider -VerificationLevel "AlwaysVerifiable" ``` @@ -67,7 +68,7 @@ To do this, the command first calls the `Get-CsPublicProvider` cmdlet without an This collection is then piped to the `Set-CsPublicProvider` cmdlet, which takes each provider in the collection and changes the value of the VerificationLevel property to AlwaysVerifiable. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPublicProvider | Where-Object {$_.VerificationLevel -eq "AlwaysUnverifiable"} | Set-CsPublicProvider -VerificationLevel "AlwaysVerifiable" ``` @@ -80,7 +81,49 @@ In turn, this filtered collection is piped to the `Set-CsPublicProvider` cmdlet, ## PARAMETERS +### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether or not the federation relationship between your organization and the public provider is active. +If set to True, users in your organization will be able to exchange instant messages and presence information with users who have accounts hosted on the public provider. +If set to False, users in your organization will not be able to exchange instant messages and presence information with users who have accounts hosted on the public provider. + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the public provider to be modified. The Identity is typically the name of the website providing the services. @@ -88,8 +131,7 @@ The Identity is typically the name of the website providing the services. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -99,13 +141,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -114,25 +158,10 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Enabled -Indicates whether or not the federation relationship between your organization and the public provider is active. -If set to True, users in your organization will be able to exchange instant messages and presence information with users who have accounts hosted on the public provider. -If set to False, users in your organization will not be able to exchange instant messages and presence information with users who have accounts hosted on the public provider. - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -VerificationLevel -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -VerificationLevel Indicates how (or if) messages sent from a public provider are verified to ensure that they were sent from that provider. The VerificationLevel must be set to one of the following values: @@ -157,8 +186,7 @@ This value has been deprecated for use in Skype for Business Server. ```yaml Type: VerificationLevelType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,30 +195,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -199,15 +213,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -221,13 +236,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayPublicProvider object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayPublicProvider + The `Set-CsPublicProvider` cmdlet accepts pipelined instances of the public provider object. ## OUTPUTS -### +### None The `Set-CsPublicProvider` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Edge.DisplayPublicProvider object. diff --git a/skype/skype-ps/skype/Set-CsPushNotificationConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsPushNotificationConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Set-CsPushNotificationConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsPushNotificationConfiguration.md index 7a86381463..cf5fd1aa2c 100644 --- a/skype/skype-ps/skype/Set-CsPushNotificationConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsPushNotificationConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cspushnotificationconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsPushNotificationConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/set-cspushnotificationconfiguration +schema: 2.0.0 +title: Set-CsPushNotificationConfiguration --- # Set-CsPushNotificationConfiguration @@ -56,7 +58,7 @@ For example, you could enable push notifications to Windows Phone users (by sett ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsPushNotificationConfiguration -Identity "site:Redmond" -EnableApplePushNotificationService $False ``` @@ -64,7 +66,7 @@ Set-CsPushNotificationConfiguration -Identity "site:Redmond" -EnableApplePushNot The command shown in Example 1 disables push notifications from the Apple Push Notification Service for the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsPushNotificationConfiguration -Filter "site:*" | Set-CsPushNotificationConfiguration -EnableApplePushNotificationService $False ``` @@ -74,7 +76,7 @@ To do this, the command first uses the `Get-CsPushNotificationConfiguration` cmd That collection of settings is then piped to the `Set-CsPushNotificationConfiguration` cmdlet, which takes each item in the collection and sets the EnableApplePushNotificationService property to False. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsPushNotificationConfiguration | Where-Object {$_.EnableMicrosoftPushNotificationService -eq $False} | Set-CsPushNotificationConfiguration -EnableApplePushNotificationService $False ``` @@ -87,24 +89,10 @@ That filtered collection is then piped to the `Set-CsPushNotificationConfigurati ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableApplePushNotificationService -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableApplePushNotificationService When set to True, iPhone users will receive push notifications from the Apple Push Notification Service. When set to False, iPhone users will not receive these notifications. @@ -114,8 +102,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -125,6 +112,9 @@ Accept wildcard characters: False ``` ### -EnableMicrosoftPushNotificationService + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, Windows Phone users will receive push notifications from the Microsoft Push Notification Service. When set to False, Windows Phone users will not receive these notifications. @@ -134,8 +124,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -145,14 +134,16 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,6 +153,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the push notification configuration settings to be modified. To refer to the global settings, use this syntax: @@ -177,8 +171,7 @@ Note that you cannot use wildcards when specifying an Identity. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -188,13 +181,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -204,6 +199,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for the push notification settings being modified. For example: @@ -221,8 +219,26 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -232,6 +248,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. @@ -239,7 +258,6 @@ Describes what would happen if you executed the command without actually executi Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -253,14 +271,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WriteableConfig.Settings.PushNotificationConfiguration.PushNotificationConfiguration. +### Microsoft.Rtc.Management.WriteableConfig.Settings.PushNotificationConfiguration.PushNotificationConfiguration The `Set-CsPushNotificationConfiguration` cmdlet accepts pipelined instances of the PushNotificationConfiguration object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsPushNotificationConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WriteableConfig.Settings.PushNotificationConfiguration.PushNotificationConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsQoEConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsQoEConfiguration.md similarity index 81% rename from skype/skype-ps/skype/Set-CsQoEConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsQoEConfiguration.md index 257965025e..c4659f38bd 100644 --- a/skype/skype-ps/skype/Set-CsQoEConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsQoEConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csqoeconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsQoEConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csqoeconfiguration +schema: 2.0.0 +title: Set-CsQoEConfiguration --- # Set-CsQoEConfiguration @@ -45,7 +46,7 @@ QoE is part of the Monitoring Server role; therefore Monitoring Server must be d ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsQoEConfiguration -Identity site:Redmond -EnableQoE $False ``` @@ -54,7 +55,7 @@ The command in Example 1 uses the `Set-CsQoEConfiguration` cmdlet to modify the The new settings turn off QoE by setting the EnableQoE parameter to False. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsQoEConfiguration -Identity site:Dublin -KeepQoEDataForDays 45 -PurgeHourOfDay 4 ``` @@ -68,50 +69,16 @@ Note: If you have enabled QoE and call detail recording (CDR), for performance r ## PARAMETERS -### -Identity -The unique identifier of the settings you want to modify. -Possible values are global and site:\, where \ is the name of the site in your Skype for Business Server deployment to which you want to apply the changes. - - -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -An object reference to a QoE configuration object. -This object must be of type QoESettings and can be retrieved by calling the `Get-CsQoEConfiguration` cmdlet. - - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableExternalConsumer -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableExternalConsumer Specifies whether an external consumer is able to receive QoE reports. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -121,13 +88,15 @@ Accept wildcard characters: False ``` ### -EnablePurging + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies whether records will be purged after the duration defined in the KeepQoEDataForDays property has elapsed. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -137,6 +106,9 @@ Accept wildcard characters: False ``` ### -EnableQoE + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies whether QoE records will be collected and saved to the monitoring database. Note that even if EnableQoE is set to True, QoE data will not be collected unless a Monitoring Server has been deployed and associated with a Registrar pool. @@ -144,8 +116,7 @@ Note that even if EnableQoE is set to True, QoE data will not be collected unles ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -155,13 +126,15 @@ Accept wildcard characters: False ``` ### -ExternalConsumerIssuedCertId + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The certificate ID of the certificate that allows access to the external consumer web service. ```yaml Type: IssuedCertId Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -171,13 +144,15 @@ Accept wildcard characters: False ``` ### -ExternalConsumerName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The friendly name of the external consumer of the QoE report. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -187,13 +162,15 @@ Accept wildcard characters: False ``` ### -ExternalConsumerURL + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The URL of the external consumer to which the QoE reports will be posted. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -202,7 +179,68 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the settings you want to modify. +Possible values are global and site:\, where \ is the name of the site in your Skype for Business Server deployment to which you want to apply the changes. + + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +An object reference to a QoE configuration object. +This object must be of type QoESettings and can be retrieved by calling the `Get-CsQoEConfiguration` cmdlet. + + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -KeepQoEDataForDays + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number of days QoE data will be stored before being purged from the database. This value is ignored if EnablePurging is set to False. @@ -211,8 +249,7 @@ Must be a value from 1 through 2562. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -222,6 +259,9 @@ Accept wildcard characters: False ``` ### -PurgeHourOfDay + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The hour of the day that QoE records that have exceeded the number of days specified in the KeepQoEDataForDays property will be purged. Must be a value 0 through 23, representing the hour of the day. @@ -230,8 +270,7 @@ For example, 0 would be midnight, 13 would be 1:00 PM. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -240,14 +279,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -257,29 +298,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -293,13 +320,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.QoE.QoESettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.QoE.QoESettings + Accepts pipelined input of QoE configuration objects. ## OUTPUTS -### +### None The `Set-CsQoEConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.QoE.QoESettings object. diff --git a/skype/skype-ps/skype/Set-CsRegistrar.md b/skype/skype-ps/SkypeForBusiness/Set-CsRegistrar.md similarity index 81% rename from skype/skype-ps/skype/Set-CsRegistrar.md rename to skype/skype-ps/SkypeForBusiness/Set-CsRegistrar.md index b304b0a075..7726613673 100644 --- a/skype/skype-ps/skype/Set-CsRegistrar.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRegistrar.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csregistrar applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsRegistrar -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csregistrar +schema: 2.0.0 +title: Set-CsRegistrar --- # Set-CsRegistrar @@ -45,7 +46,7 @@ These modifications include changing port settings as well as specifying the act ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsRegistrar -Identity "Registrar:atl-cs-001.litwareinc.com" -SipPort 5072 ``` @@ -53,7 +54,7 @@ Set-CsRegistrar -Identity "Registrar:atl-cs-001.litwareinc.com" -SipPort 5072 The command shown in Example 1 sets the SIP port for the Registrar Registrar:atl-cs-001.litwareinc.com to 5072. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsService -Registrar | ForEach-Object {Set-CsRegistrar -Identity $_.Identity -SipPort 5072} ``` @@ -63,7 +64,7 @@ To do this, the command first uses the `Get-CsService` cmdlet and the Registrar This collection is then piped to the `ForEach-Object` cmdlet, which takes each Registrar in the collection and runs the `Set-CsRegistrar` cmdlet in order to change the SIP port to 5072. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsRegistrar -Identity "Registrar:atl-cs-001.litwareinc.com" -BackupRegistrar "Registrar:dublin-cs-001.litwareinc.com" -EnableAutomaticFailover $True ``` @@ -73,32 +74,28 @@ Example 3 configures both a backup Registrar (BackupRegistrar) and automatic fai ## PARAMETERS -### -Identity -Service location of the Registrar to be modified. -For example: - -`-Identity "Registrar:atl-cs-001.litwareinc.com"` - -Note that you can leave off the prefix "Registrar:" when specifying a Registrar. -For example: +### -ArchivingDatabase -`-Identity "atl-cs-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Service Identity of the database used by the Archiving service. ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -ArchivingServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service location of the Archiving Server to be associated with the Registrar. For example: @@ -108,8 +105,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,6 +115,9 @@ Accept wildcard characters: False ``` ### -BackupRegistrar + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service location of the Registrar to be used if this Registrar is not available. For example: @@ -128,8 +127,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -139,6 +137,9 @@ Accept wildcard characters: False ``` ### -EdgeServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service location of the Edge Server to be associated with the Registrar. For example: @@ -148,8 +149,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -159,6 +159,9 @@ Accept wildcard characters: False ``` ### -EnableAutomaticFailover + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If True, the backup Registrar will be employed any time the primary Registrar is unavailable. If False, the backup Registrar will not be used if the primary Registrar is not available. @@ -168,8 +171,7 @@ If this parameter is set to True, then those users will be dropped from the back ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,6 +181,9 @@ Accept wildcard characters: False ``` ### -FailbackDetectionInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the amount of time that the system will wait before checking to see if a Registrar that had become unavailable is now available. If you have set EnableAutomaticFailover to True, the system will "failover" to the backup Registrar any time a Registrar becomes unavailable. That simply means that the system will take users who are logged-on to the failed Registrar and attempt to log them on to the backup Registrar. @@ -201,8 +206,7 @@ This parameter cannot be used unless you have specified a backup Registrar. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -212,6 +216,9 @@ Accept wildcard characters: False ``` ### -FailureDetectionInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the time interval that the system will wait before deciding that a Registrar is unavailable. If EnableAutomaticFailover has been set to True, the system will then attempt to log users on to the backup Registrar instead. @@ -226,8 +233,7 @@ This parameter cannot be used unless you have specified a backup Registrar. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -236,18 +242,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MonitoringServer -Service location of the Monitoring Server to be associated with the Registrar. -For example: +### -Force -`-MonitoringServer "MonitoringServer:atl-cs-001.litwareinc.com"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -256,50 +260,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipPort -Port used for SIP (Session Initiation Protocol) traffic. +### -Identity -```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Service location of the Registrar to be modified. +For example: -### -UserServer -Service location of the User Services server to be associated with the Registrar. +`-Identity "Registrar:atl-cs-001.litwareinc.com"` + +Note that you can leave off the prefix "Registrar:" when specifying a Registrar. For example: -`-UserServer "UserServer:atl-cs-001.litwareinc.com"` +`-Identity "atl-cs-001.litwareinc.com"` ```yaml -Type: String +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WebPort -Port used for communicating with Web servers. +### -LyssWcfMtlsPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Port used by the Lync Storage Service (LYSS). +The default value is 5077. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -308,18 +306,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WebServer -Service location of the Web Server to be associated with the Registrar. -For example: +### -MirrorArchivingDatabase -`-WebServer "WebServer:atl-cs-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Service Identity of the mirror database used by the Archiving service. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -328,14 +324,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -MirrorMonitoringDatabase + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service Identity of the mirror database used by the Monitoring service. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -344,14 +342,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MonitoringDatabase + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service Identity of the monitoring database associated with the Registrar. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -360,14 +360,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -MonitoringServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the Monitoring Server to be associated with the Registrar. +For example: + +`-MonitoringServer "MonitoringServer:atl-cs-001.litwareinc.com"` + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -377,14 +383,16 @@ Accept wildcard characters: False ``` ### -Registrar + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service location of the Registrar. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -394,14 +402,16 @@ Accept wildcard characters: False ``` ### -SipHealthPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for monitoring server health. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -410,16 +420,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipServerTcpPort -SIP listening port. -The default value is 5060. +### -SipPort +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Port used for SIP (Session Initiation Protocol) traffic. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -428,31 +438,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ArchivingDatabase -Service Identity of the database used by the Archiving service. +### -SipServerTcpPort -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +SIP listening port. +The default value is 5060. -### -LyssWcfMtlsPort -Port used by the Lync Storage Service (LYSS). -The default value is 5077. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -461,14 +458,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MirrorArchivingDatabase -Service Identity of the mirror database used by the Archiving service. +### -UserServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the User Services server to be associated with the Registrar. +For example: + +`-UserServer "UserServer:atl-cs-001.litwareinc.com"` + ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -477,14 +480,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MirrorMonitoringDatabase -Service Identity of the mirror database used by the Monitoring service. +### -WebPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Port used for communicating with Web servers. ```yaml -Type: String +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -493,14 +498,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MonitoringDatabase -Service Identity of the monitoring database associated with the Registrar. +### -WebServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service location of the Web Server to be associated with the Registrar. +For example: + +`-WebServer "WebServer:atl-cs-001.litwareinc.com"` + ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -510,14 +521,16 @@ Accept wildcard characters: False ``` ### -WinFabClientConnectionPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for client connections to Windows Fabric. The default value is 5092. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -527,6 +540,9 @@ Accept wildcard characters: False ``` ### -WinFabFederationPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for Windows Fabric federation. Federation refers to the process by which Windows fabric routes messages. The default value is 5090. @@ -534,8 +550,7 @@ The default value is 5090. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -545,6 +560,9 @@ Accept wildcard characters: False ``` ### -WinFabIPCPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used by Windows Fabric for inter-process communication (IPC). IPC is a technology that allows for multiple threads in a process to exchange data. The default value is 5093. @@ -552,8 +570,7 @@ The default value is 5093. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -563,6 +580,9 @@ Accept wildcard characters: False ``` ### -WinFabLeaseAgentPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used by the Windows Fabric lease agent. Lease agents are used to interact with the kernel level lease driver. The default value is 5091. @@ -570,8 +590,7 @@ The default value is 5091. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -581,6 +600,9 @@ Accept wildcard characters: False ``` ### -WinFabReplicationPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used for Windows Fabric replication. Skype for Business Server uses Windows Fabric to replicate conference directories to all the Front End servers within a Registrar pool. The default value is 5094. @@ -589,8 +611,7 @@ The default value is 5094. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -600,6 +621,9 @@ Accept wildcard characters: False ``` ### -XmppGatewaySipPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used by the XMPP gateway associated with the Registrar. The extensible Messaging and Presence Protocol (XMPP) is an open-standard communications protocol for exchanging messages using XML. An allowed partner is an IM and presence provider whose users are allowed to exchange instant messages and presence information with your Skype for Business Server users. @@ -609,8 +633,43 @@ The default value is 5098. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -624,13 +683,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsRegistrar` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsRegistrar` cmdlet does not return any objects or values. Instead, the command modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayRegistrar object. diff --git a/skype/skype-ps/skype/Set-CsRegistrarConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsRegistrarConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Set-CsRegistrarConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsRegistrarConfiguration.md index 42491be2c9..256c058a9d 100644 --- a/skype/skype-ps/skype/Set-CsRegistrarConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRegistrarConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csregistrarconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsRegistrarConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csregistrarconfiguration +schema: 2.0.0 +title: Set-CsRegistrarConfiguration --- # Set-CsRegistrarConfiguration @@ -51,7 +52,7 @@ Registrar configuration settings are used to help manage endpoints and endpoint ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsRegistrarConfiguration -Identity site:Redmond -EnableDHCPServer $True ``` @@ -60,7 +61,7 @@ Example 1 modifies the Registrar configuration settings applied to the Redmond s In this example, the value of the EnableDHCPServer property is set to True. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsRegistrarConfiguration | Where-Object {$_.MaxEndpointsPerUser -gt 8} | Set-CsRegistrarConfiguration -MaxEndpointsPerUser 8 ``` @@ -71,7 +72,7 @@ This collection is then piped to the `Where-Object` cmdlet, which picks out only Finally, the filtered collection is piped to the `Set-CsRegistrarConfiguration` cmdlet, which sets the maximum number of endpoints for each item in that collection to 8. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsRegistrarConfiguration -Filter "site:*"| Set-CsRegistrarConfiguration -EnableDHCPServer $False ``` @@ -83,54 +84,29 @@ This collection is then piped to the `Set-CsRegistrarConfiguration` cmdlet, whic ## PARAMETERS -### -Identity -Unique identifier for the Registrar configuration settings to be modified. -To modify the global settings, use this syntax: - -`-Identity global` - -To modify settings configured at the site scope, use syntax similar to this: - -`-Identity site:Redmond` - -To modify settings at the service level, use syntax like this: +### -BackupStoreUnavailableThreshold -`-Identity service:Registrar:atl-cs-001.litwareinc.com` - -Note that Registrar settings can only be applied to the Registrar service. -An error message will occur if you try to apply these settings to any other service. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Specifies the amount of time the system will wait before determining that the backup store is unavailable; at that point, users will be placed in survivability mode. +The default value is 30 minutes (00:30:00). ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: TimeSpan +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -DefaultEndpointExpiration -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -DefaultEndpointExpiration When endpoints log on they have the option of requesting an expiration timeout; this specifies the time interval that an endpoint can remain logged onto the system before it must contact the server and request an extension. The DefaultEndpointExpiration property represents the expiration timeout interval for clients that do not request a specific timeout value. @@ -140,8 +116,7 @@ The default value is 600 (10 minutes). ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -151,14 +126,16 @@ Accept wildcard characters: False ``` ### -EnableDHCPServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether endpoints can use DHCP servers to locate a Registrar. If True, clients will send a DHCP Inform message when they first start; the DHCP server will respond by sending the fully qualified domain name (FQDN) of a Registrar that can be used to log on the user. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,19 +144,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxEndpointExpiration -When endpoints log on they have the option of requesting an expiration timeout; this specifies the time interval that an endpoint can remain logged onto the system before it must contact the server and request an extension. -The MaxEndpointExpiration property represents the maximum amount of time that clients can be granted. -For example, if the maximum time is set to 600 seconds and a client requests a timeout interval of 800 seconds, the client will be given the maximum allowed expiration period: 600 seconds. +### -EnableWinFabLogUpload -The MaxEndpointExpiration must be between 300 (5 minutes) and 900 (15 minutes). -The default value is 900. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: $true | $false ```yaml -Type: Int32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -188,25 +162,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxEndpointsPerUser -Indicates the maximum number of endpoints a user can simultaneously have connected to the system. -For example, a user who is logged on to Skype for Business Server with both a computer and a mobile phone would be using two endpoints. -MaxEndPointsPerUser must be set to a value between 1 and 64, inclusive. -The default value is 8. - -Although it is possible to allow a user as many as 64 endpoints, it is recommended that the maximum number of endpoints not exceed 8. -Values of 9 or more are used for backwards compatibility and, in rare cases, when suggested by Microsoft support personnel. -For new deployments, the maximum number of endpoints should be no more than 8. +### -Force -Note, too, that the maximum number of endpoints is intended to give individual users multiple points of presence. -As such, this setting is designed for individual users and not for groups of users (such as an entire department.) +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: UInt16 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -215,51 +180,72 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MinEndpointExpiration -When endpoints log on they have the option of requesting an expiration timeout; this specifies the time interval that an endpoint can remain logged onto the system before it must contact the server and request an extension. -The MinEndpointExpiration property represents the minimum amount of time that clients can be granted. -For example, if the minimum time is set to 600 seconds and a client requests a timeout interval of 200 seconds, the client will be given the minimum allowed expiration period: 600 seconds. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the Registrar configuration settings to be modified. +To modify the global settings, use this syntax: + +`-Identity global` + +To modify settings configured at the site scope, use syntax similar to this: + +`-Identity site:Redmond` + +To modify settings at the service level, use syntax like this: + +`-Identity service:Registrar:atl-cs-001.litwareinc.com` + +Note that Registrar settings can only be applied to the Registrar service. +An error message will occur if you try to apply these settings to any other service. -The MinEndpointExpiration must be between 300 (5 minutes) and 900 (15 minutes). -The default value is 300. ```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MaxEndpointExpiration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When endpoints log on they have the option of requesting an expiration timeout; this specifies the time interval that an endpoint can remain logged onto the system before it must contact the server and request an extension. +The MaxEndpointExpiration property represents the maximum amount of time that clients can be granted. +For example, if the maximum time is set to 600 seconds and a client requests a timeout interval of 800 seconds, the client will be given the maximum allowed expiration period: 600 seconds. + +The MaxEndpointExpiration must be between 300 (5 minutes) and 900 (15 minutes). +The default value is 900. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -268,14 +254,27 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -MaxEndpointsPerUser + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum number of endpoints a user can simultaneously have connected to the system. +For example, a user who is logged on to Skype for Business Server with both a computer and a mobile phone would be using two endpoints. +MaxEndPointsPerUser must be set to a value between 1 and 64, inclusive. +The default value is 8. + +Although it is possible to allow a user as many as 64 endpoints, it is recommended that the maximum number of endpoints not exceed 8. +Values of 9 or more are used for backwards compatibility and, in rare cases, when suggested by Microsoft support personnel. +For new deployments, the maximum number of endpoints should be no more than 8. + +Note, too, that the maximum number of endpoints is intended to give individual users multiple points of presence. +As such, this setting is designed for individual users and not for groups of users (such as an entire department.) + ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -284,15 +283,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -BackupStoreUnavailableThreshold -Specifies the amount of time the system will wait before determining that the backup store is unavailable; at that point, users will be placed in survivability mode. -The default value is 30 minutes (00:30:00). +### -MaxUserCount + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the maximum number of users that can simultaneously be logged on to a Registrar. +MaxUserCount can be set to any integer value between 2000 and 100000, inclusive. +The default value is 12000. + ```yaml -Type: TimeSpan +Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -301,17 +304,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxUserCount -Indicates the maximum number of users that can simultaneously be logged on to a Registrar. -MaxUserCount can be set to any integer value between 2000 and 100000, inclusive. -The default value is 12000. +### -MinEndpointExpiration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +When endpoints log on they have the option of requesting an expiration timeout; this specifies the time interval that an endpoint can remain logged onto the system before it must contact the server and request an extension. +The MinEndpointExpiration property represents the minimum amount of time that clients can be granted. +For example, if the minimum time is set to 600 seconds and a client requests a timeout interval of 200 seconds, the client will be given the minimum allowed expiration period: 600 seconds. + +The MinEndpointExpiration must be between 300 (5 minutes) and 900 (15 minutes). +The default value is 300. ```yaml -Type: UInt64 +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -321,6 +328,9 @@ Accept wildcard characters: False ``` ### -PoolState + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Current state for the Registrar pool. Allowed values are: @@ -334,8 +344,7 @@ The default value is Active. ```yaml Type: PoolState Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -344,14 +353,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableWinFabLogUpload -PARAMVALUE: $true | $false +### -UserCertificateReplicationThreshold + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: UInt64 ```yaml -Type: Boolean +Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -360,14 +371,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserCertificateReplicationThreshold -PARAMVALUE: UInt64 +### -WinFabMaxLogsSizeMb + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: Int32 ```yaml -Type: UInt64 +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -376,14 +389,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WinFabMaxLogsSizeMb -PARAMVALUE: Int32 +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -397,13 +430,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.Registrar.RegistrarSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.Registrar.RegistrarSettings + The `Set-CsRegistrarConfiguration` cmdlet accepts pipelined instances of the Registrar settings object. ## OUTPUTS -### +### None The `Set-CsRegistrarConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Registrar.RegistrarSettings object. diff --git a/skype/skype-ps/skype/Set-CsReportingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsReportingConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Set-CsReportingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsReportingConfiguration.md index 9e96050de2..fb7e8bfe1c 100644 --- a/skype/skype-ps/skype/Set-CsReportingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsReportingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csreportingconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsReportingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csreportingconfiguration +schema: 2.0.0 +title: Set-CsReportingConfiguration --- # Set-CsReportingConfiguration @@ -53,7 +54,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsReportingConfiguration -Identity "service:MonitoringDatabase:atl-sql-002.litwareinc.com" -ReportingURL "https://atl-sql-002.litwareinc.com/lync_reports" ``` @@ -64,30 +65,16 @@ In this example, the reporting URL is changed to `https://atl-sql-002.litwareinc ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Force Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -97,6 +84,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service Identity of the monitoring database whose reporting configuration settings are being modified. For example: @@ -105,8 +95,7 @@ For example: ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -116,13 +105,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,14 +123,34 @@ Accept wildcard characters: False ``` ### -ReportingUrl + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URL for the Skype for Business Server Monitoring Reports. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -149,13 +160,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -169,13 +182,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.Reporting.ReportingConfiguration The `Set-CsReportingConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Reporting.ReportingConfiguration object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsReportingConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.Reporting.ReportingConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsRgsAgentGroup.md b/skype/skype-ps/SkypeForBusiness/Set-CsRgsAgentGroup.md similarity index 91% rename from skype/skype-ps/skype/Set-CsRgsAgentGroup.md rename to skype/skype-ps/SkypeForBusiness/Set-CsRgsAgentGroup.md index 287057404c..2b03965e7a 100644 --- a/skype/skype-ps/skype/Set-CsRgsAgentGroup.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRgsAgentGroup.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csrgsagentgroup applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsRgsAgentGroup -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csrgsagentgroup +schema: 2.0.0 +title: Set-CsRgsAgentGroup --- # Set-CsRgsAgentGroup @@ -43,7 +44,7 @@ If you do not call `Set-CsRgsAgentGroup`, your changes will exist in memory only ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` $x = Get-CsRgsAgentGroup -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" @@ -60,7 +61,7 @@ Command 2 in the example modifies the value of the RoutingMethod property. In the final command in the example, the `Set-CsRgsAgentGroup` cmdlet is used to write these changes to the actual Help Desk agent group. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $x = Get-CsRgsAgentGroup -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" @@ -77,7 +78,7 @@ The second command in the example assigns a new value (helpdesk@litwareinc.com) After the new value has been assigned, `Set-CsRgsAgentGroup` is then used to write the changes to the Help Desk agent group on ApplicationServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` $x = Get-CsRgsAgentGroup -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" @@ -95,7 +96,7 @@ In command 3, the `Set-CsRgsAgentGroup` is used to write the changes (that is, t Note that if you do not call `Set-CsRgsAgentGroup`, the changes will be made in memory only, and will not be applied to the actual agent group. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` $x = Get-CsRgsAgentGroup -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" @@ -115,7 +116,28 @@ If you do not call `Set-CsRgsAgentGroup`, the changes will be made in memory onl ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Object reference to the Response Group agent group to be modified. An object reference is typically retrieved by using the `Get-CsRgsAgentGroup` cmdlet and assigning the returned value to a variable; for example, this command returns an object reference to the Help Desk agent group and stores that object reference in a variable named $x: @@ -125,8 +147,7 @@ An object reference is typically retrieved by using the `Get-CsRgsAgentGroup` cm ```yaml Type: AgentGroup Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -135,14 +156,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -152,29 +175,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -188,13 +197,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Rgs.Management.WritableSettings.AgentGroup object. +### Microsoft.Rtc.Rgs.Management.WritableSettings.AgentGroup + `Set-CsRgsAgentGroup` accepts pipelined instances of the Response Group agent group object. ## OUTPUTS -### +### None `Set-CsRgsAgentGroup` does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.AgentGroup object. diff --git a/skype/skype-ps/skype/Set-CsRgsConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsRgsConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Set-CsRgsConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsRgsConfiguration.md index 6114842831..477cc35c02 100644 --- a/skype/skype-ps/skype/Set-CsRgsConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRgsConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csrgsconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsRgsConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csrgsconfiguration +schema: 2.0.0 +title: Set-CsRgsConfiguration --- # Set-CsRgsConfiguration @@ -42,7 +43,7 @@ The `Set-CsRgsConfiguration` cmdlet provides a way for you to modify the propert ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsRgsConfiguration -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -AgentRingbackGracePeriod 30 ``` @@ -51,7 +52,7 @@ The command shown in Example 1 modifies the AgentRingbackGracePeriod property fo In this example, AgentRingbackGracePeriod is set to 30 seconds. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsService -ApplicationServer | Where-Object {$_.Applications -contains "urn:application:RGS"} | ForEach-Object {Set-CsRgsConfiguration -Identity $_.Identity -AgentRingbackGracePeriod 30} ``` @@ -64,7 +65,7 @@ In turn, those computers are piped to the `ForEach-Object` cmdlet. `ForEach-Object` then takes each computer in the collection and uses the `Set-CsRgsConfiguration` to set the value of the AgentRingbackGracePeriod of the computer's Response Group configuration settings r to 30 seconds. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` $x = Import-CsRgsAudioFile -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -FileName "WhileYouWait.wav" -Content ([System.IO.File]::ReadAllBytes('C:\Media\WhileYouWait.wav')) @@ -83,43 +84,10 @@ After the file has been imported, `Set-CsRgsConfiguration` is called in order to ## PARAMETERS -### -Identity -Name of the service hosting the Response Group configuration settings. -For example: `-Identity "service:ApplicationServer:atl-cs-001.litwareinc.com."` - -```yaml -Type: RgsIdentity -Parameter Sets: Direct -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Instance -Object reference to the Response Group configuration settings to be modified. -An object reference is typically retrieved by using the `Get-CsRgsConfiguration` cmdlet and assigning the returned value to a variable; for example, this command returns an object reference to the configuration settings found on the service ApplicationServer:atl-cs-001.litwareinc.com and stores that object reference in a variable named $x: +### -AgentRingbackGracePeriod -`$x = Get-CsRgsConfiguration -Identity service:ApplicationServer:atl-cs-001.litwareinc.com` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: ServiceSettings -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AgentRingbackGracePeriod If an agent declines a call, the AgentRingbackGracePeriod represents the amount of time (in seconds) that can elapse before the call returns to the same agent. The grace period can be set to any integer value between 30 and 600 seconds (10 minutes), inclusive. The default value is 60 seconds. @@ -127,8 +95,7 @@ The default value is 60 seconds. ```yaml Type: Int16 Parameter Sets: Direct -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,6 +105,9 @@ Accept wildcard characters: False ``` ### -DefaultMusicOnHoldFile + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Represents the music that, by default, will be played any time a caller is placed on hold. The default music will play only if a Response Group workflow has not defined its own music on hold. @@ -149,8 +119,7 @@ If DefaultMusicOnHold is equal to a null value (the default value) and if a work ```yaml Type: AudioFile Parameter Sets: Direct -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -160,6 +129,9 @@ Accept wildcard characters: False ``` ### -DisableCallContext + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If set to False (the default value), each agent is able to see the call context (information such as caller wait time or workflow questions and answers) whenever a call received. (This information is visible from within Skype for Business) If set to True, call context information is not relayed to agents when a call is received. @@ -169,8 +141,7 @@ Note that the call context is only used with IVR queues. ```yaml Type: Boolean Parameter Sets: Direct -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -180,13 +151,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -195,14 +168,56 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the service hosting the Response Group configuration settings. +For example: `-Identity "service:ApplicationServer:atl-cs-001.litwareinc.com."` + +```yaml +Type: RgsIdentity +Parameter Sets: Direct +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Object reference to the Response Group configuration settings to be modified. +An object reference is typically retrieved by using the `Get-CsRgsConfiguration` cmdlet and assigning the returned value to a variable; for example, this command returns an object reference to the configuration settings found on the service ApplicationServer:atl-cs-001.litwareinc.com and stores that object reference in a variable named $x: + +`$x = Get-CsRgsConfiguration -Identity service:ApplicationServer:atl-cs-001.litwareinc.com` + +```yaml +Type: ServiceSettings +Parameter Sets: Instance +Aliases: + +Required: True +Position: 2 +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -211,14 +226,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -232,13 +249,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Rgs.Management.WritableSettings.ServiceSettings object. +### Microsoft.Rtc.Rgs.Management.WritableSettings.ServiceSettings + `Set-CsRgsConfiguration` accepts pipelined instances of the Response Group application settings object. ## OUTPUTS -### +### None `Set-CsRgsConfiguration` does not return any objects or values. Instead, the cmdlet configures existing instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.ServiceSettings object. diff --git a/skype/skype-ps/skype/Set-CsRgsHolidaySet.md b/skype/skype-ps/SkypeForBusiness/Set-CsRgsHolidaySet.md similarity index 92% rename from skype/skype-ps/skype/Set-CsRgsHolidaySet.md rename to skype/skype-ps/SkypeForBusiness/Set-CsRgsHolidaySet.md index 479d34c95d..9078ca5e07 100644 --- a/skype/skype-ps/skype/Set-CsRgsHolidaySet.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRgsHolidaySet.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csrgsholidayset applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsRgsHolidaySet -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csrgsholidayset +schema: 2.0.0 +title: Set-CsRgsHolidaySet --- # Set-CsRgsHolidaySet @@ -53,7 +54,7 @@ If you do not call `Set-CsRgsHolidaySet`, then the changes you make will exist i ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` $x = New-CsRgsHoliday -StartDate "12/25/2010" -EndDate "12/26/2010" -Name "Christmas Day" @@ -75,7 +76,7 @@ Command 3 uses the Add method to add the new holiday ($x) to the virtual copy of The final command then uses `Set-CsRgsHolidaySet` to write these changes (and add the new holiday) to the service ApplicationServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $x = Get-CsRgsHolidaySet -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "2010 Holidays" @@ -97,7 +98,7 @@ After the Christmas Day holiday has been retrieved, command 3 uses the Remove me The final command in the example then uses `Set-CsRgsHolidaySet` to write these changes (removing the Christmas Day holiday) to the actual 2010 Holidays holiday set on ApplicationServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` $x = Get-CsRgsHolidaySet -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "2010 Holidays" @@ -116,7 +117,28 @@ After this property has been cleared, the final command in the example uses the ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Object reference to the Response Group holiday set to be modified. An object reference is typically retrieved by using the `Get-CsRgsHolidaySet` cmdlet and assigning the returned value to a variable; for example, this command returns an object reference to the Help Desk holiday set and stores that object reference in a variable named $x: @@ -125,8 +147,7 @@ An object reference is typically retrieved by using the `Get-CsRgsHolidaySet` cm ```yaml Type: HolidaySet Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -135,14 +156,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -152,29 +175,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -188,13 +197,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Rgs.Management.WritableSettings.HolidaySet object. +### Microsoft.Rtc.Rgs.Management.WritableSettings.HolidaySet + `Remove-CsRgsHolidaySet` accepts pipelined instances of the Response Group holiday set object. ## OUTPUTS -### +### None `Set-CsRgsHolidaySet` does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.HolidaySet object. diff --git a/skype/skype-ps/skype/Set-CsRgsHoursOfBusiness.md b/skype/skype-ps/SkypeForBusiness/Set-CsRgsHoursOfBusiness.md similarity index 92% rename from skype/skype-ps/skype/Set-CsRgsHoursOfBusiness.md rename to skype/skype-ps/SkypeForBusiness/Set-CsRgsHoursOfBusiness.md index 2357b448fd..00df87bfa3 100644 --- a/skype/skype-ps/skype/Set-CsRgsHoursOfBusiness.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRgsHoursOfBusiness.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csrgshoursofbusiness applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsRgsHoursOfBusiness -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csrgshoursofbusiness +schema: 2.0.0 +title: Set-CsRgsHoursOfBusiness --- # Set-CsRgsHoursOfBusiness @@ -27,7 +28,7 @@ Set-CsRgsHoursOfBusiness [-Instance] [-Force] [-WhatIf] [-Confir ## DESCRIPTION In order to provide callers with the best possible experience, the Response Group application makes it possible for you to clearly define when Response Group agents are available to answer calls and when they are not available to answer calls. With the Response Group application, you can define business hours; these hours indicate the days of the week and hours of the day that agents are available to answer calls. -For example, if your organization is typically open from 9:00 A.M. +For example, if your organization is typically open from 9:00 A.M. to 5:00 P.M. Monday through Friday, then you would configure business hours that show that agents are available from 9:00 A.M. to 5:00 P.M. @@ -64,7 +65,7 @@ When your modifications are complete, you then use `Set-CsRgsHoursOfBusiness` to ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` $weekend = New-CsRgsTimeRange -Name "Weekend Hours" -OpenTime "12:00" -CloseTime "17:00" @@ -88,7 +89,7 @@ When that command is finished, commands 3 and 4 are used to set the SaturdayHour Finally, the last command in the example then uses `Set-CsRgsHoursOfBusiness` to write these changes back to the actual business hours set. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $x = Get-CsRgsHoursOfBusiness -Identity "service:ApplicationServer:atl-cs-001.litwareinc.com" -Name "Help Desk Business Hours" @@ -110,7 +111,28 @@ When the command finishes running, there will no longer be any Saturday business ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Object reference to the business hours set to be modified. An object reference is typically retrieved by using the `Get-CsRgsHoursOfBusiness` cmdlet and assigning the returned value to a variable; for example, this command returns an object reference to the Help Desk business hours set and stores that object reference in a variable named $x: @@ -119,8 +141,7 @@ An object reference is typically retrieved by using the `Get-CsRgsHoursOfBusines ```yaml Type: BusinessHours Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -129,14 +150,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -146,29 +169,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -182,13 +191,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Rgs.Management.WritableSettings.BusinessHours object. +### Microsoft.Rtc.Rgs.Management.WritableSettings.BusinessHours + `Set-CsRgsHoursOfBusiness` accepts pipelined instances of the Response Group business hours object. ## OUTPUTS -### +### None Modifies existing instances of the Microsoft.Rtc.Rgs.Management.WriteableSettings.BusinessHours object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsRgsQueue.md b/skype/skype-ps/SkypeForBusiness/Set-CsRgsQueue.md similarity index 92% rename from skype/skype-ps/skype/Set-CsRgsQueue.md rename to skype/skype-ps/SkypeForBusiness/Set-CsRgsQueue.md index 4fbf3f12e4..02c5089eb0 100644 --- a/skype/skype-ps/skype/Set-CsRgsQueue.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRgsQueue.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csrgsqueue applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsRgsQueue -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csrgsqueue +schema: 2.0.0 +title: Set-CsRgsQueue --- # Set-CsRgsQueue @@ -40,7 +41,7 @@ If you do not call `Set-CsRgsQueue`, your changes will be made in memory only, a ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` $x = Get-CsRgsQueue -Identity Service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" @@ -59,7 +60,7 @@ Note that, up to this point, the changes have taken place only in memory. Until you call `Set-CsRgsQueue` the actual Response Group queue on ApplicationServer:atl-cs-001.litwareinc.com will remain unchanged. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $x = Get-CsRgsQueue -Identity service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk Overflow Queue" @@ -93,7 +94,28 @@ After the call action has been assigned, the final command in the example calls ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Object reference to the Response Group queue to be modified. An object reference is typically retrieved by using the `Get-CsRgsQueue` cmdlet and assigning the returned value to a variable; for example, this command returns an object reference to the Help Desk queue and stores that object reference in a variable named $x: @@ -102,8 +124,7 @@ An object reference is typically retrieved by using the `Get-CsRgsQueue` cmdlet ```yaml Type: Queue Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -112,14 +133,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -129,29 +152,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -165,13 +174,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Rgs.Management.WritableSettings.Queue object. +### Microsoft.Rtc.Rgs.Management.WritableSettings.Queue + `Set-CsRgsQueue` accepts pipelined instances of the Response Group queue object. ## OUTPUTS -### +### None `Set-CsRgsQueue` does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Queue object. diff --git a/skype/skype-ps/skype/Set-CsRgsWorkflow.md b/skype/skype-ps/SkypeForBusiness/Set-CsRgsWorkflow.md similarity index 92% rename from skype/skype-ps/skype/Set-CsRgsWorkflow.md rename to skype/skype-ps/SkypeForBusiness/Set-CsRgsWorkflow.md index 2a4c7f6b0e..8aed668970 100644 --- a/skype/skype-ps/skype/Set-CsRgsWorkflow.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRgsWorkflow.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csrgsworkflow applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsRgsWorkflow -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Rgs.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csrgsworkflow +schema: 2.0.0 +title: Set-CsRgsWorkflow --- # Set-CsRgsWorkflow @@ -41,7 +42,7 @@ If you do not call `Set-CsRgsWorkflow` then your changes will exist only in memo ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` $businessHours = Get-CsRgsHoursOfBusiness service:ApplicationServer:atl-cs-001.litwareinc.com -Name "US Business Hours" @@ -66,7 +67,7 @@ This last step is important because, until this point, all the changes have take To actually save these changes to the Help Desk workflow, you must call `Set-CsRgsWorkflow`, passing the cmdlet the object reference ($y) containing the virtual copy of the workflow. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $x = Get-CsRgsWorkflow service:ApplicationServer:atl-cs-001.litwareinc.com -Name "Help Desk" @@ -81,7 +82,7 @@ In command 2, a new description ("Workflow for the Redmond Help Desk") is added After the description has been changed, command 3 uses the `Set-CsRgsWorkflow` to write these changes back to the actual Help Desk workflow located on ApplicationServer:atl-cs-001.litwareinc.com. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` $musicFile = [System.IO.File]::ReadAllBytes('C:\MediaFiles\Hold.wav') | Import-CsRgsAudioFile -Identity Service:ApplicationServer:atl-cs-001.litwareinc.com -FileName "HelpDeskHoldMusic.wav" @@ -108,7 +109,28 @@ After $musicFile has been assigned to CustomMusicOnHoldFile, the final command u ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Object reference to the Response Group application workflow to be modified. An object reference is typically retrieved by using the `Get-CsRgsWorkflow` cmdlet and assigning the returned value to a variable; for example, this command returns an object reference to the Help Desk workflow and stores that object reference in a variable named $x: @@ -124,8 +146,7 @@ That means that the following two commands are functionally identical: ```yaml Type: Workflow Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -134,14 +155,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -151,29 +174,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -187,13 +196,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Rgs.Management.WritableSettings.Workflow object. +### Microsoft.Rtc.Rgs.Management.WritableSettings.Workflow + `Set-CsRgsWorkflow` accepts pipelined instances of the Response Group workflow object. ## OUTPUTS -### +### None `Set-CsRgsWorkflow` does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Rgs.Management.WritableSettings.Workflow object. diff --git a/skype/skype-ps/skype/Set-CsRoutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsRoutingConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Set-CsRoutingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsRoutingConfiguration.md index 5a2141d994..1798ba5b6a 100644 --- a/skype/skype-ps/skype/Set-CsRoutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsRoutingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsRoutingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csroutingconfiguration +schema: 2.0.0 +title: Set-CsRoutingConfiguration --- # Set-CsRoutingConfiguration @@ -41,7 +42,7 @@ To modify routing configurations, modify the individual voice routes by calling ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $a = Get-CsRoutingConfiguration @@ -75,53 +76,56 @@ That one line will accomplish the same task shown in Example 1. ## PARAMETERS -### -Identity -The scope of the routing configuration. -This must be Global. +### -CallViaWorkCallerId + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +The number the system will display for the callback portion of an external call. +External calls first connect the user making the call by calling a specified number (typically the user's desk phone), once connected to the user, the system dials the outside number. +The CallViaWorkCallerId parameter specifies the number that will be displayed during the first leg, or callback segment, of the call via work external call. +For more information, see `New-CsCallViaWorkPolicy`. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -A routing configuration (Microsoft.Rtc.Management.WritablConfig.Policy.Voice.PstnRoutingSettings) object. -An object of this type can be retrieved by calling the `Get-CsRoutingConfiguration` cmdlet. +### -EnableLocationBasedRouting +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, voice routing will be managed by taking into account the location of both the user placing the call and the user receiving the call. +The default value is False. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Route -A list of all voice routes (Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route objects) defined for the Skype for Business Server deployment. +### -Force -You should modify individual voice route objects by using the `Set-CsVoiceRoute` cmdlet. -That is the recommended way of modifying routes in this list. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: PSListModifier +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -130,46 +134,59 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The scope of the routing configuration. +This must be Global. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A routing configuration (Microsoft.Rtc.Management.WritablConfig.Policy.Voice.PstnRoutingSettings) object. +An object of this type can be retrieved by calling the `Get-CsRoutingConfiguration` cmdlet. + ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Route + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A list of all voice routes (Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route objects) defined for the Skype for Business Server deployment. + +You should modify individual voice route objects by using the `Set-CsVoiceRoute` cmdlet. +That is the recommended way of modifying routes in this list. + ```yaml -Type: SwitchParameter +Type: PSListModifier Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -178,17 +195,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallViaWorkCallerId -The number the system will display for the callback portion of an external call. -External calls first connect the user making the call by calling a specified number (typically the user's desk phone), once connected to the user, the system dials the outside number. -The CallViaWorkCallerId parameter specifies the number that will be displayed during the first leg, or callback segment, of the call via work external call. -For more information, see `New-CsCallViaWorkPolicy`. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -197,15 +213,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableLocationBasedRouting -When set to True, voice routing will be managed by taking into account the location of both the user placing the call and the user receiving the call. -The default value is False. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -219,13 +236,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.WritableConfig.Management.Policy.Voice.PSTNRoutingSettings object. +### Microsoft.Rtc.WritableConfig.Management.Policy.Voice.PSTNRoutingSettings + Accepts pipelined input of a routing configuration object. ## OUTPUTS -### +### None The `Set-CsRoutingConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.PstnRoutingSettings object. diff --git a/skype/skype-ps/skype/Set-CsServerApplication.md b/skype/skype-ps/SkypeForBusiness/Set-CsServerApplication.md similarity index 83% rename from skype/skype-ps/skype/Set-CsServerApplication.md rename to skype/skype-ps/SkypeForBusiness/Set-CsServerApplication.md index 96b56c6e53..681731d8f0 100644 --- a/skype/skype-ps/skype/Set-CsServerApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsServerApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csserverapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsServerApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csserverapplication +schema: 2.0.0 +title: Set-CsServerApplication --- # Set-CsServerApplication @@ -40,7 +41,7 @@ The `Set-CsServerApplication` cmdlet provides a way for administrators to modify ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsServerApplication -Identity "Registrar:atl-cs-001.litwareinc.com/ExumRouting" -Enabled $True ``` @@ -49,7 +50,7 @@ The command shown in Example 1 enables the server application that has the Ident Because Identities must be unique, this command will only enable a single server application. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsServerApplication | Where-Object {$_.Enabled -eq $False} | Set-CsServerApplication -Enabled $True ``` @@ -62,50 +63,55 @@ In turn, the filtered collection is piped to the `Set-CsServerApplication` cmdle ## PARAMETERS -### -Identity -Unique identifier for the server application to be modified. -Server application Identities are composed of the service where the application is hosted plus the application name. -For example, the server application named QoEAgent might have an Identity similar to this: Registrar:atl-cs-001.litwareinc.com/QoEAgent. +### -Critical + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True (the default value), then Skype for Business Server will not start unless the application in question can be started. +If False, then Skype for Business Server will start regardless of whether or not the application can be started. + ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Set this value to True to enable the application. +Set the value to False to disable the application. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Critical -If set to True (the default value), then Skype for Business Server will not start unless the application in question can be started. -If False, then Skype for Business Server will start regardless of whether or not the application can be started. +### -Force +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -114,24 +120,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Enabled -Set this value to True to enable the application. -Set the value to False to disable the application. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the server application to be modified. +Server application Identities are composed of the service where the application is hosted plus the application name. +For example, the server application named QoEAgent might have an Identity similar to this: Registrar:atl-cs-001.litwareinc.com/QoEAgent. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the order of execution for server applications. The application with priority 0 is started first; the application with priority 1 is started second and so on. Note that each service that hosts a server application has its own unique set of priorities. @@ -145,8 +175,7 @@ For example, if you delete an application that has a priority of 0, then the app ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -155,15 +184,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ScriptName -Path to the Microsoft SIP Processing Language (MSPL) script used by the application. -MSPL is a scripting language used for filtering and routing SIP messages. +### -Script + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to associate the server application with a script. +To add a script to a server application, use syntax similar to this: + +`-Script "Update.ps1"` + +To remove a script, simply set the Script property to a null value: + +`-Script $Null` + +Each server application can only be associated with one script. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -172,15 +211,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Uri -Unique Uniform Resource Identifier (URI) for the application. -For example, the QoEAgent application has the URI `http://www.microsoft.com/LCS/QoEAgent`. +### -ScriptName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Path to the Microsoft SIP Processing Language (MSPL) script used by the application. +MSPL is a scripting language used for filtering and routing SIP messages. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -189,14 +230,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Uri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique Uniform Resource Identifier (URI) for the application. +For example, the QoEAgent application has the URI `http://www.microsoft.com/LCS/QoEAgent`. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -206,13 +250,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -222,38 +268,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Script -Enables you to associate the server application with a script. -To add a script to a server application, use syntax similar to this: - -`-Script "Update.ps1"` - -To remove a script, simply set the Script property to a null value: - -`-Script $Null` - -Each server application can only be associated with one script. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -267,13 +290,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.ServerApplication.Application object. +### Microsoft.Rtc.Management.WritableConfig.Settings.ServerApplication.Application + The `Set-CsServerApplication` cmdlet accepts pipelined instances of the server application object. ## OUTPUTS -### +### None The `Set-CsServerApplication` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.ServerApplication.application object. diff --git a/skype/skype-ps/skype/Set-CsSimpleUrlConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsSimpleUrlConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Set-CsSimpleUrlConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsSimpleUrlConfiguration.md index c34fbf16bf..4a4c27c552 100644 --- a/skype/skype-ps/skype/Set-CsSimpleUrlConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsSimpleUrlConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cssimpleurlconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsSimpleUrlConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cssimpleurlconfiguration +schema: 2.0.0 +title: Set-CsSimpleUrlConfiguration --- # Set-CsSimpleUrlConfiguration @@ -74,7 +75,7 @@ After updating a simple URL collection, you must then run the `Enable-CsComputer ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsSimpleUrlConfiguration -Identity "site:Redmond" -SimpleUrl $Null ``` @@ -84,7 +85,7 @@ The command shown in Example 1 removes all the simple URLs from the Redmond site This removes all the simple URLs from the collection. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $urlEntry = New-CsSimpleUrlEntry -Url "https://meet.fabrikam.com" @@ -104,7 +105,7 @@ This is done by using the `Set-CsSimpleUrlConfiguration` cmdlet, the SimpleUrl p This syntax causes the URL stored in the object reference $simpleUrl to be added to the SimpleUrl property. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` $urlEntry = New-CsSimpleUrlEntry -Url "https://fabrikam.vdomain.com" @@ -128,7 +129,28 @@ This syntax simply causes the URL stored in the object reference $simpleUrl to b ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the collection of simple URLs to be modified. To modify the global collection, use this syntax: @@ -144,8 +166,7 @@ If this parameter is not specified then the global collection will be modified. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -155,13 +176,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -171,6 +194,9 @@ Accept wildcard characters: False ``` ### -SimpleUrl + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Simple URLs configured for this collection. These URLs must be created by using the `New-SimpleUrl` cmdlet and the `New-SimpleUrlEntry` cmdlet. @@ -178,8 +204,7 @@ These URLs must be created by using the `New-SimpleUrl` cmdlet and the `New-Simp ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -188,23 +213,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Tenant -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Tenant Globally unique identifier (GUID) of the Skype for Business Online tenant account whose Simple URL configuration settings are to be modified. For example: @@ -218,8 +230,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -228,14 +239,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -244,14 +257,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -265,14 +280,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.SimpleUrl.SimpleUrlConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.SimpleUrl.SimpleUrlConfiguration + The `Set-CsSimpleUrlConfiguration` cmdlet accepts pipelined instances of the simple URL configuration object. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Set-CsSipDomain.md b/skype/skype-ps/SkypeForBusiness/Set-CsSipDomain.md similarity index 87% rename from skype/skype-ps/skype/Set-CsSipDomain.md rename to skype/skype-ps/SkypeForBusiness/Set-CsSipDomain.md index dc43ae35bf..a80d735b4e 100644 --- a/skype/skype-ps/skype/Set-CsSipDomain.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsSipDomain.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cssipdomain applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsSipDomain -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cssipdomain +schema: 2.0.0 +title: Set-CsSipDomain --- # Set-CsSipDomain @@ -38,7 +39,7 @@ The `Set-CsSipDomain` cmdlet provides a way for you to change your default SIP d ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsSipDomain -Identity fabrikam.com -IsDefault $True ``` @@ -49,7 +50,28 @@ When this command is run, Fabrikam.com will become the default domain and the do ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the SIP domain to be configured as the default domain. For example: @@ -59,8 +81,7 @@ For example: ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -70,6 +91,9 @@ Accept wildcard characters: False ``` ### -IsDefault + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the domain is the default SIP domain, the domain used by Skype for Business Server any time a domain name is not explicitly stated. If set to True, the new domain will become the new default domain. You cannot set this value to False because that would leave you without a default SIP domain. @@ -80,8 +104,7 @@ If you change the default SIP domain you will need to restart the RTCCAA and RTC ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -90,14 +113,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -107,29 +132,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -143,13 +154,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsSipDomain` cmdlet does not accept pipelined data. ## OUTPUTS -### +### None The `Set-CsSipDomain` cmdlet does not return any objects or values. Instead, the cmdlet is used to modify existing instances of the Microsoft.Rtc.Management.Xds.SipDomain object. diff --git a/skype/skype-ps/skype/Set-CsSipResponseCodeTranslationRule.md b/skype/skype-ps/SkypeForBusiness/Set-CsSipResponseCodeTranslationRule.md similarity index 87% rename from skype/skype-ps/skype/Set-CsSipResponseCodeTranslationRule.md rename to skype/skype-ps/SkypeForBusiness/Set-CsSipResponseCodeTranslationRule.md index 8709e8d4e9..a25b80dfaa 100644 --- a/skype/skype-ps/skype/Set-CsSipResponseCodeTranslationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsSipResponseCodeTranslationRule.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cssipresponsecodetranslationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsSipResponseCodeTranslationRule -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cssipresponsecodetranslationrule +schema: 2.0.0 +title: Set-CsSipResponseCodeTranslationRule --- # Set-CsSipResponseCodeTranslationRule @@ -57,7 +58,7 @@ The `Set-CsSipResponseCodeTranslationRule` cmdlet provides a way for you to modi ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsSipResponseCodeTranslationRule -Identity "PstnGateway:192.168.0.240/Rule404" -ReceivedISUPCauseValue 477 ``` @@ -65,7 +66,7 @@ Set-CsSipResponseCodeTranslationRule -Identity "PstnGateway:192.168.0.240/Rule40 The command shown in Example 1 modifies the ReceivedISUPCauseValue property for the translation rule with the Identity PstnGateway:192.168.0.240/Rule404. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsSipResponseCodeTranslationRule -Identity "PstnGateway:192.168.0.240/Rule404" -Priority 0 ``` @@ -74,7 +75,7 @@ In Example 2, the translation rule with the Identity PstnGateway:192.168.0.240/R This is done by setting the Priority to 0. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsSipResponseCodeTranslationRule | Set-CsSipResponseCodeTranslationRule -ReceivedISUPCauseValue -1 ``` @@ -86,7 +87,28 @@ That collection is then piped to the `Set-CsSipResponseCodeTranslationRule` cmdl ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the translation rule to be modified. The Identity for a translation rule consists of two parts: the scope where the rule was configured, and the name given to the rule when it was created. For example, a translation rule named Rule404 that was created at the global scope would have an Identity that looked like this: global/Rule404. @@ -94,8 +116,7 @@ For example, a translation rule named Rule404 that was created at the global sco ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -104,32 +125,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TranslatedResponseCode -Value of SIP response code that the ReceivedResponseCode and/or the ReceivedISUPCauseCode should be translated to. -Translated response codes can be any integer value between 400 and 699, inclusive. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + ```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Relative priority of the translation rule. Rules are processed in order of their assigned priority; the first rule to be processed has a priority of 0; the second rule to be processed has a priority of 1 and so on. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,18 +163,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceivedResponseCode -Value of the SIP response code used by a gateway when responding to an INVITE message. -A response code can be any integer value between 400 and 699, inclusive. -Although the cmdlet will accept integer values less than 400, these are not recognized as final responses. -As a result, the translation rule will never be used. -A value of 0 means that only the ISUP cause code will be used when executing the translation rule; the SIP response code will be ignored. +### -ReceivedISUPCauseValue + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Value of the ISDN User Part (ISUP) code that must be present in the SIP response message used by a gateway when responding to an INVITE message. +A value of -1 indicates that only the SIP response code will be used when executing the translation rule; the ISUP cause code will be ignored. + ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -158,14 +183,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -ReceivedResponseCode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Value of the SIP response code used by a gateway when responding to an INVITE message. +A response code can be any integer value between 400 and 699, inclusive. +Although the cmdlet will accept integer values less than 400, these are not recognized as final responses. +As a result, the translation rule will never be used. +A value of 0 means that only the ISUP cause code will be used when executing the translation rule; the SIP response code will be ignored. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -174,14 +205,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -TranslatedResponseCode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Value of SIP response code that the ReceivedResponseCode and/or the ReceivedISUPCauseCode should be translated to. +Translated response codes can be any integer value between 400 and 699, inclusive. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -191,13 +225,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -206,33 +242,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. - - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +### -WhatIf -### -ReceivedISUPCauseValue -Value of the ISDN User Part (ISUP) code that must be present in the SIP response message used by a gateway when responding to an INVITE message. -A value of -1 indicates that only the SIP response code will be used when executing the translation rule; the ISUP cause code will be ignored. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -246,13 +265,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.SipResponseCodeTranslationRule#Decorated object. +### Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.SipResponseCodeTranslationRule#Decorated + The `Set-CsSipResponseCodeTranslationRule` cmdlet accepts pipelined instances of the SIP response code translation rule object. ## OUTPUTS -### +### None The `Set-CsSipResponseCodeTranslationRule` cmdlet does not return any objects or values. Instead, the cmdlet modifies instances of the Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.SipResponseCodeTranslationRule#Decorated object. diff --git a/skype/skype-ps/skype/Set-CsSite.md b/skype/skype-ps/SkypeForBusiness/Set-CsSite.md similarity index 84% rename from skype/skype-ps/skype/Set-CsSite.md rename to skype/skype-ps/SkypeForBusiness/Set-CsSite.md index b5779296c3..5ffa0119c0 100644 --- a/skype/skype-ps/skype/Set-CsSite.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsSite.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cssite applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsSite -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cssite +schema: 2.0.0 +title: Set-CsSite --- # Set-CsSite @@ -40,7 +41,7 @@ However, you can use the `Set-CsSite` cmdlet to change the display name, the des ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsSite -Identity Redmond -Description "Full-time employees in Redmond, WA." ``` @@ -48,7 +49,7 @@ Set-CsSite -Identity Redmond -Description "Full-time employees in Redmond, WA." The command shown in Example 1 modifies the Description property for the Redmond site (-Identity Redmond). -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsSite -Identity Redmond -DisplayName "US Headquarters" ``` @@ -56,7 +57,7 @@ Set-CsSite -Identity Redmond -DisplayName "US Headquarters" Example 2 changes the display name for the Redmond site to "US Headquarters". -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsSite | Where-Object {$_.Description -eq $Null} | ForEach-Object {Set-CsSite $_.Identity -Description "Litwareinc.com"} ``` @@ -69,36 +70,35 @@ This cmdlet takes each item in the collection and uses the `Set-CsSite` cmdlet t ## PARAMETERS -### -Identity -Name of the site to be modified; for example: - -`-Identity "Redmond"` +### -DefaultPersistentChatPool -Do not use the format "site:Redmond" when specifying the identity. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Fully qualified domain name of the default Persistent Chat pool for the site. ```yaml -Type: XdsGlobalRelativeIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to add additional information to a site object. For example, the Description might include contact information for the site. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -108,6 +108,9 @@ Accept wildcard characters: False ``` ### -DisplayName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Friendly name for the site. For example: @@ -117,8 +120,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,6 +130,9 @@ Accept wildcard characters: False ``` ### -FederationRoute + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service location of the Edge Server used to provide a bridge between your internal network and the Internet. For example: @@ -137,8 +142,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -147,14 +151,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. + ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -163,31 +170,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the site to be modified; for example: + +`-Identity "Redmond"` + +Do not use the format "site:Redmond" when specifying the identity. + ```yaml -Type: SwitchParameter +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. +### -XmppFederationRoute + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Service Identity of the Edge Server used for XMPP (Extensible Messaging and Presence Protocol) federation. +For example: + +`-XmppFederationRoute EdgeServer:atl-xmpp-001.litwareinc.com` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -196,14 +214,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DefaultPersistentChatPool -Fully qualified domain name of the default Persistent Chat pool for the site. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -212,17 +232,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -XmppFederationRoute -Service Identity of the Edge Server used for XMPP (Extensible Messaging and Presence Protocol) federation. -For example: +### -WhatIf -`-XmppFederationRoute EdgeServer:atl-xmpp-001.litwareinc.com` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -236,13 +255,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsSite` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsSite` cmdlet does not return any objects or values. Instead, the cmdlet modifies instances of the Microsoft.Rtc.Management.Deploy.Internal.Site+CentralSite object. diff --git a/skype/skype-ps/skype/Set-CsSlaConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsSlaConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Set-CsSlaConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsSlaConfiguration.md index 17fb0a02a8..8e13552421 100644 --- a/skype/skype-ps/skype/Set-CsSlaConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsSlaConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csslaconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsSlaConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csslaconfiguration +schema: 2.0.0 +title: Set-CsSlaConfiguration --- # Set-CsSlaConfiguration @@ -24,7 +25,7 @@ Set-CsSlaConfiguration [-BusyOption ] [-Target ] ``` ## DESCRIPTION -Shared Line Appearance (SLA) is a feature in Skype for Business (SfB) for handling multiple calls on a specific number called a shared number. SLA can configure any enterprise voice enabled SfB user as a shared number with multiple lines to respond to multiple calls. The calls are not actually received on the shared number, instead they are forwarded to users that act as delegates for the shared number. Any one of the delegates can pick up the call while the rest of the delegates get a notification on their phone about who picked up the call and which line has become busy as a result. Both the number of lines and the delegates are configurable for a shared number in SLA. In addition, advanced options such as BusyOption (what happens in a situation when all lines are busy) and MissedCallOption (the case in which none of the delegates pick up a call) etc. can also be configured for a shared number. +Shared Line Appearance (SLA) is a feature in Skype for Business (SfB) for handling multiple calls on a specific number called a shared number. SLA can configure any enterprise voice enabled SfB user as a shared number with multiple lines to respond to multiple calls. The calls are not actually received on the shared number, instead they are forwarded to users that act as delegates for the shared number. Any one of the delegates can pick up the call while the rest of the delegates get a notification on their phone about who picked up the call and which line has become busy as a result. Both the number of lines and the delegates are configurable for a shared number in SLA. In addition, advanced options such as BusyOption (what happens in a situation when all lines are busy) and MissedCallOption (the case in which none of the delegates pick up a call) etc. can also be configured for a shared number. The Set-CsSlaConfiguration cmdlet modifies the properties of an SLA configuration. @@ -34,21 +35,21 @@ Get-CsAdminRole | Where-Object {$_.Cmdlets -match "Set-CsSlaConfiguration"} ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` PS C:\> Set-CsSlaConfiguration -Identity SLAGroup1 -MaxNumberOfCalls 3 -BusyOption BusyOnBusy ``` This example creates an SLA group for an existing Enterprise Voice user, SLAGroup1, and uses the number assigned for SLAGroup1 as the SLA mainline number. Also It sets the maximum number of concurrent calls for the new SLA group to 3, and for calls in excess of that to hear a busy signal. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` PS C:\> Set-CsSlaConfiguration -Identity SLAGroup1 -BusyOption Forward -Target tel:+2025551234 ``` This example sets calls that exceed the maximum number of concurrent calls to be forwarded to the telephone number 202-555-1234. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` PS C:\> Set-CsSlaConfiguration -Identity SLAGroup1 -MissedCallOption Forward -MissedCallForwardTarget sip:sla_forward_number@contoso.com -BusyOption Forward -MaxNumberOfCalls 2 -Target sip:sla_forward_number@contoso.com ``` @@ -57,25 +58,10 @@ This example specifies that missed calls to be forwarded to the user named sla_f ## PARAMETERS -### -Identity -Indicates the Identity of the SLA group to be created or modified. User Identities can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). You can also reference a user account by using the Active Directory distinguished name. - -You can use the asterisk (\*) wildcard character when using the Display Name as the user Identity. For example, the Identity "\*Smith" returns all the users who have a display name that ends with the string value "Smith". - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -BusyOption -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -BusyOption Specifies the action to take when the SLA group exceeds the maximum number of simultaneous calls. Possible values are: * Forward * BusyOnBusy @@ -84,8 +70,7 @@ Specifies the action to take when the SLA group exceeds the maximum number of si ```yaml Type: SlaBusyOption Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -94,30 +79,36 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the SLA group to be created or modified. User Identities can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). You can also reference a user account by using the Active Directory distinguished name. + +You can use the asterisk (\*) wildcard character when using the Display Name as the user Identity. For example, the Identity "\*Smith" returns all the users who have a display name that ends with the string value "Smith". ```yaml -Type: SwitchParameter +Type: UserIdParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -MaxNumberOfCalls + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Sets the maximum number of concurrent calls to be allowed in the SLA group. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -127,6 +118,9 @@ Accept wildcard characters: False ``` ### -MissedCallForwardTarget + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the sip address of a user account or a telephone number to forward the call when you select `Forward` in the `MissedCallOption` parameter. The target could be a user in your organization or a phone number following next syntax: * tel:\ * sip:\ @@ -134,8 +128,7 @@ Specifies the sip address of a user account or a telephone number to forward the ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -145,6 +138,9 @@ Accept wildcard characters: False ``` ### -MissedCallOption + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the action to take when the SLA group delegates do not answer a call. Possible values are: * Disconnect * Forward @@ -154,8 +150,7 @@ Specifies the action to take when the SLA group delegates do not answer a call. ```yaml Type: SlaUserMissedCallOption Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -165,13 +160,15 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to pass a user object through the pipeline that represents the SLA group being created or modified. By default, the Set-CsSlaConfiguration cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -181,6 +178,9 @@ Accept wildcard characters: False ``` ### -Target + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the sip address of a user account or a telephone number to forward the call when you select `Forward` in the `BusyOption` parameter. The target could be a user in your organization or a phone number following next syntax: * tel:\ * sip:\ @@ -188,8 +188,7 @@ Specifies the sip address of a user account or a telephone number to forward the ```yaml Type: Uri Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -198,14 +197,34 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named diff --git a/skype/skype-ps/skype/Set-CsStaticRoutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsStaticRoutingConfiguration.md similarity index 90% rename from skype/skype-ps/skype/Set-CsStaticRoutingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsStaticRoutingConfiguration.md index e573931e83..3f1ef1899a 100644 --- a/skype/skype-ps/skype/Set-CsStaticRoutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsStaticRoutingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csstaticroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsStaticRoutingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csstaticroutingconfiguration +schema: 2.0.0 +title: Set-CsStaticRoutingConfiguration --- # Set-CsStaticRoutingConfiguration @@ -48,7 +49,7 @@ This means that you can use the cmdlet to add new routes to a collection, or to ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` $x = Get-CsStaticRoutingConfiguration -Identity global | Select-Object -ExpandProperty Route | Where-Object {$_.MatchUri -eq "litwareinc.com" -and $_.MatchOnlyPhoneUri -eq $True} @@ -67,7 +68,7 @@ After the route has been retrieved, the second command in the example adds that To do this, the `Set-CsStaticRoutingConfiguration` cmdlet is called along with the Route parameter; the parameter value @{Add=$x} instructs the `Set-CsStaticRoutingConfiguration` cmdlet to append the route stored in the variable $x to the collection of routes maintained in the Route property. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $x = Get-CsStaticRoutingConfiguration -Identity service:Registrar:atl-cs-001.litwareinc.com | Select-Object -ExpandProperty Route | Where-Object {$_.MatchUri -eq "litwareinc.com" -and $_.MatchOnlyPhoneUri -eq $True} @@ -85,7 +86,7 @@ After the route has been retrieved, the second command deletes that route from t To do this, the `Set-CsStaticRoutingConfiguration` cmdlet is called along with the Route parameter; the parameter value @{Remove=$x} instructs the `Set-CsStaticRoutingConfiguration` cmdlet to delete the route stored in the variable $x. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Set-CsStaticRoutingConfiguration -Identity service:Registrar:atl-cs-001.litwareinc.com -Route $Null ``` @@ -97,7 +98,28 @@ After the command completes, the collection will still exist, but it will no lon ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the static routing configuration collection to be modified. To modify the global collection, use this syntax: @@ -115,8 +137,7 @@ If this parameter is not included the `Set-CsStaticRoutingConfiguration` cmdlet ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -126,13 +147,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -142,6 +165,9 @@ Accept wildcard characters: False ``` ### -Route + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Individual static routes maintained within the collection. Routes to be added to a collection must either be copied from another collection or created by using the `New-CsStaticRoute` cmdlet; to delete a route from a collection, you must first create an object reference to that route. For details, see the Examples section of help topic. @@ -149,8 +175,7 @@ For details, see the Examples section of help topic. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -159,14 +184,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -176,29 +203,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -212,13 +225,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.RoutingSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.RoutingSettings + The `Set-CsStaticRoutingConfiguration` cmdlet accepts pipelined instances of the static routing settings object. ## OUTPUTS -### +### None The `Set-CsStaticRoutingConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.SipProxy.RoutingSettings object. diff --git a/skype/skype-ps/skype/Set-CsStorageServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsStorageServiceConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Set-CsStorageServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsStorageServiceConfiguration.md index e8dde2d1fe..ed8ed44b4c 100644 --- a/skype/skype-ps/skype/Set-CsStorageServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsStorageServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csstorageserviceconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsStorageServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csstorageserviceconfiguration +schema: 2.0.0 +title: Set-CsStorageServiceConfiguration --- # Set-CsStorageServiceConfiguration @@ -48,36 +49,22 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 At this point in time there are no property values that can be modified by using the Set-CsStorageServiceConfiguration cmdlet. ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableAsyncAdaptorTaskAbort -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableAsyncAdaptorTaskAbort PARAMVALUE: $true | $false ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -87,13 +74,15 @@ Accept wildcard characters: False ``` ### -EnableAutoImportFlushedData + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: $true | $false ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -103,13 +92,15 @@ Accept wildcard characters: False ``` ### -EnableFabricReplicationSetReduction + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: $true | $false ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,13 +110,15 @@ Accept wildcard characters: False ``` ### -FabricInvalidStateTimeoutDuration + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: UInt64 ```yaml Type: UInt64 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,13 +128,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any nonfatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -151,6 +146,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the storage service configuration settings to be modified. Storage service configuration settings can be applied to the global, site, or service scope (for the Registrar service only). @@ -169,8 +167,7 @@ To modify settings at the service level, use syntax similar to this: ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -180,13 +177,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -195,14 +194,34 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -216,13 +235,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.StorageService.StorageServiceSettings The `Set-CsStorageServiceConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.StorageService.StorageServiceSettings object. ## OUTPUTS -### -None. +### None The `Set-CsStorageServiceConfiguration` cmdlet does not return any data or objects. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsTeamsUpgradeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsTeamsUpgradeConfiguration.md similarity index 94% rename from skype/skype-ps/skype/Set-CsTeamsUpgradeConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsTeamsUpgradeConfiguration.md index c8556d260f..2917bdbd00 100644 --- a/skype/skype-ps/skype/Set-CsTeamsUpgradeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTeamsUpgradeConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csteamsupgradeconfiguration -applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsTeamsUpgradeConfiguration -schema: 2.0.0 -manager: bulenteg +applicable: Skype for Business Server 2015, Skype for Business Server 2019 author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/set-csteamsupgradeconfiguration +schema: 2.0.0 +title: Set-CsTeamsUpgradeConfiguration --- # Set-CsTeamsUpgradeConfiguration @@ -47,94 +49,106 @@ The above cmdlet specifies that users subject to upgrade should download Teams i ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. +### -DownloadTeams + +> Applicable: Skype for Business Online + +The DownloadTeams property allows admins to control whether the Skype for Business client should automatically download Teams in the background. This Boolean setting is only honored on Windows clients, and only for certain values of the user's TeamsUpgradePolicy. If NotifySfbUser=true or if Mode=TeamsOnly in TeamsUpgradePolicy, this setting is honored. Otherwise it is ignored. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: Required: False Position: Named -Default value: None +Default value: True Accept pipeline input: False Accept wildcard characters: False ``` +### -Force -### -DownloadTeams -The DownloadTeams property allows admins to control whether the Skype for Business client should automatically download Teams in the background. This Boolean setting is only honored on Windows clients, and only for certain values of the user's TeamsUpgradePolicy. If NotifySfbUser=true or if Mode=TeamsOnly in TeamsUpgradePolicy, this setting is honored. Otherwise it is ignored. +> Applicable: Skype for Business Online + +{{Fill Force Description}} ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named -Default value: True +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SfBMeetingJoinUx -The SfBMeetingJoinUx property allows admins to specify which app is used to join Skype for Business meetings, even after the user has been upgraded to Teams. Allowed values are: "SkypeMeetingsApp" and "NativeLimitedClient". "NativeLimitedClient" means the existing Skype for Business rich client will be used, but since the user is upgraded, only meeting functionality is available. Calling and Messaging are done via Teams. "SkypeMeetingsApp" means use the web-downloadable app. This setting can be useful for organizations that have upgraded to Teams and no longer want to install Skype for Business on their users' computers. + +### -Identity + +> Applicable: Skype for Business Online + +{{Fill Identity Description}} ```yaml -Type: string +Type: XdsIdentity Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False -Position: Named -Default value: NativeLimitedClient +Position: 1 +Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -{{Fill Force Description}} + + + +### -SfBMeetingJoinUx + +> Applicable: Skype for Business Online + +The SfBMeetingJoinUx property allows admins to specify which app is used to join Skype for Business meetings, even after the user has been upgraded to Teams. Allowed values are: "SkypeMeetingsApp" and "NativeLimitedClient". "NativeLimitedClient" means the existing Skype for Business rich client will be used, but since the user is upgraded, only meeting functionality is available. Calling and Messaging are done via Teams. "SkypeMeetingsApp" means use the web-downloadable app. This setting can be useful for organizations that have upgraded to Teams and no longer want to install Skype for Business on their users' computers. ```yaml -Type: SwitchParameter +Type: string Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False Position: Named -Default value: None +Default value: NativeLimitedClient Accept pipeline input: False Accept wildcard characters: False ``` +### -Tenant -### -Identity -{{Fill Identity Description}} +> Applicable: Skype for Business Online + +{{Fill Tenant Description}} ```yaml -Type: XdsIdentity +Type: Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Online Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Confirm +> Applicable: Skype for Business Online -### -Tenant -{{Fill Tenant Description}} +Prompts you for confirmation before running the cmdlet. ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -144,6 +158,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + Shows what would happen if the cmdlet runs. The cmdlet is not run. @@ -151,7 +168,6 @@ The cmdlet is not run. Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/Set-CsTeamsUpgradePolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsTeamsUpgradePolicy.md similarity index 96% rename from skype/skype-ps/skype/Set-CsTeamsUpgradePolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsTeamsUpgradePolicy.md index 86e0f3e376..20436facda 100644 --- a/skype/skype-ps/skype/Set-CsTeamsUpgradePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTeamsUpgradePolicy.md @@ -1,14 +1,14 @@ --- +applicable: Skype for Business Server 2015, Skype for Business Server 2019 +author: hirenshah1 external help file: Microsoft.Rtc.Management.dll-Help.xml +Locale: en-US +manager: rogupta Module Name: SkypeForBusiness +ms.author: hirshah online version: https://learn.microsoft.com/powershell/module/skype/set-csteamsupgradepolicy -applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsTeamsUpgradePolicy schema: 2.0.0 -manager: rogupta -author: hirenshah1 -ms.author: hirshah -ms.reviewer: +title: Set-CsTeamsUpgradePolicy --- # Set-CsTeamsUpgradePolicy @@ -59,13 +59,14 @@ This disables notifications for users in the Redmond1 site. ### -Description +> Applicable: Skype for Business Server 2019 + Free form text that can be used by administrators as desired. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -75,13 +76,14 @@ Accept wildcard characters: False ### -Identity +> Applicable: Skype for Business Server 2019 + The identity of the policy. To specify the global policy for the organization, use "global". To specify a specific site, use "site:\" where \ is the name of the site. To specify any other policy provide the name of that policy. ```yaml Type: XdsIdentity Parameter Sets: Identity Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: 1 Default value: None @@ -91,13 +93,14 @@ Accept wildcard characters: False ### -NotifySfbUsers +> Applicable: Skype for Business Server 2019 + If true, users with this policy see a notification in their Skype for Business client indicating that Teams is coming soon. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None @@ -107,13 +110,14 @@ Accept wildcard characters: False ### -Tenant +> Applicable: Skype for Business Server 2019 + {{Fill Tenant Description}} ```yaml Type: Guid Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019 Required: False Position: Named Default value: None diff --git a/skype/skype-ps/skype/Set-CsTelemetryConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsTelemetryConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Set-CsTelemetryConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsTelemetryConfiguration.md index 8a7a2ec48f..d8ff51fddf 100644 --- a/skype/skype-ps/skype/Set-CsTelemetryConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTelemetryConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cstelemetryconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsTelemetryConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cstelemetryconfiguration +schema: 2.0.0 +title: Set-CsTelemetryConfiguration --- # Set-CsTelemetryConfiguration @@ -35,7 +36,7 @@ For privacy information, see the Skype for Business Privacy Statement (https://g ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsTelemetryConfiguration -Identity site:Redmond -EnableClientTelemetry $True ``` @@ -45,31 +46,17 @@ This example enables client telemetry on the configuration scoped to the Redmond ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableClientTelemetry -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableClientTelemetry When set to true, client telemetry will be enabled. The default is false. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -79,13 +66,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error messages and completes the cmdlet operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -95,6 +84,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + A unique identifier that includes the scope of the telemetry configuration. Telemetry configurations can be scoped at the Global, Site, or Service level. For example, "site:Redmond" (for site). @@ -112,8 +104,7 @@ You can combine the two commands to zero in on a single role in a single pool. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -123,13 +114,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,14 +131,34 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -159,13 +172,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.Management.Automation.PSObject This cmdlet takes pipeline input of the `Get-CsTelemetryConfiguration` cmdlet. ## OUTPUTS -### -None +### None ## NOTES diff --git a/skype/skype-ps/skype/Set-CsTenantHybridConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsTenantHybridConfiguration.md similarity index 93% rename from skype/skype-ps/skype/Set-CsTenantHybridConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsTenantHybridConfiguration.md index ca249562b2..b9885c193c 100644 --- a/skype/skype-ps/skype/Set-CsTenantHybridConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTenantHybridConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cstenanthybridconfiguration applicable: Skype for Business Server 2019 -title: Set-CsTenantHybridConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/set-cstenanthybridconfiguration +schema: 2.0.0 +title: Set-CsTenantHybridConfiguration --- # Set-CsTenantHybridConfiguration @@ -58,7 +60,7 @@ However, you can't create or modify hybrid PSTN sites through the CsTenantHybrid ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsTenantHybridConfiguration -HybridConfigServiceInternalUrl "https://internal.litwareinc.com" ``` @@ -68,30 +70,16 @@ The command shown in Example 1 sets the internal service URL for the global coll ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Online -### -Force Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -101,13 +89,15 @@ Accept wildcard characters: False ``` ### -HybridConfigServiceExternalUrl + +> Applicable: Skype for Business Online + External Web service URL. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -117,13 +107,15 @@ Accept wildcard characters: False ``` ### -HybridConfigServiceInternalUrl + +> Applicable: Skype for Business Online + Internal Web service URL. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -133,6 +125,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Online + Unique Identity of the tenant hybrid configuration settings to be modified. Because you are limited to a single, global collection of hybrid configuration settings, the only collection that can be modified by using the Identity parameter is the global collection: @@ -143,8 +138,7 @@ To modify the settings for an individual tenant, use the Tenant parameter instea ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: 2 @@ -154,13 +148,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Online + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -170,13 +166,15 @@ Accept wildcard characters: False ``` ### -PeerDestination + +> Applicable: Skype for Business Online + Fully qualified domain name of your on-premises Access Edge server. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -186,6 +184,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Specifies the global unique identifier (GUID) of the Skype for Business Online tenant account on which the cmdlet will operate. For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"`. @@ -198,8 +199,7 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -209,6 +209,9 @@ Accept wildcard characters: False ``` ### -UseOnPremDialPlan + +> Applicable: Skype for Business Online + If set to $true, hybrid users will use the dial plan defined for your on-premises Skype for Business Server organization. If set to $false, hybrid users will use the dial plan defined for your Skype for Business Online organization. The default is $true. @@ -216,8 +219,25 @@ The default is $true. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Online + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -227,13 +247,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named @@ -247,14 +269,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsTenantHybridConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Set-CsTenantUpdateTimeWindow.md b/skype/skype-ps/SkypeForBusiness/Set-CsTenantUpdateTimeWindow.md similarity index 88% rename from skype/skype-ps/skype/Set-CsTenantUpdateTimeWindow.md rename to skype/skype-ps/SkypeForBusiness/Set-CsTenantUpdateTimeWindow.md index 16213f56b6..586c0fd7b8 100644 --- a/skype/skype-ps/skype/Set-CsTenantUpdateTimeWindow.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTenantUpdateTimeWindow.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cstenantupdatetimewindow applicable: Skype for Business Online -title: Set-CsTenantUpdateTimeWindow -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/set-cstenantupdatetimewindow +schema: 2.0.0 +title: Set-CsTenantUpdateTimeWindow --- # Set-CsTenantUpdateTimeWindow @@ -69,7 +71,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsTenantUpdateTimeWindow -Identity FirstAndLastWeekend -Monthly -WeeksOfMonth First,Last -DaysOfWeek Sunday,Saturday -StartTime 1:00 -Duration 5:00 ``` @@ -77,7 +79,7 @@ Set-CsTenantUpdateTimeWindow -Identity FirstAndLastWeekend -Monthly -WeeksOfMont This example updates an existing tenant update time window in the tenant in Monthly type. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsTenantUpdateTimeWindow -Identity MidDay -Monthly -DayOfMonth 15 -StartTime 5:00 -Duration 6:00 ``` @@ -85,7 +87,7 @@ Set-CsTenantUpdateTimeWindow -Identity MidDay -Monthly -DayOfMonth 15 -StartTime This example updates an existing tenant update time window in the tenant in Monthly type. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsTenantUpdateTimeWindow -Identity Weekday -Weekly -DaysOfWeek Monday,Tuesday,Wednesday,Thursday,Friday -StartTime 3:00 -Duration 10:00 ``` @@ -93,7 +95,7 @@ Set-CsTenantUpdateTimeWindow -Identity Weekday -Weekly -DaysOfWeek Monday,Tuesda This example updates an existing tenant update time window in the tenant in Weekly type. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Set-CsTenantUpdateTimeWindow -Identity Night -Daily ``` @@ -104,13 +106,15 @@ This example updates an existing tenant update time window in the tenant in Dail ## PARAMETERS ### -Daily + +> Applicable: Skype for Business Online + Type of Time window is daily. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -120,14 +124,16 @@ Accept wildcard characters: False ``` ### -DayOfMonth + +> Applicable: Skype for Business Online + Day of month. It must be defined when Type is Monthly. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -137,6 +143,9 @@ Accept wildcard characters: False ``` ### -DaysOfWeek + +> Applicable: Skype for Business Online + Days of week. It can be multiple days separated by a comma. It must be defined when Type is Weekly or Monthly. @@ -144,8 +153,7 @@ It must be defined when Type is Weekly or Monthly. ```yaml Type: TenantUpdateTimeWindowDayOfWeek Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -154,30 +162,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Identity -Specifies the identity of the tenant update time window. +### -Duration + +> Applicable: Skype for Business Online + +Duration of the update time window. ```yaml -Type: XdsGlobalRelativeIdentity +Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Monthly -Type of Time window is monthly. +### -Force + +> Applicable: Skype for Business Online + +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -186,32 +200,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Weekly -Type of Time window is weekly. +### -Identity + +> Applicable: Skype for Business Online + +Specifies the identity of the tenant update time window. ```yaml -Type: SwitchParameter +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WeeksOfMonth -Weeks of month. -It can be multiple weeks separated by a comma. -It must be defined when Type is Monthly. +### -Instance + +> Applicable: Skype for Business Online + +PARAMVALUE: PSObject ```yaml -Type: TenantUpdateTimeWindowWeekOfMonth +Type: PSObject Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -220,14 +236,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -PARAMVALUE: SwitchParameter +### -Monthly + +> Applicable: Skype for Business Online + +Type of Time window is monthly. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -236,14 +254,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Duration -Duration of the update time window. +### -StartTime + +> Applicable: Skype for Business Online + +Time of day when the update time window starts. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -252,16 +272,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Tenant + +> Applicable: Skype for Business Online + +PARAMVALUE: Guid ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -270,14 +290,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -PARAMVALUE: PSObject +### -Weekly + +> Applicable: Skype for Business Online + +Type of Time window is weekly. ```yaml -Type: PSObject +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -286,14 +308,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -StartTime -Time of day when the update time window starts. +### -WeeksOfMonth + +> Applicable: Skype for Business Online + +Weeks of month. +It can be multiple weeks separated by a comma. +It must be defined when Type is Monthly. ```yaml -Type: TimeSpan +Type: TenantUpdateTimeWindowWeekOfMonth Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -302,14 +328,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -PARAMVALUE: Guid +### -Confirm + +> Applicable: Skype for Business Online + +PARAMVALUE: SwitchParameter ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -319,13 +347,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/Set-CsTestDevice.md b/skype/skype-ps/SkypeForBusiness/Set-CsTestDevice.md similarity index 85% rename from skype/skype-ps/skype/Set-CsTestDevice.md rename to skype/skype-ps/SkypeForBusiness/Set-CsTestDevice.md index 47708627fc..df4f08d6c0 100644 --- a/skype/skype-ps/skype/Set-CsTestDevice.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTestDevice.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cstestdevice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsTestDevice -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cstestdevice +schema: 2.0.0 +title: Set-CsTestDevice --- # Set-CsTestDevice @@ -46,7 +47,7 @@ After a test device has been created, you can then use the `Set-CsTestDevice` cm ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsTestDevice -Identity site:Redmond/UCPhone -Identifier "09768-ABDR-83295" ``` @@ -54,7 +55,7 @@ Set-CsTestDevice -Identity site:Redmond/UCPhone -Identifier "09768-ABDR-83295" Example 1 modifies the Identifier property for the test device named UCPhone assigned to the Redmond site. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsTestDevice -Identity site:Redmond/UCPhone -IdentifierType SerialNumber -Identifier "09768-ABDR-83295" ``` @@ -65,45 +66,28 @@ In this case, however, the command not only specifies a new Identifier but also ## PARAMETERS -### -Identity -Indicates the Identity of the test device to be modified. -For example: - -`-Identity site:Redmond/UCPhoneTestDevice` +### -Force -Note that you cannot use wildcards when specifying an Identity. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -Identifier -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -Identifier Based on the IdentifierType, indicates the Media Access Control (MAC) address or serial number of the new test device. Serial numbers can be specified using numbers, letters, hyphens and underscores; for example: @@ -123,8 +107,7 @@ A MAC address such as 01-02-03-04-05 will not be accepted because it does not ha ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,6 +117,9 @@ Accept wildcard characters: False ``` ### -IdentifierType + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the test device will be uniquely identified by its MAC address or by its serial number. To identify a device by its MAC address, set the IdentifierType to MACAddress. To identify a device by its serial number, set the IdentifierType to SerialNumber. @@ -142,8 +128,7 @@ MACAddress and SerialNumber are the only allowed values. ```yaml Type: IdentifierType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -152,46 +137,76 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates the Identity of the test device to be modified. +For example: + +`-Identity site:Redmond/UCPhoneTestDevice` + +Note that you cannot use wildcards when specifying an Identity. + ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -205,13 +220,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.TestDevice object. +### Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.TestDevice + The `Set-CsTestDevice` cmdlet accepts pipelined input of the test device object. ## OUTPUTS -### +### None The `Set-CsTestDevice` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.DeviceUpdate.TestDevice object. diff --git a/skype/skype-ps/skype/Set-CsTestUserCredential.md b/skype/skype-ps/SkypeForBusiness/Set-CsTestUserCredential.md similarity index 89% rename from skype/skype-ps/skype/Set-CsTestUserCredential.md rename to skype/skype-ps/SkypeForBusiness/Set-CsTestUserCredential.md index 35ebd6a75a..eaf54eac3b 100644 --- a/skype/skype-ps/skype/Set-CsTestUserCredential.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTestUserCredential.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cstestusercredential applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsTestUserCredential -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cstestusercredential +schema: 2.0.0 +title: Set-CsTestUserCredential --- # Set-CsTestUserCredential @@ -50,7 +51,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsTestUserCredential -SipAddress "sip:kenmyer@litwareinc.com" -UserName "litwareinc\kenmyer" -Password "07Apples" ``` @@ -59,7 +60,7 @@ The command shown in Example 1 configures the user with the SIP address sip:kenm Note that you must also supply the user name (in the form domain name\user name) and the user's password when you configure an account as a watcher node test user. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $x = Get-Credential "litwareinc\kenmyer" @@ -74,6 +75,9 @@ To do this, the first command in the example uses the `Get-Credential` cmdlet to ## PARAMETERS ### -Credential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to configure test credentials by using a Windows PowerShell credentials object rather than the Password and UserName parameters; this has the advantage of ensuring that the user password is masked when you type it onscreen. To use the Credential parameter you must first create a PSCredential object using the `Get-Credential` cmdlet and then store the resulting object in a variable. @@ -86,8 +90,7 @@ That variable is then used as the parameter value for the Credential parameter. ```yaml Type: PSCredential Parameter Sets: UsePSCredential -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -96,7 +99,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Password + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Password for the account whose test user credentials are being set. (Note that this password will be displayed onscreen in plain text.) For example: @@ -107,8 +131,7 @@ You do not need to use the Password or the UserName parameters if you use the Cr ```yaml Type: String Parameter Sets: UseRawText -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -118,6 +141,9 @@ Accept wildcard characters: False ``` ### -SipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address of the account whose test user credentials are being set. For example: @@ -126,8 +152,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -137,6 +162,9 @@ Accept wildcard characters: False ``` ### -UserName + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + User name of the account being configured for test credentials. The user name can be the SamAccountName or Active Directory DisplayName; for example: @@ -150,8 +178,7 @@ For example: ```yaml Type: String Parameter Sets: UseRawText -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -161,13 +188,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -176,30 +205,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -213,14 +228,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsTestUserCredential` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None Instead, the `Set-CsTestUserCredential` cmdlet modifies existing instances of the System.Management.Automation.PSCredential object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsThirdPartyVideoSystem.md b/skype/skype-ps/SkypeForBusiness/Set-CsThirdPartyVideoSystem.md similarity index 89% rename from skype/skype-ps/skype/Set-CsThirdPartyVideoSystem.md rename to skype/skype-ps/SkypeForBusiness/Set-CsThirdPartyVideoSystem.md index 8ceafe90ca..600103dd5d 100644 --- a/skype/skype-ps/skype/Set-CsThirdPartyVideoSystem.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsThirdPartyVideoSystem.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csthirdpartyvideosystem applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsThirdPartyVideoSystem -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csthirdpartyvideosystem +schema: 2.0.0 +title: Set-CsThirdPartyVideoSystem --- # Set-CsThirdPartyVideoSystem @@ -33,7 +34,7 @@ If you later need to modify the property values for one of these contact objects ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsThirdPartyVideoSystem -Filter {DisplayName -eq "Redmond Video System" | Set-CsThirdPartyVideoSystem -SipAddress "sip:redmondvideo$litwareinc.com" ``` @@ -43,7 +44,7 @@ To carry out this task, the command first uses the `Get-CsThirdPartyVideoSystem` The contact object for that system is then piped to the `Set-CsThirdPartyVideoSystem` cmdlet, which changes the object's SIP address to sip:redmondvideo@litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsThirdPartyVideoSystem | Set-CsThirdPartyVideoSystem -Enabled $False ``` @@ -55,49 +56,16 @@ That collection is then piped to the `Set-CsThirdPartyVideoSystem` cmdlet, which ## PARAMETERS -### -Identity -Unique identifier for the video system being modified. -Video systems are identified by using the Active Directory distinguished name (DN) of the associated contact object. -By default, video systems use a GUID (globally unique identifier) as their common name, which means systems will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. -In turn, that means that you might find it easier to modify third-party video systems by using the `Get-CsThirdPartyVideoSystem` cmdlet to return the devices and then piping those objects to the `Set-CsThirdPartyVideoSystem` cmdlet. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -DisplayName -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -DisplayName Configures the Active Directory display name of the video system. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -107,13 +75,15 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + When set to True ($True) the video system can be used with Skype for Business Server. ```yaml Type: Boolean Parameter Sets: (All) Aliases: CsEnabled -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -123,6 +93,9 @@ Accept wildcard characters: False ``` ### -ExchangeArchivingPolicy + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Indicates where the contact's instant messaging sessions are archived. Allowed values are: @@ -137,8 +110,7 @@ ArchivingToExchange ```yaml Type: ExchangeArchivingPolicyOptionsEnum Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -147,7 +119,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the video system being modified. +Video systems are identified by using the Active Directory distinguished name (DN) of the associated contact object. +By default, video systems use a GUID (globally unique identifier) as their common name, which means systems will typically have an Identity similar to this: CN={ce84964a-c4da-4622-ad34-c54ff3ed361f},OU=Redmond,DC=Litwareinc,DC=com. +In turn, that means that you might find it easier to modify third-party video systems by using the `Get-CsThirdPartyVideoSystem` cmdlet to return the devices and then piping those objects to the `Set-CsThirdPartyVideoSystem` cmdlet. + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + ### -LineURI + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Phone number for the analog device. The line URI should be specified by using the E.164 format, and should be prefixed by the "TEL:" prefix. For example: @@ -161,8 +157,7 @@ Any extension number should be added to the end of the line URI; for example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -172,14 +167,16 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to pass a contact object through the pipeline that represents the third-party video system being modified. By default, the `Set-CsThirdPartyVideoSystem` cmdlet does not pass objects through the pipeline. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -189,6 +186,9 @@ Accept wildcard characters: False ``` ### -SipAddress + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier that allows the video system to communicate with SIP devices such as Skype for Business. The SIP address must be prefaced by the prefix "sip:". For example: @@ -198,8 +198,25 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -209,13 +226,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -229,12 +248,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADThirdPartyVideoSystemContact The `Set-CsThirdPartyVideoSystem` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADThirdPartyVideoSystemContact object. ## OUTPUTS -### +### None By default, the `Set-CsThirdPartyVideoSystem` cmdlet does not return any data or objects. However, if you include the PassThru parameter the cmdlet will pass instances of the Microsoft.Rtc.Management.ADConnect.Schema.OCSADThirdPartyVideoSystemContact object through the pipeline. diff --git a/skype/skype-ps/skype/Set-CsThirdPartyVideoSystemPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsThirdPartyVideoSystemPolicy.md similarity index 89% rename from skype/skype-ps/skype/Set-CsThirdPartyVideoSystemPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsThirdPartyVideoSystemPolicy.md index c59e5e1f93..f0e8476699 100644 --- a/skype/skype-ps/skype/Set-CsThirdPartyVideoSystemPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsThirdPartyVideoSystemPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csthirdpartyvideosystempolicy applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsThirdPartyVideoSystemPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csthirdpartyvideosystempolicy +schema: 2.0.0 +title: Set-CsThirdPartyVideoSystemPolicy --- # Set-CsThirdPartyVideoSystemPolicy @@ -44,7 +45,7 @@ Both the global policy and any custom policies you create can later be modified ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsThirdPartyVideoSystemPolicy -Identity "RedmondVideoSystemPolicy" -SupportsSendingLowResolution $False ``` @@ -53,7 +54,7 @@ The command shown in Example 1 modifies the per-user third-party video system po In this example, the ability to send low-resolution video is disabled. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsThirdPartyVideoSystemPolicy -Filter "site:*" | Set-CsThirdPartyVideoSystemPolicy -SupportsSendingLowResolution $False ``` @@ -65,30 +66,16 @@ That collection of site-based policies is then piped to the `Set-CsThirdPartyVid ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Force Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -98,6 +85,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identity assigned to the policy when it was created. Third-party video system policies can be created at the global, site or per-user scope. To refer to the global instance, use this syntax: @@ -118,8 +108,7 @@ If this parameter is not specified then `Set-CsThirdPartyVideoSystemPolicy` will ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -129,13 +118,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -145,14 +136,16 @@ Accept wildcard characters: False ``` ### -SupportsSendingLowResolution + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether or not low-resolution video can be used in conjunction with a VTC device. The default value is True ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,6 +155,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for the third-party video system policy being modified. For example: @@ -174,8 +170,25 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -185,13 +198,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -205,13 +220,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.ThirdPartyVideoSystem.ThirdPartyVideoSystemPolicy The `Set-CsThirdPartyVideoSystemPolicy` cmdlet accepts pipelined instance of the Microsoft.Rtc.Management.WritableConfig.Policy.ThirdPartyVideoSystem.ThirdPartyVideoSystemPolicy object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsThirdPartyVideoSystemPolicy` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Policy.ThirdPartyVideoSystem.ThirdPartyVideoSystemPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsTrunkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsTrunkConfiguration.md similarity index 85% rename from skype/skype-ps/skype/Set-CsTrunkConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsTrunkConfiguration.md index d679673e79..6313994909 100644 --- a/skype/skype-ps/skype/Set-CsTrunkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTrunkConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cstrunkconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsTrunkConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cstrunkconfiguration +schema: 2.0.0 +title: Set-CsTrunkConfiguration --- # Set-CsTrunkConfiguration @@ -55,7 +56,7 @@ These settings configure such things as whether media bypass is enabled on this ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsTrunkConfiguration -Identity site:Redmond -EnableBypass $True ``` @@ -65,7 +66,7 @@ Media bypass is enabled by assigning the value $True to the EnableBypass paramet The remaining properties for this configuration will retain their existing values. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsOutboundTranslationRule -Identity site:Redmond/OTR1 -Translation '$1' ``` @@ -75,7 +76,7 @@ Notice that we don't actually make a call to the `Set-CsTrunkConfiguration` cmdl Changes made using the `Set-CsOutboundTranslationRule` cmdlet will be automatically reflected in the trunk configuration with an Identity matching the scope portion of the Identity of the outbound translation rule. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsTrunkConfiguration -Filter site:* | Set-CsTrunkConfiguration -SRTPMode "Optional" ``` @@ -85,7 +86,7 @@ The first part of the command is a call to the `Get-CsTrunkConfiguration` cmdlet This collection of configurations is then piped to the `Set-CsTrunkConfiguration` cmdlet, which sets the SRTPMode property of each to Optional. -### -------------------------- EXAMPLE 4 -------------------------- +### EXAMPLE 4 ``` Set-CsTrunkConfiguration -Identity site:Redmond -EnablePIDFLOSupport $True ``` @@ -98,43 +99,30 @@ You must set EnablePIDFLOSupport to True in order for location information to be ## PARAMETERS -### -Identity -A unique identifier that includes the scope of the trunk configuration. -Trunk configurations can exist at the Global scope, the Site scope, or at the Service scope for a PSTN Gateway service. -For example, site:Redmond (for site) or PstnGateway:Redmond.litwareinc.com (for service). +### -AcceptGatewayPAIForOutboundCalls -```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. - -This parameter requires an object of type Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TrunkConfiguration, which can be retrieved by calling the `Get-CsTrunkConfiguration` cmdlet. +Set this parameter to True ($true) to modify the trunk configuration to display forwarded number for different trunks. +This parameter was introduced in the January 2019 cumulative update, for more information see [Incorrect caller ID is shown on the Skype for Business client in a call-forwarding scenario](https://support.microsoft.com/help/4458692/incorrect-caller-id-shown-on-the-skype-for-business-client-in-a-call) ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named -Default value: None -Accept pipeline input: True (ByValue) +Default value: False +Accept pipeline input: False Accept wildcard characters: False ``` + ### -ConcentratedTopology + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The value of this parameter determines whether there is a well-known media termination point. (An example of a well-known media termination point would be a PSTN gateway where the media termination has the same IP as the signaling termination.) Set this value to False if the trunk does not have a well-known media termination point. @@ -143,8 +131,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -154,13 +141,36 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A string describing the purpose of the trunk configuration. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Enable3pccRefer + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether the 3pcc protocol can be used to allow transferred calls to bypass the hosted site. +3pcc is also known as "third party control" and occurs when a third-party is used to connect a pair of callers (for example, an operator placing a call from person A to person B). +The REFER method is a standard SIP method which indicates that the recipient should contact a third-party by using information supplied by the sender. +The default value is False ($False). + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -170,6 +180,9 @@ Accept wildcard characters: False ``` ### -EnableBypass + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The value of this parameter determines whether media bypass is enabled for this trunk. Set this value to True to enable bypass. Note that in order for the media bypass to work successfully, certain capabilities must be supported by PSTN gateways, SBCs, and PBXs, including: @@ -194,8 +207,7 @@ Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -204,16 +216,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMobileTrunkSupport -Defines whether the service provider is a mobile carrier. +### -EnableFastFailoverTimer -Default: False +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, outbound calls that are not answered by the gateway within 10 seconds will be routed to the next available trunk; if there are no additional trunks then the call will automatically be dropped. +In an organization with slow networks and gateway responses, that could potentially result in calls being dropped unnecessarily. + +The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -222,18 +237,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnablePIDFLOSupport -Defines whether to route emergency calls with Presence Information Data Format Location Object (PIDF-LO) through the defined gateway. -Set this parameter to True if emergency calls are to be routed to a certified emergency services provider. -(The location will be transmitted with the call.) +### -EnableLocationRestriction -Default: False +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, location-based voice routing will be enabled for calls passing through the SIP trunks managed by the specified collection of SIP trunk configuration settings. +With location-based voice routing, the locations of both the user making the call and the user receiving the call are taken into account when calls are routed. +If this property is set to True (the default value is False) then you should also set the NetworkSiteId property. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -242,23 +257,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableReferSupport -Defines whether this trunk supports receiving Refer requests from the Mediation Server. - -Media bypass can be enabled only under the following circumstances: +### -EnableMobileTrunkSupport -- The ConcentratedTopology parameter is set to True -- The EnableReferSupport parameter is set to False and RTCPActiveCalls and RTCPCallsOnHold are set to False, or EnableReferSupport is set to True +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that if EnableBypass is True and EnableReferSupport is False, bypass calls that are subsequently transferred will become non-bypass. +Defines whether the service provider is a mobile carrier. -Default: True +Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -267,20 +277,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSessionTimer -Specifies whether the session timer is enabled. -Session timers are used to determine whether a particular session is still active. +### -EnableOnlineVoice -Note that even if this parameter is set to False, session timers can be applicable if the remote connection has session timer enabled. -In such a case, the Mediation Server will reply to session timer probes from the remote entity. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether the SIP trunks support online voice. +With online voice, users have an on-premises Lync Server account but have their voicemail hosted by Skype for Business Online. +The default value is False ($False). -Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -289,18 +298,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableSignalBoost -When this parameter is set to True the PSTN gateway, IP-PBX or SBC at the service provider will boost the audio volume in voice streams that are sent to the Mediation Server or Skype for Business Server clients. -If this value is set to False, audio will be boosted either at the Mediation Server (for non-bypass calls) or in Skype for Business Server clients (for bypass calls). +### -EnablePIDFLOSupport -Default: False +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Defines whether to route emergency calls with Presence Information Data Format Location Object (PIDF-LO) through the defined gateway. +Set this parameter to True if emergency calls are to be routed to a certified emergency services provider. +(The location will be transmitted with the call.) + +Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -309,16 +320,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxEarlyDialogs -The maximum number of forked responses a PSTN gateway, IP-PBX, or SBC at the service provider can receive to an Invite that it sent to the Mediation Server. +### -EnableReferSupport -Default: 20 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Defines whether this trunk supports receiving Refer requests from the Mediation Server. + +Media bypass can be enabled only under the following circumstances: + +- The ConcentratedTopology parameter is set to True +- The EnableReferSupport parameter is set to False and RTCPActiveCalls and RTCPCallsOnHold are set to False, or EnableReferSupport is set to True + +Note that if EnableBypass is True and EnableReferSupport is False, bypass calls that are subsequently transferred will become non-bypass. + +Default: True ```yaml -Type: UInt32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -327,19 +347,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutboundTranslationRulesList -A collection of phone number translation rules that apply to calls handled by Outbound Routing (calls routed to PBX or PSTN destinations). +### -EnableRTPLatching -While this list and these rules can be modified directly with this cmdlet, we recommend that you modify the outbound translation rules with the `Set-CsOutboundTranslationRule` cmdlet. -The `Set-CsOutboundTranslationRule` cmdlet will modify the rule and these modifications will be automatically reflected in the trunk configuration. -To modify the trunk configuration by adding a new outbound translation rule, call the `New-CsOutboundTranslationRule` cmdlet; the new rule will be added to the trunk configuration with the matching scope. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Indicates whether or not the SIP trunks support RTP latching. +RTP latching is a technology that enables RTP/RTCP connectivity through a NAT (network address translator) device or firewall. +The default value is False ($False). ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -348,16 +367,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RemovePlusFromUri -Setting this parameter to True will cause the Mediation Server to remove leading plus signs (+) from Uniform Resources Identifiers (URIs) before sending them on to the service provider. +### -EnableSessionTimer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies whether the session timer is enabled. +Session timers are used to determine whether a particular session is still active. + +Note that even if this parameter is set to False, session timers can be applicable if the remote connection has session timer enabled. +In such a case, the Mediation Server will reply to session timer probes from the remote entity. Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -366,21 +391,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RTCPActiveCalls -This parameter determines whether RTCP packets are sent from the PSTN gateway, IP-PBX or SBC at the service provider for active calls. -An active call in this context is a call where media is allowed to flow in at least one direction. -If RTCPActiveCalls is set to True, the Mediation Server or Skype for Business Server client can terminate a call if it does not receive RTCP packets for a period exceeding 30 seconds. +### -EnableSignalBoost -Note that disabling the checks for received RTCP media for active calls in Skype for Business Server elements removes an important safeguard for detecting a dropped peer and should be done only if necessary. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Default: True +When this parameter is set to True the PSTN gateway, IP-PBX or SBC at the service provider will boost the audio volume in voice streams that are sent to the Mediation Server or Skype for Business Server clients. +If this value is set to False, audio will be boosted either at the Mediation Server (for non-bypass calls) or in Skype for Business Server clients (for bypass calls). + +Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -389,21 +413,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RTCPCallsOnHold -This parameter determines whether RTCP packets continue to be sent across the trunk for calls that have been placed on hold and no media packets are expected to flow in either direction. -If Music on Hold is enabled at either the Skype for Business Server client or the trunk, the call will be considered to be active and this property will be ignored. -In these circumstances use the RTCPActiveCalls parameter. - -Note that disabling the checks for received RTCP media for active calls in Skype for Business Server elements removes an important safeguard for detecting a dropped peer and should be done only if necessary. +### -Force -Default: True +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -412,20 +431,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipResponseCodeTranslationRulesList -A list of SIP response code translation rules that apply to response codes received from a PSTN gateway, IP-PBX or SBC at the service provider. -These rules allow the administrator to map SIP response codes with values between 400 and 699 received over a trunk to new values more consistent with Skype for Business Server. +### -ForwardAnonymousCallGatewayPAI -You can create this list and corresponding rules directly with this cmdlet. -However, we recommend that you create the SIP response code translation rules by calling the `New-CsSipResponseCodeTranslationRule` cmdlet. -That cmdlet will create the rule and assign it to the trunk configuration with the matching scope. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +If an anonymous call is forwarded to an outgoing PSTN call, this parameter indicates whether the incoming P-Asserted-Identity (PAI) header at the Gateway call will be preserved in the PSTN call. The default value is **False** ($False). + +**Notes:** +- `EnablePAIPAssthrough` is deprecated in favor of `ForwardAnonymousCallGatewayPAI`. This change is made by installing KB5016483. +- When `ForwardAnonymousCallGatewayPAI` is used, `ForwardPAI` must be set to **True**. ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -434,28 +453,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SRTPMode -The value of this parameter determines the level of support for SRTP to protect media traffic between the Mediation Server and the PSTN gateway, IP-PBX, or SBC at the service provider. -For media bypass cases, this value must be compatible with the EncryptionLevel setting in the media configuration. -Media configuration is set by using the `New-CsMediaConfiguration` cmdlet and the `Set-CsMediaConfiguration` cmdlet. - -Valid values: - -- Required: SRTP encryption must be used. -- Optional: SRTP will be used if the service provider supports it. -- NotSupported: SRTP encryption is not supported and therefore will not be used. - -Note: SRTPMode is used only if the gateway is configured to use Transport Layer Security (TLS). -If the gateway is configured with Transmission Control Protocol (TCP) as the transport, SRTPMode is internally set to NotSupported. +### -ForwardCallHistory -Default: Required +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Indicates whether call history information will be forwarded through the trunk. +The default value is False ($False). ```yaml -Type: SRTPMode +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -464,14 +472,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -ForwardPAI + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether the P-Asserted-Identity (PAI) header will be forwarded along with the call. +The PAI header provides a way to verify the identity of the caller. +The default value is False ($False). ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -480,49 +492,58 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier that includes the scope of the trunk configuration. +Trunk configurations can exist at the Global scope, the Site scope, or at the Service scope for a PSTN Gateway service. +For example, site:Redmond (for site) or PstnGateway:Redmond.litwareinc.com (for service). ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +This parameter requires an object of type Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TrunkConfiguration, which can be retrieved by calling the `Get-CsTrunkConfiguration` cmdlet. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Enable3pccRefer -Indicates whether the 3pcc protocol can be used to allow transferred calls to bypass the hosted site. -3pcc is also known as "third party control" and occurs when a third-party is used to connect a pair of callers (for example, an operator placing a call from person A to person B). -The REFER method is a standard SIP method which indicates that the recipient should contact a third-party by using information supplied by the sender. -The default value is False ($False). +### -MaxEarlyDialogs + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The maximum number of forked responses a PSTN gateway, IP-PBX, or SBC at the service provider can receive to an Invite that it sent to the Mediation Server. + +Default: 20 ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -531,17 +552,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableFastFailoverTimer -When set to True, outbound calls that are not answered by the gateway within 10 seconds will be routed to the next available trunk; if there are no additional trunks then the call will automatically be dropped. -In an organization with slow networks and gateway responses, that could potentially result in calls being dropped unnecessarily. +### -NetworkSiteID -The default value is True. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Site ID of the network site associated with the collection of trunk configuration settings. +If the EnableLocationRestriction property is set to True then location-based voice routing through this trunk will be managed by using the settings configured for the specified site. +Network site IDs can be retrieved by using this command: + +`Get-CsNetworkSite | Select NetworkSiteID` ```yaml -Type: Boolean +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -550,17 +574,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableOnlineVoice -Indicates whether the SIP trunks support online voice. -With online voice, users have an on-premises Lync Server account but have their voicemail hosted by Skype for Business Online. -The default value is False ($False). +### -OutboundCallingNumberTranslationRulesList +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Collection of outbound calling number translation rules assigned to the trunk. +You can retrieve information about the available rules by running this command: + +`Get-CsOutboundCallingNumberTranslationRule` ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -569,16 +595,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableRTPLatching -Indicates whether or not the SIP trunks support RTP latching. -RTP latching is a technology that enables RTP/RTCP connectivity through a NAT (network address translator) device or firewall. -The default value is False ($False). +### -OutboundTranslationRulesList + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A collection of phone number translation rules that apply to calls handled by Outbound Routing (calls routed to PBX or PSTN destinations). + +While this list and these rules can be modified directly with this cmdlet, we recommend that you modify the outbound translation rules with the `Set-CsOutboundTranslationRule` cmdlet. +The `Set-CsOutboundTranslationRule` cmdlet will modify the rule and these modifications will be automatically reflected in the trunk configuration. +To modify the trunk configuration by adding a new outbound translation rule, call the `New-CsOutboundTranslationRule` cmdlet; the new rule will be added to the trunk configuration with the matching scope. + ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -587,15 +618,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ForwardCallHistory -Indicates whether call history information will be forwarded through the trunk. -The default value is False ($False). +### -PstnUsages + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Collection of PSTN usages assigned to the trunk. +You can retrieve information about the available usages by running this command: + +`Get-CsPstnUsage` ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -604,16 +639,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ForwardPAI -Indicates whether the P-Asserted-Identity (PAI) header will be forwarded along with the call. -The PAI header provides a way to verify the identity of the caller. -The default value is False ($False). +### -RemovePlusFromUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Setting this parameter to True will cause the Mediation Server to remove leading plus signs (+) from Uniform Resources Identifiers (URIs) before sending them on to the service provider. + +Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -622,18 +659,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ForwardAnonymousCallGatewayPAI -If an anonymous call is forwarded to an outgoing PSTN call, this parameter indicates whether the incoming P-Asserted-Identity (PAI) header at the Gateway call will be preserved in the PSTN call. The default value is **False** ($False). +### -RTCPActiveCalls + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter determines whether RTCP packets are sent from the PSTN gateway, IP-PBX or SBC at the service provider for active calls. +An active call in this context is a call where media is allowed to flow in at least one direction. +If RTCPActiveCalls is set to True, the Mediation Server or Skype for Business Server client can terminate a call if it does not receive RTCP packets for a period exceeding 30 seconds. + +Note that disabling the checks for received RTCP media for active calls in Skype for Business Server elements removes an important safeguard for detecting a dropped peer and should be done only if necessary. + +Default: True -**Notes:** -- `EnablePAIPAssthrough` is deprecated in favor of `ForwardAnonymousCallGatewayPAI`. This change is made by installing KB5016483. -- When `ForwardAnonymousCallGatewayPAI` is used, `ForwardPAI` must be set to **True**. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -642,17 +684,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutboundCallingNumberTranslationRulesList -Collection of outbound calling number translation rules assigned to the trunk. -You can retrieve information about the available rules by running this command: +### -RTCPCallsOnHold + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter determines whether RTCP packets continue to be sent across the trunk for calls that have been placed on hold and no media packets are expected to flow in either direction. +If Music on Hold is enabled at either the Skype for Business Server client or the trunk, the call will be considered to be active and this property will be ignored. +In these circumstances use the RTCPActiveCalls parameter. + +Note that disabling the checks for received RTCP media for active calls in Skype for Business Server elements removes an important safeguard for detecting a dropped peer and should be done only if necessary. + +Default: True -`Get-CsOutboundCallingNumberTranslationRule` ```yaml -Type: PSListModifier +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -661,17 +709,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PstnUsages -Collection of PSTN usages assigned to the trunk. -You can retrieve information about the available usages by running this command: +### -SipResponseCodeTranslationRulesList + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A list of SIP response code translation rules that apply to response codes received from a PSTN gateway, IP-PBX or SBC at the service provider. +These rules allow the administrator to map SIP response codes with values between 400 and 699 received over a trunk to new values more consistent with Skype for Business Server. + +You can create this list and corresponding rules directly with this cmdlet. +However, we recommend that you create the SIP response code translation rules by calling the `New-CsSipResponseCodeTranslationRule` cmdlet. +That cmdlet will create the rule and assign it to the trunk configuration with the matching scope. -`Get-CsPstnUsage` ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -680,16 +733,30 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableLocationRestriction -When set to True, location-based voice routing will be enabled for calls passing through the SIP trunks managed by the specified collection of SIP trunk configuration settings. -With location-based voice routing, the locations of both the user making the call and the user receiving the call are taken into account when calls are routed. -If this property is set to True (the default value is False) then you should also set the NetworkSiteId property. +### -SRTPMode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The value of this parameter determines the level of support for SRTP to protect media traffic between the Mediation Server and the PSTN gateway, IP-PBX, or SBC at the service provider. +For media bypass cases, this value must be compatible with the EncryptionLevel setting in the media configuration. +Media configuration is set by using the `New-CsMediaConfiguration` cmdlet and the `Set-CsMediaConfiguration` cmdlet. + +Valid values: + +- Required: SRTP encryption must be used. +- Optional: SRTP will be used if the service provider supports it. +- NotSupported: SRTP encryption is not supported and therefore will not be used. + +Note: SRTPMode is used only if the gateway is configured to use Transport Layer Security (TLS). +If the gateway is configured with Transmission Control Protocol (TCP) as the transport, SRTPMode is internally set to NotSupported. + +Default: Required + ```yaml -Type: Boolean +Type: SRTPMode Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -698,18 +765,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NetworkSiteID -Site ID of the network site associated with the collection of trunk configuration settings. -If the EnableLocationRestriction property is set to True then location-based voice routing through this trunk will be managed by using the settings configured for the specified site. -Network site IDs can be retrieved by using this command: +### -Confirm -`Get-CsNetworkSite | Select NetworkSiteID` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -718,36 +783,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AcceptGatewayPAIForOutboundCalls -Set this parameter to True ($true) to modify the trunk configuration to display forwarded number for different trunks. -This parameter was introduced in the January 2019 cumulative update, for more information see [Incorrect caller ID is shown on the Skype for Business client in a call-forwarding scenario](https://support.microsoft.com/help/4458692/incorrect-caller-id-shown-on-the-skype-for-business-client-in-a-call) +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named -Default value: False +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.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TrunkConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TrunkConfiguration + Accepts pipelined input of trunk configuration objects. ## OUTPUTS -### +### None This cmdlet does not return a value; it modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TrunkConfiguration. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsTrustedApplication.md b/skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplication.md similarity index 86% rename from skype/skype-ps/skype/Set-CsTrustedApplication.md rename to skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplication.md index 5decd88312..3b79a8117e 100644 --- a/skype/skype-ps/skype/Set-CsTrustedApplication.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cstrustedapplication applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsTrustedApplication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cstrustedapplication +schema: 2.0.0 +title: Set-CsTrustedApplication --- # Set-CsTrustedApplication @@ -38,7 +39,7 @@ While this prefix is part of the Identity, it's not required when you specify th ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsTrustedApplication -Identity TrustPool.litwareinc.com/tapp2 -Port 6200 ``` @@ -51,15 +52,35 @@ We then include the Port parameter, giving it a value of 6200 to modify that val ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The unique identifier of the trusted application you want to modify. Identity values must be entered in the format \/\, where pool FQDN is the FQDN of the pool on which the application resides, and application ID is the name of the application. ```yaml Type: ExternalApplicationIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -69,13 +90,15 @@ Accept wildcard characters: False ``` ### -Port + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The port number on which the application will run. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -84,14 +107,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -101,29 +126,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -137,13 +148,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Xds.DisplayTrustedApplication object. +### Microsoft.Rtc.Management.Xds.DisplayTrustedApplication + Accepts pipelined input of trusted application objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.Xds.DisplayTrustedApplication. diff --git a/skype/skype-ps/skype/Set-CsTrustedApplicationEndpoint.md b/skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplicationEndpoint.md similarity index 79% rename from skype/skype-ps/skype/Set-CsTrustedApplicationEndpoint.md rename to skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplicationEndpoint.md index 505d5b29a7..ed9e10f0e2 100644 --- a/skype/skype-ps/skype/Set-CsTrustedApplicationEndpoint.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplicationEndpoint.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cstrustedapplicationendpoint applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsTrustedApplicationEndpoint -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cstrustedapplicationendpoint +schema: 2.0.0 +title: Set-CsTrustedApplicationEndpoint --- # Set-CsTrustedApplicationEndpoint @@ -35,7 +36,7 @@ This cmdlet modifies an existing endpoint contact object in Active Directory Dom ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsTrustedApplicationEndpoint -Identity "sip:endpoint1@litwareinc.com" -DisplayName "Endpoint 1" ``` @@ -45,7 +46,7 @@ Notice that the Identity value begins with the string sip: followed by the SIP a The next parameter, DisplayName, is given a value of "Endpoint 1", which changes the display name of the contact to that value. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsTrustedApplicationEndpoint -Identity "Endpoint 1" | Set-CsTrustedApplicationEndpoint -DisplayNumber "(425)555-1212" ``` @@ -58,30 +59,16 @@ This object is then piped to the `Set-CsTrustedApplicationEndpoint` cmdlet, whic ## PARAMETERS -### -Identity -The Identity (the distinguished name) or the SIP address of the application endpoint to be modified. - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -DisplayName -Required: True -Position: 1 -Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -DisplayName The display name of the endpoint contact object. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -91,13 +78,15 @@ Accept wildcard characters: False ``` ### -DisplayNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The telephone number of the contact as it will appear in the Address Book. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -107,6 +96,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether the contact is enabled for Skype for Business Server. Default: True @@ -116,7 +108,6 @@ Default: True Type: Boolean Parameter Sets: (All) Aliases: CsEnabled -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -126,6 +117,9 @@ Accept wildcard characters: False ``` ### -EnabledForFederation + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether federated users have access to this contact. Default: False @@ -133,8 +127,7 @@ Default: False ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -144,6 +137,9 @@ Accept wildcard characters: False ``` ### -EnterpriseVoiceEnabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether the contact is enabled for Enterprise Voice. Default: True @@ -151,8 +147,7 @@ Default: True ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -161,15 +156,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LineURI -The phone number of the contact. -Must be in the format TEL:\, for example TEL:+14255551212. +### -ExchangeArchivingPolicy + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates where the contact's instant messaging sessions are archived. +Allowed values are: + +* Uninitialized +* UseLyncArchivingPolicy +* ArchivingToExchange +* NoArchiving ```yaml -Type: String +Type: ExchangeArchivingPolicyOptionsEnum Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -178,16 +180,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PrimaryLanguage -The primary language used for the trusted application. -The language must be configured using a valid language code, such as en-US (U.S. -English), fr-FR (French), etc. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Identity (the distinguished name) or the SIP address of the application endpoint to be modified. + +```yaml +Type: UserIdParameter +Parameter Sets: (All) +Aliases: + +Required: True +Position: 1 +Default value: None +Accept pipeline input: True (ByPropertyName, ByValue) +Accept wildcard characters: False +``` + +### -LineURI + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The phone number of the contact. +Must be in the format TEL:\, for example TEL:+14255551212. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -196,16 +217,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SecondaryLanguages -A collection of languages that can also be used for trusted applications. -Values must be configured as a comma-separated values list of language codes. -For example, the following syntax sets French Canadian and French as secondary languages: `-SecondaryLanguages "fr-CA","fr-FR"`. +### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Including this parameter will cause the cmdlet to not only modify the contact object but will return the new object as output. ```yaml -Type: Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.String] +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -214,15 +235,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipAddress -You cannot modify the SIP address of a contact. -The SIP address is assigned when the application endpoint is created. +### -PrimaryLanguage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The primary language used for the trusted application. +The language must be configured using a valid language code, such as en-US (U.S. +English), fr-FR (French), etc. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -231,14 +255,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Type -This parameter is not used with this cmdlet. +### -SecondaryLanguages + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A collection of languages that can also be used for trusted applications. +Values must be configured as a comma-separated values list of language codes. +For example, the following syntax sets French Canadian and French as secondary languages: `-SecondaryLanguages "fr-CA","fr-FR"`. ```yaml -Type: String +Type: Microsoft.Rtc.Management.ADConnect.Core.MultiValuedProperty`1[System.String] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -247,14 +275,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Including this parameter will cause the cmdlet to not only modify the contact object but will return the new object as output. +### -SipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +You cannot modify the SIP address of a contact. +The SIP address is assigned when the application endpoint is created. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -263,14 +294,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Type + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not used with this cmdlet. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -280,13 +313,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -295,20 +330,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExchangeArchivingPolicy -Indicates where the contact's instant messaging sessions are archived. -Allowed values are: +### -WhatIf -* Uninitialized -* UseLyncArchivingPolicy -* ArchivingToExchange -* NoArchiving +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: ExchangeArchivingPolicyOptionsEnum +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -322,13 +353,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact object. +### Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact + Accepts pipelined input of trusted application endpoint objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.ADConnect.Schema.OCSADApplicationContact. diff --git a/skype/skype-ps/skype/Set-CsTrustedApplicationPool.md b/skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplicationPool.md similarity index 80% rename from skype/skype-ps/skype/Set-CsTrustedApplicationPool.md rename to skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplicationPool.md index aa6bd0be59..9d043c2295 100644 --- a/skype/skype-ps/skype/Set-CsTrustedApplicationPool.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsTrustedApplicationPool.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cstrustedapplicationpool applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsTrustedApplicationPool -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cstrustedapplicationpool +schema: 2.0.0 +title: Set-CsTrustedApplicationPool --- # Set-CsTrustedApplicationPool @@ -36,7 +37,7 @@ Note that you can't modify the computers that are associated with a pool by usin ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsTrustedApplicationPool -Identity TrustPool.litwareinc.com -OutboundOnly $True ``` @@ -49,30 +50,16 @@ This example modifies the OutboundOnly property of the pool by specifying a valu ## PARAMETERS -### -Identity -The fully qualified domain name (FQDN) or service ID of the pool whose settings you want to modify. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AppSharingPortCount -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AppSharingPortCount The number of ports available in the port range for application sharing connections. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -82,13 +69,15 @@ Accept wildcard characters: False ``` ### -AppSharingPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number of the first port in the port range available for application sharing connections. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -98,13 +87,15 @@ Accept wildcard characters: False ``` ### -AudioPortCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number of ports available in the port range for audio connections. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -114,13 +105,15 @@ Accept wildcard characters: False ``` ### -AudioPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number of the first port in the port range available for audio connections. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -129,15 +122,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The fully qualified domain name (FQDN) or service ID of the pool whose settings you want to modify. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: (All) +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OutboundOnly + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies whether a trusted application can initiate a connection to a server within the pool. Set this value to True if you want all connections to be initiated by the server rather than the application. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -147,6 +178,9 @@ Accept wildcard characters: False ``` ### -Registrar + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The service ID or FQDN of the Registrar service for the pool. Note that changing the Registrar will orphan any contacts attached to the application. Those contacts must be moved by calling the `Move-CsApplicationEndpoint` cmdlet. @@ -154,8 +188,7 @@ Those contacts must be moved by calling the `Move-CsApplicationEndpoint` cmdlet. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -165,6 +198,9 @@ Accept wildcard characters: False ``` ### -RequiresReplication + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether replication is required for this pool. Set this value to False if replication is not required. You would ordinarily set this parameter to False for Microsoft Outlook Web Access and manually-provisioned applications. @@ -173,8 +209,7 @@ You would ordinarily set this parameter to False for Microsoft Outlook Web Acces ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -184,6 +219,9 @@ Accept wildcard characters: False ``` ### -ThrottleAsServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Set this parameter to false to throttle connections between the servers within the pool and trusted applications as clients. This places greater restrictions on the connections than the default True, which throttles connections as servers. Throttling a connection simply places restrictions on the number of transactions that can occur simultaneously. @@ -191,8 +229,7 @@ Throttling a connection simply places restrictions on the number of transactions ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -202,6 +239,9 @@ Accept wildcard characters: False ``` ### -TreatAsAuthenticated + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether authentication is required for trusted applications connecting to servers within the pool. Set this parameter to False if you want to require trusted applications to be authenticated. The default value of True allows the trusted applications to connect under the assumption they've already been authenticated. @@ -209,8 +249,7 @@ The default value of True allows the trusted applications to connect under the a ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -220,13 +259,15 @@ Accept wildcard characters: False ``` ### -VideoPortCount + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number of ports available in the port range for video connections. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -236,13 +277,15 @@ Accept wildcard characters: False ``` ### -VideoPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The number of the first port in the port range available for video connections. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -251,14 +294,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -268,29 +313,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -304,13 +335,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Xds.DisplayExternalServer object. +### Microsoft.Rtc.Management.Xds.DisplayExternalServer + Accepts pipelined input of trusted application pool objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.Xds.DisplayExternalServer. diff --git a/skype/skype-ps/skype/Set-CsUCPhoneConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsUCPhoneConfiguration.md similarity index 84% rename from skype/skype-ps/skype/Set-CsUCPhoneConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUCPhoneConfiguration.md index 5a7d9ecb84..65b2aea786 100644 --- a/skype/skype-ps/skype/Set-CsUCPhoneConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUCPhoneConfiguration.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csucphoneconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsUCPhoneConfiguration -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/set-csucphoneconfiguration +schema: 2.0.0 +title: Set-CsUCPhoneConfiguration --- # Set-CsUCPhoneConfiguration @@ -58,7 +60,7 @@ The following parameters are not applicable to Skype for Business Online: Calend ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsUCPhoneConfiguration -Identity global -SIPSecurityMode "Medium" ``` @@ -66,7 +68,7 @@ Set-CsUCPhoneConfiguration -Identity global -SIPSecurityMode "Medium" The command shown in Example 1 sets the SIP security mode of the global UC phone settings to Medium. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsUCPhoneConfiguration -Identity site:Redmond -PhoneLockTimeout "00:30:00" ``` @@ -75,7 +77,7 @@ Example 2 modifies the UC phone settings configured for the Redmond site. In this case, the PhoneLockTimeout property is set to 30 minutes; this is done by including the PhoneLockTimeout parameter and the parameter value "00:30:00" (00 hours: 30 minutes: 00 seconds). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsUCPhoneConfiguration -Filter "site:*" | Set-CsUCPhoneConfiguration -PhoneLockTimeout "00:30:00" ``` @@ -86,7 +88,7 @@ To do this, the command starts off by calling the `Get-CsUCPhoneConfiguration` c This filtered collection is then piped to the `Set-CsUCPhoneConfiguration` cmdlet, which uses the PhoneLockTimeout parameter and the parameter value "00:30:00" (00 hours: 30 minutes: 00 seconds) to set the phone lock timeout value for each item in the collection to 30 minutes. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsUCPhoneConfiguration | Where-Object {$_.SIPSecurityMode -ne "High"} | Set-CsUCPhoneConfiguration -EnforcePhoneLock $True -PhoneLockTimeout "00:30:00" ``` @@ -96,7 +98,7 @@ To perform this task, the command first uses the `Get-CsUCPhoneConfiguration` cm (Because SIP security can only be set to Low, Medium, or High, this clause will select all the settings where SIPSecurityMode is set to either Low or Medium.) The filtered collection is then piped to the `Set-CsUCPhoneConfiguration` cmdlet, which uses the EnforcePhoneLock and the PhoneLockTimeout parameters to modify the phone locking and phone lock timeout properties. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Get-CsUCPhoneConfiguration | Where-Object {$_.PhoneLockTimeout -lt "00:10:00"} | Set-CsUCPhoneConfiguration -PhoneLockTimeout "00:10:00" ``` @@ -109,89 +111,119 @@ In turn, the filtered collection is piped to the `Set-CsUCPhoneConfiguration` cm ## PARAMETERS -### -Identity -Represents the unique identifier assigned to the collection of UC phone configuration settings. -To refer to the global settings, use this syntax: +### -CalendarPollInterval -`-Identity global` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -To refer to a collection configured at the site scope use syntax similar to this: +Indicates how often the UC device retrieves information from your Outlook calendar. +The value must be specified using the format hours:minutes:seconds; for example, to set the time interval to 1 hour (the maximum allowed interval) use this syntax: `-CalendarPollInterval "01:00:00"`. +The default value is 3 minutes (00:03:00). -`-Identity site:Redmond` -Note that you cannot use wildcard characters when specifying an Identity. +```yaml +Type: TimeSpan +Parameter Sets: (All) +Aliases: -If this parameter is omitted, then the `Set-CsUCPhoneConfiguration` cmdlet will modify the global settings. +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnforcePhoneLock + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Determines whether or not UC phones are automatically locked after the number of minutes specified by PhoneLockTimeout. +The default value is True. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -CalendarPollInterval -Indicates how often the UC device retrieves information from your Outlook calendar. -The value must be specified using the format hours:minutes:seconds; for example, to set the time interval to 1 hour (the maximum allowed interval) use this syntax: `-CalendarPollInterval "01:00:00"`. -The default value is 3 minutes (00:03:00). +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Represents the unique identifier assigned to the collection of UC phone configuration settings. +To refer to the global settings, use this syntax: + +`-Identity global` + +To refer to a collection configured at the site scope use syntax similar to this: + +`-Identity site:Redmond` + +Note that you cannot use wildcard characters when specifying an Identity. + +If this parameter is omitted, then the `Set-CsUCPhoneConfiguration` cmdlet will modify the global settings. ```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EnforcePhoneLock -Determines whether or not UC phones are automatically locked after the number of minutes specified by PhoneLockTimeout. -The default value is True. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` ### -LoggingLevel + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Enables logging on the UC device. Valid values are Off; Low; Medium and High. The default value is Off. @@ -200,8 +232,7 @@ The default value is Off. ```yaml Type: LoggingLevel Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -211,6 +242,9 @@ Accept wildcard characters: False ``` ### -MinPhonePinLength + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the minimum number of digits required for personal identification numbers (PINs). Minimum value: 4 @@ -223,8 +257,7 @@ Default: 6 ```yaml Type: Byte Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -234,6 +267,9 @@ Accept wildcard characters: False ``` ### -PhoneLockTimeout + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the length of time, in minutes, that a UC phone will remain idle before automatically locking. This value must be less than 01:00:00 (1 hour). @@ -243,8 +279,7 @@ The default value is 00:10:00 (10 minutes). ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -254,6 +289,9 @@ Accept wildcard characters: False ``` ### -SIPSecurityMode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the level of security that the server applies to SIP sessions initiated by a UC phone. Valid values are: @@ -270,8 +308,7 @@ The default value is High. ```yaml Type: SIPSecurityMode Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -280,19 +317,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Voice8021p -Specifies the user priority value (the 802.1p value) for voice traffic within the Skype for Business Server deployment. +### -Tenant -This setting is effective only for networks in which switches and bridges are 802.1p-capable. -The minimum value for this property is 0 and the maximum value is 7. -The default value is 0. +> Applicable: Skype for Business Online +{{Fill Tenant Description}} ```yaml -Type: Byte +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -301,19 +335,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VoiceDiffServTag -Specifies the decimal representation of the 6-bit DiffServ Code Point (DSCP) priority marking. -This marking defines the Per Hop Behavior (PHB) for IP packets passed by the UC phones that are managed by this server. +### -Voice8021p -This value must be between 0 and 63, inclusive. -The default value is 40. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the user priority value (the 802.1p value) for voice traffic within the Skype for Business Server deployment. + +This setting is effective only for networks in which switches and bridges are 802.1p-capable. +The minimum value for this property is 0 and the maximum value is 7. +The default value is 0. ```yaml Type: Byte Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -322,32 +358,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - +### -VoiceDiffServTag -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Specifies the decimal representation of the 6-bit DiffServ Code Point (DSCP) priority marking. +This marking defines the Per Hop Behavior (PHB) for IP packets passed by the UC phones that are managed by this server. -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +This value must be between 0 and 63, inclusive. +The default value is 40. ```yaml -Type: SwitchParameter +Type: Byte Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -357,6 +382,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. @@ -364,7 +392,6 @@ Prompts you for confirmation before executing the command. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -373,14 +400,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -{{Fill Tenant Description}} +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: wi Required: False Position: Named @@ -394,13 +424,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.UcPhoneSettings object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.UcPhoneSettings + The `Set-CsUCPhoneConfiguration` cmdlet accepts pipelined instances of the UC phone settings object. ## OUTPUTS -### +### None The `Set-CsUCPhoneConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.UcPhoneSettings object. diff --git a/skype/skype-ps/skype/Set-CsUICulture.md b/skype/skype-ps/SkypeForBusiness/Set-CsUICulture.md similarity index 90% rename from skype/skype-ps/skype/Set-CsUICulture.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUICulture.md index e596429fed..e8725a2449 100644 --- a/skype/skype-ps/skype/Set-CsUICulture.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUICulture.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csuiculture applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsUICulture -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csuiculture +schema: 2.0.0 +title: Set-CsUICulture --- # Set-CsUICulture @@ -44,7 +45,7 @@ For example, if you originally installed an Italian version of Skype for Busines ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsUICulture -Culture "en-US" ``` @@ -54,7 +55,7 @@ English. This is done by using the language code en-US. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsUICulture -Culture "default" ``` @@ -66,6 +67,9 @@ The default value is the culture setting used when you originally installed Skyp ## PARAMETERS ### -Culture + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify the culture used for the Lync Server Management Shell. Set the culture to "en-US" for U.S. English, or set the culture to "default" to use the language used when you originally installed Skype for Business Server. @@ -74,8 +78,7 @@ English, or set the culture to "default" to use the language used when you origi ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -84,14 +87,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -100,14 +105,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -121,13 +128,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsUICulture` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsUICulture` cmdlet does not return any values or objects. Instead, the cmdlet modifies existing instances of the System.Globalization.CultureInfo class. diff --git a/skype/skype-ps/skype/Set-CsUnassignedNumber.md b/skype/skype-ps/SkypeForBusiness/Set-CsUnassignedNumber.md similarity index 86% rename from skype/skype-ps/skype/Set-CsUnassignedNumber.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUnassignedNumber.md index 404dd230e4..b49ce1b45e 100644 --- a/skype/skype-ps/skype/Set-CsUnassignedNumber.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUnassignedNumber.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csunassignednumber applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsUnassignedNumber -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csunassignednumber +schema: 2.0.0 +title: Set-CsUnassignedNumber --- # Set-CsUnassignedNumber @@ -65,7 +66,7 @@ To check Exchange Auto Attendant settings, run the `Get-CsExUmContact` cmdlet. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsUnassignedNumber -Identity UNSet1 -NumberRangeStart "+14255551000" -NumberRangeEnd "+14255551900" ``` @@ -75,7 +76,7 @@ We first pass the Identity parameter the value UNSet1, the name of the unassigne We then use the NumberRangeStart (+14255551000) and NumberRangeEnd (+14255551900) parameters to modify the range of unassigned numbers to which the specified announcement or Auto Attendant will apply. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUnassignedNumber | Where-Object {$_.AnnouncementName -match "Welcome"} | Set-CsUnassignedNumber -AnnouncementService ApplicationServer:redmond.litwareinc.com -AnnouncementName "Help Desk Announcement" ``` @@ -89,47 +90,16 @@ Note that even if the new Announcement has a different name but the same service ## PARAMETERS -### -Identity -The unique name for the range of unassigned numbers being modified. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: RangeSpecification, AnnouncementService, Identity, AutoAttendant -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -A reference to an object containing unassigned number settings. -This object must be of type Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange and can be retrieved by calling the `Get-CsUnassignedNumber` cmdlet. +### -AnnouncementName -```yaml -Type: PSObject -Parameter Sets: RangeSpecification, AnnouncementService, AutoAttendant, Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AnnouncementName The name of the Announcement that will be used to handle calls to this range of numbers. ```yaml Type: String Parameter Sets: AnnouncementService -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 6 @@ -139,13 +109,15 @@ Accept wildcard characters: False ``` ### -AnnouncementService + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The fully qualified domain name (FQDN) or service ID of the Announcement server. ```yaml Type: String Parameter Sets: AnnouncementService Aliases: AnnouncementServerFqdn -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 5 @@ -155,6 +127,9 @@ Accept wildcard characters: False ``` ### -ExUmAutoAttendantPhoneNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The phone number of the Exchange Auto Attendant to route calls in this range to. The Skype for Business Auto Attendant contact must already be set up in order to assign a value to this parameter. @@ -162,8 +137,7 @@ The Skype for Business Auto Attendant contact must already be set up in order to ```yaml Type: String Parameter Sets: AutoAttendant -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 5 @@ -172,28 +146,65 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -NumberRangeStart -The first number in the range of unassigned numbers. -Must be less than or equal to the value supplied for NumberRangeEnd. +### -Force -The number must match the regular expression (tel:)?(\+)?\[1-9\]\d{0,17}(;ext=\[1-9\]\d{0,9})?. -This means the number may begin with the string tel: (if you don't specify that string it will be automatically added for you), a plus sign (+) and a digit 1 through 9. -The phone number can be up to 17 digits and may be followed by an extension in the format ;ext= followed by the extension number. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String -Parameter Sets: RangeSpecification, AnnouncementService, AutoAttendant -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False -Position: 3 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique name for the range of unassigned numbers being modified. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: RangeSpecification, AnnouncementService, Identity, AutoAttendant +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A reference to an object containing unassigned number settings. +This object must be of type Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange and can be retrieved by calling the `Get-CsUnassignedNumber` cmdlet. + +```yaml +Type: PSObject +Parameter Sets: RangeSpecification, AnnouncementService, AutoAttendant, Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -NumberRangeEnd + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The last number in the range of unassigned numbers. Must be greater than or equal to the number supplied for NumberRangeStart. To specify a range of one number, use the same number for the NumberRangeStart and NumberRangeEnd. @@ -205,8 +216,7 @@ The phone number can be up to 17 digits and may be followed by and extension in ```yaml Type: String Parameter Sets: RangeSpecification, AnnouncementService, AutoAttendant -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 4 @@ -215,32 +225,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Priority -It is possible for unassigned number ranges to overlap. -If a number falls within more than one range, the range with the highest priority will take effect. +### -NumberRangeStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The first number in the range of unassigned numbers. +Must be less than or equal to the value supplied for NumberRangeEnd. +The number must match the regular expression (tel:)?(\+)?\[1-9\]\d{0,17}(;ext=\[1-9\]\d{0,9})?. +This means the number may begin with the string tel: (if you don't specify that string it will be automatically added for you), a plus sign (+) and a digit 1 through 9. +The phone number can be up to 17 digits and may be followed by an extension in the format ;ext= followed by the extension number. ```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: RangeSpecification, AnnouncementService, AutoAttendant +Aliases: Required: False -Position: Named +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +It is possible for unassigned number ranges to overlap. +If a number falls within more than one range, the range with the highest priority will take effect. + ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -249,14 +268,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -265,14 +286,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -286,13 +309,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange object. +### Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange + Accepts pipelined input of unassigned number objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.Voice.Helpers.DisplayAnnouncementVacantNumberRange. diff --git a/skype/skype-ps/skype/Set-CsUser.md b/skype/skype-ps/SkypeForBusiness/Set-CsUser.md similarity index 88% rename from skype/skype-ps/skype/Set-CsUser.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUser.md index 6578b30a14..f666ac652a 100644 --- a/skype/skype-ps/skype/Set-CsUser.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUser.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csuser applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsUser -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/set-csuser +schema: 2.0.0 +title: Set-CsUser --- # Set-CsUser @@ -42,7 +44,7 @@ You should not attempt to manually configure these attributes. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ```powershell Set-CsUser -Identity "Pilar Ackerman" -EnterpriseVoiceEnabled $True ``` @@ -52,7 +54,7 @@ In this case, the account is modified to enable Enterprise Voice, the Microsoft This task is carried out by adding the EnterpriseVoiceEnabled parameter, and then setting the parameter value to $True. -### -------------------------- Example 2 -------------------------- +### Example 2 ```powershell Get-CsUser -LdapFilter "Department=Finance" | Set-CsUser -EnterpriseVoiceEnabled $True ``` @@ -61,7 +63,7 @@ In Example 2, all the users in the Finance department have their accounts enable In this command, the `Get-CsUser` cmdlet and the LdapFilter parameter are first used to return a collection of all the users who work in the Finance department. That information is then piped to the `Set-CsUser` cmdlet, which enables Enterprise Voice for each account in the collection. -### -------------------------- Example 3 -------------------------- +### Example 3 ```powershell Set-CsUser -Identity "Pilar Ackerman" -LineUri "tel:+123456789" ``` @@ -71,28 +73,29 @@ In this case, the account is modified to set the phone number assigned to the us ## PARAMETERS -### -Identity -Indicates the Identity of the user account to be modified. -User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). -User Identities can also be referenced by using the user's Active Directory distinguished name. +### -AcpInfo -You can use the asterisk (*) wildcard character when using the display name as the user Identity. -For example, the Identity "Smith" returns all the users who have a display name that ends with the string value " Smith". +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to assign one or more third-party audio conferencing providers to a user. +However, it is recommended that you use the `Set-CsUserAcp` cmdlet to assign Audio conferencing providers. ```yaml -Type: UserIdParameter +Type: AcpInfo Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 1 +Required: False +Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` ### -AudioVideoDisabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether the user is allowed to make audio/visual (A/V) calls by using Skype for Business. If set to True, the user will largely be restricted to sending and receiving instant messages. @@ -104,7 +107,25 @@ You cannot disable A/V communications if a user is currently enabled for remote Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a domain controller to connect to when modifying a user account. +If this parameter is not included then the cmdlet will use the first available domain controller. + +```yaml +Type: Fqdn +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -114,6 +135,9 @@ Accept wildcard characters: False ``` ### -Enabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates whether or not the user has been enabled for Skype for Business Server. If you set this value to False, the user will no longer be able to log on to Skype for Business Server; setting this value to True re-enables the user's logon privileges. @@ -126,7 +150,6 @@ When you run the `Disable-CsUser` cmdlet, all the Skype for Business Server data Type: Boolean Parameter Sets: (All) Aliases: CsEnabled -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -135,15 +158,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to specify a domain controller to connect to when modifying a user account. -If this parameter is not included then the cmdlet will use the first available domain controller. +### -EnterpriseVoiceEnabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether the user has been enabled for Enterprise Voice, which is the Microsoft implementation of Voice over Internet Protocol (VoIP). +With Enterprise Voice, users can make telephone calls using the Internet rather than using the standard telephone network. + +**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. ```yaml -Type: Fqdn +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -152,17 +179,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnterpriseVoiceEnabled -Indicates whether the user has been enabled for Enterprise Voice, which is the Microsoft implementation of Voice over Internet Protocol (VoIP). -With Enterprise Voice, users can make telephone calls using the Internet rather than using the standard telephone network. +### -ExchangeArchivingPolicy -**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates where the user's instant messaging sessions are archived. +Allowed values are: + +Uninitialized + +UseLyncArchivingPolicy + +ArchivingToExchange + +NoArchiving ```yaml -Type: Boolean +Type: ExchangeArchivingPolicyOptionsEnum Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -172,6 +207,9 @@ Accept wildcard characters: False ``` ### -HostedVoiceMail + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, enables a user's voice mail calls to be routed to a hosted version of Microsoft Exchange Server. In addition, setting this option to True enables Skype for Business users to directly place a call to another user's voice mail. @@ -181,7 +219,6 @@ In addition, setting this option to True enables Skype for Business users to dir Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -190,36 +227,33 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LineURI -Phone number to be assigned to the user in Skype for Business Server or Direct Routing phone number to be assigned to a Microsoft Teams user in GCC High and DoD cloud instances only. - -The line Uniform Resource Identifier (URI) must be specified using the E.164 format and the "tel:" prefix, for example: tel:+14255551297. -Any extension number should be added to the end of the line URI, for example: tel:+14255551297;ext=51297. +### -Identity -It is important to note that Skype for Business Server treats tel:+14255551297 and tel:+14255551297;ext=51297 as two different numbers. -If you assign Ken Myer the line URI tel:+14255551297 and later try to assign Pilar Ackerman the line URI tel:+14255551297;ext=51297, that assignment will succeed; the number assigned to Pilar will not -be flagged as a duplicate number. This is due to the fact that, depending on your setup, those two numbers could actually be different. For example, in some organizations dialing 1-425-555-1297 -routes your call to an Exchange Auto Attendant. Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call -directly to the user. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -For Direct Routing phone numbers in GCC High and DoD cloud instances, assigning a base phone number to a user or resource account is not supported if you already have other users or resource accounts assigned phone numbers with the same base phone number and extensions or vice versa. For instance, if you have a user with the assigned phone number +14255551200;ext=123 you can't assign the phone number +14255551200 to another user or resource account or if you have a user or resource account with the assigned phone number +14255551200 you can't assign the phone number +14255551200;ext=123 to another user or resource account. Assigning phone numbers with the same base number but different extensions to users and resource accounts is supported. For instance, you can have a user with +14255551200;ext=123 and another user with +14255551200;ext=124. +Indicates the Identity of the user account to be modified. +User Identities can be specified using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory display name (for example, Ken Myer). +User Identities can also be referenced by using the user's Active Directory distinguished name. -Note: Extension should be part of the E164 Number. For example if you have 5 digit Extensions then the last 5 digits of the E164 Number should always match the 5 digit extension tel:+14255551297;ext=51297 +You can use the asterisk (*) wildcard character when using the display name as the user Identity. +For example, the Identity "Smith" returns all the users who have a display name that ends with the string value " Smith". ```yaml -Type: String +Type: UserIdParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams -Required: False -Position: Named +Required: True +Position: 1 Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` ### -LineServerURI + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The URI of the remote call control telephone gateway assigned to the user. The LineServerUri is the gateway URI, prefaced by "sip:". For example: sip:rccgateway@litwareinc.com @@ -228,7 +262,6 @@ For example: sip:rccgateway@litwareinc.com Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -237,20 +270,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PrivateLine -Phone number for the user's private telephone line. -A private line is a phone number that is not published in Active Directory Domain Services and, as a result, is not readily available to other people. -In addition, this private line bypasses most in-bound call routing rules; for example, a call to a private line will not be forwarded to a person's delegates. -Private lines are often used for personal phone calls or for business calls that should be kept separate from other team members. +### -LineURI -The private line value should be specified using the E.164 format, and be prefixed by the "tel:" prefix. -For example: tel:+14255551297. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + +Phone number to be assigned to the user in Skype for Business Server or Direct Routing phone number to be assigned to a Microsoft Teams user in GCC High and DoD cloud instances only. + +The line Uniform Resource Identifier (URI) must be specified using the E.164 format and the "tel:" prefix, for example: tel:+14255551297. +Any extension number should be added to the end of the line URI, for example: tel:+14255551297;ext=51297. + +It is important to note that Skype for Business Server treats tel:+14255551297 and tel:+14255551297;ext=51297 as two different numbers. +If you assign Ken Myer the line URI tel:+14255551297 and later try to assign Pilar Ackerman the line URI tel:+14255551297;ext=51297, that assignment will succeed; the number assigned to Pilar will not +be flagged as a duplicate number. This is due to the fact that, depending on your setup, those two numbers could actually be different. For example, in some organizations dialing 1-425-555-1297 +routes your call to an Exchange Auto Attendant. Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call +directly to the user. + +For Direct Routing phone numbers in GCC High and DoD cloud instances, assigning a base phone number to a user or resource account is not supported if you already have other users or resource accounts assigned phone numbers with the same base phone number and extensions or vice versa. For instance, if you have a user with the assigned phone number +14255551200;ext=123 you can't assign the phone number +14255551200 to another user or resource account or if you have a user or resource account with the assigned phone number +14255551200 you can't assign the phone number +14255551200;ext=123 to another user or resource account. Assigning phone numbers with the same base number but different extensions to users and resource accounts is supported. For instance, you can have a user with +14255551200;ext=123 and another user with +14255551200;ext=124. + +Note: Extension should be part of the E164 Number. For example if you have 5 digit Extensions then the last 5 digits of the E164 Number should always match the 5 digit extension tel:+14255551297;ext=51297 ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -259,38 +301,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RemoteCallControlTelephonyEnabled -Indicates whether the user has been enabled for remote call control telephony. -When enabled for remote call control, a user can employ Skype for Business to answer phone calls made to his or her desk phone. -Phone calls can also be made using Skype for Business. -These calls all rely on the standard telephone network, also known as the public switched telephone network (PSTN). -To make and receive phone calls over the Internet, the user must be enabled for Enterprise Voice. -For details, see the parameter EnterpriseVoiceEnabled. +### -OnPremLineURI -To be enabled for remote call control, a user must have both a LineUri and a LineServerUri. +> Applicable: Skype for Business Online -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Specifies the phone number assigned to the user if no number is assigned to that user in the Skype for Business hybrid environment. +The line Uniform Resource Identifier (URI) must be specified using the E.164 format and use the "tel:" prefix. +For example: tel:+14255551297. +Any extension number should be added to the end of the line URI, for example: tel:+14255551297;ext=51297. -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Note that Skype for Business treats tel:+14255551297 and tel:+14255551297;ext=51297 as two different numbers. +If you assign Ken Myer the line URI tel:+14255551297 and later try to assign Pilar Ackerman the line URI tel:+14255551297;ext=51297, that assignment will succeed. +Depending on your setup, those two numbers could actually be different. +For example, in some organizations dialing 1-425-555-1297 routes your call to an Exchange Auto Attendant. +Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call directly to the user. -### -SipAddress -Unique identifier (similar to an email address) that allows the user to communicate using SIP devices such as Skype for Business. -The SIP address must use the sip: prefix as well as a valid SIP domain; for example: `-SipAddress sip:kenmyer@litwareinc.com`. +**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. + +**Note**: Using this parameter for Microsoft Teams users in GCC High and DoD cloud instances has been deprecated. Use the -LineURI parameter instead. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -300,6 +333,9 @@ Accept wildcard characters: False ``` ### -PassThru + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to pass a user object through the pipeline that represents the user whose account is being modified. By default, the `Set-CsUser` cmdlet does not pass objects through the pipeline. @@ -309,7 +345,6 @@ By default, the `Set-CsUser` cmdlet does not pass objects through the pipeline. Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -318,14 +353,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -PrivateLine + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Phone number for the user's private telephone line. +A private line is a phone number that is not published in Active Directory Domain Services and, as a result, is not readily available to other people. +In addition, this private line bypasses most in-bound call routing rules; for example, a call to a private line will not be forwarded to a person's delegates. +Private lines are often used for personal phone calls or for business calls that should be kept separate from other team members. + +The private line value should be specified using the E.164 format, and be prefixed by the "tel:" prefix. +For example: tel:+14255551297. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -334,14 +377,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -RemoteCallControlTelephonyEnabled + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates whether the user has been enabled for remote call control telephony. +When enabled for remote call control, a user can employ Skype for Business to answer phone calls made to his or her desk phone. +Phone calls can also be made using Skype for Business. +These calls all rely on the standard telephone network, also known as the public switched telephone network (PSTN). +To make and receive phone calls over the Internet, the user must be enabled for Enterprise Voice. +For details, see the parameter EnterpriseVoiceEnabled. + +To be enabled for remote call control, a user must have both a LineUri and a LineServerUri. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -350,15 +402,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AcpInfo -Enables you to assign one or more third-party audio conferencing providers to a user. -However, it is recommended that you use the `Set-CsUserAcp` cmdlet to assign Audio conferencing providers. +### -SipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier (similar to an email address) that allows the user to communicate using SIP devices such as Skype for Business. +The SIP address must use the sip: prefix as well as a valid SIP domain; for example: `-SipAddress sip:kenmyer@litwareinc.com`. ```yaml -Type: AcpInfo +Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -367,23 +421,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ExchangeArchivingPolicy -Indicates where the user's instant messaging sessions are archived. -Allowed values are: - -Uninitialized - -UseLyncArchivingPolicy +### -Confirm -ArchivingToExchange +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -NoArchiving +Prompts you for confirmation before executing the command. ```yaml -Type: ExchangeArchivingPolicyOptionsEnum +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -392,27 +439,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OnPremLineURI -Specifies the phone number assigned to the user if no number is assigned to that user in the Skype for Business hybrid environment. -The line Uniform Resource Identifier (URI) must be specified using the E.164 format and use the "tel:" prefix. -For example: tel:+14255551297. -Any extension number should be added to the end of the line URI, for example: tel:+14255551297;ext=51297. - -Note that Skype for Business treats tel:+14255551297 and tel:+14255551297;ext=51297 as two different numbers. -If you assign Ken Myer the line URI tel:+14255551297 and later try to assign Pilar Ackerman the line URI tel:+14255551297;ext=51297, that assignment will succeed. -Depending on your setup, those two numbers could actually be different. -For example, in some organizations dialing 1-425-555-1297 routes your call to an Exchange Auto Attendant. -Conversely, dialing just the extension (51297) or using Skype for Business to dial the number 1-425-555-1297 extension 51297 will route your call directly to the user. +### -WhatIf -**Note**: Using this parameter for Microsoft Teams users in commercial and GCC cloud instances has been deprecated. Use the new [Set-CsPhoneNumberAssignment](/powershell/module/teams/set-csphonenumberassignment) cmdlet instead. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -**Note**: Using this parameter for Microsoft Teams users in GCC High and DoD cloud instances has been deprecated. Use the -LineURI parameter instead. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: wi Required: False Position: Named @@ -426,14 +462,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -String or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.Stringor Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. The `Set-CsUser` cmdlet accepts a pipelined string value representing the Identity of a user account that has been enabled for Skype for Business Server. The cmdlet also accepts pipelined instances of the Active Directory user object. ## OUTPUTS -### +### None The `Set-CsUser` cmdlet does not return any objects. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsUserAcp.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserAcp.md similarity index 84% rename from skype/skype-ps/skype/Set-CsUserAcp.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUserAcp.md index e79059fc9a..a64d95d181 100644 --- a/skype/skype-ps/skype/Set-CsUserAcp.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserAcp.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csuseracp applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsUserAcp -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/set-csuseracp +schema: 2.0.0 +title: Set-CsUserAcp --- # Set-CsUserAcp @@ -51,7 +53,7 @@ If a match is not found, then a new provider will be added to Ken Myer's user ac ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsUserAcp -Identity "Ken Myer" -TollNumber "14255551298" -ParticipantPassCode 13761 -Domain "fabrikam.com" -Name "Fabrikam ACP" ``` @@ -61,7 +63,7 @@ To do this, the Identity parameter is used to indicate the user account to be mo In addition, the required parameters TollNumber, ParticipantPassCode, Domain and Name are included, along with the appropriate parameter values. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsUser -LdapFilter "Department=Finance" | Set-CsUserAcp -TollNumber "14255551298" -ParticipantPassCode 13761 -Domain "fabrikam.com" -Name "Fabrikam ACP" ``` @@ -71,7 +73,7 @@ To do this, the command first uses the `Get-CsUser` cmdlet and the LdapFilter (w This collection is then piped to the `Set-CsUserAcp` cmdlet, which assigns the same audio conferencing provider (Fabrikam ACP) to each user in the collection. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Set-CsUserAcp -Identity "Ken Myer" -TollNumber "14255551298" -ParticipantPassCode 13761 -Domain "fabrikam.com" -Name "Fabrikam ACP" -TollFreeNumbers "18005551010", "18005551020" ``` @@ -83,7 +85,34 @@ To assign these two values, include the TollFreeNumbers parameter followed by th ## PARAMETERS +### -Domain + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Domain name of the audio conferencing provider. +For example: + +`-Domain "fabrikam.com"` + +The domain name will be given to you by the audio conferencing provider. + + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the Identity of the user account to be modified. You can specify a user's identity using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer) and 4) the user's Active Directory Domain Services display name (for example, Ken Myer). User identities can also be referenced by using the user's Active Directory distinguished name. @@ -95,8 +124,7 @@ For example, the Identity "* Smith" returns all the users with a display name th ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -105,22 +133,20 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Domain -Domain name of the audio conferencing provider. -For example: +### -IsDefault -`-Domain "fabrikam.com"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -The domain name will be given to you by the audio conferencing provider. +Indicates whether or not this is the default audio conferencing provider for the user. +Each user can only have one default provider. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -128,6 +154,9 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the audio conferencing provider. For example: @@ -137,8 +166,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -148,6 +176,9 @@ Accept wildcard characters: False ``` ### -ParticipantPasscode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Passcode required when connecting to a conference by using the audio conferencing provider. For example: @@ -157,8 +188,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -167,36 +197,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TollNumber -Non-toll-free phone number used for audio conferences. -For example: - -`-TollNumber "14255551298"` - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +### -PassThru -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -### -IsDefault -Indicates whether or not this is the default audio conferencing provider for the user. -Each user can only have one default provider. +Enables you to pass an object through the pipeline that represents the user whose account properties are being configured. +The PassThru parameter is required in such cases because, by default, the `Set-CsUserAcp` cmdlet does not pass objects through the pipeline. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -206,6 +218,9 @@ Accept wildcard characters: False ``` ### -TollFreeNumbers + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + Collection of toll-free phone number used for audio conferences. For example: @@ -219,8 +234,7 @@ To add multiple toll-free numbers, separate the individual numbers by using comm ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -229,37 +243,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Url -Web URL for the audio conferencing provider; for example: +### -TollNumber -`-Url "https://acp.fabrikam.com"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 -The web URL enables audio conferencing providers to point users to a webpage containing additional dial-in phone numbers, as well as information about the services offered by the audio conferencing provider. +Non-toll-free phone number used for audio conferences. +For example: + +`-TollNumber "14255551298"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PassThru -Enables you to pass an object through the pipeline that represents the user whose account properties are being configured. -The PassThru parameter is required in such cases because, by default, the `Set-CsUserAcp` cmdlet does not pass objects through the pipeline. +### -Url + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Web URL for the audio conferencing provider; for example: + +`-Url "https://acp.fabrikam.com"` + +The web URL enables audio conferencing providers to point users to a webpage containing additional dial-in phone numbers, as well as information about the services offered by the audio conferencing provider. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -268,15 +288,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -285,15 +307,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Online, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -307,15 +331,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -String or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.Stringor Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. The `Set-CsUserAcp` cmdlet accepts a pipelined string value representing the Identity of a user account that has been enabled for Skype for Business Server. The cmdlet also accepts pipelined instances of the Active Directory user object. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Set-CsUserCallForwardingSettings.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserCallForwardingSettings.md similarity index 92% rename from skype/skype-ps/skype/Set-CsUserCallForwardingSettings.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUserCallForwardingSettings.md index 1c371c4113..2c97601843 100644 --- a/skype/skype-ps/skype/Set-CsUserCallForwardingSettings.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserCallForwardingSettings.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csusercallforwardingsettings applicable: Skype for Business Server 2019 -title: Set-CsUserCallForwardingSettings -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csusercallforwardingsettings +schema: 2.0.0 +title: Set-CsUserCallForwardingSettings --- # Set-CsUserCallForwardingSettings @@ -84,23 +85,10 @@ This example sends unanswered calls to voicemail after 30 seconds. ## PARAMETERS -### -Confirm -Prompts you for confirmation before running the cmdlet. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2019CU1 +### -DelegateRingWaitTime -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2019CU1 -### -DelegateRingWaitTime Specifies the time, in seconds, to wait before ringing delegates. Acceptable inputs: 0, 5, 10, 15. The parameter DelegateWaitRingTime needs to be explicitly set to a positive value to allow call forwarding to delegates. @@ -108,7 +96,6 @@ Specifies the time, in seconds, to wait before ringing delegates. Acceptable inp Type: Int32 Parameter Sets: EnableForwarding Aliases: -Applicable: Skype for Business Server 2019CU1 Required: False Position: Named @@ -118,13 +105,15 @@ Accept wildcard characters: False ``` ### -Delegates + +> Applicable: Skype for Business Server 2019CU1 + Specifies the list of delegates that calls will be forwarded to. This parameter can only be used with EnableForwarding and EnableSimulRing parameters. ```yaml Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: EnableForwarding, EnableSimulRing Aliases: -Applicable: Skype for Business Server 2019CU1 Required: False Position: Named @@ -134,13 +123,15 @@ Accept wildcard characters: False ``` ### -DisableForwarding + +> Applicable: Skype for Business Server 2019CU1 + This is a switch parameter that disables forwarding. Cannot be used with the EnableSimulRing and EnableForwarding parameters. ```yaml Type: SwitchParameter Parameter Sets: DisableForwarding Aliases: -Applicable: Skype for Business Server 2019CU1 Required: True Position: Named @@ -150,13 +141,15 @@ Accept wildcard characters: False ``` ### -EnableForwarding + +> Applicable: Skype for Business Server 2019CU1 + Enables forwarding to the specified destination. Cannot be used with the EnableSimulRing and DisableForwarding parameters. ```yaml Type: String Parameter Sets: EnableForwarding Aliases: -Applicable: Skype for Business Server 2019CU1 Required: True Position: Named @@ -166,6 +159,9 @@ Accept wildcard characters: False ``` ### -EnableSimulRing + +> Applicable: Skype for Business Server 2019CU1 + This is a switch parameter that enables forwarding to the specified destination. Cannot be used along with the DisableForwarding and EnableForwarding parameters. SimulRingDestination can be a phone number, delegates, or team call group. Acceptable input formats: "\", Team, Delegates. @@ -173,7 +169,6 @@ This is a switch parameter that enables forwarding to the specified destination. Type: String Parameter Sets: EnableSimulRing Aliases: -Applicable: Skype for Business Server 2019CU1 Required: True Position: Named @@ -183,13 +178,15 @@ Accept wildcard characters: False ``` ### -SettingsActiveWorkHours + +> Applicable: Skype for Business Server 2019CU1 + Switch parameter that specifies that settings should apply during work hours defined in Outlook. When this is not specified, settings apply all the time by default. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2019CU1 Required: False Position: Named @@ -199,13 +196,15 @@ Accept wildcard characters: False ``` ### -Team + +> Applicable: Skype for Business Server 2019CU1 + Specifies list of team members that calls will be forwarded to. The add and remove switches will add and remove specified users from the Team Members list. The replace parameter will set the list to the specified list, wiping out the previous list. Add and remove can be used together, but neither of them can be used along with replace. Acceptable input formats for add/remove/replace list: The inputs can be a single user address (in one of the below formats), or a comma separated list of user addresses, in the 4 standard formats that Identity parameter accepts. ```yaml Type: System.Management.Automation.PSListModifier`1[System.String] Parameter Sets: EnableSimulRing Aliases: -Applicable: Skype for Business Server 2019CU1 Required: False Position: Named @@ -215,13 +214,15 @@ Accept wildcard characters: False ``` ### -TeamDelegateRingWaitTime + +> Applicable: Skype for Business Server 2019CU1 + Specifies the time, in seconds, to wait before ringing team members. ```yaml Type: Int32 Parameter Sets: EnableSimulRing Aliases: -Applicable: Skype for Business Server 2019CU1 Required: False Position: Named @@ -231,13 +232,15 @@ Accept wildcard characters: False ``` ### -UnansweredToOther + +> Applicable: Skype for Business Server 2019CU1 + Specifies that unanswered calls will be send to other user or phone number. ```yaml Type: String Parameter Sets: DisableForwarding, EnableSimulRing Aliases: -Applicable: Skype for Business Server 2019CU1 Required: False Position: Named @@ -247,13 +250,15 @@ Accept wildcard characters: False ``` ### -UnansweredToVoicemail + +> Applicable: Skype for Business Server 2019CU1 + Specifies that unanswered calls will be send to voicemail. ```yaml Type: SwitchParameter Parameter Sets: DisableForwarding, EnableSimulRing Aliases: -Applicable: Skype for Business Server 2019CU1 Required: False Position: Named @@ -263,13 +268,15 @@ Accept wildcard characters: False ``` ### -UnansweredWaitTime + +> Applicable: Skype for Business Server 2019CU1 + Specifies the time, in seconds, to wait before send unanswered calls to voicemail. ```yaml Type: Int32 Parameter Sets: DisableForwarding, EnableSimulRing Aliases: -Applicable: Skype for Business Server 2019CU1 Required: False Position: Named @@ -279,13 +286,15 @@ Accept wildcard characters: False ``` ### -User + +> Applicable: Skype for Business Server 2019CU1 + Specifies the SIP address of the user whose call forwarding settings will be modified. ```yaml Type: String Parameter Sets: (All) Aliases: DisplayName, SipAddress, Identity -Applicable: Skype for Business Server 2019CU1 Required: True Position: 0 @@ -294,6 +303,24 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Skype for Business Server 2019CU1 + +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 +``` + ### CommonParameters 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). diff --git a/skype/skype-ps/skype/Set-CsUserDatabaseState.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserDatabaseState.md similarity index 86% rename from skype/skype-ps/skype/Set-CsUserDatabaseState.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUserDatabaseState.md index 457fd92a5b..3c682cfdbd 100644 --- a/skype/skype-ps/skype/Set-CsUserDatabaseState.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserDatabaseState.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csuserdatabasestate applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsUserDatabaseState -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csuserdatabasestate +schema: 2.0.0 +title: Set-CsUserDatabaseState --- # Set-CsUserDatabaseState @@ -44,7 +45,7 @@ However, to run the `Set-CsUserDatabaseState` cmdlet remotely you will need to m ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsUserDatabaseState -Identity "UserDatabase:atl-sql-001.litwareinc.com" -Online $False ``` @@ -53,7 +54,7 @@ The command shown in Example 1 takes the user database UserDatabase:atl-sql-001. This is done by setting the Online property to $False. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsUserDatabaseState -RegistrarPool atl-cs-001.litwareinc.com -Online $False ``` @@ -61,7 +62,7 @@ Set-CsUserDatabaseState -RegistrarPool atl-cs-001.litwareinc.com -Online $False In Example 2, all the user databases on the Registrar pool `atl-cs-001.litwareinc.com` are taken offline. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsUserDatabaseState | Where-Object {$_.Online -eq $False} | ForEach-Object {Set-CsUserDatabaseState -Identity $_.Identity -Online $True} ``` @@ -76,7 +77,28 @@ That is because the latter cmdlet cannot directly accept pipelined information. ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier of the user database whose online status is to be modified. For example: @@ -88,8 +110,7 @@ You cannot use both Identity and RegistrarPool in the same command, nor can you ```yaml Type: String Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -99,14 +120,16 @@ Accept wildcard characters: False ``` ### -Online + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True ($True), makes a database available online. When set to False ($False), takes a database offline. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 2 @@ -116,6 +139,9 @@ Accept wildcard characters: False ``` ### -RegistrarPool + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the Registrar pool hosting the user databases whose online status is to be modified. For example: @@ -127,8 +153,7 @@ You cannot use both -Identity and -RegistrarPool in the same command, nor can yo ```yaml Type: Fqdn Parameter Sets: RegistrarPool -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -137,14 +162,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -154,29 +181,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -190,14 +203,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -String. +### System.String The `Set-CsUserDatabaseState` cmdlet accepts a string value representing the Identity of the user database to be updated. ## OUTPUTS -### -None. +### None Instead, the `Set-CsUserDatabaseState` cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.UserStoreState object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsUserDelegates.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserDelegates.md similarity index 99% rename from skype/skype-ps/skype/Set-CsUserDelegates.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUserDelegates.md index 51ab7a0a53..9494402d24 100644 --- a/skype/skype-ps/skype/Set-CsUserDelegates.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserDelegates.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csuserdelegates applicable: Skype for Business Server 2019 -title: Set-CsUserDelegates -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csuserdelegates +schema: 2.0.0 +title: Set-CsUserDelegates --- # Set-CsUserDelegates @@ -36,21 +37,6 @@ This cmdlet modifies the specified user's delegation settings, returns an 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: None -Accept pipeline input: False -Accept wildcard characters: False -``` - ### -Delegates Specifies list of delegates. The add and remove switches will add and remove specified users from the delegates list. The replace parameter will set the list to the specified list, wiping out the previous list. Add and remove can be used together, but neither of them can be used along with replace. Acceptable input formats for add/remove/replace list: The inputs can be a single user address (in one of the below formats), or a comma separated list of user addresses, in the 4 standard formats that Identity parameter accepts. @@ -96,6 +82,21 @@ 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 +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/skype/skype-ps/skype/Set-CsUserPstnSettings.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserPstnSettings.md similarity index 91% rename from skype/skype-ps/skype/Set-CsUserPstnSettings.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUserPstnSettings.md index 92e36241ea..c636f59240 100644 --- a/skype/skype-ps/skype/Set-CsUserPstnSettings.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserPstnSettings.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csuserpstnsettings applicable: Skype for Business Online -title: Set-CsUserPstnSettings -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/set-csuserpstnsettings +schema: 2.0.0 +title: Set-CsUserPstnSettings --- # Set-CsUserPstnSettings @@ -34,7 +36,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsUserPstnSettings -Identity jphillips@contoso.com -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" -AllowInternationalCalls $true ``` @@ -44,30 +46,10 @@ This example modifies the specified user's PSTN settings to allow international ## PARAMETERS -### -Identity -Specifies the identity of the target user. -Acceptable values include: - -Example: jphillips@contoso.com - -Example: sip:jphillips@contoso.com - -Example: 98403f08-577c-46dd-851a-f0460a13b03d - -```yaml -Type: UserIdParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +### -AllowInternationalCalls -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Online -### -AllowInternationalCalls If set to $true, the user is enabled for international calls. If $false, international calls are not enabled. The default is $false. @@ -75,8 +57,7 @@ The default is $false. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -85,14 +66,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -The Confirm switch causes the command to pause processing and requires confirmation to proceed. +### -HybridPSTNSite + +> Applicable: Skype for Business Online + +Specifies the identity (name) of the hybrid public switched telephone network (PSTN) site that provides PSTN services for the user. +Set HybridPSTNSite to $null to revert to the default PSTN site. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -101,24 +85,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HybridPSTNSite -Specifies the identity (name) of the hybrid public switched telephone network (PSTN) site that provides PSTN services for the user. -Set HybridPSTNSite to $null to revert to the default PSTN site. +### -Identity + +> Applicable: Skype for Business Online + +Specifies the identity of the target user. +Acceptable values include: + +Example: jphillips@contoso.com + +Example: sip:jphillips@contoso.com + +Example: 98403f08-577c-46dd-851a-f0460a13b03d ```yaml -Type: String +Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Specifies the global unique identifier (GUID) of the Skype for Business Online tenant account on which the cmdlet will operate. For example: `-Tenant "38aad667-af54-4397-aaa7-e94c79ec2308"`. @@ -131,8 +126,25 @@ The Tenant parameter is primarily for use in a hybrid deployment. ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Online + +The Confirm switch causes the command to pause processing and requires confirmation to proceed. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -142,6 +154,9 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. @@ -149,7 +164,6 @@ By using this switch, you can view what changes would occur without having to co Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named @@ -163,12 +177,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.UserPstnSettings The `Set-CsUserPstnSettings` cmdlet returns instances of the UserPstnSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsUserReplicatorConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserReplicatorConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Set-CsUserReplicatorConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUserReplicatorConfiguration.md index 55e92367ce..36be8c72e1 100644 --- a/skype/skype-ps/skype/Set-CsUserReplicatorConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserReplicatorConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csuserreplicatorconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsUserReplicatorConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csuserreplicatorconfiguration +schema: 2.0.0 +title: Set-CsUserReplicatorConfiguration --- # Set-CsUserReplicatorConfiguration @@ -59,7 +60,7 @@ You can use this cmdlet to add or remove domains from the list of domains the Us ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsUserReplicatorConfiguration -Identity global -ReplicationCycleInterval "00:05:00" ``` @@ -67,7 +68,7 @@ Set-CsUserReplicatorConfiguration -Identity global -ReplicationCycleInterval "00 Example 1 sets the value of the ReplicationCycleInterval of the global User Replicator settings to five minutes (00 hours: 05 minutes: 00 seconds). -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Set-CsUserReplicatorConfiguration -Identity global -ADDomainNamingContextList $Null ``` @@ -77,7 +78,7 @@ This task is carried out by including the ADDomainNamingContextList parameter an By setting this value to null the User Replicator will automatically discover and synchronize with all the available domains. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Set-CsUserReplicatorConfiguration -Identity global -ADDomainNamingContextList @{Add="dc=fabrikam,dc=com"} ``` @@ -93,7 +94,7 @@ When the AdDomainNamingContextList property is set to anything but a null value, This will be the case even if there are other domains in the deployment. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Set-CsUserReplicatorConfiguration -Identity global -ADDomainNamingContextList @{Remove="dc=fabrikam,dc=com"} ``` @@ -104,56 +105,60 @@ To do this the syntax `@{Remove=}` is used, along with the distinguished name (D ## PARAMETERS -### -Identity -Unique identifier of the User Replicator configuration settings to be modified. -To modify the global settings, use this syntax: +### -ADDomainNamingContextList -`-Identity global` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Distinguished names of the Active Directory domains that the User Replicator must synchronize with. +For example, to add a domain to the list use syntax similar to this: + +`-ADDomainNamingContextList @{Add="dc=fabrikam,dc=com"}` + +If you set this property to a null value the User Replicator will discover and synchronize with all available domains. +If this property is not null then the User Replicator will only synchronize with the domains specified in the ADDomainNamingContextList. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSListModifier +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -DomainControllerList + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +List of domain controllers to be used for user replication. +Typically the user replicator service is able to identify domain controllers by using the DsGetDcName Windows API. +Because of this, it is recommended that you consult with Microsoft support personnel before manually selecting domain controllers by using this parameter. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSListModifier +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -ADDomainNamingContextList -Distinguished names of the Active Directory domains that the User Replicator must synchronize with. -For example, to add a domain to the list use syntax similar to this: +### -Force -`-ADDomainNamingContextList @{Add="dc=fabrikam,dc=com"}` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -If you set this property to a null value the User Replicator will discover and synchronize with all available domains. -If this property is not null then the User Replicator will only synchronize with the domains specified in the ADDomainNamingContextList. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSListModifier +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,51 +167,61 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReplicationCycleInterval -Represents the amount of time that the User Replicator waits before checking for user account updates in AD DS. -The replication cycle interval can be any time value between 1 second and 23 hours, 59 minutes, and 59 seconds; the default value is 1 minute. -The interval must be expressed using the format hours:minutes:seconds. -For example, this syntax sets to time interval to one hour and 15 minutes: +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier of the User Replicator configuration settings to be modified. +To modify the global settings, use this syntax: + +`-Identity global` -`-ReplicationCycleInterval 01:15:00` ```yaml -Type: TimeSpan -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -ReplicationCycleInterval + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Represents the amount of time that the User Replicator waits before checking for user account updates in AD DS. +The replication cycle interval can be any time value between 1 second and 23 hours, 59 minutes, and 59 seconds; the default value is 1 minute. +The interval must be expressed using the format hours:minutes:seconds. +For example, this syntax sets to time interval to one hour and 15 minutes: + +`-ReplicationCycleInterval 01:15:00` ```yaml -Type: SwitchParameter +Type: TimeSpan Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -215,14 +230,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -SkipFirstSyncAllowedDowntime + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Indicates how long Skype for Business Server should wait for user data to synchronize before marking the service as started. +The default value is 2 hours (02:00:00), meaning that, after 2 hours, the status of the replication service will changed from Pending to Started. ```yaml -Type: SwitchParameter +Type: TimeSpan Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -231,16 +249,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainControllerList -List of domain controllers to be used for user replication. -Typically the user replicator service is able to identify domain controllers by using the DsGetDcName Windows API. -Because of this, it is recommended that you consult with Microsoft support personnel before manually selecting domain controllers by using this parameter. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: PSListModifier +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -249,15 +267,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkipFirstSyncAllowedDowntime -Indicates how long Skype for Business Server should wait for user data to synchronize before marking the service as started. -The default value is 2 hours (02:00:00), meaning that, after 2 hours, the status of the replication service will changed from Pending to Started. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: TimeSpan +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -271,13 +290,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.UserReplicator.UserReplicatorConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.UserReplicator.UserReplicatorConfiguration + The `Set-CsUserReplicatorConfiguration` cmdlet accepts pipelined input of the User Replicator configuration object. ## OUTPUTS -### +### None The `Set-CsUserReplicatorConfiguration` cmdlet does not return any objects or values. Instead, the cmdlet modifies the global instance (the only such instance) of the Microsoft.Rtc.Management.WritableConfig.Settings.UserReplicator.UserReplicatorConfiguration object. diff --git a/skype/skype-ps/skype/Set-CsUserServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserServer.md similarity index 84% rename from skype/skype-ps/skype/Set-CsUserServer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUserServer.md index 5e4b1ca974..d00ad130f5 100644 --- a/skype/skype-ps/skype/Set-CsUserServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csuserserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsUserServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csuserserver +schema: 2.0.0 +title: Set-CsUserServer --- # Set-CsUserServer @@ -42,7 +43,7 @@ The cmdlet also lets you modify the port used for connections to the Focus Facto ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsUserServer -Identity "UserServer:atl-cs-001.litwareinc.com" -McuFactorySipPort 445 ``` @@ -51,7 +52,7 @@ The command shown in Example 1 changes the McuFactorySipPort for a single User S In this example, the port is changed to 445. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsService -UserServer | ForEach-Object {Set-CsUserServer -Identity $_.Identity -McuFactorySipPort 445} ``` @@ -65,32 +66,29 @@ The data must be piped to the `ForEach-Object` cmdlet because the `Set-CsUserSer ## PARAMETERS -### -Identity -Unique identifier for the User Services pool to be modified. -For example: - -`-Identity "UserServer:atl-cs-001.litwareinc.com"` - -Note that you can leave off the prefix "UserServer:" when specifying a User server. -For example: +### -ConfDirManagementWcfTcpPort -`-Identity "atl-cs-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Windows Communication Foundation (WCF) port used for managing conference directories. +The default value is 9001. ```yaml -Type: XdsGlobalRelativeIdentity +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -ConferenceServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Service ID for the conferencing server associated with the User Services pool. For example: @@ -100,8 +98,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -110,16 +107,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -McuFactorySipPort -Port used for connecting to the Focus Factory (McuFactory). -The Focus Factory allocates media control units (MCUs) in order to add specific media types such as audio to conferences. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: UInt16 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -128,34 +125,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserDatabase -Service ID for the user database associated with the User Services pool. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the User Services pool to be modified. For example: -`-UserDatabase "UserDatabase:atl-cs-001.litwareinc.com"` +`-Identity "UserServer:atl-cs-001.litwareinc.com"` + +Note that you can leave off the prefix "UserServer:" when specifying a User server. +For example: + +`-Identity "atl-cs-001.litwareinc.com"` ```yaml -Type: String +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -McuFactorySipPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Port used for connecting to the Focus Factory (McuFactory). +The Focus Factory allocates media control units (MCUs) in order to add specific media types such as audio to conferences. + ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -164,14 +172,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -UserDatabase + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service ID for the user database associated with the User Services pool. +For example: + +`-UserDatabase "UserDatabase:atl-cs-001.litwareinc.com"` + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -180,14 +194,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -UserPinManagementWcfHttpPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Port used by Windows Communication Foundation (WCF) when managed user PINs. +The default value is 443. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -196,15 +213,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ConfDirManagementWcfTcpPort -Windows Communication Foundation (WCF) port used for managing conference directories. -The default value is 9001. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: UInt16 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -213,15 +231,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserPinManagementWcfHttpPort -Port used by Windows Communication Foundation (WCF) when managed user PINs. -The default value is 443. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: UInt16 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -235,13 +254,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsUserServer` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Set-CsUserServer` cmdlet does not return any objects or values. Instead, the cmdlet modifies existing instances of the Microsoft.Rtc.Management.Xds.DisplayUserServer object. diff --git a/skype/skype-ps/skype/Set-CsUserServicesConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserServicesConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Set-CsUserServicesConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUserServicesConfiguration.md index e84ea92d4a..d051fb0aa9 100644 --- a/skype/skype-ps/skype/Set-CsUserServicesConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserServicesConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csuserservicesconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsUserServicesConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csuserservicesconfiguration +schema: 2.0.0 +title: Set-CsUserServicesConfiguration --- # Set-CsUserServicesConfiguration @@ -50,7 +51,7 @@ The `Set-CsUserServicesConfiguration` cmdlet provides a way for administrators t ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsUserServicesConfiguration -Identity site:Redmond -AnonymousUserGracePeriod "00:30:00" ``` @@ -59,7 +60,7 @@ The command shown in Example 1 modifies the User Services configuration settings In this example, the AnonymousUserGracePeriod is set to 30 minutes (00 hours: 30 minutes: 00 seconds). -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsUserServicesConfiguration -Identity site:Redmond -MaintenanceTimeOfDay "13:30" ``` @@ -69,7 +70,7 @@ This is done by using the MaintenanceTimeOfDay parameter and the parameter value That sets the maintenance time of day to 1:30 PM (13 hours and 30 minutes on a 24-hour clock). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsUserServicesConfiguration -Filter "service:*" | Set-CsUserServicesConfiguration -MaxContacts 300 ``` @@ -79,7 +80,7 @@ To carry out this task, the command first uses the `Get-CsUserServicesConfigurat This filtered collection is then passed to the `Set-CsUserServicesConfiguration` cmdlet, which takes each item in the collection and sets the MaxContacts property to 300. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Get-CsUserServicesConfiguration | Where-Object {$_.MaxContacts -gt 300} | Set-CsUserServicesConfiguration -MaxContacts 300 ``` @@ -93,51 +94,28 @@ In turn, the filtered collection is piped to the `Set-CsUserServicesConfiguratio ## PARAMETERS -### -Identity -Unique identifier for the User Services configuration settings to be modified. -To modify the global settings, use this syntax: - -`-Identity global` - -To modify settings configured at the site scope, use syntax similar to this: - -`-Identity site:Redmond` - -To modify settings at the service level, use syntax like this: +### -AllowNonRoomSystemNotification -`-Identity service:UserServer:atl-cs-001.litwareinc.com` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +PARAMVALUE: $true | $false ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -AnonymousUserGracePeriod -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` - -### -AnonymousUserGracePeriod Represents the amount of time an anonymous (unauthenticated) user can remain in a meeting without an authenticated user being present in that same meeting. For example, if this value is set to 15 minutes an anonymous user can stay in the meeting for, at most, 15 minutes before an authenticated user must join. If an authenticated user does not join before the grace period expires then the anonymous user will be removed from the meeting. @@ -150,8 +128,7 @@ The grace period can be set to any value between 0 second and 1 day; the default ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -161,6 +138,9 @@ Accept wildcard characters: False ``` ### -DeactivationGracePeriod + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum amount of time that a meeting can remain active. This value must be specified using the following format: days.hours:minutes:seconds. For example, to enable a meeting to last for 60 hours you would use this format: 2.12:00:00 (2 days: 12 hours: 00 minutes: 00 seconds.) @@ -171,8 +151,7 @@ The default value is 1 day. ```yaml Type: TimeSpan Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,6 +161,9 @@ Accept wildcard characters: False ``` ### -DefaultSubscriptionExpiration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Subscriptions are created any time a user makes a request for data such as presence information. When the request is made, the user (or, more correctly, the user's client application) can request the length of time that the subscription remains valid before it must be renewed. If no such request is issued, then the subscription is set to the value specified by the DefaultSubscriptionExpiration property. @@ -192,8 +174,25 @@ The default value is 28800 seconds (8 hours). ```yaml Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -202,7 +201,58 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the User Services configuration settings to be modified. +To modify the global settings, use this syntax: + +`-Identity global` + +To modify settings configured at the site scope, use syntax similar to this: + +`-Identity site:Redmond` + +To modify settings at the service level, use syntax like this: + +`-Identity service:UserServer:atl-cs-001.litwareinc.com` + + +```yaml +Type: XdsIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -MaintenanceTimeOfDay + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the time of day when regularly-scheduled database maintenance (such as the purging of outdated records) takes place. This value must be specified as a date-time value; you can use either the 24-hour format (for example, "14:00") or the 12-hour format (for example, "2:00 PM"). @@ -211,8 +261,7 @@ The default value for MaintenanceTimeOfDay is 1:00 AM (01:00:00). ```yaml Type: DateTime Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -222,6 +271,9 @@ Accept wildcard characters: False ``` ### -MaxContacts + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum number of contacts a user can have; the default value is 250. The MaxContacts property represents the absolute maximum number of contacts a user can have. However, you can use the CsClientPolicy cmdlets to limit certain users to a maximum number of contacts lower than the value of MaxContacts. @@ -229,8 +281,7 @@ However, you can use the CsClientPolicy cmdlets to limit certain users to a maxi ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -240,6 +291,9 @@ Accept wildcard characters: False ``` ### -MaxPersonalNotes + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Indicates the maximum number of personal notes that are stored in the user's note history. By default, the last 3 personal notes are maintained in the note history. The maximum number of notes that can be maintained in the history is 10. @@ -247,8 +301,7 @@ The maximum number of notes that can be maintained in the history is 10. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -258,14 +311,16 @@ Accept wildcard characters: False ``` ### -MaxScheduledMeetingsPerOrganizer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum number of meetings that a single user can serve as organizer for at a given time. The default value is 1000; this means that, if a user is already the organizer for 1000 meetings, his or her attempt to schedule a new meeting (meeting number 1001) will fail. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -275,6 +330,9 @@ Accept wildcard characters: False ``` ### -MaxSubscriptionExpiration + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Subscriptions are created any time a user makes a request for data such as presence information. When the request is made, the user (or, more correctly, the user's client application) can request the length of time that the subscription remains valid before it must be renewed. The MaxSubscriptionExpiration property represents the maximum amount of time that clients can be granted. @@ -286,8 +344,7 @@ The default value is 43200 seconds (12 hours). ```yaml Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -297,14 +354,16 @@ Accept wildcard characters: False ``` ### -MaxSubscriptions + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The maximum number of SIP subscribe dialogs a user can have open at any one time. A subscribe dialog represents a request for SIP resources. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -313,32 +372,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SubscribeToCollapsedDG -If set to True (the default value), client applications will be allowed to subscribe to distribution groups that are not currently expanded in the Contacts list. -This enables the client to maintain up-to-minute presence information for each member of the group. -If set to False, client applications will not be allowed to subscribe to "collapsed" groups. +### -MinSubscriptionExpiration -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Subscriptions are created any time a user makes a request for data such as presence information. +When the request is made, the user (or, more correctly, the user's client application) can request the length of time that the subscription remains valid before it must be renewed. +The MinSubscriptionExpiration property represents the minimum amount of time that clients can be granted. +For example, if the minimum time is set to 1200 seconds and a client requests a timeout interval of 200 seconds, the client will be given the minimum allowed expiration period: 1200 seconds. + +The minimum subscription time must be expressed as an integer value between 300 seconds (5 minutes) and 86400 seconds (24 hours), inclusive. +The default value is 1200 seconds (20 minutes). -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: SwitchParameter +Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -347,30 +397,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -PresenceProviders -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Collection of presence providers for the User Service configuration settings. +Presence providers are best added to a collection of User Service configuration settings by using the `New-CsPresenceProvider` cmdlet. ```yaml -Type: SwitchParameter +Type: PSListModifier Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -379,21 +416,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MinSubscriptionExpiration -Subscriptions are created any time a user makes a request for data such as presence information. -When the request is made, the user (or, more correctly, the user's client application) can request the length of time that the subscription remains valid before it must be renewed. -The MinSubscriptionExpiration property represents the minimum amount of time that clients can be granted. -For example, if the minimum time is set to 1200 seconds and a client requests a timeout interval of 200 seconds, the client will be given the minimum allowed expiration period: 1200 seconds. +### -SubscribeToCollapsedDG -The minimum subscription time must be expressed as an integer value between 300 seconds (5 minutes) and 86400 seconds (24 hours), inclusive. -The default value is 1200 seconds (20 minutes). +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +If set to True (the default value), client applications will be allowed to subscribe to distribution groups that are not currently expanded in the Contacts list. +This enables the client to maintain up-to-minute presence information for each member of the group. +If set to False, client applications will not be allowed to subscribe to "collapsed" groups. ```yaml -Type: Int64 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -402,15 +436,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PresenceProviders -Collection of presence providers for the User Service configuration settings. -Presence providers are best added to a collection of User Service configuration settings by using the `New-CsPresenceProvider` cmdlet. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: PSListModifier +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -419,14 +454,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowNonRoomSystemNotification -PARAMVALUE: $true | $false +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -440,13 +477,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.UserServicesSettings object. +### Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.UserServicesSettings + The `Set-CsUserServicesConfiguration` cmdlet accepts pipelined instances of the user services settings object. ## OUTPUTS -### +### None The `Set-CsUserServicesConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Settings.UserServices.UserServicesSettings object. diff --git a/skype/skype-ps/skype/Set-CsUserServicesPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserServicesPolicy.md similarity index 89% rename from skype/skype-ps/skype/Set-CsUserServicesPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUserServicesPolicy.md index b616c7d545..5a38a616ab 100644 --- a/skype/skype-ps/skype/Set-CsUserServicesPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserServicesPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csuserservicespolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsUserServicesPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csuserservicespolicy +schema: 2.0.0 +title: Set-CsUserServicesPolicy --- # Set-CsUserServicesPolicy @@ -56,7 +57,7 @@ The following parameters are not applicable to Skype for Business Online: Force, ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsUserServicesPolicy -Identity "RedmondUserServicesPolicy" -UcsAllowed $False ``` @@ -65,7 +66,7 @@ The command shown in Example 1 disables the use of the Unified Contact Store for This means that users managed by this policy will not have their contacts stored in the Unified Contact Store. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUserServicesPolicy -Filter "site:*" | Set-CsUserServicesPolicy -UcsAllowed $False ``` @@ -77,16 +78,17 @@ This collection is then piped to the `Set-CsUserServicesPolicy` cmdlet, which ta ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. -Suppresses the display of any non-fatal error message that might arise when running the command. +### -EnableAwaySinceIndication + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: $true | $false ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,14 +98,16 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -113,6 +117,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the policy to be modified. To modify the global policy, use this syntax: @@ -134,8 +141,7 @@ If this parameter is not included then the `Set-CsUserServicesPolicy` cmdlet wil ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -145,14 +151,16 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -161,7 +169,31 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -MigrationDelayInDays + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the number of days the system will wait before beginning a migration to or from the unified contact store. +MigrationDelayInDays can be set to any value between 0 and 180, inclusive. +The default value is 0. + + +```yaml +Type: Int32 +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account for which the user services policy being modified. For example: @@ -175,8 +207,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -186,6 +217,9 @@ Accept wildcard characters: False ``` ### -UcsAllowed + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When set to True (the default value) users affected by the policy will automatically be migrated to the unified contact store (assuming that they have an account on Exchange and that they log on using Skype for Business). When set to False, users can be removed from the unified contact store, but only if they are "manually" removed by the `Invoke-CsUcsRollback` cmdlet. @@ -193,8 +227,7 @@ When set to False, users can be removed from the unified contact store, but only ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -203,15 +236,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -220,34 +256,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableAwaySinceIndication -PARAMVALUE: $true | $false - - -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -WhatIf -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -MigrationDelayInDays -Specifies the number of days the system will wait before beginning a migration to or from the unified contact store. -MigrationDelayInDays can be set to any value between 0 and 180, inclusive. -The default value is 0. +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -261,13 +280,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.UserServices.UserServicesPolicy The `Set-CsUserServicesPolicy` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Policy.UserServices.UserServicesPolicy object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsUserServicesPolicy` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Policy.UserServices.UserServicesPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsUserTeamMembers.md b/skype/skype-ps/SkypeForBusiness/Set-CsUserTeamMembers.md similarity index 99% rename from skype/skype-ps/skype/Set-CsUserTeamMembers.md rename to skype/skype-ps/SkypeForBusiness/Set-CsUserTeamMembers.md index ec4147db30..054fb54c27 100644 --- a/skype/skype-ps/skype/Set-CsUserTeamMembers.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsUserTeamMembers.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csuserteammembers applicable: Skype for Business Server 2019 -title: Set-CsUserTeamMembers -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csuserteammembers +schema: 2.0.0 +title: Set-CsUserTeamMembers --- # Set-CsUserTeamMembers @@ -36,21 +37,6 @@ This cmdlet adds two other users to the specified user's team members list, retu ## 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 Suppresses the display of any non-fatal error message that might occur when running the command. @@ -96,6 +82,21 @@ 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 +``` + ### -WhatIf Shows what would happen if the cmdlet runs. The cmdlet is not run. diff --git a/skype/skype-ps/skype/Set-CsVideoGateway.md b/skype/skype-ps/SkypeForBusiness/Set-CsVideoGateway.md similarity index 88% rename from skype/skype-ps/skype/Set-CsVideoGateway.md rename to skype/skype-ps/SkypeForBusiness/Set-CsVideoGateway.md index 166e402503..c7df66cbd4 100644 --- a/skype/skype-ps/skype/Set-CsVideoGateway.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVideoGateway.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csvideogateway applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsVideoGateway -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csvideogateway +schema: 2.0.0 +title: Set-CsVideoGateway --- # Set-CsVideoGateway @@ -37,7 +38,7 @@ After a Video Gateway has been defined, you can then manage the properties of th ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsVideoGateway -Identity "VideoGateway:atl-cs-001.litwareinc.com" -VideoGatewaySipClientTcpPort 444 ``` @@ -46,7 +47,7 @@ The command shown in Example 1 changes the TCP client port for the video gateway In this example, the port is set to 444. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsService -VideoGateway | Set-CsVideoGateway -VideoGatewaySipClientTcpPort 444 ``` @@ -57,30 +58,16 @@ To do this, the command first uses the `Get-CsService` cmdlet and the -VideoGate ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Force Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -90,6 +77,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Service location of the video gateway being modified. For example: @@ -98,8 +88,7 @@ For example: ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -109,13 +98,15 @@ Accept wildcard characters: False ``` ### -VideoGatewaySipClientTcpPort + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + TCP (Transmission Control Protocol) listening port on the Video Gateway used for SIP trunk communication with a Video Interop Server pool. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -125,13 +116,15 @@ Accept wildcard characters: False ``` ### -VideoGatewaySipClientTlsPort + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + TLS (Transport Layer Security) listening port on the Video Gateway used for SIP trunk communication with a Video Interop Server pool. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,13 +134,33 @@ Accept wildcard characters: False ``` ### -VideoInteropServer + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Service location for the Video Interop Server associated with this Video Gateway. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -157,13 +170,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -177,13 +192,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.Xds.DisplayVideoGateway The `Set-CsVideoGateway` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.Xds.DisplayVideoGateway object. ## OUTPUTS -### -None. +### None The `Set-CsVideoGateway` cmdlet does not return any objects or values. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsVideoInteropServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServer.md similarity index 87% rename from skype/skype-ps/skype/Set-CsVideoInteropServer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServer.md index 206a48e916..631a1087b6 100644 --- a/skype/skype-ps/skype/Set-CsVideoInteropServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csvideointeropserver applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsVideoInteropServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csvideointeropserver +schema: 2.0.0 +title: Set-CsVideoInteropServer --- # Set-CsVideoInteropServer @@ -44,7 +45,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsVideoInteropServer -Identity "VideoInteropServer:atl-cs-001.litwareinc.com" -SipTrunkTlsPort 444 ``` @@ -52,7 +53,7 @@ Set-CsVideoInteropServer -Identity "VideoInteropServer:atl-cs-001.litwareinc.com This example sets the SIP trunk TLS port for the Video Interop server VideoInteropServer:atl-cs-001.litwareinc.com to port 444. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsService -VideoInteropServer | Set-CsVideoInteropServer -SipTrunkTlsPort 444 ``` @@ -65,6 +66,9 @@ That collection is then piped to the `Set-CsVideoInteropServer` cmdlet, which ch ## PARAMETERS ### -AudioPortCount + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Total number of ports allocated for sending and receiving audio traffic. The actual ports to be opened will start with the value configured for AudioPortStart and continue through the number of ports specified for AudioPortCount. For example, if the AudioPortStart is set to 60000 and the AudioPortCount is set to 100, then ports 60000 through 60099 will be used for audio traffic. @@ -72,8 +76,7 @@ For example, if the AudioPortStart is set to 60000 and the AudioPortCount is set ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -83,14 +86,16 @@ Accept wildcard characters: False ``` ### -AudioPortStart + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + First port in the range of ports allocated for sending and receiving audio traffic. For example: `-AudioPortStart 60000`. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -99,30 +104,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Force Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,14 +123,16 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Service location of the Video Interop Server to be modified. For example: `-Identity "VideoInteropServer:atl-cs-001.litwareinc.com"`. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -149,14 +142,16 @@ Accept wildcard characters: False ``` ### -Registrar + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Service identity of the Registrar associated with the Video Interop Server. For example: `-Registrar "Registrar:atl-cs-001.litwareinc.com"`. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -166,13 +161,15 @@ Accept wildcard characters: False ``` ### -RegistrationTcpPort + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,13 +179,15 @@ Accept wildcard characters: False ``` ### -RegistrationTlsPort + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + This parameter is reserved for internal Microsoft use. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -198,13 +197,15 @@ Accept wildcard characters: False ``` ### -SipTrunkTcpPort + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + TCP (Transmission Control Protocol) listening port on the Video Interop Server used for SIP trunk communication with a Video Gateway. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -214,13 +215,15 @@ Accept wildcard characters: False ``` ### -SipTrunkTlsPort + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + TLS (Transport Layer Security) listening port on the Video Interop Server used for SIP trunk communication with a Video Gateway. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -230,6 +233,9 @@ Accept wildcard characters: False ``` ### -VideoPortCount + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Total number of ports allocated for sending and receiving video traffic. The actual ports to be opened will start with the value configured for VideoPortStart and continue through the number of ports specified for VideoPortCount. For example, if the VideoPortStart is set to 60000 and the VideoPortCount is set to 100, then ports 60000 through 60099 will be used for video traffic. @@ -237,8 +243,7 @@ For example, if the VideoPortStart is set to 60000 and the VideoPortCount is set ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -248,14 +253,34 @@ Accept wildcard characters: False ``` ### -VideoPortStart + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + First port in the range of ports allocated for sending and receiving video traffic. For example: `-AudioPortStart 60000`. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -265,13 +290,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -285,13 +312,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.Xds.DisplayVideoInteropServer The `Set-CsVideoInteropServer` accepts pipelined instances of the Microsoft.Rtc.Management.Xds.DisplayVideoInteropServer object. ## OUTPUTS -### -None. +### None The `Set-CsVideoInteropServer` cmdlet does not return any objects or values. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsVideoInteropServerConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServerConfiguration.md similarity index 86% rename from skype/skype-ps/skype/Set-CsVideoInteropServerConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServerConfiguration.md index 80989a190d..d2a50a004e 100644 --- a/skype/skype-ps/skype/Set-CsVideoInteropServerConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServerConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csvideointeropserverconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsVideoInteropServerConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csvideointeropserverconfiguration +schema: 2.0.0 +title: Set-CsVideoInteropServerConfiguration --- # Set-CsVideoInteropServerConfiguration @@ -53,7 +54,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsVideoInteropServerConfiguration -Identity "site:Redmond" -EnableEnhancedVideoExperience $False ``` @@ -61,7 +62,7 @@ Set-CsVideoInteropServerConfiguration -Identity "site:Redmond" -EnableEnhancedVi This example disables enhanced video experience for the collection of VIS settings assigned to the Redmond site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVideoInteropServerConfiguration | Set-CsVideoInteropServerConfiguration -EnableEnhancedVideoExperience $False ``` @@ -73,30 +74,16 @@ That collection is piped to the `Set-CsVideoInteropServerConfiguration` cmdlet, ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableEnhancedVideoExperience -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableEnhancedVideoExperience When set to True ($True) the single video stream coming from a third party video system will be converted to multiple streams in order to meet the needs of devices using different video resolutions or frame rates. The default value is True ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -106,13 +93,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error messages and completes the cmdlet operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,6 +111,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier for the video server configuration settings to be modified. To modify the global settings, use this syntax: @@ -140,8 +132,7 @@ If this parameter is not included, the `Set-CsVideoInteropServerConfiguration` c ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -151,13 +142,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -166,14 +159,34 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -183,18 +196,20 @@ Accept wildcard characters: False ``` ### CommonParameters -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). +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.Rtc.Management.WritableConfig.Settings.VideoInteropServer.VideoInteropServerConfiguration + The `Set-CsVideoInteropServerConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.VideoInteropServer.VideoInteropServerConfiguration object. ## OUTPUTS -### -None. -The `Set-CsVideoInteropServerConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.VideoInteropServer.VideoInteropServerConfiguration object. +### None ## NOTES diff --git a/skype/skype-ps/skype/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md index 05da2f52c4..98a02cd713 100644 --- a/skype/skype-ps/skype/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVideoInteropServerSyntheticTransactionConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csvideointeropserversynthetictransactionconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsVideoInteropServerSyntheticTransactionConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csvideointeropserversynthetictransactionconfiguration +schema: 2.0.0 +title: Set-CsVideoInteropServerSyntheticTransactionConfiguration --- # Set-CsVideoInteropServerSyntheticTransactionConfiguration @@ -36,7 +37,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsVideoInteropServerSyntheticTransactionConfiguration -Identity Global -WatcherNodeFqdns "watchernode.contoso.com" ``` @@ -46,30 +47,16 @@ This example sets the Global configuration to trust connections from the Watcher ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Force Suppresses the display of any non-fatal error messages and completes the cmdlet operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -79,6 +66,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Unique identity assigned to the VIS configuration when it was created. VIS settings can be configured at the global, site, or service scope (for the VideoInteropServer service only). To refer to the global instance, use this syntax: @@ -92,8 +82,7 @@ Use this syntax to refer to a collection at the site scope: ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -103,13 +92,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,6 +110,9 @@ Accept wildcard characters: False ``` ### -WatcherNodeFqdns + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the URL of the watcher node relevant to the synthetic transaction. For example: `-WatcherNodeFqdns "atl-cs-001.Contoso.com"`. Watcher nodes are computers that periodically use Microsoft System Center Operations Manager and Skype for Business Server synthetic transactions to verify that Skype for Business Server components are working as expected. @@ -132,8 +126,25 @@ To add or remove one or more values without affecting any existing entries, use ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -143,13 +154,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -163,13 +176,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### VideoInteropServerSyntheticTransactionConfiguration Accepts pipelined instances of the VideoInteropServerSyntheticTransactionConfiguration object. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Set-CsVideoTrunkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsVideoTrunkConfiguration.md similarity index 89% rename from skype/skype-ps/skype/Set-CsVideoTrunkConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsVideoTrunkConfiguration.md index 32c668c947..2681ad0bc9 100644 --- a/skype/skype-ps/skype/Set-CsVideoTrunkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVideoTrunkConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csvideotrunkconfiguration applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsVideoTrunkConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csvideotrunkconfiguration +schema: 2.0.0 +title: Set-CsVideoTrunkConfiguration --- # Set-CsVideoTrunkConfiguration @@ -59,7 +60,7 @@ Both the single global collection of settings and any custom settings that you c ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsVideoTrunkConfiguration -Identity "site:Seattle" -EnableSessionTimer $False ``` @@ -67,7 +68,7 @@ Set-CsVideoTrunkConfiguration -Identity "site:Seattle" -EnableSessionTimer $Fals This example disables session timers for the collection of Video Trunk configuration settings assigned to the Seattle site. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVideoTrunkConfiguration | Set-CsVideoTrunkConfiguration -EnableSessionTimer $False ``` @@ -79,31 +80,17 @@ That collection is then piped to the `Set-CsVideoTrunkConfiguration` cmdlet, whi ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -EnableMediaEncryptionForSipOverTls -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -EnableMediaEncryptionForSipOverTls When set to True ($True) it is expected that the Video Gateway or third party video teleconferencing system (VTC) uses TLS to protect SIP signaling and uses SRTP to protect the media traffic. The default value is True ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -113,6 +100,9 @@ Accept wildcard characters: False ``` ### -EnableSessionTimer + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies whether the session timer is enabled. Session timers are used to determine whether a particular session is still active. The default is false ($False). @@ -123,8 +113,7 @@ In such a case, the Video Interop Server will reply to session timer probes from ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,13 +123,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error messages and completes the cmdlet operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -150,6 +141,9 @@ Accept wildcard characters: False ``` ### -ForwardErrorCorrectionType + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the type of Forward Error Correction (FEC) to be used between the Video Interop Server (VIS) and a Video Gateway. The valid settings are: @@ -160,8 +154,7 @@ Cisco: Enables FEC compatible with Cisco Video Gateways, such as Cisco Unified C ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -171,14 +164,16 @@ Accept wildcard characters: False ``` ### -GatewaySendsRtcpForActiveCalls + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + When set to True ($True) it is expected that the Video Gateway or third party video teleconferencing system (VTC) sends RTCP for calls that are enabled for media sending from the Video Gateway or VTC. The default value is True ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -188,14 +183,16 @@ Accept wildcard characters: False ``` ### -GatewaySendsRtcpForCallsOnHold + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + When set to True ($True) it is expected that the Video Gateway or third party video teleconferencing system (VTC) sends RTCP for calls that are disabled for media sending from the Video Gateway or VTC. The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -205,6 +202,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + The Identity parameter specifies the unique identifier for the video trunk configuration to be modified. For example, this syntax creates a new collection of settings assigned to the Redmond site: `-Identity "site:Redmond"`. @@ -215,8 +215,7 @@ If this parameter is not specified, the `Set-CsVideoTrunkConfiguration` cmdlet w ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -226,13 +225,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -241,14 +242,34 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -262,13 +283,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.VideoTrunkConfiguration The `Set-CsVideoTrunkConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.VideoTrunkConfiguration object. ## OUTPUTS -### -None. +### None The `Set-CsVideoTrunkConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.VideoTrunkConfiguration object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsVoiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Set-CsVoiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsVoiceConfiguration.md index 55b566c49c..d8f32ab875 100644 --- a/skype/skype-ps/skype/Set-CsVoiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csvoiceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsVoiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csvoiceconfiguration +schema: 2.0.0 +title: Set-CsVoiceConfiguration --- # Set-CsVoiceConfiguration @@ -48,7 +49,7 @@ To return a list of all the role-based access control (RBAC) roles this cmdlet h ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $a = Get-CsVoiceConfiguration @@ -84,15 +85,35 @@ That one line will accomplish the same task shown in Example 1. ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The scope of this object. The only value possible for this parameter is Global. ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -102,14 +123,16 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A reference to a voice configuration (Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration) object. An object of this type can be retrieved by calling the `Get-CsVoiceConfiguration` cmdlet. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,6 +142,9 @@ Accept wildcard characters: False ``` ### -VoiceTestConfigurations + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A list of all voice test configurations (Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration objects) defined for the Skype for Business Server deployment. You should modify individual voice test configuration objects by using the `Set-CsVoiceTestConfiguration` cmdlet. @@ -128,8 +154,7 @@ That is the recommended way of modifying configurations in this list. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -138,14 +163,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -155,29 +182,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -191,13 +204,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration + The `Set-CsVoiceConfiguration` cmdlet accepts pipelined input of a voice configuration object. ## OUTPUTS -### +### None The `Set-CsVoiceConfiguration` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceConfiguration object. diff --git a/skype/skype-ps/skype/Set-CsVoiceNormalizationRule.md b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceNormalizationRule.md similarity index 83% rename from skype/skype-ps/skype/Set-CsVoiceNormalizationRule.md rename to skype/skype-ps/SkypeForBusiness/Set-CsVoiceNormalizationRule.md index 75e02f9f89..28cf784f1d 100644 --- a/skype/skype-ps/skype/Set-CsVoiceNormalizationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceNormalizationRule.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csvoicenormalizationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsVoiceNormalizationRule -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: rogupta +online version: https://learn.microsoft.com/powershell/module/skype/set-csvoicenormalizationrule +schema: 2.0.0 +title: Set-CsVoiceNormalizationRule --- # Set-CsVoiceNormalizationRule @@ -46,7 +48,7 @@ Rules that are modified by using this cmdlet are part of the dial plan and, in a ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsVoiceNormalizationRule -Identity "site:Redmond/Prefix Redmond" -Description "Add a prefix to all numbers on site Redmond" ``` @@ -54,7 +56,7 @@ Set-CsVoiceNormalizationRule -Identity "site:Redmond/Prefix Redmond" -Descriptio This example sets the description of the rule Prefix Redmond on site Redmond to "Add a prefix to all numbers on site Redmond". -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsVoiceNormalizationRule -Identity global/SeattleFourDigit -Description "Translate an internal four-digit extension" -Translation '+1206556$1' ``` @@ -65,7 +67,7 @@ In addition, a Translation value has been specified that modifies the rule to tr For example, if the existing pattern matched any four-digit number and the number 1234 were entered, this rule would translate that extension to the number +12065561234. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $a = Get-CsVoiceNormalizationRule -Identity global/RedmondFourDigit $a.name = "RedmondRule" @@ -81,90 +83,98 @@ Next, we pass the variable to the Instance parameter of the `Set-CsVoiceNormaliz ## PARAMETERS -### -Identity -A unique identifier for the rule. -The Identity specified must include the scope followed by a slash followed by the name; for example: site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name. +### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A friendly description of the normalization rule. + +Maximum string length: 512 characters. + ```yaml -Type: XdsIdentity +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 1 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. -This object must be of type NormalizationRule and can be retrieved by calling the `Get-CsVoiceNormalizationRule` cmdlet. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -A friendly description of the normalization rule. +### -Identity -Maximum string length: 512 characters. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +A unique identifier for the rule. +The Identity specified must include the scope followed by a slash followed by the name; for example: site:Redmond/Rule1, where site:Redmond is the scope and Rule1 is the name. ```yaml -Type: String +Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IsInternalExtension -If True, the result of applying this rule will be a number internal to the enterprise. -If False, applying the rule results in an external number. -This value is ignored if the value of the OptimizeDeviceDialing property of the associated dial plan is set to False. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +This object must be of type NormalizationRule and can be retrieved by calling the `Get-CsVoiceNormalizationRule` cmdlet. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Priority -The order in which rules are applied. -A number might match more than one rule. -This parameter sets the order in which the rules are tested against the number. +### -IsInternalExtension + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If True, the result of applying this rule will be a number internal to the enterprise. +If False, applying the rule results in an external number. +This value is ignored if the value of the OptimizeDeviceDialing property of the associated dial plan is set to False. ```yaml -Type: Int32 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -174,14 +184,16 @@ Accept wildcard characters: False ``` ### -Pattern + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A regular expression that the dialed number must match in order for this rule to be applied. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -190,15 +202,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Translation -The regular expression pattern that will be applied to the number to convert it to E.164 format. +### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The order in which rules are applied. +A number might match more than one rule. +This parameter sets the order in which the rules are tested against the number. ```yaml -Type: String +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -207,15 +223,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Tenant +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +For internal Microsoft usage. ```yaml -Type: SwitchParameter +Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -224,15 +241,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Translation + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The regular expression pattern that will be applied to the number to convert it to E.164 format. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -242,6 +261,9 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. @@ -249,7 +271,6 @@ Prompts you for confirmation before executing the command. Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -258,14 +279,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -For internal Microsoft usage. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + ```yaml -Type: Guid +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -279,13 +303,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule + The `Set-CsVoiceNormalizationRule` cmdlet accepts pipelined input of voice normalization rule objects. ## OUTPUTS -### +### None The `Set-CsVoiceNormalizationRule` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule object. diff --git a/skype/skype-ps/skype/Set-CsVoicePolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsVoicePolicy.md similarity index 84% rename from skype/skype-ps/skype/Set-CsVoicePolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsVoicePolicy.md index bd2491217f..aee2f11644 100644 --- a/skype/skype-ps/skype/Set-CsVoicePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVoicePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csvoicepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsVoicePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csvoicepolicy +schema: 2.0.0 +title: Set-CsVoicePolicy --- # Set-CsVoicePolicy @@ -53,7 +54,7 @@ Use this cmdlet to change the settings that enable and disable many of these fea ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsVoicePolicy UserVoicePolicy2 -AllowSimulRing $false -PstnUsages @{remove="Local"} ``` @@ -64,7 +65,7 @@ This command also removes "Local" from the list of PSTN usages for this policy. The Identity parameter is a positional parameter, therefore if you put the identity value first in the list of parameters you don't need to explicitly state that it's the Identity.) -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $a = Get-CsPstnUsage @@ -81,48 +82,55 @@ This refers to the Usage property of the PSTN usage settings, which contains the ## PARAMETERS -### -Identity -A unique identifier specifying the scope, and in some cases the name, of the policy. +### -AllowCallForwarding + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If this parameter is set to True, users assigned to this policy can forward calls. +If this parameter is set to False, calls cannot be forwarded. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. -This object must be of type VoicePolicy and can be retrieved by calling the `Get-CsVoicePolicy` cmdlet. +### -AllowPSTNReRouting + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When this parameter is set to True, calls made to internal numbers homed on another pool will be routed through the public switched telephone network (PSTN) when the pool or WAN is unavailable. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowCallForwarding -If this parameter is set to True, users assigned to this policy can forward calls. -If this parameter is set to False, calls cannot be forwarded. +### -AllowSimulRing + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Simultaneous ring is a feature that allows multiple phones to ring when a single number is dialed. +Setting this parameter to True enables simultaneous ring. +If this parameter is set to False, simultaneous ring cannot be configured for any user assigned to this policy. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -131,14 +139,21 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowPSTNReRouting -When this parameter is set to True, calls made to internal numbers homed on another pool will be routed through the public switched telephone network (PSTN) when the pool or WAN is unavailable. +### -CallForwardingSimulRingUsageType + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Provides a way for administrators to manage call forwarding and simultaneous ringing. +Allowed values are: + +* VoicePolicyUsage - The default voice policy usage is used to manage call forwarding and simultaneous ringing on all calls. This is the default value. +* InternalOnly - Call forwarding and simultaneous ringing are limited to calls made from one Lync user to another. +* CustomUsage. A custom PSTN usage will be used to manage call forwarding and simultaneous ringing. This usage must be specified using the CustomCallForwardingSimulRingUsages parameter. ```yaml -Type: Boolean +Type: CallForwardingSimulRingUsageType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -147,16 +162,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowSimulRing -Simultaneous ring is a feature that allows multiple phones to ring when a single number is dialed. -Setting this parameter to True enables simultaneous ring. -If this parameter is set to False, simultaneous ring cannot be configured for any user assigned to this policy. +### -CustomCallForwardingSimulRingUsages + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Custom PSTN usage used to manage call forwarding and simultaneous ringing. +To add a custom usage to voice policy use syntax similar to this: + +`-CustomCallForwardingSimulRingUsages @{Add="RedmondPstnUsage"}` + +To remove a custom usage, use this syntax: + +`-CustomCallForwardingSimulRingUsages @{Remove="RedmondPstnUsage"}` + +Note that the usage must exist before it can be used with the CustomCallForwardingSimulRingUsages parameter. ```yaml -Type: Boolean +Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -166,6 +190,9 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A description of the voice policy. Maximum length: 1040 characters. @@ -173,8 +200,25 @@ Maximum length: 1040 characters. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -EnableBusyOptions + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +{{Fill EnableBusyOptions Description}} + +```yaml +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -184,6 +228,9 @@ Accept wildcard characters: False ``` ### -EnableBWPolicyOverride + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Policies can be set to limit bandwidth and set various other properties relating to network configuration. Setting this parameter to True will allow override of these policies. In other words, if this parameter is set to True no bandwidth checks will be made, calls will go through regardless of the call admission control (CAC) settings. @@ -191,8 +238,7 @@ In other words, if this parameter is set to True no bandwidth checks will be mad ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -202,6 +248,9 @@ Accept wildcard characters: False ``` ### -EnableCallPark + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Call Park application allows a call to be held, or parked, at a certain number within a range of numbers for later retrieval. Setting this parameter to True enables this application for users assigned this policy. If this parameter is set to False, users assigned to this policy cannot park calls that have been dialed to their phone number. @@ -209,8 +258,7 @@ If this parameter is set to False, users assigned to this policy cannot park cal ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -220,14 +268,16 @@ Accept wildcard characters: False ``` ### -EnableCallTransfer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether calls can be transferred to another number. If this parameter is set to True, calls can be transferred; if the parameter is set to False, calls cannot be transferred. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -237,6 +287,9 @@ Accept wildcard characters: False ``` ### -EnableDelegation + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Call delegation allows a user to answer calls for another user or make calls on the other user's behalf. For example, a manager can set up call delegation so that all incoming calls ring both his or her phone and the phone of an administrator. Setting this parameter to True allows users with this policy to set up call delegation. @@ -245,8 +298,7 @@ Setting this parameter to False disables call delegation. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -256,6 +308,9 @@ Accept wildcard characters: False ``` ### -EnableMaliciousCallTracing + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Malicious call tracing is a standard that is in place to trace calls that a user designates as malicious. These calls can be traced even if caller ID is blocked. The trace is available only to the proper authorities and not to the user. @@ -264,8 +319,7 @@ Setting this property to True enables the ability to set a trace on malicious ca ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -275,6 +329,9 @@ Accept wildcard characters: False ``` ### -EnableTeamCall + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Team Call allows a user to designate a group of other users whose phones will ring when that user's number is called. This feature is useful in teams where, for example, anyone from a team can answer incoming calls from customers. Setting this parameter to True enables this feature. @@ -282,8 +339,7 @@ Setting this parameter to True enables this feature. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -292,32 +348,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Name -A friendly name describing this policy. +### -EnableVoicemailEscapeTimer -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +When set to True, calls to an unanswered mobile device will be routed to the organization voicemail instead of the mobile device provider's voicemail. +If a call is answered "too soon" (that is, before the value configured for the PSTNVoicemailEscapeTimer property has elapsed) it will be assumed that the mobile device is not available and the call will be routed to the organization voicemail. -### -PreventPSTNTollBypass -PSTN tolls are more commonly known as long-distance charges. -Organizations can sometimes bypass these tolls by implementing a Voice over Internet Protocol (VoIP) solution that enables branch offices to connect via network calls. -Setting this parameter to True will send calls through PSTN and incur charges rather than going through the network and bypassing the tolls. +The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -326,20 +369,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PstnUsages -A list of PSTN usages available to this policy. -The PSTN usage ties a voice policy to a phone route. +### -Force -Any string value can be placed into this list, as long as the value exists in the current global list of PSTN usages. -(Duplicate strings are not allowed; all string must be unique.) The list of PSTN usages can be retrieved by calling the `Get-CsPstnUsage` cmdlet. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Keep in mind that if you use this parameter to remove all PSTN usages from the policy, users granted this policy will not be able to make outbound PSTN calls. +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: PSListModifier +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -348,46 +387,53 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A unique identifier specifying the scope, and in some cases the name, of the policy. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +This object must be of type VoicePolicy and can be retrieved by calling the `Get-CsVoicePolicy` cmdlet. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A friendly name describing this policy. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -396,19 +442,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CallForwardingSimulRingUsageType -Provides a way for administrators to manage call forwarding and simultaneous ringing. -Allowed values are: +### -PreventPSTNTollBypass -* VoicePolicyUsage - The default voice policy usage is used to manage call forwarding and simultaneous ringing on all calls. This is the default value. -* InternalOnly - Call forwarding and simultaneous ringing are limited to calls made from one Lync user to another. -* CustomUsage. A custom PSTN usage will be used to manage call forwarding and simultaneous ringing. This usage must be specified using the CustomCallForwardingSimulRingUsages parameter. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +PSTN tolls are more commonly known as long-distance charges. +Organizations can sometimes bypass these tolls by implementing a Voice over Internet Protocol (VoIP) solution that enables branch offices to connect via network calls. +Setting this parameter to True will send calls through PSTN and incur charges rather than going through the network and bypassing the tolls. ```yaml -Type: CallForwardingSimulRingUsageType +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -417,23 +462,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CustomCallForwardingSimulRingUsages -Custom PSTN usage used to manage call forwarding and simultaneous ringing. -To add a custom usage to voice policy use syntax similar to this: +### -PstnUsages -`-CustomCallForwardingSimulRingUsages @{Add="RedmondPstnUsage"}` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -To remove a custom usage, use this syntax: +A list of PSTN usages available to this policy. +The PSTN usage ties a voice policy to a phone route. -`-CustomCallForwardingSimulRingUsages @{Remove="RedmondPstnUsage"}` +Any string value can be placed into this list, as long as the value exists in the current global list of PSTN usages. +(Duplicate strings are not allowed; all string must be unique.) The list of PSTN usages can be retrieved by calling the `Get-CsPstnUsage` cmdlet. -Note that the usage must exist before it can be used with the CustomCallForwardingSimulRingUsages parameter. +Keep in mind that if you use this parameter to remove all PSTN usages from the policy, users granted this policy will not be able to make outbound PSTN calls. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -442,26 +486,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableVoicemailEscapeTimer -When set to True, calls to an unanswered mobile device will be routed to the organization voicemail instead of the mobile device provider's voicemail. -If a call is answered "too soon" (that is, before the value configured for the PSTNVoicemailEscapeTimer property has elapsed) it will be assumed that the mobile device is not available and the call will be routed to the organization voicemail. - -The default value is False. +### -PSTNVoicemailEscapeTimer -```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -PSTNVoicemailEscapeTimer Amount of time (in milliseconds) used to determine whether or not a call has been answered "too soon." If a response is received within this time interval Skype for Business Server will assume that the mobile device is not available and automatically switch the call to the organization's voicemail. If no response is received before the time interval is reached then the call will be allowed to proceed. @@ -471,8 +499,7 @@ The default value is 1500 milliseconds. ```yaml Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -482,6 +509,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Globally unique identifier (GUID) of the Skype for Business Online tenant account whose voice policy is to be modified. For example: @@ -495,8 +525,7 @@ You can return the tenant ID for each of your tenants by running this command: ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -506,6 +535,9 @@ Accept wildcard characters: False ``` ### -VoiceDeploymentMode + +> Applicable: Lync Server 2013 + Allowed values are: * OnPrem @@ -518,8 +550,7 @@ The default value is OnPrem. ```yaml Type: VoiceDeploymentMode Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013 +Aliases: Required: False Position: Named @@ -528,14 +559,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableBusyOptions -{{Fill EnableBusyOptions Description}} +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Boolean +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -549,13 +600,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoicePolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoicePolicy + Accepts pipelined input of voice policy objects. ## OUTPUTS -### +### None This cmdlet does not return a value or object. Instead, it configures instances of the Microsoft.Rtc.Management.WritableConfig.Voice.VoicePolicy object. diff --git a/skype/skype-ps/skype/Set-CsVoiceRoute.md b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceRoute.md similarity index 86% rename from skype/skype-ps/skype/Set-CsVoiceRoute.md rename to skype/skype-ps/SkypeForBusiness/Set-CsVoiceRoute.md index 7a66daa439..ee996fc344 100644 --- a/skype/skype-ps/skype/Set-CsVoiceRoute.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceRoute.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csvoiceroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsVoiceRoute -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csvoiceroute +schema: 2.0.0 +title: Set-CsVoiceRoute --- # Set-CsVoiceRoute @@ -44,7 +45,7 @@ A voice route includes a regular expression that identifies which phone numbers ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsVoiceRoute -Identity Route1 -Description "Test Route" ``` @@ -52,7 +53,7 @@ Set-CsVoiceRoute -Identity Route1 -Description "Test Route" This command sets the Description of the Route1 voice route to "Test Route." -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsVoiceRoute -Identity Route1 -PstnUsages @{add="Long Distance"} ``` @@ -61,7 +62,7 @@ The command in this example modifies the voice route with the identity Route1 to Long Distance must be in the list of global PSTN usages (which can be retrieved with a call to the `Get-CsPstnUsage` cmdlet). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $x = (Get-CsPstnUsage).Usage @@ -78,7 +79,7 @@ Notice the value passed to the PstnUsages parameter: @{replace=$x}. This value says to replace everything in the PstnUsages list for this route with the contents of $x, which contain the PSTN usages list retrieved in line 1. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` $x = Get-CsVoiceRoute -Identity Route1 @@ -96,7 +97,7 @@ Next, the Name property of that object is assigned the string value "RouteA". Finally, the object (contained in the variable $x) is passed to the Instance parameter of the `Set-CsVoiceRoute` cmdlet to make the change. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` $y = Get-CsVoiceRoute -Identity Route1 @@ -114,56 +115,59 @@ Finally, we call the `Set-CsVoiceRoute` cmdlet, passing the Instance parameter t ## PARAMETERS -### -Identity -The unique identity of the voice route. -(If the route name contains a space, such as Test Route, you must enclose the full string in parentheses.) +### -AlternateCallerId + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If the SuppressCallerId parameter is set to True, the value of the AlternateCallerId parameter will be displayed to receiving parties rather than the caller's actual number. +This number should be a valid number and could be used to represent a division within an organization, such as Support or Human Resources. + +If the SuppressCallerId parameter is set to False, the AlternateCallerId parameter is ignored. + +This value must match the regular expression (\+)?\[1-9\]\d*(;ext=\[1-9\]\d*)?. +In other words, the value can begin with a plus sign (+) but doesn't need to; must consist of any number of digits; and may be followed by an extension that begins with ;ext= followed by any number of digits. +(Note that if you include an extension the string must be placed within double quotes.) ```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. -This object must be of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route and can be retrieved by calling the `Get-CsVoiceRoute` cmdlet. +### -Description + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +A description of what this phone route is for. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -AlternateCallerId -If the SuppressCallerId parameter is set to True, the value of the AlternateCallerId parameter will be displayed to receiving parties rather than the caller's actual number. -This number should be a valid number and could be used to represent a division within an organization, such as Support or Human Resources. +### -Force -If the SuppressCallerId parameter is set to False, the AlternateCallerId parameter is ignored. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -This value must match the regular expression (\+)?\[1-9\]\d*(;ext=\[1-9\]\d*)?. -In other words, the value can begin with a plus sign (+) but doesn't need to; must consist of any number of digits; and may be followed by an extension that begins with ;ext= followed by any number of digits. -(Note that if you include an extension the string must be placed within double quotes.) +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -172,23 +176,49 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Description -A description of what this phone route is for. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identity of the voice route. +(If the route name contains a space, such as Test Route, you must enclose the full string in parentheses.) ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +This object must be of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route and can be retrieved by calling the `Get-CsVoiceRoute` cmdlet. + + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -NumberPattern + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A regular expression that specifies the phone numbers to which this route applies. Numbers matching this pattern will be routed according to the rest of the routing settings. For example, the default number pattern, \[0-9\]{10}, specifies a 10-digit number containing any digits 0 through 9. @@ -196,8 +226,7 @@ For example, the default number pattern, \[0-9\]{10}, specifies a 10-digit numbe ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -207,14 +236,16 @@ Accept wildcard characters: False ``` ### -Priority + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A number could resolve to multiple voice routes. The priority determines the order in which the routes will be applied if more than one route is possible. ```yaml Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -224,6 +255,9 @@ Accept wildcard characters: False ``` ### -PstnGatewayList + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A Mediation Server can be associated with multiple gateways. This parameter contains a list of gateways associated with this voice route. Each member of this list must be the service Identity of the PSTN gateway or Mediation Server. @@ -239,8 +273,7 @@ If you make changes to a voice route and leave the PstnGatewayList list empty, o ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -250,6 +283,9 @@ Accept wildcard characters: False ``` ### -PstnUsages + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A list of PSTN usages (such as Local or Long Distance) that can be applied to this voice route. The PSTN usage must be an existing usage. (PSTN usages can be retrieved by calling the `Get-CsPstnUsage` cmdlet.) @@ -259,8 +295,7 @@ If you make changes to a voice route and leave the PstnUsages list empty, or if ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -270,6 +305,9 @@ Accept wildcard characters: False ``` ### -SuppressCallerId + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Determines whether a caller's ID will be revealed on outbound calls. If this parameter is set to True, caller ID will be suppressed. In place of the actual ID, the value of the AlternateCallerId will be displayed. @@ -278,8 +316,7 @@ When SuppressCallerId is set to True, a value for AlternateCallerId must be supp ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -289,13 +326,15 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -304,30 +343,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -WhatIf -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -WhatIf Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -341,13 +366,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route + The `Set-CsVoiceRoute` cmdlet accepts pipelined input of voice route objects. ## OUTPUTS -### +### None The `Set-CsVoiceRoute` cmdlet does not return a value or object. Instead, the cmdlet configures instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route object. diff --git a/skype/skype-ps/skype/Set-CsVoiceRoutingPolicy.md b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceRoutingPolicy.md similarity index 86% rename from skype/skype-ps/skype/Set-CsVoiceRoutingPolicy.md rename to skype/skype-ps/SkypeForBusiness/Set-CsVoiceRoutingPolicy.md index 1c2aeaffd5..5f5a817587 100644 --- a/skype/skype-ps/skype/Set-CsVoiceRoutingPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceRoutingPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csvoiceroutingpolicy applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsVoiceRoutingPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csvoiceroutingpolicy +schema: 2.0.0 +title: Set-CsVoiceRoutingPolicy --- # Set-CsVoiceRoutingPolicy @@ -45,7 +46,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsVoiceRoutingPolicy -Identity "RedmondVoiceRoutingPolicy" -PstnUsages @{Add="Long Distance"} ``` @@ -53,7 +54,7 @@ Set-CsVoiceRoutingPolicy -Identity "RedmondVoiceRoutingPolicy" -PstnUsages @{Add The command shown in Example 1 adds the PSTN usage "Long Distance" to the per-user voice routing policy RedmondVoiceRoutingPolicy. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsVoiceRoutingPolicy -Identity "RedmondVoiceRoutingPolicy" -PstnUsages @{Remove="Local"} ``` @@ -61,7 +62,7 @@ Set-CsVoiceRoutingPolicy -Identity "RedmondVoiceRoutingPolicy" -PstnUsages @{Rem In Example 2, the PSTN usage "Local" is removed from the per-user voice routing policy RedmondVoiceRoutingPolicy. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVoiceRoutingPolicy | Where-Object {$_.PstnUsages -contains "Local"} | Set-CsVoiceRoutingPolicy -PstnUsages @{Remove="Local"} ``` @@ -74,31 +75,17 @@ Those policies are then piped to the `Set-CsVoiceRoutingPolicy` cmdlet, which de ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Description -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Description Enables administrators to provide explanatory text to accompany a voice routing policy. For example, the Description might include information about the users the policy should be assigned to. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -108,13 +95,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -124,6 +113,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Unique identifier assigned to the policy when it was created. Voice routing policies can be assigned at the global scope or the per-user scope. To refer to the global instance, use this syntax: @@ -140,8 +132,7 @@ If you do not specify an Identity, then the `Set-CsVoiceRoutingPolicy` cmdlet wi ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -151,13 +142,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -167,13 +160,15 @@ Accept wildcard characters: False ``` ### -Name + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A friendly name describing this policy. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -183,6 +178,9 @@ Accept wildcard characters: False ``` ### -PstnUsages + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A list of PSTN usages (such as Local or Long Distance) that can be applied to this voice routing policy. The PSTN usage must be an existing usage. (PSTN usages can be retrieved by calling the `Get-CsPstnUsage` cmdlet.) @@ -190,8 +188,25 @@ The PSTN usage must be an existing usage. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -201,13 +216,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -221,13 +238,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceRoutingPolicy The `Set-CsVoiceRoutingPolicy` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceRoutingPolicy object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsVoiceRoutingPolicy` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoiceRoutingPolicy object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsVoiceTestConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceTestConfiguration.md similarity index 83% rename from skype/skype-ps/skype/Set-CsVoiceTestConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsVoiceTestConfiguration.md index 56905fbe1a..6ac20e0312 100644 --- a/skype/skype-ps/skype/Set-CsVoiceTestConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVoiceTestConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csvoicetestconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsVoiceTestConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csvoicetestconfiguration +schema: 2.0.0 +title: Set-CsVoiceTestConfiguration --- # Set-CsVoiceTestConfiguration @@ -45,7 +46,7 @@ The configurations modified with this cmdlet are tested using the `Test-CsVoiceT ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsVoiceTestConfiguration -Identity TestConfig1 -DialedNumber 14255551212 ``` @@ -54,7 +55,7 @@ This example sets the dialed number of the voice test configuration for TestConf This is the number that will be checked against the voice policy and route to ensure normalization occurs as expected, as well as to ensure the correct routes and dial plans are being applied. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsVoiceTestConfiguration -Identity TestConfig1 -TargetDialPlan site:Redmond1 -ExpectedTranslatedNumber "+912065551212" ``` @@ -66,43 +67,10 @@ Because a change in dial plan could mean a change in normalization rules, the Ex ## PARAMETERS -### -Identity -A string uniquely identifying the test scenario you want to modify. - -The value of this parameter does not include scope because this object can be created only at the global scope. -Therefore only a name is required. - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Instance -An object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration that contains an existing voice test configuration with the changes you'd like to make to that configuration. -An object of this type can be retrieved by calling the `Get-CsVoiceTestConfiguration` cmdlet. - -```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -DialedNumber -Required: False -Position: Named -Default value: None -Accept pipeline input: True (ByValue) -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -DialedNumber The phone number you want to use to test the policies, usages, and so on. Must be 512 characters or fewer. @@ -110,8 +78,7 @@ Must be 512 characters or fewer. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -121,6 +88,9 @@ Accept wildcard characters: False ``` ### -ExpectedRoute + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name of the voice route expected to be used during the configuration test. If a different route is used, based on the target dial plan and voice policy, the test will fail. You can retrieve available voice routes by calling the `Get-CsVoiceRoute` cmdlet. @@ -130,8 +100,7 @@ Must be 256 characters or fewer. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,6 +110,9 @@ Accept wildcard characters: False ``` ### -ExpectedTranslatedNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The phone number in the format you expect to see it in after translation. This is the value of the DialedNumber parameter after normalization. If you run the `Test-CsVoiceTestConfiguration` cmdlet and the DialedNumber does not result in the value in ExpectedTranslatedNumber, the test will report as Fail. @@ -151,8 +123,7 @@ Must be 512 characters or fewer. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,6 +133,9 @@ Accept wildcard characters: False ``` ### -ExpectedUsage + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name of the PSTN usage expected to be used during the configuration test. If a different PSTN usage is used, based on the target dial plan and voice policy, the test will fail. You can retrieve available usages by calling the `Get-CsPstnUsage` cmdlet. @@ -172,8 +146,25 @@ Must be 256 characters or fewer. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -182,7 +173,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A string uniquely identifying the test scenario you want to modify. + +The value of this parameter does not include scope because this object can be created only at the global scope. +Therefore only a name is required. + +```yaml +Type: XdsGlobalRelativeIdentity +Parameter Sets: Identity +Aliases: + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Instance + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +An object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration that contains an existing voice test configuration with the changes you'd like to make to that configuration. +An object of this type can be retrieved by calling the `Get-CsVoiceTestConfiguration` cmdlet. + +```yaml +Type: PSObject +Parameter Sets: Instance +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: True (ByValue) +Accept wildcard characters: False +``` + ### -TargetDialplan + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Identity of the dial plan to be used for this test. Dial plans can be retrieved by calling the `Get-CsDialPlan` cmdlet. @@ -191,8 +225,7 @@ Must be 40 characters or fewer. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -202,6 +235,9 @@ Accept wildcard characters: False ``` ### -TargetVoicePolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The Identity of the voice policy against which to run this test. Voice policies can be retrieved by calling the `Get-CsVoicePolicy` cmdlet. @@ -211,8 +247,7 @@ Must be 40 characters or fewer. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -221,14 +256,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -238,29 +275,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -274,13 +297,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration + Accepts pipelined input of voice test configuration objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration This cmdlet returns an object of type Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsVoicemailReroutingConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsVoicemailReroutingConfiguration.md similarity index 84% rename from skype/skype-ps/skype/Set-CsVoicemailReroutingConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsVoicemailReroutingConfiguration.md index b20a8c0c9d..c2ca51150a 100644 --- a/skype/skype-ps/skype/Set-CsVoicemailReroutingConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsVoicemailReroutingConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csvoicemailreroutingconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsVoicemailReroutingConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csvoicemailreroutingconfiguration +schema: 2.0.0 +title: Set-CsVoicemailReroutingConfiguration --- # Set-CsVoicemailReroutingConfiguration @@ -44,7 +45,7 @@ Note that these settings are not available unless the Enabled property has been ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsVoicemailReroutingConfiguration -Identity site:Redmond1 -Enabled $True ``` @@ -52,7 +53,7 @@ Set-CsVoicemailReroutingConfiguration -Identity site:Redmond1 -Enabled $True This example enables the voice mail rerouting configuration settings for the site Redmond1. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Set-CsVoicemailReroutingConfiguration -Identity site:Redmond1 -SubscriberAccessNumber "+14255551213" ``` @@ -62,54 +63,56 @@ This example modifies the voice mail rerouting settings that apply to the site R ## PARAMETERS -### -Identity -The unique identifier of the configuration you want to modify. -For this cmdlet the Identity will be either Global or Site:\, where \ is the name of the site to which the settings are applied. +### -AutoAttendantNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Phone number of the Auto Attendant to which the voice mail deposit attempts should be re-routed. + +The number supplied to this parameter must be a LineUri of an existing contact object. + +Value must be a number beginning with a digit 1 through 9, optionally preceded by a plus (+), followed by any number of digits. ```yaml -Type: XdsIdentity -Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +### -Enabled -This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.ExumRouting.VoicemailReroutingConfiguration (which can be retrieved by calling the `Get-CsVoicemailReroutingConfiguration` cmdlet). +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Indicates whether attempts to access voice mail should be re-routed through PSTN when IP connectivity is down. ```yaml -Type: PSObject -Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -AutoAttendantNumber -Phone number of the Auto Attendant to which the voice mail deposit attempts should be re-routed. +### -Force -The number supplied to this parameter must be a LineUri of an existing contact object. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Value must be a number beginning with a digit 1 through 9, optionally preceded by a plus (+), followed by any number of digits. +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -118,50 +121,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Enabled -Indicates whether attempts to access voice mail should be re-routed through PSTN when IP connectivity is down. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The unique identifier of the configuration you want to modify. +For this cmdlet the Identity will be either Global or Site:\, where \ is the name of the site to which the settings are applied. ```yaml -Type: Boolean -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: XdsIdentity +Parameter Sets: Identity +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SubscriberAccessNumber -Subscriber Access number to which the voice mail retrieval attempts should be re-routed. +### -Instance -The number supplied to this parameter must be a LineUri of an existing contact object. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. + +This object must be of type Microsoft.Rtc.Management.WritableConfig.Settings.ExumRouting.VoicemailReroutingConfiguration (which can be retrieved by calling the `Get-CsVoicemailReroutingConfiguration` cmdlet). -Value must be a number beginning with a digit 1 through 9, optionally preceded by a plus (+), followed by any number of digits. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSObject +Parameter Sets: Instance +Aliases: Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -SubscriberAccessNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Subscriber Access number to which the voice mail retrieval attempts should be re-routed. + +The number supplied to this parameter must be a LineUri of an existing contact object. + +Value must be a number beginning with a digit 1 through 9, optionally preceded by a plus (+), followed by any number of digits. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -170,14 +183,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -186,14 +201,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -207,13 +224,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.ExumRouting.VoicemailReroutingConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.ExumRouting.VoicemailReroutingConfiguration + Accepts pipelined input of voice mail rerouting configuration objects. ## OUTPUTS -### +### None This cmdlet does not return a value. It modifies an object of type Microsoft.Rtc.Management.WritableConfig.Settings.ExumRouting.VoicemailReroutingConfiguration. diff --git a/skype/skype-ps/skype/Set-CsWatcherNodeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsWatcherNodeConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Set-CsWatcherNodeConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsWatcherNodeConfiguration.md index 8f943ec290..aab18de104 100644 --- a/skype/skype-ps/skype/Set-CsWatcherNodeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsWatcherNodeConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cswatchernodeconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsWatcherNodeConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cswatchernodeconfiguration +schema: 2.0.0 +title: Set-CsWatcherNodeConfiguration --- # Set-CsWatcherNodeConfiguration @@ -47,7 +48,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $x = New-CsExtendedTest -TestUsers "sip:kenmyer@litwareinc.com", "sip:pilar@litwareinc.com" -Name "Audio Conferencing Test" -TestType "AudioConferencingProvider" @@ -59,7 +60,7 @@ To do this, the first command in the example uses the `New-CsExtendedTest` cmdle In the second command, the `Set-CsWatcherNodeConfiguration` cmdlet adds the new test to the watcher node configuration settings; this is done by using the ExtendedTests parameter and the syntax `@{Add=$x}`. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $x = Get-CsWatcherNodeConfiguration -Identity "atl-cs-001.litwareinc.com" @@ -79,7 +80,7 @@ To remove the second extended test, use the syntax `RemoveAt(1)`. After the object reference has been updated, the final command uses the `Set-CsWatcherNodeConfiguration` cmdlet and the Instance parameter to write the changes made to the object reference back to the actual watcher node settings for the pool `atl-cs-001.litwareinc.com`. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsWatcherNodeConfiguration -Identity "atl-cs-001.litwareinc.com" -ExtendedTests $Null ``` @@ -90,31 +91,17 @@ This task is performed by including the ExtendedTests parameter and the paramete ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. +### -Enabled -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Enabled Enables or disables the watcher node. The default value is True ($True). ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -124,14 +111,16 @@ Accept wildcard characters: False ``` ### -ExtendedTests + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Object reference to one or more instances of the ExtendedTest object. These objects must be created using the `New-CsExtendedTest` cmdlet. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,13 +130,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -157,13 +148,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the pool associated with the watcher node configuration settings. ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: 2 @@ -173,13 +166,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -189,13 +184,15 @@ Accept wildcard characters: False ``` ### -PortNumber + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -205,6 +202,9 @@ Accept wildcard characters: False ``` ### -Tests + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Synthetic transactions to be run by the watcher node. Allowed values are: @@ -256,8 +256,7 @@ To disable all the tests for a watcher node, set the value of the Tests paramete ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -267,6 +266,9 @@ Accept wildcard characters: False ``` ### -TestUsers + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP addresses of the test users employed by the watcher node. To add additional test users to the node use syntax similar to this: @@ -287,8 +289,7 @@ If you have two users and try to remove one of those users (ostensibly leaving t ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -297,15 +298,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseInternalWebUrls -When set to True ($True), instructs the watcher node to use the internal Web URLs rather than the external Web URLs. -This provides a way to way to verify URL validity for users located behind the organization's firewall. +### -UseAutoDiscovery + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True), watcher nodes will use the Autodiscover service locate the target pool. +When set to False (the default value), watcher nodes will use the pool FQDN and SRV records to locate pools. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -314,14 +317,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -UseInternalWebUrls + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True), instructs the watcher node to use the internal Web URLs rather than the external Web URLs. +This provides a way to way to verify URL validity for users located behind the organization's firewall. ```yaml -Type: SwitchParameter +Type: Boolean Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -331,13 +337,15 @@ Accept wildcard characters: False ``` ### -XmppTestReceiverMailAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + XMPP email address to be used when testing the XMPP gateway. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -346,15 +354,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseAutoDiscovery -When set to True ($True), watcher nodes will use the Autodiscover service locate the target pool. -When set to False (the default value), watcher nodes will use the pool FQDN and SRV records to locate pools. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: Boolean +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -368,13 +395,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.TargetPool#Decorated The `Set-CsWatcherNodeConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.TargetPool#Decorated object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsWatcherNodeConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.WatcherNode.TargetPool#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsWebServer.md b/skype/skype-ps/SkypeForBusiness/Set-CsWebServer.md similarity index 79% rename from skype/skype-ps/skype/Set-CsWebServer.md rename to skype/skype-ps/SkypeForBusiness/Set-CsWebServer.md index 5bf3b8c7cc..2eb1bdfa1c 100644 --- a/skype/skype-ps/skype/Set-CsWebServer.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsWebServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cswebserver applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsWebServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cswebserver +schema: 2.0.0 +title: Set-CsWebServer --- # Set-CsWebServer @@ -51,7 +52,7 @@ Port changes like these (and other modifications) can be made using the `Set-CsW ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Set-CsWebServer -Identity "WebServer:atl-cs-001.litwareinc.com" -PrimaryHttpPort 89 ``` @@ -60,7 +61,7 @@ The command shown in Example 1 changes the PrimaryHttpPort for a single Web Serv In this example, the port is changed to port number 89. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Get-CsService -WebServer | ForEach-Object {Set-CsWebServer -Identity $_.Identity -PrimaryHttpPort 89} ``` @@ -74,32 +75,10 @@ The data must be piped to the `ForEach-Object` cmdlet because the `Set-CsWebServ ## PARAMETERS -### -Identity -Unique identifier for the Web Services pool. -For example: - -`-Identity "WebServer:atl-cs-001.litwareinc.com"` - -Note that you can leave off the prefix "WebServer:" when specifying a Web server. -For example: - -`-Identity "atl-cs-001.litwareinc.com"` - - -```yaml -Type: XdsGlobalRelativeIdentity -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AppSharingPortCount -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AppSharingPortCount Total number of ports allocated for application sharing. The actual ports to be opened will start with the value configured for AppSharingPortStart and continue through the number of ports specified for AppSharingPortCount. For example, if the AppSharingPortStart is set to 60000 and the AppSharingPortCount is set to 100 then ports 60000 through 60099 will be used for application sharing. @@ -108,8 +87,7 @@ The default value is 16383. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -119,14 +97,16 @@ Accept wildcard characters: False ``` ### -AppSharingPortStart + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + First port in the range of ports allocated for application sharing. The default value is 49152. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -136,6 +116,9 @@ Accept wildcard characters: False ``` ### -ExternalFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) used by people connecting to the Web Services pool from outside the internal network. For example: @@ -145,8 +128,7 @@ For example: ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -156,14 +138,16 @@ Accept wildcard characters: False ``` ### -ExternalHttpPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port number for external web connections made using the HTTP protocol. The default value is port 8080. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -173,14 +157,16 @@ Accept wildcard characters: False ``` ### -ExternalHttpsPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port number for external web connections made using the HTTPS protocol. The default value is port 4443. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -189,15 +175,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PrimaryHttpPort -Port number for internal web connections made using the HTTP protocol. -The default value is port 80. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: UInt16 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -206,32 +193,45 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PrimaryHttpsPort -Port number for internal web connections made using the HTTPS protocol. -The default value is port 443. +### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Unique identifier for the Web Services pool. +For example: + +`-Identity "WebServer:atl-cs-001.litwareinc.com"` + +Note that you can leave off the prefix "WebServer:" when specifying a Web server. +For example: + +`-Identity "atl-cs-001.litwareinc.com"` + ```yaml -Type: UInt16 +Type: XdsGlobalRelativeIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ReachExternalPsomServerPort -External port number for the Persistent Shared Object Model Protocol, a Microsoft protocol used for conferences. -The default port number is 8061. +### -InternalFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name for the Mobility Services. +The InternalFqdn should only be accessible from inside the organization's firewall. + ```yaml -Type: UInt16 +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -240,15 +240,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReachPrimaryPsomServerPort -Primary port number for the Persistent Shared Object Model (PSOM) Protocol, a Microsoft protocol used for conferences. -The default port number is 8060. +### -McxSipExternalListeningPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +External listening port for the Mobility service. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -257,18 +258,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserServer -Service ID for the User Services pool associated with the Web Services pool. -For example: +### -McxSipPrimaryListeningPort -`-UserServer "UserServer:atl-cs-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Internal listening port for the Mobility service. ```yaml -Type: String +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -277,14 +276,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -MeetingRoomAdminPortalExternalListeningPort + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +External listening port for the Skype for Business Meeting Room Admin Portal. +The Admin Portal is a web-based utility that makes it easy for administrator to manage meeting rooms. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -293,14 +295,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -MeetingRoomAdminPortalInternalListeningPort + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Internal listening port for the Skype for Business Meeting Room Admin Portal. +The Admin Portal is a web-based utility that makes it easy for administrator to manage meeting rooms. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -309,14 +314,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -PrimaryHttpPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Port number for internal web connections made using the HTTP protocol. +The default value is port 80. ```yaml -Type: SwitchParameter +Type: UInt16 Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -325,16 +333,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InternalFqdn -Fully qualified domain name for the Mobility Services. -The InternalFqdn should only be accessible from inside the organization's firewall. +### -PrimaryHttpsPort +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Port number for internal web connections made using the HTTPS protocol. +The default value is port 443. ```yaml -Type: Fqdn +Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -344,14 +353,16 @@ Accept wildcard characters: False ``` ### -PublishedExternalHttpPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port number for the published external HTTP port. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -361,14 +372,16 @@ Accept wildcard characters: False ``` ### -PublishedExternalHttpsPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + External port for the Mobility service. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -378,14 +391,16 @@ Accept wildcard characters: False ``` ### -PublishedPrimaryHttpPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port number for the published primary HTTP port. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -395,14 +410,16 @@ Accept wildcard characters: False ``` ### -PublishedPrimaryHttpsPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Internal port for the Mobility service. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -411,14 +428,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -McxSipExternalListeningPort -External listening port for the Mobility service. +### -ReachExternalPsomServerPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +External port number for the Persistent Shared Object Model Protocol, a Microsoft protocol used for conferences. +The default port number is 8061. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -427,14 +447,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -McxSipPrimaryListeningPort -Internal listening port for the Mobility service. +### -ReachPrimaryPsomServerPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Primary port number for the Persistent Shared Object Model (PSOM) Protocol, a Microsoft protocol used for conferences. +The default port number is 8060. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -444,14 +467,16 @@ Accept wildcard characters: False ``` ### -RmWebSipExternalListeningPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + External listening port for the Persistent Chat Room Management Web App. This application is available only if you have installed and configured Persistent Chat. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -461,14 +486,16 @@ Accept wildcard characters: False ``` ### -RmWebSipPrimaryListeningPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Primary listening port for the Persistent Chat Room Management Web App. This application is available only if you have installed and configured Persistent Chat. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -478,14 +505,16 @@ Accept wildcard characters: False ``` ### -SupportConferenceConsoleSipExternalListeningPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Listening port for the Support Conferencing Console. The default value is 6007. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -495,14 +524,34 @@ Accept wildcard characters: False ``` ### -SupportConferenceConsoleSipPrimaryListeningPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Port used by the Office 365 Support Conference Console. This console is used by support personnel to troubleshoot problems with conferences and online meetings. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UcapSipPrimaryListeningPort + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Primary listening port for the UCAP (Unified Communication Application Platform). + +```yaml +Type: UInt16 +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -512,14 +561,16 @@ Accept wildcard characters: False ``` ### -UcwaSipExternalListeningPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + External SIP listening port for the Unified Communications Web API (UCWA). The default value is 5088. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -529,14 +580,16 @@ Accept wildcard characters: False ``` ### -UcwaSipPrimaryListeningPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Internal SIP listening port for the Unified Communications Web API (UCWA). The default value is 5089. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -545,15 +598,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MeetingRoomAdminPortalExternalListeningPort -External listening port for the Skype for Business Meeting Room Admin Portal. -The Admin Portal is a web-based utility that makes it easy for administrator to manage meeting rooms. +### -UserServer + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Service ID for the User Services pool associated with the Web Services pool. +For example: + +`-UserServer "UserServer:atl-cs-001.litwareinc.com"` + ```yaml -Type: UInt16 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -562,15 +620,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MeetingRoomAdminPortalInternalListeningPort -Internal listening port for the Skype for Business Meeting Room Admin Portal. -The Admin Portal is a web-based utility that makes it easy for administrator to manage meeting rooms. +### -VxmlSipPrimaryListeningPort + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter is not currently used with Skype for Business Server. ```yaml Type: UInt16 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -579,14 +638,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UcapSipPrimaryListeningPort -Primary listening port for the UCAP (Unified Communication Application Platform). +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: UInt16 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -595,14 +656,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -VxmlSipPrimaryListeningPort -This parameter is not currently used with Skype for Business Server. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: UInt16 +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -616,14 +679,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Set-CsWebServer` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None Instead, the `Set-CsWebServer` cmdlet modifies instances of the Microsoft.Rtc.Management.Xds.DisplayWebServer object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsWebServiceConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsWebServiceConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Set-CsWebServiceConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsWebServiceConfiguration.md index 7a41b51175..577c6cdecb 100644 --- a/skype/skype-ps/skype/Set-CsWebServiceConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsWebServiceConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-cswebserviceconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsWebServiceConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-cswebserviceconfiguration +schema: 2.0.0 +title: Set-CsWebServiceConfiguration --- # Set-CsWebServiceConfiguration @@ -168,62 +169,56 @@ This is done by setting the CrossDomainAuthorizationList property to a null valu ## PARAMETERS -### -Identity - -Unique identifier for the Web Services configuration settings to be modified. -To modify settings configured at the site scope, use syntax similar to this: - -`-Identity "site:Redmond"` - -To modify settings configured at the service scope, use syntax similar to this: - -`-Identity "service:WebServer:atl-cs-001.litwareinc.com"` - -To modify settings configured at the global scope, you can use this syntax: +### -AllowAnonymousAccessToLWAConference -`-identity global` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -If the Identity parameter is not used then the `Set-CsWebServiceConfiguration` cmdlet will automatically modify the global collection. +When set to True, anonymous users will be allowed to attend Skype for Business Web App conferences. ```yaml -Type: XdsIdentity -Parameter Sets: Identity +Type: Boolean +Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance +### -AllowExternalAuthentication -Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), OAuth authentication can be used to authenticate external users. ```yaml -Type: PSObject -Parameter Sets: Instance +Type: Boolean +Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named Default value: None -Accept pipeline input: True (ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowAnonymousAccessToLWAConference +### -AutoLaunchLyncWebAccess -When set to True, anonymous users will be allowed to attend Skype for Business Web App conferences. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter has been deprecated for use with the on-premises version of Skype for Business Server. + +When set to True, Skype for Business Web App will automatically be used as the default web popup for joining an online conference, provided that the prerequisites for using Skype for Business Web App (for example, Silverlight have been installed and Internet Explorer is not blocking pop-up windows) have been met. + +The default value is True. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -234,6 +229,8 @@ Accept wildcard characters: False ### -CASigningKeyLength +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Sets the size of the CA signing key, the private key used by a certification authority (CA) to sign digital certificates. The signing key length can be set to any integer value between 2048 and 16384 bytes; the default value is 2048. @@ -241,7 +238,30 @@ The signing key length can be set to any integer value between 2048 and 16384 by Type: UInt64 Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -CrossDomainAuthorizationList + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Collection of domains allowed to host web applications that send cross-domain scripting requests to the Skype for Business Server deployment. + +Domains to be added to the list must be created using the `New-CsWebOrigin` cmdlet and then added to the new collection of Web service configuration settings. +Note, too that domain names must be prefaced using the http: or the https: prefix. +See Examples 5, 6 and 7 of this help topic for more information. + +This parameter was introduced in the February, 2013 release of Lync Server 2013. + +```yaml +Type: PSListModifier +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -252,6 +272,8 @@ Accept wildcard characters: False ### -DefaultValidityPeriodHours +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When using certificate authentication, clients can request the period of time (in hours) that the certificate remains valid. DefaultValidityPeriodHours represents the amount of time a certificate will remain valid if the client does not request a custom validity period. @@ -262,7 +284,6 @@ The default value is 4320 (180 days). Type: UInt64 Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -273,6 +294,8 @@ Accept wildcard characters: False ### -EnableCertChainDownload +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If set to True, servers presented with an authentication certificate will download the certificate chain for that certificate. The certificate chain traces an individual certificate back to the issuing CA. Certificates will not be accepted for authentication unless the certificate's CA is trusted. @@ -281,7 +304,6 @@ Certificates will not be accepted for authentication unless the certificate's CA Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -291,6 +313,8 @@ Accept wildcard characters: False ``` ### -EnableCORS +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If set to True, Cross-Origin Resource Sharing is enabled. ```yaml @@ -298,7 +322,6 @@ Type: Boolean Position: Named Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -309,6 +332,8 @@ Accept wildcard characters: False ### -EnableGroupExpansion +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If set to True, group expansion will be enabled in Skype for Business. With group expansion, users can configure a distribution group as a contact, then "expand" that group. When a group has been expanded, users can see the individual members of a group and their current presence information. @@ -317,7 +342,6 @@ When a group has been expanded, users can see the individual members of a group Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -326,16 +350,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -InferCertChainFromSSL +### -EnableMediaBasicAuth -If set to True, servers will use the certificate information included in the Secure Sockets Layer (SSL) protocol to determine the issuing CA. -Certificates will not be accepted for authentication unless the certificate's CA is trusted. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True), enables basic authentication for media. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -344,17 +368,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MACResolverUrl +### -EnableStatisticsInResponse -URL for a Web service capable of performing Media Access Control (MAC) resolution. -MAC resolution involves taking the MAC address of a connected client and returning the chassis and port IDs of the network switch that client is connected to. -MAC resolution is used by the Enhanced 9-1-1 service. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True ($True) the X-MS-WebInfraStats header is included in all HTTP responses. +The default value is False ($False). ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -363,17 +387,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxCSRKeySize +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. -Sets the maximum size of the Certificate Signing Request (CSR) key. -(A CSR is a message sent from an applicant to a CA in order to apply for a digital certificate.) The maximum size for a CSR key can be set to any integer value between 1024 and 16384 bytes. -The default value is 16384. ```yaml -Type: UInt64 +Type: SwitchParameter Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -382,19 +406,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxGroupSizeToExpand +### -HstsMaxAgeInSeconds -Represents the maximum number of people that will be displayed when a group is expanded. -For example, if MaxGroupSizeToExpand is set to 75 only the first 75 members of the group will be displayed any time the group is expanded. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -MaxGroupSizeToExpand can be set to any integer value between 1 and 1000, inclusive. -The default value is 100. +Specifies the value of max-age in Strict-Transport-Security header in a HTTPS response. +Default value is 315360000. +A negative value means Strict-Transport-Security header will not appear in HTTPS responses. ```yaml -Type: UInt32 +Type: Int64 Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -403,38 +426,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MaxValidityPeriodHours +### -Identity -When using certificate authentication, clients can request the period of time (in hours) that the certificate remains valid. -MaxValidityPeriodHours represents the maximum amount of time a client can request. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -MaxValidityPeriodHours can be any integer value between 8 hours and 8760 hours (365 days). -The default value is 8760. +Unique identifier for the Web Services configuration settings to be modified. +To modify settings configured at the site scope, use syntax similar to this: + +`-Identity "site:Redmond"` + +To modify settings configured at the service scope, use syntax similar to this: + +`-Identity "service:WebServer:atl-cs-001.litwareinc.com"` + +To modify settings configured at the global scope, you can use this syntax: + +`-identity global` + +If the Identity parameter is not used then the `Set-CsWebServiceConfiguration` cmdlet will automatically modify the global collection. ```yaml -Type: UInt64 -Parameter Sets: (All) +Type: XdsIdentity +Parameter Sets: Identity Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -MinCSRKeySize +### -InferCertChainFromSSL -Sets the minimum size of the Certificate Signing Request (CSR) key. -The minimum size can be set to any integer value between 1024 and 16384 bytes. -The default value is 16384. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If set to True, servers will use the certificate information included in the Secure Sockets Layer (SSL) protocol to determine the issuing CA. +Certificates will not be accepted for authentication unless the certificate's CA is trusted. ```yaml -Type: UInt64 +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -443,37 +476,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -MinValidityPeriodHours +### -Instance -When using certificate authentication, clients can request the period of time (in hours) that the certificate remains valid. -MinValidityPeriodHours represents the minimum amount of time a client can request. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -MinValidityPeriodHours can be any integer value between 8 hours and 4320 hours (180 days). -The default value is 8. +Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml -Type: UInt64 -Parameter Sets: (All) +Type: PSObject +Parameter Sets: Instance Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -SecondaryLocationSourceUrl +### -MACResolverUrl -URL for a web service that can process a location request. -This service is only used when location requests cannot be resolved locally. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URL for a Web service capable of performing Media Access Control (MAC) resolution. +MAC resolution involves taking the MAC address of a connected client and returning the chassis and port IDs of the network switch that client is connected to. +MAC resolution is used by the Enhanced 9-1-1 service. ```yaml Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -482,18 +514,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowDownloadCommunicatorAttendeeLink - -This parameter has been deprecated for use with the on-premises version of Skype for Business Server. +### -MaxCSRKeySize -If set to True (the default value), users joining a meeting by using a client application other than Skype for Business will see a link that points them to a download for Skype for Business Web App. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Sets the maximum size of the Certificate Signing Request (CSR) key. +(A CSR is a message sent from an applicant to a CA in order to apply for a digital certificate.) The maximum size for a CSR key can be set to any integer value between 1024 and 16384 bytes. +The default value is 16384. ```yaml -Type: Boolean +Type: UInt64 Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -502,18 +534,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ShowJoinUsingLegacyClientLink +### -MaxGroupSizeToExpand -This parameter has been deprecated for use with the on-premises version of Skype for Business Server. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -If set to True, users joining a meeting by using a client application other than Skype for Business will be given the opportunity to join the meeting by using their current client application. -The default value is False. +Represents the maximum number of people that will be displayed when a group is expanded. +For example, if MaxGroupSizeToExpand is set to 75 only the first 75 members of the group will be displayed any time the group is expanded. + +MaxGroupSizeToExpand can be set to any integer value between 1 and 1000, inclusive. +The default value is 100. ```yaml -Type: Boolean +Type: UInt32 Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -522,18 +556,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TrustedCACerts +### -MaxValidityPeriodHours -Collection of certificates representing certificate chains trusted by the Web Server. -New certificates added to the collection must be created by using the `New-CsWebTrustedCACertificate` cmdlet. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -This collection is not used if the InferCertChainFromSSL property is set to True. +When using certificate authentication, clients can request the period of time (in hours) that the certificate remains valid. +MaxValidityPeriodHours represents the maximum amount of time a client can request. + +MaxValidityPeriodHours can be any integer value between 8 hours and 8760 hours (365 days). +The default value is 8760. ```yaml -Type: PSListModifier +Type: UInt64 Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -542,16 +578,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseCertificateAuth +### -MinCSRKeySize -When set to True (the default value), clients can be authenticated using certificates. -Set this value to False to disable certificate authentication. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Sets the minimum size of the Certificate Signing Request (CSR) key. +The minimum size can be set to any integer value between 1024 and 16384 bytes. +The default value is 16384. ```yaml -Type: Boolean +Type: UInt64 Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -560,16 +598,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UsePinAuth +### -MinValidityPeriodHours -When set to True (the default value), clients can be authenticated using personal identification numbers (PINs). -Set this value to False to disable PIN authentication. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When using certificate authentication, clients can request the period of time (in hours) that the certificate remains valid. +MinValidityPeriodHours represents the minimum amount of time a client can request. + +MinValidityPeriodHours can be any integer value between 8 hours and 4320 hours (180 days). +The default value is 8. ```yaml -Type: Boolean +Type: UInt64 Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -578,22 +620,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseWindowsAuth - -Determines how (and if) users will be authenticated using Windows authentication; that is, using the same credentials they used when they logged on to Windows. -Valid values are: +### -MobilePreferredAuthType -Negotiate - The client and server will work together to determine the proper authentication protocol (either Kerberos or NTLM). +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -NTLM - Windows authentication will be allowed, but only using the NTLM protocol. +Specifies the default authentication method used for mobile client connectivity. +Values can include: None | OAuth | WebTicketServiceAnon | WebTicketServiceWinNegotiate | WebTicketServiceWinNtlm | WebTicketServiceCert | WebTicketServicePin | WsFedPassive | WsFedBearer | WebTicketServiceAuth. -None - Windows authentication will not be allowed. +Note that if this value is set to a method that is not supported, the web ticket service may not start and an error will be generated in the Event log. ```yaml -Type: UseWindowsAuth +Type: MobilePreferredAuthType Parameter Sets: (All) Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -602,15 +641,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf +### -OverrideAuthTypeForExternalClients -Describes what would happen if you executed the command without actually executing the command. +The proper way to access the functionality that this parameter provide is to use the Get/Set-CsAuthConfig cmdlet. For more information, see [Set-CsAuthConfig](https://learn.microsoft.com/powershell/module/skype/set-csauthconfig). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -619,15 +657,14 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm +### -OverrideAuthTypeForInternalClients -Prompts you for confirmation before executing the command. +The proper way to access the functionality that this parameter provide is to use the Get/Set-CsAuthConfig cmdlet. For more information, see [Set-CsAuthConfig](https://learn.microsoft.com/powershell/module/skype/set-csauthconfig). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -636,16 +673,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force +### -PendingGetWaitSupportingApps -Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Specifies a semicolon-separated list of applications for which PendingGetWaitTimeOutInMinutes need to be set. +Supported applications are Android, iPhone, iPad, Macintosh, Windows. +To support all applications you can give All as input. +For example: +- To support Android and Macintosh - Android;Macintosh; +- To support all devices - All; +The default value is None. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -654,15 +697,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AllowExternalAuthentication +### -PendingGetWaitTimeOutInMinutes -When set to True (the default value), OAuth authentication can be used to authenticate external users. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Specifies the time in minutes to send an event at a particular interval to Keep Alive EventChannel. +The value can be specified in between 5 to 15 minutes (both inclusive). +The default value is 15 minutes. ```yaml -Type: Boolean +Type: Int64 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -671,19 +717,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -AutoLaunchLyncWebAccess - -This parameter has been deprecated for use with the on-premises version of Skype for Business Server. +### -SecondaryLocationSourceUrl -When set to True, Skype for Business Web App will automatically be used as the default web popup for joining an online conference, provided that the prerequisites for using Skype for Business Web App (for example, Silverlight have been installed and Internet Explorer is not blocking pop-up windows) have been met. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The default value is True. +URL for a web service that can process a location request. +This service is only used when location requests cannot be resolved locally. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -694,6 +738,8 @@ Accept wildcard characters: False ### -ShowAlternateJoinOptionsExpanded +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + This parameter has been deprecated for use with the on-premises version of Skype for Business Server. When set to True then alternate options for joining an online conference will automatically be expanded and shown to users. @@ -703,7 +749,6 @@ When set to False (the default value) these options will be available, but the u Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -712,16 +757,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseWsFedPassiveAuth +### -ShowDownloadCommunicatorAttendeeLink + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter has been deprecated for use with the on-premises version of Skype for Business Server. + +If set to True (the default value), users joining a meeting by using a client application other than Skype for Business will see a link that points them to a download for Skype for Business Web App. -When set to True, allows for passive authentication: authentication of users by using URL redirection or smart linking. -The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -730,15 +778,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WsFedPassiveMetadataUri +### -ShowJoinUsingLegacyClientLink -URI used by the WS-federation Web requestor protocol. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +This parameter has been deprecated for use with the on-premises version of Skype for Business Server. + +If set to True, users joining a meeting by using a client application other than Skype for Business will be given the opportunity to join the meeting by using their current client application. +The default value is False. ```yaml -Type: String +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -747,21 +799,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -CrossDomainAuthorizationList +### -TrustedCACerts -Collection of domains allowed to host web applications that send cross-domain scripting requests to the Skype for Business Server deployment. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Domains to be added to the list must be created using the `New-CsWebOrigin` cmdlet and then added to the new collection of Web service configuration settings. -Note, too that domain names must be prefaced using the http: or the https: prefix. -See Examples 5, 6 and 7 of this help topic for more information. +Collection of certificates representing certificate chains trusted by the Web Server. +New certificates added to the collection must be created by using the `New-CsWebTrustedCACertificate` cmdlet. -This parameter was introduced in the February, 2013 release of Lync Server 2013. +This collection is not used if the InferCertChainFromSSL property is set to True. ```yaml Type: PSListModifier Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -770,15 +820,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableMediaBasicAuth +### -UseCertificateAuth -When set to True ($True), enables basic authentication for media. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), clients can be authenticated using certificates. +Set this value to False to disable certificate authentication. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -787,16 +839,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -EnableStatisticsInResponse +### -UseDomainAuthInLWA -When set to True ($True) the X-MS-WebInfraStats header is included in all HTTP responses. -The default value is False ($False). +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, domain authentication can be employed as a way to authenticate Skype for Business Web App users. ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -805,17 +857,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -HstsMaxAgeInSeconds +### -UsePinAuth -Specifies the value of max-age in Strict-Transport-Security header in a HTTPS response. -Default value is 315360000. -A negative value means Strict-Transport-Security header will not appear in HTTPS responses. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True (the default value), clients can be authenticated using personal identification numbers (PINs). +Set this value to False to disable PIN authentication. ```yaml -Type: Int64 +Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -824,16 +876,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PendingGetWaitTimeOutInMinutes -Specifies the time in minutes to send an event at a particular interval to Keep Alive EventChannel. -The value can be specified in between 5 to 15 minutes (both inclusive). -The default value is 15 minutes. +### -UseWebClientLegacyUI + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, the user interface is displayed for Lync Server 2013. +When set to False, the Skype for Business user interface is displayed. ```yaml -Type: Int64 +Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -842,40 +895,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PendingGetWaitSupportingApps -Specifies a semicolon-separated list of applications for which PendingGetWaitTimeOutInMinutes need to be set. -Supported applications are Android, iPhone, iPad, Macintosh, Windows. -To support all applications you can give All as input. -For example: -- To support Android and Macintosh - Android;Macintosh; -- To support all devices - All; -The default value is None. +### -UseWindowsAuth -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Determines how (and if) users will be authenticated using Windows authentication; that is, using the same credentials they used when they logged on to Windows. +Valid values are: -### -MobilePreferredAuthType +Negotiate - The client and server will work together to determine the proper authentication protocol (either Kerberos or NTLM). -Specifies the default authentication method used for mobile client connectivity. -Values can include: None | OAuth | WebTicketServiceAnon | WebTicketServiceWinNegotiate | WebTicketServiceWinNtlm | WebTicketServiceCert | WebTicketServicePin | WsFedPassive | WsFedBearer | WebTicketServiceAuth. +NTLM - Windows authentication will be allowed, but only using the NTLM protocol. -Note that if this value is set to a method that is not supported, the web ticket service may not start and an error will be generated in the Event log. +None - Windows authentication will not be allowed. ```yaml -Type: MobilePreferredAuthType +Type: UseWindowsAuth Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -884,15 +920,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseDomainAuthInLWA +### -UseWsFedPassiveAuth -When set to True, domain authentication can be employed as a way to authenticate Skype for Business Web App users. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When set to True, allows for passive authentication: authentication of users by using URL redirection or smart linking. +The default value is False ($False). ```yaml Type: Boolean Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -901,16 +939,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UseWebClientLegacyUI +### -WsFedPassiveMetadataUri -When set to True, the user interface is displayed for Lync Server 2013. -When set to False, the Skype for Business user interface is displayed. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +URI used by the WS-federation Web requestor protocol. ```yaml -Type: Boolean +Type: String Parameter Sets: (All) Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -919,14 +957,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverrideAuthTypeForExternalClients +### -Confirm -The proper way to access the functionality that this parameter provide is to use the Get/Set-CsAuthConfig cmdlet. For more information, see [Set-CsAuthConfig](https://learn.microsoft.com/powershell/module/skype/set-csauthconfig). +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: cf Required: False Position: Named @@ -935,14 +975,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OverrideAuthTypeForInternalClients +### -WhatIf -The proper way to access the functionality that this parameter provide is to use the Get/Set-CsAuthConfig cmdlet. For more information, see [Set-CsAuthConfig](https://learn.microsoft.com/powershell/module/skype/set-csauthconfig). +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: +Aliases: wi Required: False Position: Named diff --git a/skype/skype-ps/skype/Set-CsXmppAllowedPartner.md b/skype/skype-ps/SkypeForBusiness/Set-CsXmppAllowedPartner.md similarity index 89% rename from skype/skype-ps/skype/Set-CsXmppAllowedPartner.md rename to skype/skype-ps/SkypeForBusiness/Set-CsXmppAllowedPartner.md index cb19f7f293..7137d8903d 100644 --- a/skype/skype-ps/skype/Set-CsXmppAllowedPartner.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsXmppAllowedPartner.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csxmppallowedpartner applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsXmppAllowedPartner -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csxmppallowedpartner +schema: 2.0.0 +title: Set-CsXmppAllowedPartner --- # Set-CsXmppAllowedPartner @@ -50,7 +51,7 @@ Skype for Business Server Control Panel: To edit the property values for an exis ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsXmppAllowedPartner -Identity "contoso.com" -SupportDialbackNegotiation $False ``` @@ -59,7 +60,7 @@ The command shown in Example 1 disables dialback negotiation for the XMPP allowe This is done by including the SupportDialbackNegotiation parameter and setting the parameter value to False ($False). -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsXmppAllowedPartner | Set-CsXmppAllowedPartner -SaslNegotiation "Required" ``` @@ -69,7 +70,7 @@ To carry out this task, the command first uses the `Get-CsXmppAllowedPartner` cm That collection is then piped to the `Set-CsXmppAllowedPartner` cmdlet, which sets the value of the SaslNegotiation property for each partner in the collection to Required. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Set-CsXmppAllowedPartner -Identity "contoso.com" -AdditionalDomains @{Add="na.contoso.com"} ``` @@ -79,7 +80,7 @@ To do this, the AdditionalDomains parameter is included, along with the syntax @ That syntax adds na.contoso.com to any other domains currently found in the AdditionalDomains property. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Set-CsXmppAllowedPartner -Identity "contoso.com" -AdditionalDomains @{Remove="europe.contoso.com"} ``` @@ -89,7 +90,7 @@ To remove this domain, the AdditionalDomains parameter is included along with th That syntax removes Europe.contoso.com from the AdditionalDomains property without affecting any other domains that might also be stored in AdditionalDomains. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Set-CsXmppAllowedPartner -Identity "contoso.com" -AdditionalDomains $Null ``` @@ -101,13 +102,15 @@ This is done by including the AdditionalDomains parameter and the parameter valu ## PARAMETERS ### -AdditionalDomains + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Additional XMPP domains belonging to the allowed partner. ```yaml Type: PSListModifier Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -116,30 +119,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -ConnectionLimit -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -ConnectionLimit Specifies the maximum number of simultaneous connections to a specific partner. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -149,14 +138,16 @@ Accept wildcard characters: False ``` ### -Description + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables administrators to provide additional text regarding the XMPP allowed partner. For example, the Description might include contact information for the partner. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -166,13 +157,15 @@ Accept wildcard characters: False ``` ### -EnableKeepAlive + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Indicates whether or not the XMPP partner should periodically transmit "keep alive" packets in order to verify that the connection is still active. The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -182,13 +175,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -198,13 +193,15 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Fully qualified domain name (FQDN) of the XMPP allowed partner to be modified (for example, fabrikam.com). ```yaml Type: XdsGlobalRelativeIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 2 @@ -214,13 +211,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -230,6 +229,9 @@ Accept wildcard characters: False ``` ### -PartnerType + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Specifies the relationship between Skype for Business Server and the XMPP partner. Allowed values are: @@ -243,8 +245,7 @@ The default value is PublicUnverified. ```yaml Type: PartnerType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -254,13 +255,15 @@ Accept wildcard characters: False ``` ### -ProxyFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Full qualified domain name of the proxy server used by the XMPP partner. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -270,6 +273,9 @@ Accept wildcard characters: False ``` ### -SaslNegotiation + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Indicates support for the Simple Authentication and Security Layer protocol, a protocol used for server authentication. Allowed values are: @@ -283,8 +289,7 @@ The default value is Required. ```yaml Type: SaslNegotiation Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -294,6 +299,9 @@ Accept wildcard characters: False ``` ### -SupportDialbackNegotiation + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Indicates whether dialback negotiation will be supported. With dialback negotiation, when Server A contacts Server B communication is not immediately established. Instead, Server B first attempts to verify the identity if Server A by contacting the authoritative DNS server for the domain that Server A claims to be from. @@ -307,8 +315,7 @@ The default value is True. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -318,6 +325,9 @@ Accept wildcard characters: False ``` ### -TlsNegotiation + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Indicates support for the Transport Layer Security protocol, a protocol used to encrypt server-to-server data streams. Allowed values are: @@ -332,8 +342,25 @@ The default value is Required. ```yaml Type: TlsNegotiation Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -343,13 +370,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -363,13 +392,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppAllowedPartner#Decorated The `Set-CsXmppAllowedPartner` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppAllowedPartner#Decorated object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsXmppAllowedPartner` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppAllowedPartner#Decorated object. ## NOTES diff --git a/skype/skype-ps/skype/Set-CsXmppGatewayConfiguration.md b/skype/skype-ps/SkypeForBusiness/Set-CsXmppGatewayConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Set-CsXmppGatewayConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Set-CsXmppGatewayConfiguration.md index 4a97a22ae7..f7bab25774 100644 --- a/skype/skype-ps/skype/Set-CsXmppGatewayConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Set-CsXmppGatewayConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/set-csxmppgatewayconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Set-CsXmppGatewayConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/set-csxmppgatewayconfiguration +schema: 2.0.0 +title: Set-CsXmppGatewayConfiguration --- # Set-CsXmppGatewayConfiguration @@ -58,7 +59,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Set-C ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Set-CsXmppGatewayConfiguration -Identity "global" -ConnectionLimit 1200 ``` @@ -68,31 +69,17 @@ Example 1 modifies the ConnectionLimit property for the global collection of XMP ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -ConnectionLimit -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -ConnectionLimit Total number of simultaneous connections allowed for all XMPP partners. The default value is 1000. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -102,6 +89,9 @@ Accept wildcard characters: False ``` ### -DialbackPassphrase + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Password used when connecting to an XMPP partner over a TCP dialback connection. With TCP dialback, the partner contacts the XMPP gateway and then hangs up. The XMPP gateway calls the partner back, and the communication session can then begin. @@ -109,8 +99,7 @@ The XMPP gateway calls the partner back, and the communication session can then ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -120,6 +109,9 @@ Accept wildcard characters: False ``` ### -EnableLoggingAllMessageBodies + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When set to True, Skype for Business Server will log the actual content of all instant messages. For privacy reasons, message content is typically deleted and only information about the communicating endpoints is included in the log files. @@ -129,8 +121,7 @@ The default value is False. ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -140,13 +131,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Suppresses the display of any non-fatal error message that might occur when running the command ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -156,6 +149,9 @@ Accept wildcard characters: False ``` ### -Identity + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Unique identifier for the XMPP gateway configuration settings to be modified. Because you can only have a single, global instance of these settings, you do not need to specify an Identity when calling the `Set-CsXmppGatewayConfiguration` cmdlet. If you prefer, however, you can use the following syntax to reference the global settings: @@ -166,8 +162,7 @@ If you prefer, however, you can use the following syntax to reference the global ```yaml Type: XdsIdentity Parameter Sets: Identity -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: 2 @@ -177,13 +172,15 @@ Accept wildcard characters: False ``` ### -Instance + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Allows you to pass a reference to an object to the cmdlet rather than set individual parameter values. ```yaml Type: PSObject Parameter Sets: Instance -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -193,6 +190,9 @@ Accept wildcard characters: False ``` ### -KeepAliveInterval + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Maximum amount of time (in seconds) that can elapse before the partner must send a "keep alive" message. (A keep alive message simply verifies that the connection is still active.) If the time interval expires before a keep alive message is received, the connection will be closed. The default value is 300 seconds. @@ -200,8 +200,7 @@ The default value is 300 seconds. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -211,14 +210,16 @@ Accept wildcard characters: False ``` ### -PartnerConnectionLimit + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Total number of simultaneous connections allowed for a single XMPP partner. The default value is 20. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -228,6 +229,9 @@ Accept wildcard characters: False ``` ### -StreamEstablishmentTimeout + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Maximum amount of time (in seconds) allotted for the XMPP partner to establish an XMPP stream. If this timeout period is surpassed the connection will automatically be terminated. The default value is 60 seconds. @@ -235,8 +239,7 @@ The default value is 60 seconds. ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -246,14 +249,16 @@ Accept wildcard characters: False ``` ### -StreamInactivityTimeout + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Maximum amount of time (in seconds) that an XMPP stream can be inactive before the connection is automatically terminated. The default value is 600 seconds (10 minutes). ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -263,14 +268,34 @@ Accept wildcard characters: False ``` ### -SubscriptionRefreshInterval + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Maximum amount of time (in seconds) that can elapse before the partner must refresh its presence subscription. The default value is 28800 seconds (8 hours). ```yaml Type: UInt32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -280,13 +305,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -300,13 +327,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppGatewaySettings The `Set-CsXmppGatewayConfiguration` cmdlet accepts pipelined instances of the Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppGatewaySettings object. ## OUTPUTS -### -None. +### None Instead, the `Set-CsXmppGatewayConfiguration` cmdlet modifies existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.XmppFederation.XmppGatewaySettings object. ## NOTES diff --git a/skype/skype-ps/skype/Show-CsClsLogging.md b/skype/skype-ps/SkypeForBusiness/Show-CsClsLogging.md similarity index 91% rename from skype/skype-ps/skype/Show-CsClsLogging.md rename to skype/skype-ps/SkypeForBusiness/Show-CsClsLogging.md index 034eb323fd..6ccc8abf23 100644 --- a/skype/skype-ps/skype/Show-CsClsLogging.md +++ b/skype/skype-ps/SkypeForBusiness/Show-CsClsLogging.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/show-csclslogging applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Show-CsClsLogging -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/show-csclslogging +schema: 2.0.0 +title: Show-CsClsLogging --- # Show-CsClsLogging @@ -40,7 +41,7 @@ The `Show-CsClsLogging` cmdlet returns information about all the scenarios curre ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Show-CsClsLogging ``` @@ -48,7 +49,7 @@ Show-CsClsLogging The command shown in Example 1 returns information about the scenarios currently being logged on the server where this cmdlet is run. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Show-CsClsLogging -Pools "atl-cs-001.litwareinc.com" ``` @@ -59,13 +60,15 @@ In Example 2, logging information is returned for all the servers in the pool `a ## PARAMETERS ### -AsXml + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When specified, information is returned using XML. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -75,6 +78,9 @@ Accept wildcard characters: False ``` ### -Computers + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to return logging information from a specified server or set of servers. To return information from a single server, specify the fully qualified domain name of that server. For example: @@ -91,8 +97,7 @@ If you do not include the Computers parameter or the Pools parameter, the `Show- ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -102,6 +107,9 @@ Accept wildcard characters: False ``` ### -Pools + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to return logging information for each server in a pool. To return information for a pool, specify the fully qualified domain name of that pool. For example: @@ -115,8 +123,7 @@ Multiple pools can be specified by separating the pool FQDNs using commas: ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -130,14 +137,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Show-CsClsLogging` cmdlet does not accept pipelined input. ## OUTPUTS -### -String value or XML output. +### System.Stringvalue or XML output. The `Show-CsClsLogging` cmdlet does not return objects. ## NOTES diff --git a/skype/skype-ps/skype/skype.md b/skype/skype-ps/SkypeForBusiness/SkypeForBusiness.md similarity index 100% rename from skype/skype-ps/skype/skype.md rename to skype/skype-ps/SkypeForBusiness/SkypeForBusiness.md diff --git a/skype/skype-ps/skype/Start-CsClsLogging.md b/skype/skype-ps/SkypeForBusiness/Start-CsClsLogging.md similarity index 90% rename from skype/skype-ps/skype/Start-CsClsLogging.md rename to skype/skype-ps/SkypeForBusiness/Start-CsClsLogging.md index 52f1ac216a..66bae02fdd 100644 --- a/skype/skype-ps/skype/Start-CsClsLogging.md +++ b/skype/skype-ps/SkypeForBusiness/Start-CsClsLogging.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/start-csclslogging applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Start-CsClsLogging -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/start-csclslogging +schema: 2.0.0 +title: Start-CsClsLogging --- # Start-CsClsLogging @@ -43,7 +44,7 @@ However, administrators can manually stop a logging operation at any time by usi ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Start-CsClsLogging -Scenario "AlwaysOn" ``` @@ -51,7 +52,7 @@ Start-CsClsLogging -Scenario "AlwaysOn" Example 1 starts logging the AlwaysOn scenario on all the computers in the current topology. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Start-CsClsLogging -Scenario "cps" -Pools "atl-cs-001.litwareinc.com" -Duration 12:00 ``` @@ -61,36 +62,16 @@ The command shown in Example 2 starts CPS logging on all the computers in the po ## PARAMETERS -### -Scenario -Name of the centralized logging scenario to be started. -Available scenarios (and their names) names can be returned by using this command: - -`Get-CsClsScenario | Select-Object Name` - -Note that you can only specify one scenario per call to the `Start-CsClsLogging` cmdlet. -Also only one scenario other than the "AlwaysOn" scenario can be started on a computer at any one time. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AsXml -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AsXml When specified, information is returned using XML. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -100,6 +81,9 @@ Accept wildcard characters: False ``` ### -Computers + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to start logging on a specified server or set of servers. To start logging on a single server, specify the fully qualified domain name of that server. For example: @@ -116,8 +100,7 @@ If you do not include the Computers parameter or the Pools parameter, the `Start ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -127,6 +110,9 @@ Accept wildcard characters: False ``` ### -Duration + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Amount of time that the logging operation should run. For example, this syntax causes the logging operation to run for 2 hours (0 days.02 hours:00 minutes) and then stop: @@ -146,8 +132,7 @@ The default value is 4 hours (04:00). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -157,6 +142,9 @@ Accept wildcard characters: False ``` ### -Pools + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to start logging a scenario on each server in a pool. To start logging in a pool, specify the fully qualified domain name of that pool. For example: @@ -170,8 +158,7 @@ Multiple pools can be specified by separating the pool FQDNs using commas: ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -180,19 +167,41 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Scenario + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the centralized logging scenario to be started. +Available scenarios (and their names) names can be returned by using this command: + +`Get-CsClsScenario | Select-Object Name` + +Note that you can only specify one scenario per call to the `Start-CsClsLogging` cmdlet. +Also only one scenario other than the "AlwaysOn" scenario can be started on a computer at any one time. + +```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 (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### -None. +### None The `Start-CsClsLogging` cmdlet does not accept pipelined input. ## OUTPUTS -### -String value or XML output. +### System.Stringvalue or XML output. The `Start-CsClsLogging` cmdlet does not return objects. ## NOTES diff --git a/skype/skype-ps/skype/Start-CsPool.md b/skype/skype-ps/SkypeForBusiness/Start-CsPool.md similarity index 87% rename from skype/skype-ps/skype/Start-CsPool.md rename to skype/skype-ps/SkypeForBusiness/Start-CsPool.md index 61b0bbeaf5..e68f0462b9 100644 --- a/skype/skype-ps/skype/Start-CsPool.md +++ b/skype/skype-ps/SkypeForBusiness/Start-CsPool.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/start-cspool applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Start-CsPool -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/start-cspool +schema: 2.0.0 +title: Start-CsPool --- # Start-CsPool @@ -30,7 +31,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Start-CsPool -PoolFqdn "atl-cs-001.litwareinc.com" -SkipRoutingGroup "bef5fa3b-3c97-4af0-abe7-611deee7616c" ``` @@ -40,31 +41,16 @@ This example starts the `"atl-cs-001.litwareinc.com"` pool and skips one routing ## PARAMETERS -### -PoolFqdn -Fully qualified domain name of the pool being started. -For example: `-PoolFqdn "atl-cs-001.litwareinc.com"` - -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Suppresses the display of any non-fatal error messages and completes the cmdlet operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -73,31 +59,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error messages and completes the cmdlet operation. +### -PoolFqdn + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the pool being started. +For example: `-PoolFqdn "atl-cs-001.litwareinc.com"` ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 1 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -QuorumLossRecovery + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + If true ($True), user data is reloaded from the backup store for any routing groups currently in quorum loss. (A quorum loss occurs when neither a database nor its replicas are available.) The default is false ($False.) ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -107,6 +98,9 @@ Accept wildcard characters: False ``` ### -SkipRoutingGroup + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies one or more routing groups by GUID to skip during startup. Use this parameter if one or more of the routing groups are having problems getting placed on servers. @@ -118,8 +112,7 @@ To specify more than one routing group use the syntax: `-SkipRoutingGroup "bef5f ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -129,6 +122,9 @@ Accept wildcard characters: False ``` ### -SkipServer + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Specifies one or more servers to skip during startup. Use this parameter if one or more of the front end servers cannot be started. Note that there is a minimum number of servers required for the pool to be functional. @@ -140,8 +136,25 @@ To specify more than one server use the syntax: `-SkipServer "AtlServerOne.litwa ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -151,13 +164,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -171,13 +186,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None +### None ## OUTPUTS -### -None +### None ## NOTES diff --git a/skype/skype-ps/skype/Start-CsWindowsService.md b/skype/skype-ps/SkypeForBusiness/Start-CsWindowsService.md similarity index 87% rename from skype/skype-ps/skype/Start-CsWindowsService.md rename to skype/skype-ps/SkypeForBusiness/Start-CsWindowsService.md index ab1c0c8008..e2ef66809d 100644 --- a/skype/skype-ps/skype/Start-CsWindowsService.md +++ b/skype/skype-ps/SkypeForBusiness/Start-CsWindowsService.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/start-cswindowsservice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Start-CsWindowsService -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/start-cswindowsservice +schema: 2.0.0 +title: Start-CsWindowsService --- # Start-CsWindowsService @@ -50,7 +51,7 @@ However, the `Start-CsWindowsService` cmdlet will not automatically start any de ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Start-CsWindowsService ``` @@ -60,7 +61,7 @@ This is done by calling the `Start-CsWindowsService` cmdlet without any paramete Note that you will not receive an error if you try to start a service that has already been started. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Start-CsWindowsService -Name "RTCRGS" ``` @@ -69,7 +70,7 @@ Example 2 starts the Response Group application service on the local computer. To do this, the command uses the Name parameter followed by the service name: RTCRGS. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Start-CsWindowsService -Name "RTCRGS" -ComputerName atl-cs-001.litwareinc.com ``` @@ -78,7 +79,7 @@ The command shown in Example 3 also starts the Response Group application servic To start a service on a remote computer, include the ComputerName parameter followed by the FQDN of the remote computer. -### -------------------------- Example 4 ------------------------ +### Example 4 ``` Get-CsWindowsService | Where-Object {$_.Status -ne "Running"} | Start-CsWindowsService ``` @@ -91,39 +92,36 @@ This filtered collection is then piped to the `Start-CsWindowsService` cmdlet, w ## PARAMETERS -### -Name -Name of the Skype for Business Server service you want to start. -Note that you must use the service name (for example, RTCCAA) and not the service display name. -You can only pass a single service name to the Name parameter, and you cannot use wildcards in the service name. -Service names can be retrieved using the `Get-CsWindowsService` cmdlet. +### -ComputerName -Keep in mind that the `Start-CsWindowsService` cmdlet can only start Skype for Business Server services; you cannot use this cmdlet to start other Windows services. -For those services, you might be able to use the Windows PowerShell `Start-Service` cmdlet. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the remote computer hosting the service to be started; if this parameter is not included, then the `Start-CsWindowsService` cmdlet will start the specified service (or services) on the local computer. +The remote computer should be referenced using its FQDN; for example, atl-cs-001.litwareinc.com. ```yaml Type: String Parameter Sets: Name -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ComputerName -Name of the remote computer hosting the service to be started; if this parameter is not included, then the `Start-CsWindowsService` cmdlet will start the specified service (or services) on the local computer. -The remote computer should be referenced using its FQDN; for example, atl-cs-001.litwareinc.com. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String -Parameter Sets: Name -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -133,6 +131,9 @@ Accept wildcard characters: False ``` ### -InputObject + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to start a service using an object reference rather than a service name. For example, if you use the `Get-CsWindowsService` cmdlet to return information about a service, and if you store the returned object in a variable named $x, you can then start the service using this command: @@ -144,8 +145,7 @@ For example, if you use the `Get-CsWindowsService` cmdlet to return information ```yaml Type: NTService Parameter Sets: InputObject -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -154,31 +154,42 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -NoWait -When present, causes the command to run and then immediately return control to the Windows PowerShell prompt. -If not present, control will not be returned until the command has completed and a status report has been written to the screen. +### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the Skype for Business Server service you want to start. +Note that you must use the service name (for example, RTCCAA) and not the service display name. +You can only pass a single service name to the Name parameter, and you cannot use wildcards in the service name. +Service names can be retrieved using the `Get-CsWindowsService` cmdlet. + +Keep in mind that the `Start-CsWindowsService` cmdlet can only start Skype for Business Server services; you cannot use this cmdlet to start other Windows services. +For those services, you might be able to use the Windows PowerShell `Start-Service` cmdlet. + ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: Name +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -NoWait + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, causes the command to run and then immediately return control to the Windows PowerShell prompt. +If not present, control will not be returned until the command has completed and a status report has been written to the screen. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -188,14 +199,16 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Path to an HTML file where error information can be stored. If this parameter is included, any errors that occur during the running of this cmdlet will be logged to the specified file (for example, C:\Logs\Service_report.html). ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -204,14 +217,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -220,14 +235,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -241,14 +258,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Deployment.Core.NTService object. +### Microsoft.Rtc.Management.Deployment.Core.NTService + The `Start-CsWindowsService` cmdlet accepts pipelined instances of the Windows service object. ## OUTPUTS -### -None. +### None Instead, the `Start-CsWindowsService` cmdlet starts instances of the Microsoft.Rtc.Management.Deployment.Core.NTService object. ## NOTES diff --git a/skype/skype-ps/skype/Stop-CsClsLogging.md b/skype/skype-ps/SkypeForBusiness/Stop-CsClsLogging.md similarity index 90% rename from skype/skype-ps/skype/Stop-CsClsLogging.md rename to skype/skype-ps/SkypeForBusiness/Stop-CsClsLogging.md index 46d2784689..ef03636766 100644 --- a/skype/skype-ps/skype/Stop-CsClsLogging.md +++ b/skype/skype-ps/SkypeForBusiness/Stop-CsClsLogging.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/stop-csclslogging applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Stop-CsClsLogging -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/stop-csclslogging +schema: 2.0.0 +title: Stop-CsClsLogging --- # Stop-CsClsLogging @@ -42,7 +43,7 @@ However, administrators can manually stop a logging operation at any time by usi ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Stop-CsClsLogging -Scenario "cps" ``` @@ -50,7 +51,7 @@ Stop-CsClsLogging -Scenario "cps" The command shown in Example 1 stops the CPS logging scenario on all the servers in the topology. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Stop-CsClsLogging -Scenario "cps" -Pools "atl-cs-001.litwareinc.com" ``` @@ -60,33 +61,16 @@ In Example 2, CPS logging scenario is stopped on all the servers in the pool `at ## PARAMETERS -### -Scenario -Name of the centralized logging scenario to be stopped. -Available scenarios (and their names) names can be returned by using this command: - -`Get-CsClsScenario | Select-Object Name` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AsXml -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AsXml When specified, information is returned using XML. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,6 +80,9 @@ Accept wildcard characters: False ``` ### -Computers + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to stop logging on a specified server or set of servers. To stop logging on a single server, specify the fully qualified domain name of that server. For example: @@ -112,8 +99,7 @@ If you do not include the Computers parameter or the Pools parameter, the `Stop- ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -123,6 +109,9 @@ Accept wildcard characters: False ``` ### -Pools + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to stop logging on each server in a pool. To stop logging in a pool, specify the fully qualified domain name of that pool. For example: @@ -136,8 +125,7 @@ Multiple pools can be specified by separating the pool FQDNs using commas: ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -146,19 +134,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Scenario + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the centralized logging scenario to be stopped. +Available scenarios (and their names) names can be returned by using this command: + +`Get-CsClsScenario | Select-Object Name` + +```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 (https://go.microsoft.com/fwlink/?LinkID=113216). ## INPUTS -### -None. +### None The `Stop-CsClsLogging` cmdlet does not accept pipelined input. ## OUTPUTS -### -String value or XML output. +### System.Stringvalue or XML output. The `Stop-CsClsLogging` cmdlet does not return objects. ## NOTES diff --git a/skype/skype-ps/skype/Stop-CsWindowsService.md b/skype/skype-ps/SkypeForBusiness/Stop-CsWindowsService.md similarity index 86% rename from skype/skype-ps/skype/Stop-CsWindowsService.md rename to skype/skype-ps/SkypeForBusiness/Stop-CsWindowsService.md index fa3302b7ad..f56c048cf6 100644 --- a/skype/skype-ps/skype/Stop-CsWindowsService.md +++ b/skype/skype-ps/SkypeForBusiness/Stop-CsWindowsService.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/stop-cswindowsservice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Stop-CsWindowsService -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/stop-cswindowsservice +schema: 2.0.0 +title: Stop-CsWindowsService --- # Stop-CsWindowsService @@ -53,7 +54,7 @@ Eventually, all the existing requests will be filled and the service will then s ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Stop-CsWindowsService -Name "RTCRGS" ``` @@ -62,7 +63,7 @@ The command shown in Example 1 stops the Response Group application service on t The Response Group application service is identified by including the Name parameter and the name of that service: RTCRGS. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Stop-CsWindowsService -Name "RTCRGS" -ComputerName atl-cs-001.litwareinc.com ``` @@ -71,7 +72,7 @@ Example 2 also stops the Response Group application service; in this example, ho To stop a service on a remote computer, include the ComputerName parameter followed by the FQDN of the remote computer. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Get-CsWindowsService | Where-Object {$_.DisplayName -like "*Call Park*"} | Stop-CsWindowsService ``` @@ -84,39 +85,36 @@ The filtered collection is then piped to the `Stop-CsWindowsService` cmdlet, whi ## PARAMETERS -### -Name -Name of the Skype for Business Server service you want to stop. -Note that you must use the service name (for example, RTCCAA) and not the service display name. -You can only pass a single service name to the Name parameter, and you cannot use wildcards in the service name. -You can use the `Get-CsWindowsService` cmdlet to retrieve service names. +### -ComputerName -Keep in mind that the `Stop-CsWindowsService` cmdlet can only stop Skype for Business Server services; you cannot use this cmdlet to stop other Windows services. -For those services, you might be able to use the Windows PowerShell `Stop-Service` cmdlet. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the remote computer running the service to be stopped; if this parameter is not included, then the `Stop-CsWindowsService` cmdlet will stop the specified service on the local computer. +The remote computer should be referenced using its FQDN; for example, atl-mcs-001.litwareinc.com. ```yaml Type: String Parameter Sets: Name -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ComputerName -Name of the remote computer running the service to be stopped; if this parameter is not included, then the `Stop-CsWindowsService` cmdlet will stop the specified service on the local computer. -The remote computer should be referenced using its FQDN; for example, atl-mcs-001.litwareinc.com. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String -Parameter Sets: Name -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -126,14 +124,16 @@ Accept wildcard characters: False ``` ### -Graceful + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Instead of immediately shutting down a service, waits until all existing service requests have been filled. (However, all new service requests will be rejected.) The service will not completely shut down until all the existing requests have been filled. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -143,6 +143,9 @@ Accept wildcard characters: False ``` ### -InputObject + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to stop a service using an object reference rather than a service name. For example, if you use the `Get-CsWindowsService` cmdlet to return information about a service and if you store the returned object in a variable named $x, you can then stop the service using this command: @@ -153,8 +156,7 @@ Stop-CsWindowsService -InputObject $x.Name ```yaml Type: NTService Parameter Sets: InputObject -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -163,15 +165,16 @@ Accept pipeline input: True (ByValue) Accept wildcard characters: False ``` -### -NoWait -When present, causes the command to run and then immediately return control to the Windows PowerShell prompt. -If not present, control will not be returned until the command has completed and a status report has been written to the screen. +### -LeaveClsAgentRunning + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When specified, stops all the Skype for Business Server services except for the centralized logging agent service. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -180,14 +183,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -LeaveWebServerRunning + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, shuts down all services except the Web Server service on the specified computer. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -196,31 +201,42 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Path to an HTML file where error information can be written. -If this parameter is included, any errors that occur during the running of this cmdlet will be logged to the specified file (for example, C:\Logs\Service_report.html). +### -Name + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the Skype for Business Server service you want to stop. +Note that you must use the service name (for example, RTCCAA) and not the service display name. +You can only pass a single service name to the Name parameter, and you cannot use wildcards in the service name. +You can use the `Get-CsWindowsService` cmdlet to retrieve service names. + +Keep in mind that the `Stop-CsWindowsService` cmdlet can only stop Skype for Business Server services; you cannot use this cmdlet to stop other Windows services. +For those services, you might be able to use the Windows PowerShell `Stop-Service` cmdlet. + ```yaml Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: Name +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -NoWait + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, causes the command to run and then immediately return control to the Windows PowerShell prompt. +If not present, control will not be returned until the command has completed and a status report has been written to the screen. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -229,14 +245,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Path to an HTML file where error information can be written. +If this parameter is included, any errors that occur during the running of this cmdlet will be logged to the specified file (for example, C:\Logs\Service_report.html). ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -245,14 +264,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LeaveClsAgentRunning -When specified, stops all the Skype for Business Server services except for the centralized logging agent service. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -261,14 +282,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -LeaveWebServerRunning -When present, shuts down all services except the Web Server service on the specified computer. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -282,14 +305,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.Deployment.Core.NTService object. +### Microsoft.Rtc.Management.Deployment.Core.NTService + The `Stop-CsWindowsService` cmdlet accepts pipelined instances of the Windows service object. ## OUTPUTS -### -None. +### None Instead, the `Stop-CsWindowsService` cmdlet stops instances of the Microsoft.Rtc.Management.Deployment.Core.NTService object. ## NOTES diff --git a/skype/skype-ps/skype/Sync-CsClsLogging.md b/skype/skype-ps/SkypeForBusiness/Sync-CsClsLogging.md similarity index 91% rename from skype/skype-ps/skype/Sync-CsClsLogging.md rename to skype/skype-ps/SkypeForBusiness/Sync-CsClsLogging.md index f1e1fb7909..1bf7f0c450 100644 --- a/skype/skype-ps/skype/Sync-CsClsLogging.md +++ b/skype/skype-ps/SkypeForBusiness/Sync-CsClsLogging.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/sync-csclslogging applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Sync-CsClsLogging -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/sync-csclslogging +schema: 2.0.0 +title: Sync-CsClsLogging --- # Sync-CsClsLogging @@ -42,7 +43,7 @@ When this is done, all the logging data currently in memory will be written to d ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Sync-CsClsLogging ``` @@ -50,7 +51,7 @@ Sync-CsClsLogging The command shown in Example 1 flushes the centralized logging caches for all the servers in the topology. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Sync-CsClsLogging -Pools "atl-cs-001.litwareinc.com" ``` @@ -61,13 +62,15 @@ In Example 2, the centralized logging caches are flushed on all the servers in t ## PARAMETERS ### -AsXml + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When specified, information is returned using XML. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -77,6 +80,9 @@ Accept wildcard characters: False ``` ### -Computers + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to flush the centralized logging service cache on a specified server or set of servers. To flush a single server cache, specify the fully qualified domain name of that server. For example: @@ -93,8 +99,7 @@ If you do not include the Computers parameter or the Pools parameter, the `Sync- ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -104,6 +109,9 @@ Accept wildcard characters: False ``` ### -Pools + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to flush the centralized logging service cache on each server in a pool. To flush the server caches in a pool, specify the fully qualified domain name of that pool. For example: @@ -117,8 +125,7 @@ Multiple pools can be specified by separating the pool FQDNs using commas: ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -132,14 +139,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Sync-CsClsLogging` cmdlet does not accept pipelined input. ## OUTPUTS -### -String value. +### System.Stringvalue. The `Sync-CsClsLogging` cmdlet does not return objects. ## NOTES diff --git a/skype/skype-ps/skype/Sync-CsUserData.md b/skype/skype-ps/SkypeForBusiness/Sync-CsUserData.md similarity index 85% rename from skype/skype-ps/skype/Sync-CsUserData.md rename to skype/skype-ps/SkypeForBusiness/Sync-CsUserData.md index 24515c4190..b1da8e1da6 100644 --- a/skype/skype-ps/skype/Sync-CsUserData.md +++ b/skype/skype-ps/SkypeForBusiness/Sync-CsUserData.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/sync-csuserdata applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Sync-CsUserData -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/sync-csuserdata +schema: 2.0.0 +title: Sync-CsUserData --- # Sync-CsUserData @@ -32,7 +33,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Sync- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Sync-CsUserData -PoolFqdn "atl-cs-001.litwareinc.com" ``` @@ -42,36 +43,40 @@ The command shown in Example 1 syncs the pool `atl-cs-001.litwareinc.com` with i ## PARAMETERS -### -PoolFqdn -Fully qualified domain name of the primary Skype for Business Server pool. -For example: +### -LocalStore -`-PoolFqdn "atl-cs-001.litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Retrieves the user data from the local replica of the Central Management store rather than from the Central Management store itself. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -LocalStore -Retrieves the user data from the local replica of the Central Management store rather than from the Central Management store itself. +### -PoolFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the primary Skype for Business Server pool. +For example: + +`-PoolFqdn "atl-cs-001.litwareinc.com"` + ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -79,14 +84,16 @@ Accept wildcard characters: False ``` ### -RoutingGroup + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to synchronize data only for the specified routing groups. Routing groups are used to indicate the Front End server that users register with. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,13 +103,15 @@ Accept wildcard characters: False ``` ### -Target + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Synchronizes data with the preassigned backup pool. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -116,14 +125,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Sync-CsUserData` cmdlet does not accept pipelined output. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Test-CsASConference.md b/skype/skype-ps/SkypeForBusiness/Test-CsASConference.md similarity index 83% rename from skype/skype-ps/skype/Test-CsASConference.md rename to skype/skype-ps/SkypeForBusiness/Test-CsASConference.md index 099b932352..4290163b24 100644 --- a/skype/skype-ps/skype/Test-CsASConference.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsASConference.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csasconference applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsASConference -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csasconference +schema: 2.0.0 +title: Test-CsASConference --- # Test-CsASConference @@ -46,7 +47,7 @@ Skype for Business Server: The functions carried out by the `Test-CsASConference ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsASConference -TargetFqdn "atl-cs-001.litwareinc.com" ``` @@ -56,7 +57,7 @@ This command assumes that you have configured a pair of test users for the speci If no such test users exist, the command will fail. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Test-CsASConference -TargetFqdn "atl-cs-001.litwareinc.com" -TestJoinLauncher ``` @@ -65,7 +66,7 @@ Example 2 tests the ability of the Join Launcher service to participate in an Ap Note that this command tests only the service itself; you do not need any mobile devices in order to run the command. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $cred1 = Get-Credential "litwareinc\pilar" @@ -85,84 +86,10 @@ To carry out this task, the `Test-CsASConference` cmdlet is called, along with t ## PARAMETERS -### -ReceiverCredential -User credential object for the first of the two user accounts to be tested. -The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: - -`$y = Get-Credential "litwareinc\pilar"` - -You need to supply the user password when running this command. - -The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool. - -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: rc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderCredential -User credential object for the second of the two user accounts to be tested. -The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: - -`$x = Get-Credential "litwareinc\kenmyer"` - -You need to supply the user password when running this command. - -The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool. - -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: sc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. - -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Authentication -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Authentication Type of authentication used when running the test. Allowed values are: @@ -175,7 +102,6 @@ Allowed values are: Type: AuthenticationMechanism Parameter Sets: (All) Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -185,13 +111,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -201,6 +129,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -222,7 +153,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -232,6 +162,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -243,7 +176,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -252,18 +184,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceiverSipAddress -SIP address for the first of the two user accounts to be tested. -For example: `-ReceiverSipAddress "sip:pilar@litwareinc.com"`. -The ReceiverSIPAddress parameter must reference the same user account as ReceiverCredential. +### -ReceiverCredential -The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for the first of the two user accounts to be tested. +The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: + +`$y = Get-Credential "litwareinc\pilar"` + +You need to supply the user password when running this command. + +The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: String +Type: PSCredential Parameter Sets: ClientPlatform -Aliases: ra -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: rc Required: True Position: Named @@ -272,13 +210,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ReceiverSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the first of the two user accounts to be tested. +For example: `-ReceiverSipAddress "sip:pilar@litwareinc.com"`. +The ReceiverSIPAddress parameter must reference the same user account as ReceiverCredential. + +The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. + ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ClientPlatform, ServerPlatform Aliases: ra -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -286,6 +233,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -293,7 +243,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -302,7 +251,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SenderCredential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for the second of the two user accounts to be tested. +The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: + +`$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. + +The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool. + +```yaml +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: sc + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -SenderSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address for the second of the two user accounts to be tested. For example: `-SenderSipAddress "sip:kenmyer@litwareinc.com"`. The SenderSipAddress parameter must reference the same user account as SenderCredential. @@ -311,9 +289,8 @@ The SIP address is not required if you are running the test under the health mon ```yaml Type: String -Parameter Sets: ClientPlatform +Parameter Sets: ClientPlatform, ServerPlatform Aliases: sa -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -322,28 +299,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TargetFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the pool to be tested. + ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: sa -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ClientPlatform, ServerPlatform +Aliases: t Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` + ### -TestJoinLauncher + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, tests the ability of the Join Launcher to participate in a conference. The Join Launcher is used to help users of mobile devices (and as a result, users of the Mobility Service) take part in conferences. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -357,13 +342,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsASConference` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsASConference` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsAVConference.md b/skype/skype-ps/SkypeForBusiness/Test-CsAVConference.md similarity index 82% rename from skype/skype-ps/skype/Test-CsAVConference.md rename to skype/skype-ps/SkypeForBusiness/Test-CsAVConference.md index 10358b7db6..c151a48269 100644 --- a/skype/skype-ps/skype/Test-CsAVConference.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsAVConference.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csavconference applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsAVConference -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csavconference +schema: 2.0.0 +title: Test-CsAVConference --- # Test-CsAVConference @@ -59,7 +60,7 @@ Instead, the cmdlet verifies that the two users can make the connections necessa ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsAVConference -TargetFqdn atl-cs-001.litwareinc.com ``` @@ -74,7 +75,7 @@ If you have not defined test users for a pool then you must include the SenderSi The `Test-CsAVConference` cmdlet will then conduct its checks using the two specified users. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred1 = Get-Credential "litwareinc\pilar" @@ -94,36 +95,107 @@ To carry out this task, the `Test-CsAVConference` cmdlet is called, along with t ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. +### -Authentication + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of authentication used in the test. +Allowed values are: + +* TrustedServer +* Negotiate +* ClientCertificate +* LiveID + +```yaml +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. + +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: olv -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -OutVerboseVariable + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. + + ```yaml Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: ovv Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -ReceiverCredential + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + User credential object for the first of the two user accounts to be tested. The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: @@ -138,7 +210,6 @@ The receiver credential is not required if you are running the test under the he Type: PSCredential Parameter Sets: ClientPlatform Aliases: rc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -148,6 +219,9 @@ Accept wildcard characters: False ``` ### -ReceiverSipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address for the first of the two user accounts to be tested. For example: `-ReceiverSipAddress "sip:pilar@litwareinc.com"`. The ReceiverSipAddress parameter must reference the same user account as ReceiverCredential. @@ -156,9 +230,8 @@ The SIP address is not required if you are running the test under the health mon ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ServerPlatform, ClientPlatform Aliases: ra -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -167,20 +240,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: ra -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -RegistrarPort -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -RegistrarPort SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -188,7 +251,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -198,6 +260,9 @@ Accept wildcard characters: False ``` ### -SenderCredential + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + User credential object for the second of the two user accounts to be tested. The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: @@ -212,7 +277,6 @@ The sender credential is not required if you are running the test under the heal Type: PSCredential Parameter Sets: ClientPlatform Aliases: sc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -222,47 +286,19 @@ Accept wildcard characters: False ``` ### -SenderSipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address for the second of the two user accounts to be tested. For example: `-SenderSipAddress "sip:kenmyer@litwareinc.com"`. The SenderSipAddress parameter must reference the same user account as SenderCredential. The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. - ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ServerPlatform, ClientPlatform Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -271,104 +307,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: - -`-OutVerboseVariable TestOutput` +### -TargetFqdn -Do not prepend a $ character when specifying the variable name. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml Type: String -Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Authentication -Type of authentication used in the test. -Allowed values are: - -* TrustedServer -* Negotiate -* ClientCertificate -* LiveID - -```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: - -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` - -To save the information stored in the logger variable to an XML file, use a command similar to this: - -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +### -TestJoinLauncher -```yaml -Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TestJoinLauncher When present, tests the ability of the Join Launcher to participate in an AV conference. The Join Launcher is used to help users of mobile devices (and, as a result, users of the Mobility Service) take part in conferences. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -382,12 +349,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsAVConference` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsAVEdgeConnectivity.md b/skype/skype-ps/SkypeForBusiness/Test-CsAVEdgeConnectivity.md similarity index 82% rename from skype/skype-ps/skype/Test-CsAVEdgeConnectivity.md rename to skype/skype-ps/SkypeForBusiness/Test-CsAVEdgeConnectivity.md index 4a02865927..adfddd3adc 100644 --- a/skype/skype-ps/skype/Test-CsAVEdgeConnectivity.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsAVEdgeConnectivity.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csavedgeconnectivity applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsAVEdgeConnectivity -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csavedgeconnectivity +schema: 2.0.0 +title: Test-CsAVEdgeConnectivity --- # Test-CsAVEdgeConnectivity @@ -43,7 +44,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Test- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsAVEdgeConnectivity -TargetFqdn "atl-cs-001.litwareinc.com" ``` @@ -51,7 +52,7 @@ Test-CsAVEdgeConnectivity -TargetFqdn "atl-cs-001.litwareinc.com" The command shown in Example 1 verifies that a preconfigured test user can connect to the A/V Edge server configured for the pool atl-cs-001.litwareinc.com Note that this command will fail if you have not defined at least one health monitoring test user for atl-cs-001.litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred = Get-Credential "litwareinc\kenmyer" @@ -65,72 +66,82 @@ After the credentials object has been obtained, the second command uses the `Tes ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. +### -Authentication + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of authentication used in the test. +Allowed values are: + +* TrustedServer +* Negotiate +* ClientCertificate +* LiveID ```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -AVEdgeAddress + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +IP address of the Edge server being tested. +Specifying the IP address enables you to test the internal side of the Edge server; in turn, this allows you to verify the connection between the test client and the internal Edge server. +Note that the internal side often has multiple IP addresses. + ```yaml Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserCredential -User credentials object for the account to be tested. -The value passed to UserCredential must be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credential object for the user litwareinc\kenmyer and stores that object in a variable named +### -AVEdgeTCPPort -`$x: $x = Get-Credential "litwareinc\kenmyer"` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -You need to supply the user password when running this command. -This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. +Transmission Control Protocol (TCP) of the Edge server being tested. + +The default value is 443. ```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: uc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: UInt16 +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Authentication -Type of authentication used in the test. -Allowed values are: +### -AVEdgeUDPPort -* TrustedServer -* Negotiate -* ClientCertificate -* LiveID +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +User Datagram Protocol (UDP) port of the Edge server being tested. + +The default value is 3478. ```yaml -Type: AuthenticationMechanism +Type: UInt16 Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -140,13 +151,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -156,6 +169,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -175,7 +191,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -185,6 +200,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -196,7 +214,6 @@ Do not use prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -206,6 +223,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -213,7 +233,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -222,83 +241,61 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address for user account to be tested; for example: `-UserSipAddress "sip:kenmyer@litwareinc.com"`. -The UserSipAddress parameter must reference the same user account as UserCredential. -This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. +### -TargetFqdn -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: ua -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml Type: String -Parameter Sets: ClientPlatform -Aliases: ua -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t Required: True -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AVEdgeAddress -IP address of the Edge server being tested. -Specifying the IP address enables you to test the internal side of the Edge server; in turn, this allows you to verify the connection between the test client and the internal Edge server. -Note that the internal side often has multiple IP addresses. +### -UserCredential -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +User credentials object for the account to be tested. +The value passed to UserCredential must be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credential object for the user litwareinc\kenmyer and stores that object in a variable named -### -AVEdgeTCPPort -Transmission Control Protocol (TCP) of the Edge server being tested. +`$x: $x = Get-Credential "litwareinc\kenmyer"` -The default value is 443. +You need to supply the user password when running this command. +This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. ```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: uc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -AVEdgeUDPPort -User Datagram Protocol (UDP) port of the Edge server being tested. +### -UserSipAddress -The default value is 3478. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for user account to be tested; for example: `-UserSipAddress "sip:kenmyer@litwareinc.com"`. +The UserSipAddress parameter must reference the same user account as UserCredential. +This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. ```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: ua Required: False Position: Named @@ -312,13 +309,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsAVEdgeConnectivity` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsAVEdgeConnectivity` cmdlet returns instances of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsAddressBookService.md b/skype/skype-ps/SkypeForBusiness/Test-CsAddressBookService.md similarity index 82% rename from skype/skype-ps/skype/Test-CsAddressBookService.md rename to skype/skype-ps/SkypeForBusiness/Test-CsAddressBookService.md index cd35b1f681..23b9e7d11f 100644 --- a/skype/skype-ps/skype/Test-CsAddressBookService.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsAddressBookService.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csaddressbookservice applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsAddressBookService -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csaddressbookservice +schema: 2.0.0 +title: Test-CsAddressBookService --- # Test-CsAddressBookService @@ -63,7 +64,7 @@ You can test the Address Book Download Web service in two different ways: by tes ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsAddressBookService -TargetFqdn atl-cs-001.litwareinc.com ``` @@ -72,7 +73,7 @@ Example 1 tests the Address Book Download Web service for the pool `atl-cs-001.l This command tests the Address Book Download Web service by using test users preconfigured for the pool `atl-cs-001.litwareinc.com`. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred1 = Get-Credential "litwareinc\kenmyer" @@ -88,7 +89,7 @@ To run this command under Ken Myer's user credentials, the UserCredential parame In addition, Ken's SIP address must be supplied using the UserSipAddress parameter. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Test-CsAddressBookService -TargetUri https://atl-cs-001.litwareinc.com/abs/handler -UserSipAddress "sip:kenmyer@litwareinc.com" ``` @@ -99,50 +100,89 @@ To do this, the `Test-CsAddressBookService` cmdlet is called along with two para ## PARAMETERS -### -UserCredential -User credential object for the user account to be used in the test. -The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: +### -Authentication -`$x = Get-Credential "litwareinc\kenmyer"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You need to supply the user password when running this command. +Type of authentication used in the test. +Allowed values are: + +* TrustedServer +* Negotiate +* ClientCertificate +* LiveID ```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: uc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address of the user to be used in the test. -If this parameter is not specified then `Test-CsAddressBookService` will conduct its checks by using the account of the logged-in user. +### -External + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to verify that external users can use the Address Book Download Web service. ```yaml -Type: String -Parameter Sets: ClientPlatform, TargetUri -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: ClientPlatform, ServerPlatform +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. + +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` + ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: olv Required: False Position: Named @@ -151,14 +191,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -External -Enables you to verify that external users can use the Address Book Download Web service. +### -OutVerboseVariable + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. + ```yaml -Type: SwitchParameter -Parameter Sets: ClientPlatform, ServerPlatform -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: ovv Required: False Position: Named @@ -168,6 +216,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -175,7 +226,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: ClientPlatform, ServerPlatform Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -185,6 +235,9 @@ Accept wildcard characters: False ``` ### -TargetFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the Registrar pool where the Address Book Download Web service is to be tested. For example: `-TargetFqdn "atl-cs-001.litwareinc.com"`. @@ -192,9 +245,8 @@ You cannot use both the TargetUri parameter and the TargetFqdn parameter in the ```yaml Type: String -Parameter Sets: ClientPlatform +Parameter Sets: ClientPlatform, ServerPlatform Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: 2 @@ -203,20 +255,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -TargetUri -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -TargetUri Uniform Resource Identifier (URI) of the Address Book Web Query service. For example: `-TargetUri "https://atl-cs-001.litwareinc.com/abs/handler"`. @@ -226,7 +268,6 @@ You cannot use both the TargetUri parameter and the TargetFqdn parameter in the Type: String Parameter Sets: TargetUri Aliases: twsu -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -235,54 +276,46 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -UserCredential -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +User credential object for the user account to be used in the test. +The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. +`$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: uc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: +### -UserSipAddress -`-OutVerboseVariable TestOutput` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Do not prepend a $ character when specifying the variable name. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address of the user to be used in the test. +If this parameter is not specified then `Test-CsAddressBookService` will conduct its checks by using the account of the logged-in user. ```yaml Type: String -Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ClientPlatform, TargetUri, ServerPlatform +Aliases: ua -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -290,6 +323,9 @@ Accept wildcard characters: False ``` ### -WebCredential + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + An object containing user credentials for accessing the Location Information service. This object can be retrieved by calling the `Get-Credential` cmdlet and supplying the appropriate credentials. @@ -299,59 +335,7 @@ This parameter is required if the TargetUri and UserSipAddress parameters are sp ```yaml Type: PSCredential Parameter Sets: TargetUri -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Authentication -Type of authentication used in the test. -Allowed values are: - -* TrustedServer -* Negotiate -* ClientCertificate -* LiveID - -```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: - -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` - -To save the information stored in the logger variable to an XML file, use a command similar to this: - -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -365,13 +349,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsAddressBookService` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsAddressBookService` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsAddressBookWebQuery.md b/skype/skype-ps/SkypeForBusiness/Test-CsAddressBookWebQuery.md similarity index 83% rename from skype/skype-ps/skype/Test-CsAddressBookWebQuery.md rename to skype/skype-ps/SkypeForBusiness/Test-CsAddressBookWebQuery.md index 6347a249c5..d862260973 100644 --- a/skype/skype-ps/skype/Test-CsAddressBookWebQuery.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsAddressBookWebQuery.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csaddressbookwebquery applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsAddressBookWebQuery -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csaddressbookwebquery +schema: 2.0.0 +title: Test-CsAddressBookWebQuery --- # Test-CsAddressBookWebQuery @@ -65,7 +66,7 @@ The test will be marked a success only if all of those steps can be completed. ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Test-CsAddressBookWebQuery -TargetFqdn atl-cs-001.litwareinc.com -TargetSipAddress "sip:kenmyer@litwareinc.com" ``` @@ -78,7 +79,7 @@ If test users have not been defined, then the command will fail. If you have not defined test users for a pool then you must include the UserSipAddress parameter and the credentials of the user under which the command should be run. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` $cred1 = Get-Credential "litwareinc\kenmyer" @@ -94,7 +95,7 @@ To run this command under Ken Myer's user credentials, the UserCredential parame The command also uses the TargetSipAddress to specify that the cmdlet should search the Address Book for the contact with the SIP Address sip:kenmyer@litwareinc.com. -### -------------------------- Example 3 ------------------------ +### Example 3 ``` Test-CsAddressBookWebQuery -TargetUri https://atl-cs-001.litwareinc.com/groupexpansion -UserSipAddress "sip:packerman@litwareinc.com" -TargetSipAddress "sip:kenmyer@litwareinc.com" ``` @@ -105,47 +106,26 @@ To do this, the `Test-CsAddressBookWebQuery` cmdlet is called along with three p ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the Registrar pool where the Address Book Web Query service is to be tested. -For example: `-TargetFqdn "atl-cs-001.litwareinc.com"`. +### -Authentication -Note that you cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type of authentication used in the test. +Allowed values are: -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +TrustedServer -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Negotiate -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +ClientCertificate + +LiveID -### -TargetSipAddress -SIP address of the contact expected to be returned by the Address Book Web Query service. -For example: `-TargetSipAddress "sip:kenmyer@litwareinc.com"`. ```yaml -Type: String +Type: AuthenticationMechanism Parameter Sets: (All) -Aliases: sip -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Ath Required: False Position: Named @@ -154,57 +134,65 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetUri -Uniform Resource Identifier (URI) of the Address Book Web Query service. -For example: `-TargetUri "https://atl-cs-001.litwareinc.com/groupexpansion"`. +### -External -Note that you cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to verify that external users can use the Address Book Web Query service. ```yaml -Type: String -Parameter Sets: TargetUri -Aliases: twsu -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserCredential -User credential object for the user account to be used in the test. -The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named +### -Force -`$x: $x = Get-Credential "litwareinc\kenmyer"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You need to supply the user password when running this command. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: uc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address of the user to be used in the test. -If this parameter is not specified then the `Test-CsAddressBookWebQuery` cmdlet will conduct its checks by using health monitoring configuration settings for the pool being tested. +### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. + +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: olv Required: False Position: Named @@ -213,27 +201,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform, TargetUri -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -OutVerboseVariable -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. -### -External -Enables you to verify that external users can use the Address Book Web Query service. ```yaml -Type: SwitchParameter -Parameter Sets: ServerPlatform, ClientPlatform -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: ovv Required: False Position: Named @@ -243,6 +226,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -250,7 +236,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: ServerPlatform, ClientPlatform Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -259,14 +244,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -SkypeSearchQuery + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +PARAMVALUE: String ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: skype Required: False Position: Named @@ -275,36 +262,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. +### -TargetFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the Registrar pool where the Address Book Web Query service is to be tested. +For example: `-TargetFqdn "atl-cs-001.litwareinc.com"`. + +Note that you cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Type: String +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: +### -TargetSipAddress -`-OutVerboseVariable TestOutput` - -Do not prepend a $ character when specifying the variable name. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +SIP address of the contact expected to be returned by the Address Book Web Query service. +For example: `-TargetSipAddress "sip:kenmyer@litwareinc.com"`. ```yaml Type: String Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: sip Required: False Position: Named @@ -313,73 +302,63 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WebCredential -An object containing user credentials for accessing the Location Information service. -This object can be retrieved by calling the `Get-Credential` cmdlet and supplying the appropriate credentials. +### -TargetUri -This parameter is required if the TargetUri and UserSipAddress parameters are specified and the computer on which the command is run does not have a server certificate. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Uniform Resource Identifier (URI) of the Address Book Web Query service. +For example: `-TargetUri "https://atl-cs-001.litwareinc.com/groupexpansion"`. + +Note that you cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command. ```yaml -Type: PSCredential +Type: String Parameter Sets: TargetUri -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: twsu -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Authentication -Type of authentication used in the test. -Allowed values are: +### -UserCredential -TrustedServer +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Negotiate - -ClientCertificate +User credential object for the user account to be used in the test. +The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named -LiveID +`$x: $x = Get-Credential "litwareinc\kenmyer"` +You need to supply the user password when running this command. ```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: uc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: +### -UserSipAddress -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -To save the information stored in the logger variable to an XML file, use a command similar to this: +SIP address of the user to be used in the test. +If this parameter is not specified then the `Test-CsAddressBookWebQuery` cmdlet will conduct its checks by using health monitoring configuration settings for the pool being tested. -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform, TargetUri +Aliases: ua Required: False Position: Named @@ -388,14 +367,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SkypeSearchQuery -PARAMVALUE: String +### -WebCredential + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +An object containing user credentials for accessing the Location Information service. +This object can be retrieved by calling the `Get-Credential` cmdlet and supplying the appropriate credentials. + +This parameter is required if the TargetUri and UserSipAddress parameters are specified and the computer on which the command is run does not have a server certificate. + ```yaml -Type: String -Parameter Sets: (All) -Aliases: skype -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: TargetUri +Aliases: Required: False Position: Named @@ -409,13 +394,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsAddressBookWebQuery` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsAddressBookWebQuery` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsAudioConferencingProvider.md b/skype/skype-ps/SkypeForBusiness/Test-CsAudioConferencingProvider.md similarity index 85% rename from skype/skype-ps/skype/Test-CsAudioConferencingProvider.md rename to skype/skype-ps/SkypeForBusiness/Test-CsAudioConferencingProvider.md index 5c7f75a011..dea13f04d1 100644 --- a/skype/skype-ps/skype/Test-CsAudioConferencingProvider.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsAudioConferencingProvider.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csaudioconferencingprovider applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsAudioConferencingProvider -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csaudioconferencingprovider +schema: 2.0.0 +title: Test-CsAudioConferencingProvider --- # Test-CsAudioConferencingProvider @@ -56,7 +57,7 @@ Note that the test will fail if the user employed by the `Test-CsAudioConferenci ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsAudioConferencingProvider -TargetFqdn atl-cs-001.litwareinc.com ``` @@ -67,7 +68,7 @@ If no test users have been defined for atl-cs-001.litwareinc.com, then the comma If you have not defined test users for a pool, then you must include the UserSipAddress parameter and the credentials of the user account that the command should employ when verifying the connection with an audio conferencing provider. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $credential = Get-Credential "litwareinc\kenmyer" @@ -84,60 +85,10 @@ To carry out this task, the `Test-CsAudioConferencingProvider` cmdlet is called, ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. - -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserCredential -User credential object for the account to be tested. -The value passed to `UserCredential` should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: - -`$x = Get-Credential "litwareinc\kenmyer"` - -You need to supply the user password when running this command. - -This parameter is not needed if the command is using test users configured by using the `CsHealthMonitoringConfiguration` cmdlets. +### -Authentication -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: uc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Authentication Type of authentication used when running the test. Allowed values are: @@ -150,7 +101,6 @@ Allowed values are: Type: AuthenticationMechanism Parameter Sets: (All) Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -160,6 +110,9 @@ Accept wildcard characters: False ``` ### -DialoutUserCredential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + User credential object for the dialout user account to be tested. The value passed to DialoutUserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $x: @@ -171,8 +124,7 @@ You need to supply the user password when running this command. ```yaml Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,6 +134,9 @@ Accept wildcard characters: False ``` ### -DialoutUserSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address for the dialout user account to be tested. For example: `-DialoutUserSipAddress "sip:pilar@litwareinc.com"`. The DialoutUserSipAddress parameter must reference the same user account as DialoutUserCredential. @@ -190,8 +145,7 @@ The DialoutUserSipAddress parameter must reference the same user account as Dial ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -201,13 +155,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -217,6 +173,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -238,7 +197,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -248,6 +206,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -259,7 +220,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -269,6 +229,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -276,7 +239,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -285,15 +247,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TargetFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the pool to be tested. + +```yaml +Type: String +Parameter Sets: ClientPlatform, ServerPlatform +Aliases: t + +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TestJoinLauncher + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, tests the ability of the Join Launcher to participate in a conference. The Join Launcher is used to help users of mobile devices (and, as a result, users of the Mobility Service) take part in conferences. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -302,33 +284,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address for the user account to be tested. -For example: `-UserSipAddress "sip:kenmyer@litwareinc.com"`. -The UserSipAddress parameter must reference the same user account as UserCredential. +### -UserCredential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for the account to be tested. +The value passed to `UserCredential` should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: + +`$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. This parameter is not needed if the command is using test users configured by using the `CsHealthMonitoringConfiguration` cmdlets. ```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: ua -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: uc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -UserSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the user account to be tested. +For example: `-UserSipAddress "sip:kenmyer@litwareinc.com"`. +The UserSipAddress parameter must reference the same user account as UserCredential. + +This parameter is not needed if the command is using test users configured by using the `CsHealthMonitoringConfiguration` cmdlets. + ```yaml Type: String -Parameter Sets: ClientPlatform +Parameter Sets: ServerPlatform, ClientPlatform Aliases: ua -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -340,13 +337,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsAudioConferencingProvider` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsAudioConferencingProvider` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsCertificateConfiguration.md b/skype/skype-ps/SkypeForBusiness/Test-CsCertificateConfiguration.md similarity index 83% rename from skype/skype-ps/skype/Test-CsCertificateConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Test-CsCertificateConfiguration.md index a47d84c519..afae693bf9 100644 --- a/skype/skype-ps/skype/Test-CsCertificateConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsCertificateConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cscertificateconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsCertificateConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-cscertificateconfiguration +schema: 2.0.0 +title: Test-CsCertificateConfiguration --- # Test-CsCertificateConfiguration @@ -34,7 +35,7 @@ It is recommended that administrators use the `Get-CsCertificate` cmdlet to retr ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsCertificateConfiguration ``` @@ -42,7 +43,7 @@ Test-CsCertificateConfiguration The command shown in Example 1 returns information about the certificates that are currently being used (on the local computer) by Skype for Business Server. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Test-CsCertificateConfiguration -Report "C:\Logs\Certificates.xml" ``` @@ -54,6 +55,9 @@ In this case, however, the Report parameter is used to specify a file path (C:\L ## PARAMETERS ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: `-Report "C:\Logs\Certificates.html"`. If this file already exists, it will be overwritten when you run the cmdlet. @@ -61,24 +65,7 @@ If this file already exists, it will be overwritten when you run the cmdlet. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Aliases: Required: False Position: Named @@ -92,14 +79,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsCertificateConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### -The `Test-CsCertificateConfiguration` cmdlet returns instances of the Microsoft.Rtc.Management.Deployment,CertificateExists object. +### Microsoft.Rtc.Management.Deployment.CertificateExists +The `Test-CsCertificateConfiguration` cmdlet returns instances of the Microsoft.Rtc.Management.Deployment.CertificateExists object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsClientAuth.md b/skype/skype-ps/SkypeForBusiness/Test-CsClientAuth.md similarity index 90% rename from skype/skype-ps/skype/Test-CsClientAuth.md rename to skype/skype-ps/SkypeForBusiness/Test-CsClientAuth.md index 6bd285963b..194e5ceeb2 100644 --- a/skype/skype-ps/skype/Test-CsClientAuth.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsClientAuth.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csclientauth applicable: Lync Server 2010 -title: Test-CsClientAuth -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csclientauth +schema: 2.0.0 +title: Test-CsClientAuth --- # Test-CsClientAuth @@ -39,7 +40,7 @@ Who can run this cmdlet: To return a list of all the role-based access control ( ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $cred1 = Get-Credential "litwareinc\kenmyer" @@ -54,39 +55,36 @@ The second command then calls `Test-CsClientAuth`, specifying the FQDN of the Re ## PARAMETERS -### -UserCredential -User credential object for the user account to be used in the test. -The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: +### -Force -`$x = Get-Credential "litwareinc\kenmyer"` +> Applicable: Lync Server 2010 -You need to supply the user password when running this command. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSCredential +Type: SwitchParameter Parameter Sets: (All) -Aliases: uc -Applicable: Lync Server 2010 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address of the user to be used in the test. -For example: `-UserSipAddress sip:kenmyer@litwareinc.com`. +### -OutVerboseVariable + +> Applicable: Lync Server 2010 + +{{Fill OutVerboseVariable Description}} ```yaml Type: String Parameter Sets: (All) -Aliases: ua -Applicable: Lync Server 2010 +Aliases: ovv -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -94,6 +92,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2010 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -101,7 +102,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Lync Server 2010 Required: False Position: Named @@ -110,24 +110,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetUri -URL of the certificate provisioning service. -If this parameter is not included then the `Test-CsClientAuth` will use the certificate provisioning service configured for the Registrar pool. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: tu -Applicable: Lync Server 2010 +### -TargetFqdn -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010 -### -TargetFqdn Fully qualified domain name (FQDN) of the Registrar pool where client authentication is to be tested. For example: `-TargetFqdn "atl-cs-001.litwareinc.com"`. @@ -135,7 +121,6 @@ For example: `-TargetFqdn "atl-cs-001.litwareinc.com"`. Type: String Parameter Sets: (All) Aliases: t -Applicable: Lync Server 2010 Required: False Position: 2 @@ -144,14 +129,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -TargetUri + +> Applicable: Lync Server 2010 + +URL of the certificate provisioning service. +If this parameter is not included then the `Test-CsClientAuth` will use the certificate provisioning service configured for the Registrar pool. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010 +Aliases: tu Required: False Position: Named @@ -160,32 +148,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. +### -UserCredential + +> Applicable: Lync Server 2010 + +User credential object for the user account to be used in the test. +The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: + +`$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. ```yaml -Type: SwitchParameter +Type: PSCredential Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Aliases: uc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -{{Fill OutVerboseVariable Description}} +### -UserSipAddress + +> Applicable: Lync Server 2010 + +SIP address of the user to be used in the test. +For example: `-UserSipAddress sip:kenmyer@litwareinc.com`. ```yaml Type: String Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010 +Aliases: ua -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -197,12 +196,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput `Test-CsClientAuth` returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsClientAuthentication.md b/skype/skype-ps/SkypeForBusiness/Test-CsClientAuthentication.md similarity index 88% rename from skype/skype-ps/skype/Test-CsClientAuthentication.md rename to skype/skype-ps/SkypeForBusiness/Test-CsClientAuthentication.md index b8dd9c675a..d7c479b01e 100644 --- a/skype/skype-ps/skype/Test-CsClientAuthentication.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsClientAuthentication.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csclientauthentication applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsClientAuthentication -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csclientauthentication +schema: 2.0.0 +title: Test-CsClientAuthentication --- # Test-CsClientAuthentication @@ -38,7 +39,7 @@ If a certificate cannot be found or downloaded, or if the cmdlet is unable to lo ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $cred1 = Get-Credential "litwareinc\kenmyer" @@ -54,53 +55,16 @@ The second command then calls the `Test-CsClientAuthentication` cmdlet, specifyi ## PARAMETERS -### -UserCredential -User credential object for the user account to be used in the test. -The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: - -`$x = Get-Credential "litwareinc\kenmyer"` - -You need to supply the user password when running this command. - -```yaml -Type: PSCredential -Parameter Sets: (All) -Aliases: uc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserSipAddress -SIP address of the user to be used in the test. -For example: `-UserSipAddress sip:kenmyer@litwareinc.com`. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: ua -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Force Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -110,13 +74,15 @@ Accept wildcard characters: False ``` ### -LiveIdAuthentication + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Verifies the ability of the test user to log on using their OrgId (Business LiveId) credentials. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -126,6 +92,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -145,7 +114,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -155,6 +123,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -166,7 +137,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -176,6 +146,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -183,7 +156,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -193,6 +165,9 @@ Accept wildcard characters: False ``` ### -TargetFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the Registrar pool where client authentication is to be tested. For example: `-TargetFqdn "atl-cs-001.litwareinc.com"`. @@ -200,7 +175,6 @@ For example: `-TargetFqdn "atl-cs-001.litwareinc.com"`. Type: String Parameter Sets: (All) Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: 2 @@ -210,6 +184,9 @@ Accept wildcard characters: False ``` ### -TargetUri + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + URL of the certificate provisioning service. If this parameter is not included then the `Test-CsClientAuthentication` cmdlet will use the certificate provisioning service configured for the Registrar pool. @@ -218,7 +195,6 @@ If this parameter is not included then the `Test-CsClientAuthentication` cmdlet Type: String Parameter Sets: (All) Aliases: tu -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -227,17 +203,59 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -UserCredential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for the user account to be used in the test. +The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: + +`$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. + +```yaml +Type: PSCredential +Parameter Sets: (All) +Aliases: uc + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address of the user to be used in the test. +For example: `-UserSipAddress sip:kenmyer@litwareinc.com`. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: ua + +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 -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsClientAuthentication` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsComputer.md b/skype/skype-ps/SkypeForBusiness/Test-CsComputer.md similarity index 87% rename from skype/skype-ps/skype/Test-CsComputer.md rename to skype/skype-ps/SkypeForBusiness/Test-CsComputer.md index 24f055387a..6cfab2ecd5 100644 --- a/skype/skype-ps/skype/Test-CsComputer.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsComputer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cscomputer applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsComputer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-cscomputer +schema: 2.0.0 +title: Test-CsComputer --- # Test-CsComputer @@ -35,7 +36,7 @@ For example, the `Test-CsComputer` cmdlet will verify that the Active Directory ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Test-CsComputer -Verbose ``` @@ -44,7 +45,7 @@ The command shown in Example 1 verifies the service activation status for the lo The Verbose parameter is included in the command to ensure that the success (or failure) of the operation is fully reported on the screen. -### -------------------------- Example 2 ------------------------ +### Example 2 ``` Test-CsComputer -Verbose -Report C:\Logs\Computer.html ``` @@ -57,6 +58,9 @@ This log is generated by including the Report parameter followed by the full pat ## PARAMETERS ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: `-Report "C:\Logs\Computer.html"`. If this file already exists, it will be overwritten when you run the cmdlet. @@ -64,24 +68,7 @@ If this file already exists, it will be overwritten when you run the cmdlet. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Aliases: Required: False Position: Named @@ -95,13 +82,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsComputer` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsComputer` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsDataConference.md b/skype/skype-ps/SkypeForBusiness/Test-CsDataConference.md similarity index 83% rename from skype/skype-ps/skype/Test-CsDataConference.md rename to skype/skype-ps/SkypeForBusiness/Test-CsDataConference.md index 261a1b7fce..512696fac9 100644 --- a/skype/skype-ps/skype/Test-CsDataConference.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsDataConference.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csdataconference applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsDataConference -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csdataconference +schema: 2.0.0 +title: Test-CsDataConference --- # Test-CsDataConference @@ -48,7 +49,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Test- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsDataConference -TargetFqdn "atl-cs-001.litwareinc.com" ``` @@ -58,7 +59,7 @@ This command assumes that you have configured a pair of test users for the speci If no such test users exist, the command will fail. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $credential1 = Get-Credential "litwareinc\pilar" @@ -78,113 +79,67 @@ To carry out this task, the `Test-CsDataConference` cmdlet is called, along with ## PARAMETERS -### -ReceiverCredential -User credential object for the first of the two user accounts to be tested. -The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: +### -Authentication -`$y = Get-Credential "litwareinc\pilar"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You need to supply the user password when running this command. +Type of authentication used when running the test. +Allowed values are: -The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool. +* TrustedServer +* Negotiate +* ClientCertificate +* LiveID ```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: rc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SenderCredential -User credential object for the second of the two user accounts to be tested. -The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: - -`$x = Get-Credential "litwareinc\kenmyer"` - -You need to supply the user password when running this command. - -The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool. - -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: sc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Force -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -TargetFqdn -Fully qualified domain name (FQDN) of the Persistent Chat pool to be tested. +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -IPVersion -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Authentication -Type of authentication used when running the test. +IP addressing type used to connect to the test conference. Allowed values are: -* TrustedServer -* Negotiate -* ClientCertificate -* LiveID +IPv4 -```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +IPv6 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Both -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +Auto ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: ipv Required: False Position: Named @@ -194,6 +149,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -215,7 +173,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -225,6 +182,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -236,7 +196,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -245,21 +204,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceiverSipAddress -SIP address for the first of the two user accounts to be tested. -For example: +### -ReceiverCredential -`-ReceiverSipAddress "sip:pilar@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The ReceiverSIPAddress parameter must reference the same user account as ReceiverCredential. +User credential object for the first of the two user accounts to be tested. +The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: -The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. +`$y = Get-Credential "litwareinc\pilar"` + +You need to supply the user password when running this command. + +The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: String +Type: PSCredential Parameter Sets: ClientPlatform -Aliases: ra -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: rc Required: True Position: Named @@ -268,13 +230,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ReceiverSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the first of the two user accounts to be tested. +For example: + +`-ReceiverSipAddress "sip:pilar@litwareinc.com"` + +The ReceiverSIPAddress parameter must reference the same user account as ReceiverCredential. + +The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. + ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ClientPlatform, ServerPlatform Aliases: ra -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -282,6 +256,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -289,7 +266,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -298,21 +274,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SenderSipAddress -SIP address for the second of the two user accounts to be tested. -For example: +### -SenderCredential -`-SenderSipAddress "sip:kenmyer@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The SenderSipAddress parameter must reference the same user account as SenderCredential. +User credential object for the second of the two user accounts to be tested. +The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: -The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. +`$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. + +The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: String +Type: PSCredential Parameter Sets: ClientPlatform -Aliases: sa -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: sc Required: True Position: Named @@ -321,53 +300,60 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SenderSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the second of the two user accounts to be tested. +For example: + +`-SenderSipAddress "sip:kenmyer@litwareinc.com"` + +The SenderSipAddress parameter must reference the same user account as SenderCredential. + +The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. + ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ClientPlatform, ServerPlatform Aliases: sa -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TestJoinLauncher -When present, tests the ability of the Join Launcher to participate in a conference. -The Join Launcher is used to help users of mobile devices (and, as a result, users of the Mobility Service) take part in conferences. +### -TargetFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the Persistent Chat pool to be tested. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ClientPlatform, ServerPlatform +Aliases: t Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IPVersion -IP addressing type used to connect to the test conference. -Allowed values are: - -IPv4 - -IPv6 +### -TestJoinLauncher -Both +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Auto +When present, tests the ability of the Join Launcher to participate in a conference. +The Join Launcher is used to help users of mobile devices (and, as a result, users of the Mobility Service) take part in conferences. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: ipv -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -381,13 +367,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsDataConference` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsDataConference` cmdlet returns instances of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsDatabase.md b/skype/skype-ps/SkypeForBusiness/Test-CsDatabase.md similarity index 81% rename from skype/skype-ps/skype/Test-CsDatabase.md rename to skype/skype-ps/SkypeForBusiness/Test-CsDatabase.md index 8d7c71703f..faf0730722 100644 --- a/skype/skype-ps/skype/Test-CsDatabase.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsDatabase.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csdatabase applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsDatabase -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csdatabase +schema: 2.0.0 +title: Test-CsDatabase --- # Test-CsDatabase @@ -52,7 +53,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Test- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsDatabase -CentralManagementDatabase ``` @@ -60,7 +61,7 @@ Test-CsDatabase -CentralManagementDatabase The command shown in Example 1 verifies the configuration of the Central Management database. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Test-CsDatabase -ConfiguredDatabases -SqlServerFqdn "atl-sql-001.litwareinc.com" ``` @@ -68,7 +69,7 @@ Test-CsDatabase -ConfiguredDatabases -SqlServerFqdn "atl-sql-001.litwareinc.com" Example 2 verifies all the Skype for Business Server databases installed on the computer atl-sql-001.litwareinc.com. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Test-CsDatabase -DatabaseType "Archiving" -SqlServerFqdn "atl-sql-001.litwareinc.com" -SqlInstanceName "archinst" ``` @@ -77,7 +78,7 @@ In Example 3, verification is performed only for the Archiving database installe Note that the SqlInstanceName parameter is included to specify the SQL Server instance (Archinst) where the Archiving database is located. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Test-CsDatabase -LocalService ``` @@ -88,14 +89,16 @@ The command shown in Example 4 verifies the databases installed on the local com ## PARAMETERS ### -CentralManagementDatabase + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Tests the configuration of the Central Management database. This parameter cannot be used in conjunction with the ConfiguredDatabases parameter or the DatabaseType parameter. ```yaml Type: SwitchParameter Parameter Sets: ByCMS -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -105,6 +108,9 @@ Accept wildcard characters: False ``` ### -ConfiguredDatabases + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Tests the configuration of all the Skype for Business Server databases installed on the specified computer. You must include the SqlServerFqdn parameter when using the ConfiguredDatabases parameter. In addition, this parameter cannot be used in the same command as the CentralManagementDatabase or the DatabaseType parameters. @@ -113,8 +119,7 @@ In addition, this parameter cannot be used in the same command as the CentralMan ```yaml Type: SwitchParameter Parameter Sets: ByConfigured -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -124,6 +129,9 @@ Accept wildcard characters: False ``` ### -DatabaseType + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Type of database to be validated. Allowed values are: @@ -159,8 +167,7 @@ User ```yaml Type: DatabaseNameType Parameter Sets: ByDatabase -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -170,6 +177,9 @@ Accept wildcard characters: False ``` ### -LocalService + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Validates all the databases used by any of the Skype for Business Server services that are installed on the local computer. This includes not only locally-installed databases but also databases installed on remote computers, provided those databases are used by one or more local services. @@ -177,8 +187,7 @@ This includes not only locally-installed databases but also databases installed ```yaml Type: SwitchParameter Parameter Sets: ByLocal -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -187,14 +196,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlServerFqdn -Fully qualified domain name of the computer whether the databases to be validated are installed. +### -Report + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: + +`-Report "C:\Logs\TestDatabases.html"` ```yaml -Type: Fqdn -Parameter Sets: ByCMS -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -203,27 +217,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: Fqdn -Parameter Sets: ByConfigured, ByDatabase -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -SqlInstanceName -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +SQL Server instance where the databases to be validated are installed. +For example: + +`-SqlInstanceName "rtc"` ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ByCMS, ByDatabase +Aliases: Required: False Position: Named @@ -232,17 +238,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: +### -SqlServerFqdn -`-Report "C:\Logs\TestDatabases.html"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name of the computer whether the databases to be validated are installed. ```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Fqdn +Parameter Sets: ByCMS, ByConfigured, ByDatabase +Aliases: Required: False Position: Named @@ -251,17 +256,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlInstanceName -SQL Server instance where the databases to be validated are installed. -For example: +### -Confirm -`-SqlInstanceName "rtc"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String -Parameter Sets: ByCMS, ByDatabase -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -271,13 +275,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -291,13 +297,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsDatabase` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsDatabase` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsDialInConferencing.md b/skype/skype-ps/SkypeForBusiness/Test-CsDialInConferencing.md similarity index 84% rename from skype/skype-ps/skype/Test-CsDialInConferencing.md rename to skype/skype-ps/SkypeForBusiness/Test-CsDialInConferencing.md index b081788241..3708cc6658 100644 --- a/skype/skype-ps/skype/Test-CsDialInConferencing.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsDialInConferencing.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csdialinconferencing applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsDialInConferencing -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csdialinconferencing +schema: 2.0.0 +title: Test-CsDialInConferencing --- # Test-CsDialInConferencing @@ -58,7 +59,7 @@ The cmdlet does not actually make any phone calls or create any dial-in conferen ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsDialInConferencing -TargetFqdn atl-cs-001.litwareinc.com ``` @@ -71,7 +72,7 @@ If test users have not been defined, then the command will fail because it will If you have not defined test users for a pool, then you must include the UserCredential parameter and the credentials of the user that the command should employ when trying to log on. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred1 = Get-Credential "litwareinc\pilar" @@ -88,69 +89,44 @@ To carry out this task, the `Test-CsDialInConferencing` cmdlet is called, along ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. +### -Authentication -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Type of authentication used in the test. +Allowed values are: -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +TrustedServer -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Negotiate -### -UserCredential -User credential object for the user account to be tested. -The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: +ClientCertificate -`$x = Get-Credential "litwareinc\kenmyer"` +LiveID -You need to supply the user password when running this command. -This parameter is not required if you are conducting the test using the health monitoring configuration settings. ```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: cc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address for user account to be tested. -For example: -UserSipAddress "sip:kenmyer@litwareinc.com". -The UserSipAddress parameter must reference the same user account as UserCredential. -This parameter is not required if you are conducting the test using the health monitoring configuration settings. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: ca -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -159,28 +135,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: ca -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -OutLoggerVariable -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -RegistrarPort -SIP port used by the Registrar service. -This parameter is not required if the Registrar uses the default port 5061. +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. + +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml -Type: Int32 +Type: String Parameter Sets: (All) -Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: olv Required: False Position: Named @@ -189,14 +166,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. +### -OutVerboseVariable + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Aliases: ovv Required: False Position: Named @@ -205,14 +190,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -RegistrarPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP port used by the Registrar service. +This parameter is not required if the Registrar uses the default port 5061. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: rp Required: False Position: Named @@ -221,46 +209,39 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: - -`-OutVerboseVariable TestOutput` +### -TargetFqdn -Do not prepend a $ character when specifying the variable name. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml Type: String -Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Authentication -Type of authentication used in the test. -Allowed values are: - -TrustedServer +### -TargetPstnPhoneNumber -Negotiate +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -ClientCertificate +Phone number for a PSTN telephone that will be used to verify that PSTN users can join the dial-in conference. +For example: -LiveID +`-TargetPstnPhoneNumber "+12065551219"` +Note that TargetPstnPhoneNumber should only be included when you are using the VerifyConferenceJoinType parameter. ```yaml -Type: AuthenticationMechanism +Type: String Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: rpn Required: False Position: Named @@ -269,48 +250,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` +### -UserCredential -Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +User credential object for the user account to be tested. +The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: -To save the information stored in the logger variable to an XML file, use a command similar to this: +`$x = Get-Credential "litwareinc\kenmyer"` -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +You need to supply the user password when running this command. +This parameter is not required if you are conducting the test using the health monitoring configuration settings. ```yaml -Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: cc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetPstnPhoneNumber -Phone number for a PSTN telephone that will be used to verify that PSTN users can join the dial-in conference. -For example: +### -UserSipAddress -`-TargetPstnPhoneNumber "+12065551219"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that TargetPstnPhoneNumber should only be included when you are using the VerifyConferenceJoinType parameter. +SIP address for user account to be tested. +For example: -UserSipAddress "sip:kenmyer@litwareinc.com". +The UserSipAddress parameter must reference the same user account as UserCredential. +This parameter is not required if you are conducting the test using the health monitoring configuration settings. ```yaml Type: String -Parameter Sets: (All) -Aliases: rpn -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: ca Required: False Position: Named @@ -320,6 +297,9 @@ Accept wildcard characters: False ``` ### -VerifyConferenceJoin + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + When set to True, verifies that the dial-in conference can joined by using a PSTN telephone. When performing this test you can optionally include the TargetPstnPhoneNumber. If you do that, TargetPstnPhoneNumber must specify the PSTN phone to be used for joining the conference. @@ -329,7 +309,6 @@ If TargetPstnPhoneNumber is not included then the `Test-CsDialInConferencing` cm Type: Boolean Parameter Sets: (All) Aliases: vcj -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -343,13 +322,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsDialInConferencing` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsDialInConferencing` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsDialPlan.md b/skype/skype-ps/SkypeForBusiness/Test-CsDialPlan.md similarity index 92% rename from skype/skype-ps/skype/Test-CsDialPlan.md rename to skype/skype-ps/SkypeForBusiness/Test-CsDialPlan.md index 77e180d416..d23e32e331 100644 --- a/skype/skype-ps/skype/Test-CsDialPlan.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsDialPlan.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csdialplan applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsDialPlan -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csdialplan +schema: 2.0.0 +title: Test-CsDialPlan --- # Test-CsDialPlan @@ -33,7 +34,7 @@ You can use this cmdlet for troubleshooting issues with number translations or f ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsDialPlan -Identity site:Redmond | Test-CsDialPlan -DialedNumber 14255559999 | Format-List ``` @@ -51,7 +52,7 @@ In order to see all the properties and values of the returned voice normalizatio This will list the phone number and normalization rule on separate lines, and the normalization rule properties and values will wrap to fit on the screen. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $a = Get-CsDialPlan -Identity site:Redmond @@ -63,7 +64,7 @@ Example 2 is identical to Example 1 except that instead of piping the results of As in Example 1, we conclude this command by piping the output to the `Format-List` cmdlet so we can see more information about the voice normalization rule than appears by default. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsDialPlan | Test-CsDialPlan -DialedNumber 2065559999 | Format-Table -Wrap ``` @@ -83,6 +84,9 @@ This shows each entry in table format (one column for the translated number and ## PARAMETERS ### -DialedNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The phone number against which you want to test the dial plan specified in the Dialplan parameter. Full Data Type: Microsoft.Rtc.Management.Voice.PhoneNumber @@ -90,8 +94,7 @@ Full Data Type: Microsoft.Rtc.Management.Voice.PhoneNumber ```yaml Type: PhoneNumber Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -101,6 +104,9 @@ Accept wildcard characters: False ``` ### -Dialplan + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + An object containing a reference to the dial plan against which you want to test the number specified in the DialedNumber parameter. Full Data Type: Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile @@ -108,8 +114,7 @@ Full Data Type: Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationPro ```yaml Type: LocationProfile Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -123,13 +128,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.LocationProfile + Accepts pipelined input of dial plan objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.LocationProfileTestResult Returns an object of type Microsoft.Rtc.Management.Voice.LocationProfileTestResult. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsExStorageConnectivity.md b/skype/skype-ps/SkypeForBusiness/Test-CsExStorageConnectivity.md similarity index 87% rename from skype/skype-ps/skype/Test-CsExStorageConnectivity.md rename to skype/skype-ps/SkypeForBusiness/Test-CsExStorageConnectivity.md index c2e02985e3..546100451b 100644 --- a/skype/skype-ps/skype/Test-CsExStorageConnectivity.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsExStorageConnectivity.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csexstorageconnectivity applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsExStorageConnectivity -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csexstorageconnectivity +schema: 2.0.0 +title: Test-CsExStorageConnectivity --- # Test-CsExStorageConnectivity @@ -40,7 +41,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Test- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsExStorageConnectivity -SipUri "sip:kenmyer@litwareinc.com" -Binding "NetNamedPipe" ``` @@ -49,7 +50,7 @@ The command shown in Example 1 tests to see if the Skype for Business Server Sto In this example, NetNamedPipe is used as the WCF binding. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Test-CsExStorageConnectivity -SipUri "sip:kenmyer@litwareinc.com" -Binding "NetNamedPipe" -Folder Dumpster ``` @@ -60,24 +61,10 @@ Example 2 verifies that the Skype for Business Server Storage Service can connec ## PARAMETERS -### -SipUri -SIP address of the Exchange mailbox where the test item should be created. - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: s -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Binding -Required: True -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Binding Windows Communication Foundation (WCF) binding. A WCF binding determines the transport, encoding, and protocol details required for clients and services to communicate with each other. valid values are: @@ -91,7 +78,6 @@ NetTCP Type: String Parameter Sets: (All) Aliases: b -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -101,13 +87,15 @@ Accept wildcard characters: False ``` ### -DeleteItem + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, the test item will be deleted from the Exchange mailbox at the end of the text. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -117,6 +105,9 @@ Accept wildcard characters: False ``` ### -Folder + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the Exchange archiving folder that the cmdlet should connect to. Allowed values are: @@ -130,8 +121,7 @@ Dumpster ```yaml Type: ExchFolder Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,13 +131,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -157,6 +149,9 @@ Accept wildcard characters: False ``` ### -HostNameStorageService + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the server where the Skype for Business Server Storage Service is running. This parameter is required if the Binding is set to NetTCP. @@ -165,7 +160,6 @@ This parameter is required if the Binding is set to NetTCP. Type: String Parameter Sets: (All) Aliases: h -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -174,14 +168,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SipUri + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address of the Exchange mailbox where the test item should be created. + + +```yaml +Type: String +Parameter Sets: (All) +Aliases: s + +Required: True +Position: 1 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -UseCache + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When presents, instructs the cmdlet to used cached auto discovery results when attempting to connect to Exchange. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -195,13 +210,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsExStorageConnectivity` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.ResourceData The `Test-CsExStorageConnectivity` cmdlet returns instances of the Microsoft.Rtc.Management.ResourceData object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsExStorageNotification.md b/skype/skype-ps/SkypeForBusiness/Test-CsExStorageNotification.md similarity index 86% rename from skype/skype-ps/skype/Test-CsExStorageNotification.md rename to skype/skype-ps/SkypeForBusiness/Test-CsExStorageNotification.md index 0a1a1928e8..8bbf4ed4ec 100644 --- a/skype/skype-ps/skype/Test-CsExStorageNotification.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsExStorageNotification.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csexstoragenotification applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsExStorageNotification -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csexstoragenotification +schema: 2.0.0 +title: Test-CsExStorageNotification --- # Test-CsExStorageNotification @@ -34,7 +35,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Test- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsExStorageNotification -SipUri "sip:kenmyer@litwareinc.com" -Binding "NetNamedPipe" ``` @@ -45,23 +46,10 @@ In this example, NetNamedPipe is used as the WCF binding. ## PARAMETERS -### -SipUri -SIP address of the Exchange Server mailbox where the test item should be created. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: s -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Binding -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Binding Windows Communication Foundation (WCF) binding. A WCF binding determines the transport, encoding, and protocol details required for clients and services to communicate with each other. valid values are: @@ -73,7 +61,6 @@ valid values are: Type: String Parameter Sets: (All) Aliases: b -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -83,13 +70,15 @@ Accept wildcard characters: False ``` ### -DeleteItem + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, the test item will be deleted from the Exchange mailbox at the end of the text. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -99,13 +88,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -115,6 +106,9 @@ Accept wildcard characters: False ``` ### -HostNameStorageService + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of the server where the Skype for Business Server Storage Service is running. This parameter is required if the Binding is set to NetTCP. @@ -123,7 +117,6 @@ This parameter is required if the Binding is set to NetTCP. Type: String Parameter Sets: (All) Aliases: h -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -132,18 +125,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SipUri + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address of the Exchange Server mailbox where the test item should be created. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: s + +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 -### -None. +### None The `Test-CsExStorageNotification` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.ResourceData The `Test-CsExStorageNotification` cmdlet returns instances of the Microsoft.Rtc.Management.ResourceData object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsExUMConnectivity.md b/skype/skype-ps/SkypeForBusiness/Test-CsExUMConnectivity.md similarity index 83% rename from skype/skype-ps/skype/Test-CsExUMConnectivity.md rename to skype/skype-ps/SkypeForBusiness/Test-CsExUMConnectivity.md index 89de2a0acc..221cdc0bc3 100644 --- a/skype/skype-ps/skype/Test-CsExUMConnectivity.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsExUMConnectivity.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csexumconnectivity applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsExUMConnectivity -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csexumconnectivity +schema: 2.0.0 +title: Test-CsExUMConnectivity --- # Test-CsExUMConnectivity @@ -43,7 +44,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Test- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsExUMConnectivity -TargetFqdn "atl-cs-001.litwareinc.com" ``` @@ -54,7 +55,7 @@ If they have, then the command will determine whether or not the first test user If test users have not been configured for the pool then the command will fail. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $credential = Get-Credential "litwareinc\kenmyer" @@ -68,7 +69,7 @@ Note that you must supply the password for this account in order to create a val The second command in the example uses the supplied credentials object ($x) and the SIP address of the user litwareinc\kenmyer in order to determine whether or this user can connect to Exchange Unified Messaging. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $credential = Get-Credential "litwareinc\kenmyer" @@ -85,60 +86,10 @@ That XML data is then written to a file named C:\Logs\ExumTest.xml by using the ## PARAMETERS -### -TargetFqdn -Fully qualified domain name of the pool being tested for Exchange Unified Messaging connectivity. - -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserCredential -User credentials object for the user account to be used in the test. -The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: - -`$x = Get-Credential "litwareinc\kenmyer"` - -You need to supply the user password when running this command. - -This parameter is not required if you are running the test by using test users configured via the `CsHealthMonitoringConfiguration` cmdlets. - -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: uc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Authentication -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Authentication Type of authentication used when running the test. Allowed values are: @@ -155,7 +106,6 @@ LiveID Type: AuthenticationMechanism Parameter Sets: (All) Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -165,13 +115,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -181,6 +133,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -202,7 +157,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -212,6 +166,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -223,7 +180,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -233,6 +189,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -240,7 +199,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -249,34 +207,67 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address of the user to be used in the test. -For example: +### -TargetFqdn -`-UserSipAddress "sip:kenmyer@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -This parameter is not required if you are running the test by using test users configured via the `CsHealthMonitoringConfiguration` cmdlets. +Fully qualified domain name of the pool being tested for Exchange Unified Messaging connectivity. ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: ua -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserCredential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credentials object for the user account to be used in the test. +The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: + +`$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. + +This parameter is not required if you are running the test by using test users configured via the `CsHealthMonitoringConfiguration` cmdlets. + +```yaml +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: uc + +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -UserSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +. +For example: + +`-UserSipAddress "sip:kenmyer@litwareinc.com"` + +This parameter is not required if you are running the test by using test users configured via the `CsHealthMonitoringConfiguration` cmdlets. + ```yaml Type: String -Parameter Sets: ClientPlatform +Parameter Sets: ServerPlatform, ClientPlatform Aliases: ua -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -288,13 +279,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsExUMConnectivity` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsExUMConnectivity` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsExUMVoiceMail.md b/skype/skype-ps/SkypeForBusiness/Test-CsExUMVoiceMail.md similarity index 82% rename from skype/skype-ps/skype/Test-CsExUMVoiceMail.md rename to skype/skype-ps/SkypeForBusiness/Test-CsExUMVoiceMail.md index 54fb97e64e..d5f532a679 100644 --- a/skype/skype-ps/skype/Test-CsExUMVoiceMail.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsExUMVoiceMail.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csexumvoicemail applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsExUMVoiceMail -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csexumvoicemail +schema: 2.0.0 +title: Test-CsExUMVoiceMail --- # Test-CsExUMVoiceMail @@ -44,7 +45,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Test- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsExUMVoiceMail -TargetFqdn "atl-cs-001.litwareinc.com" -ReceiverSipAddress "sip:kenmyer@litwareinc.com" ``` @@ -55,7 +56,7 @@ If they have, then the command will determine whether or not the first test user If test users have not been configured for the pool then the command will fail. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $credential = Get-Credential "litwareinc\pilar" @@ -69,7 +70,7 @@ Note that you must supply the password for this account in order to create a val The second command in the example uses the supplied credentials object ($x) and the SIP address of the user litwareinc\kenmyer in order to determine whether or this user can connect to Exchange Unified Messaging voice mail. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Test-CsExUMVoiceMail -TargetFqdn "atl-cs-001.litwareinc.com" -ReceiverSipAddress "sip:kenmyer@litwareinc.com" -OutLoggerVariable VoicemailTest @@ -84,63 +85,10 @@ That XML data is then written to a file named C:\Logs\VoicemailTest.xml by using ## PARAMETERS -### -SenderCredential -User credential object for the user account that will be leaving the voicemail message. -The value passed to SenderCredential must be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: - -`$x = Get-Credential "litwareinc\kenmyer"` - -You need to supply the user password when running this command. - -The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool. - -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: sc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. -For example: - -`-TargetFqdn atl-cs-001.litwareinc.com` - -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Authentication -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Authentication Type of authentication used when running the test. Allowed values are: @@ -153,7 +101,6 @@ Allowed values are: Type: AuthenticationMechanism Parameter Sets: (All) Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -163,13 +110,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -179,6 +128,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -200,7 +152,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -210,6 +161,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -221,7 +175,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -231,6 +184,9 @@ Accept wildcard characters: False ``` ### -ReceiverSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address for the user account that should receive the test voice mail (this must be a different SIP address than the SIP address used for the sender). For example: @@ -240,9 +196,8 @@ You do not have to include credentials for the voicemail recipient. ```yaml Type: String -Parameter Sets: ClientPlatform +Parameter Sets: ClientPlatform, ServerPlatform Aliases: ra -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -251,11 +206,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -RegistrarPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP port used by the Registrar service. +This parameter is not required if the Registrar uses the default port 5061. + ```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: ra -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Int32 +Parameter Sets: (All) +Aliases: rp Required: False Position: Named @@ -264,17 +225,26 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RegistrarPort -SIP port used by the Registrar service. -This parameter is not required if the Registrar uses the default port 5061. +### -SenderCredential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for the user account that will be leaving the voicemail message. +The value passed to SenderCredential must be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: + +`$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. + +The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: Int32 -Parameter Sets: (All) -Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: sc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -282,6 +252,9 @@ Accept wildcard characters: False ``` ### -SenderSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address for the user account that will be leaving the voicemail message (this must be a different SIP address than the SIP address used for the receiver). For example: @@ -293,9 +266,8 @@ The SIP address is not required if you are running the test under the health mon ```yaml Type: String -Parameter Sets: ClientPlatform +Parameter Sets: ClientPlatform, ServerPlatform Aliases: sa -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -304,20 +276,31 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TargetFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the pool to be tested. +For example: + +`-TargetFqdn atl-cs-001.litwareinc.com` + ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: sa -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ClientPlatform, ServerPlatform +Aliases: t Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -WaveFile + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Path to .WAV audio file that can be used when testing the voice mail service. If this parameter is included, the `Test-CsExUMVoiceMail` cmdlet will play the specified .WAV file when connecting to Exchange voicemail. If this parameter is not included, a default audio file will be played instead. @@ -327,7 +310,6 @@ If this parameter is not included, a default audio file will be played instead. Type: String Parameter Sets: (All) Aliases: wf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -341,13 +323,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsExUMVoiceMail` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsExUMVoiceMail` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsFederatedPartner.md b/skype/skype-ps/SkypeForBusiness/Test-CsFederatedPartner.md similarity index 82% rename from skype/skype-ps/skype/Test-CsFederatedPartner.md rename to skype/skype-ps/SkypeForBusiness/Test-CsFederatedPartner.md index 91379de7a9..0892028988 100644 --- a/skype/skype-ps/skype/Test-CsFederatedPartner.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsFederatedPartner.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csfederatedpartner applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsFederatedPartner -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csfederatedpartner +schema: 2.0.0 +title: Test-CsFederatedPartner --- # Test-CsFederatedPartner @@ -34,7 +35,7 @@ When using this cmdlet, make sure that the TargetFqdn parameter points to the in ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsFederatedPartner -TargetFqdn accessproxy.litwareinc.com -Domain fabrikam.com ``` @@ -43,7 +44,7 @@ The command shown in Example 1 verifies the connection between the local access Note that TargetFqdn must point to the internal Edge Server FQDN to which federated SIP traffic is directed. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Test-CsFederatedPartner -TargetFqdn accessproxy.litwareinc.com -Domain push.lync.com -ProxyFqdn sipfed.online.lync.com ``` @@ -53,7 +54,7 @@ You must have configured this service as a hosting provider and must have added For more information, see Configuring for push notifications in Lync Server 2013. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsAllowedDomain | ForEach-Object {Test-CsFederatedPartner -TargetFqdn accessproxy.litwareinc.com -Domain $_.Identity} ``` @@ -66,48 +67,16 @@ In turn, `ForEach-Object` runs the `Test-CsFederatedPartner` cmdlet against each ## PARAMETERS -### -Domain -Fully qualified domain name (FQDN) of the federated domain. -For example: `-Domain "fabrikam.com"`. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: d -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 3 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetFqdn -FQDN of the access proxy server used by your organization for federated SIP traffic. -The TargetFqdn must point to the internal Edge Server FQDN to which federated SIP traffic is directed. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Certificate -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Certificate Enables you to provide an X509 certificate for authentication purposes when connecting to the federated domain. ```yaml Type: X509Certificate2 Parameter Sets: (All) Aliases: ce -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -116,30 +85,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ProxyFqdn -FQDN of the access proxy server used by the federated organization. +### -Domain + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the federated domain. +For example: `-Domain "fabrikam.com"`. ```yaml Type: String Parameter Sets: (All) -Aliases: pe -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: d -Required: False -Position: Named +Required: True +Position: 3 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -148,14 +122,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Verbose -Reports detailed activity on the screen as the cmdlet runs. +### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. + +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Aliases: olv Required: False Position: Named @@ -165,6 +154,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -177,7 +169,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -186,30 +177,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. +### -ProxyFqdn -To store output in a logger variable named $TestOutput use the following syntax: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-OutLoggerVariable TestOutput` +FQDN of the access proxy server used by the federated organization. -Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: +```yaml +Type: String +Parameter Sets: (All) +Aliases: pe -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -To save the information stored in the logger variable to an XML file, use a command similar to this: +### -TargetFqdn -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of the access proxy server used by your organization for federated SIP traffic. +The TargetFqdn must point to the internal Edge Server FQDN to which federated SIP traffic is directed. ```yaml Type: String Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -220,13 +219,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None `Test-CsFederatedPartner` does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput `Test-CsFederatedPartner` returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsGroupExpansion.md b/skype/skype-ps/SkypeForBusiness/Test-CsGroupExpansion.md similarity index 81% rename from skype/skype-ps/skype/Test-CsGroupExpansion.md rename to skype/skype-ps/SkypeForBusiness/Test-CsGroupExpansion.md index 857d5182b8..98a3e13b19 100644 --- a/skype/skype-ps/skype/Test-CsGroupExpansion.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsGroupExpansion.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csgroupexpansion applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsGroupExpansion -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csgroupexpansion +schema: 2.0.0 +title: Test-CsGroupExpansion --- # Test-CsGroupExpansion @@ -65,7 +66,7 @@ Note that you can test group expansion in two different ways: by testing the ser ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsGroupExpansion -TargetFqdn atl-cs-001.litwareinc.com -GroupEmailAddress FinanceGroup@litwareinc.com ``` @@ -76,31 +77,41 @@ To run the test, the command uses the group FinanceGroup@litwareinc.com. ## PARAMETERS -### -GroupEmailAddress -Email address of the targeted distribution group. -For example: `-GroupEmailAddress "FinanceGroup@litwareinc.com"`. +### -Authentication + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of authentication used in the test. +Allowed values are: + +* TrustedServer +* Negotiate +* ClientCertificate +* LiveID ```yaml -Type: String +Type: AuthenticationMechanism Parameter Sets: (All) -Aliases: g -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Ath -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -External -Enables you to verify that external users can use group expansion. +### -DomainController + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to connect to the specified domain controller in order to test group expansion. +To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). ```yaml -Type: SwitchParameter -Parameter Sets: ServerPlatform, ClientPlatform -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: DC Required: False Position: Named @@ -109,15 +120,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -RegistrarPort -SIP port used by the Registrar service. -This parameter is not required if the Registrar uses the default port 5061. +### -External + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to verify that external users can use group expansion. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: ServerPlatform, ClientPlatform -Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -126,49 +138,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetFqdn -Fully qualified domain name (FQDN) of the Registrar pool where group expansion is to be tested. -For example: `-TargetFqdn "atl-cs-001.litwareinc.com"`. +### -Force -Note that you cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetUri -Uniform Resource Identifier (URI) of the Group Expansion Web service. -For example: `-TargetUri "https://atl-cs-001.litwareinc.com/groupexpansion"`. +### -GroupEmailAddress -Note that you cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Email address of the targeted distribution group. +For example: `-GroupEmailAddress "FinanceGroup@litwareinc.com"`. ```yaml Type: String -Parameter Sets: TargetUri -Aliases: twsu -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: g Required: True Position: Named @@ -177,41 +175,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserCredential -User credential object for the user account to be used in the test. -The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: +### -OutLoggerVariable -`$x = Get-Credential "litwareinc\kenmyer"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You will need to supply the user password when running this command. +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. -The user credential is not required if you are running the test under the credentials of the logged-on user and using the TargetFqdn parameter. -The user credential is required if you are using the TargetUri parameter. +To store output in a logger variable named $TestOutput use the following syntax: -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: uc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +`-OutLoggerVariable TestOutput` -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: -### -UserSipAddress -SIP address of the user to be used in the test. -If this parameter is not specified, then the `Test-CsGroupExpansion` cmdlet will conduct its checks using the account of the logged-on user. +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: olv Required: False Position: Named @@ -220,27 +206,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform, TargetUri -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -OutVerboseVariable -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: ovv Required: False Position: Named @@ -249,14 +230,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. +### -RegistrarPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP port used by the Registrar service. +This parameter is not required if the Registrar uses the default port 5061. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Type: Int32 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: rp Required: False Position: Named @@ -265,91 +249,87 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: +### -TargetFqdn -`-OutVerboseVariable TestOutput` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Do not prepend a $ character when specifying the variable name. +Fully qualified domain name (FQDN) of the Registrar pool where group expansion is to be tested. +For example: `-TargetFqdn "atl-cs-001.litwareinc.com"`. +Note that you cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command. ```yaml Type: String -Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -WebCredential -An object containing user credentials for accessing the Location Information service. -This object can be retrieved by calling the `Get-Credential` cmdlet and supplying the appropriate credentials. +### -TargetUri -This parameter is required if the TargetUri and UserSipAddress parameters are specified, and the computer on which the command is run does not have a server certificate. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Uniform Resource Identifier (URI) of the Group Expansion Web service. +For example: `-TargetUri "https://atl-cs-001.litwareinc.com/groupexpansion"`. + +Note that you cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command. ```yaml -Type: PSCredential +Type: String Parameter Sets: TargetUri -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: twsu -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Authentication -Type of authentication used in the test. -Allowed values are: +### -UserCredential -* TrustedServer -* Negotiate -* ClientCertificate -* LiveID +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for the user account to be used in the test. +The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: + +`$x = Get-Credential "litwareinc\kenmyer"` + +You will need to supply the user password when running this command. + +The user credential is not required if you are running the test under the credentials of the logged-on user and using the TargetFqdn parameter. +The user credential is required if you are using the TargetUri parameter. ```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: uc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: +### -UserSipAddress -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -To save the information stored in the logger variable to an XML file, use a command similar to this: +SIP address of the user to be used in the test. +If this parameter is not specified, then the `Test-CsGroupExpansion` cmdlet will conduct its checks using the account of the logged-on user. -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform, TargetUri +Aliases: ua Required: False Position: Named @@ -358,15 +338,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables you to connect to the specified domain controller in order to test group expansion. -To connect to a particular domain controller, include the DomainController parameter followed by the computer name (for example, atl-dc-001) or its fully qualified domain name (FQDN) (for example, atl-dc-001.litwareinc.com). +### -WebCredential + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +An object containing user credentials for accessing the Location Information service. +This object can be retrieved by calling the `Get-Credential` cmdlet and supplying the appropriate credentials. + +This parameter is required if the TargetUri and UserSipAddress parameters are specified, and the computer on which the command is run does not have a server certificate. + ```yaml -Type: String -Parameter Sets: (All) -Aliases: DC -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: TargetUri +Aliases: Required: False Position: Named @@ -380,13 +365,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsGroupExpansion` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsGroupExpansion` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsGroupIM.md b/skype/skype-ps/SkypeForBusiness/Test-CsGroupIM.md similarity index 84% rename from skype/skype-ps/skype/Test-CsGroupIM.md rename to skype/skype-ps/SkypeForBusiness/Test-CsGroupIM.md index 02b1dae31c..8e991e621e 100644 --- a/skype/skype-ps/skype/Test-CsGroupIM.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsGroupIM.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csgroupim applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsGroupIM -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csgroupim +schema: 2.0.0 +title: Test-CsGroupIM --- # Test-CsGroupIM @@ -73,7 +74,7 @@ Adding the Verbose parameter enables you to get a detailed account of all the ac ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsGroupIm -TargetFqdn atl-cs-001.litwareinc.com ``` @@ -87,7 +88,7 @@ If you have not defined test users for a pool, then you must include the SenderS The `Test-CsGroupIM` cmdlet will then conduct its checks using the two specified users. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred1 = Get-Credential "litwareinc\pilar" @@ -107,36 +108,107 @@ To carry out this task, the `Test-CsGroupIM` cmdlet is called, along with the fo ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. +### -Authentication + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of authentication used in the test. +Allowed values are: + +* TrustedServer +* Negotiate +* ClientCertificate +* LiveID + +```yaml +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. + +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: olv -Required: True -Position: 2 +Required: False +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -OutVerboseVariable + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. + + ```yaml Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: ovv Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -ReceiverCredential + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + User credential object for the first of the two user accounts to be tested. The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: @@ -151,7 +223,6 @@ The receiver credential is not required if you are running the test under the he Type: PSCredential Parameter Sets: ClientPlatform Aliases: rc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -161,6 +232,9 @@ Accept wildcard characters: False ``` ### -ReceiverSipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address for the first of the two user accounts to be tested. For example: `-ReceiverSipAddress "sip:pilar@litwareinc.com"`. The ReceiverSipAddress parameter must reference the same user account as ReceiverCredential. @@ -170,9 +244,8 @@ The SIP address is not required if you are running the test under the health mon ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ServerPlatform, ClientPlatform Aliases: ra -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -181,20 +254,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: ra -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -RegistrarPort -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -RegistrarPort SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -202,7 +265,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -212,6 +274,9 @@ Accept wildcard characters: False ``` ### -SenderCredential + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + User credential object for the second of the two user accounts to be tested. The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: @@ -226,7 +291,6 @@ The sender credential is not required if you are running the test under the heal Type: PSCredential Parameter Sets: ClientPlatform Aliases: sc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -236,6 +300,9 @@ Accept wildcard characters: False ``` ### -SenderSipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address for the second of the two user accounts to be tested. For example: `-SenderSipAddres "sip:kenmyer@litwareinc.com"`. The SenderSipAddress parameter must reference the same user account as SenderCredential. @@ -245,38 +312,8 @@ The SIP address is not required if you are running the test under the health mon ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ServerPlatform, ClientPlatform Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -285,104 +322,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: - -`-OutVerboseVariable TestOutput` +### -TargetFqdn -Do not prepend a $ character when specifying the variable name. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml Type: String -Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Authentication -Type of authentication used in the test. -Allowed values are: - -* TrustedServer -* Negotiate -* ClientCertificate -* LiveID - -```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: - -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` - -To save the information stored in the logger variable to an XML file, use a command similar to this: - -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +### -TestJoinLauncher -```yaml -Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TestJoinLauncher When present, tests the ability of the Join Launcher to participate in an AV conference. The Join Launcher is used to help users of mobile devices (and, as a result, users of the Mobility Service) take part in conferences. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -396,13 +364,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsGroupIM` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsGroupIM` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsIM.md b/skype/skype-ps/SkypeForBusiness/Test-CsIM.md similarity index 81% rename from skype/skype-ps/skype/Test-CsIM.md rename to skype/skype-ps/SkypeForBusiness/Test-CsIM.md index 76029053a9..6df538d3cf 100644 --- a/skype/skype-ps/skype/Test-CsIM.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsIM.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csim applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsIM -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csim +schema: 2.0.0 +title: Test-CsIM --- # Test-CsIM @@ -57,7 +58,7 @@ Assuming the two logons are successful, the cmdlet then initiates an instant mes ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsIm -TargetFqdn atl-cs-001.litwareinc.com ``` @@ -72,7 +73,7 @@ If you have not defined a Registrar for a pool, then you must include the Sender The`Test-CsIM` cmdlet will then conduct its checks by using the two specified users. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred1 = Get-Credential "litwareinc\pilar" @@ -92,55 +93,47 @@ To do this, the `Test-CsIM` cmdlet is called along with the following parameters ## PARAMETERS -### -ReceiverCredential -User credential object for the first of the two user accounts to be tested. -The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: +### -Authentication -`$y = Get-Credential "litwareinc\pilar"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You need to supply the user password when running this command. +Type of authentication used in the test. +Allowed values are: -The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool. +TrustedServer -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: rc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Negotiate -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +ClientCertificate -### -ReceiverSipAddress -SIP address for the first of the two user accounts to be tested. -For example: `-ReceiverSipAddress "sip:jhaas@litwareinc.com"`. -The ReceiverSipAddress parameter must reference the same user account as ReceiverCredential. +LiveID -The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: ra -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -EmailHost + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Email host for user employed in the Legal Intercept test. +For example: + +`-EmailHost "litwareinc.com"` + ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: ra -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -149,55 +142,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SenderCredential -User credential object for the second of the two user accounts to be tested. -The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: - -`$x = Get-Credential "litwareinc\kenmyer"` +### -Force -You need to supply the user password when running this command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: sc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SenderSipAddress -SIP address for the second of the two user accounts to be tested. -For example: `-SenderSipAddress "sip:kenmyer@litwareinc.com"`. -The SenderSipAddress parameter must reference the same user account as SenderCredential. - -The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. +### -IsSsl -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +When set to True, specifies that the test is being conducted using the Secure Socket Layer (SSL) protocol. ```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: Boolean +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -206,44 +178,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. +### -OutLoggerVariable -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +To store output in a logger variable named $TestOutput use the following syntax: -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +`-OutLoggerVariable TestOutput` -### -RegistrarPort -SIP port used by the Registrar service. -This parameter is not required if the Registrar uses the default port 5061. +Note: Do not use prepend a $ character when specifying the variable name.To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml -Type: Int32 +Type: String Parameter Sets: (All) -Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: olv Required: False Position: Named @@ -252,14 +209,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -OutVerboseVariable + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: ovv Required: False Position: Named @@ -268,14 +233,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. +### -Password + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Password for the employed in the Legal Intercept test. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Aliases: Required: False Position: Named @@ -284,20 +251,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: - -`-OutVerboseVariable TestOutput` +### -Port -Do not prepend a $ character when specifying the variable name. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Port used for the Legal Intercept service. ```yaml -Type: String +Type: UInt16 Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -306,59 +269,65 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Authentication -Type of authentication used in the test. -Allowed values are: +### -ReceiverCredential -TrustedServer +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Negotiate +User credential object for the first of the two user accounts to be tested. +The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: -ClientCertificate +`$y = Get-Credential "litwareinc\pilar"` -LiveID +You need to supply the user password when running this command. +The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: rc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -EmailHost -Email host for user employed in the Legal Intercept test. -For example: +### -ReceiverSipAddress -`-EmailHost "litwareinc.com"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the first of the two user accounts to be tested. +For example: `-ReceiverSipAddress "sip:jhaas@litwareinc.com"`. +The ReceiverSipAddress parameter must reference the same user account as ReceiverCredential. + +The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ClientPlatform, ServerPlatform +Aliases: ra -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -IsSsl -When set to True, specifies that the test is being conducted using the Secure Socket Layer (SSL) protocol. +### -RegistrarPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP port used by the Registrar service. +This parameter is not required if the Registrar uses the default port 5061. ```yaml -Type: Boolean +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: rp Required: False Position: Named @@ -367,75 +336,82 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: +### -SenderCredential -`-OutLoggerVariable TestOutput` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note: Do not use prepend a $ character when specifying the variable name.To save the information stored in the logger variable to an HTML file, use a command similar to this: +User credential object for the second of the two user accounts to be tested. +The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +`$x = Get-Credential "litwareinc\kenmyer"` -To save the information stored in the logger variable to an XML file, use a command similar to this: +You need to supply the user password when running this command. -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: sc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Password -Password for the employed in the Legal Intercept test. +### -SenderSipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the second of the two user accounts to be tested. +For example: `-SenderSipAddress "sip:kenmyer@litwareinc.com"`. +The SenderSipAddress parameter must reference the same user account as SenderCredential. + +The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ClientPlatform, ServerPlatform +Aliases: sa -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Port -Port used for the Legal Intercept service. +### -TargetFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml -Type: UInt16 -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ClientPlatform, ServerPlatform +Aliases: t Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -TestLegalIntercept + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When used, instructs `Test-CsIM` to test the Legal Intercept service for the specified user. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -445,13 +421,15 @@ Accept wildcard characters: False ``` ### -Username + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + User name for the user employed in the Legal Intercept test. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -461,13 +439,15 @@ Accept wildcard characters: False ``` ### -WaitSeconds + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Specifies the amount of time (in seconds) that the system should wait for the Legal Intercept service to respond. ```yaml Type: Int16 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -481,13 +461,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsIM` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsIM` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsInterTrunkRouting.md b/skype/skype-ps/SkypeForBusiness/Test-CsInterTrunkRouting.md similarity index 88% rename from skype/skype-ps/skype/Test-CsInterTrunkRouting.md rename to skype/skype-ps/SkypeForBusiness/Test-CsInterTrunkRouting.md index c0afe78bea..052513b19f 100644 --- a/skype/skype-ps/skype/Test-CsInterTrunkRouting.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsInterTrunkRouting.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csintertrunkrouting applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsInterTrunkRouting -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csintertrunkrouting +schema: 2.0.0 +title: Test-CsInterTrunkRouting --- # Test-CsInterTrunkRouting @@ -34,7 +35,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Test- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $trunk = Get-CsTrunkConfiguration -Identity "site:Redmond" @@ -46,79 +47,87 @@ The commands shown in Example 1 return the matching routes and matching phone us ## PARAMETERS -### -TargetNumber -PSTN telephone number to be called when conducting the test. -The target phone number should specified using the E.164 format, which means that the number will look something like this: +### -Force -`-TargetNumber "tel:+12065551219"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The phone number should include the "tel:" prefix followed by a plus sign (+), the country/region calling code (1), the area code (206) and the phone number (5551219). -Do not use dashes, parentheses, or any other characters when specifying the phone number. +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: PhoneNumber +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TrunkConfiguration -Object reference to the trunk configuration being tested. +### -RouteSettings + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Object reference that enables you to specify a collection of voice routing configuration settings when calling `Test-CsInterTrunkRouting`. To create this object reference, use a command similar to this: -`$trunk = Get-CsTrunkConfiguration -Identity "site:Redmond"` +`$route = Get-CsRoutingConfiguration -Identity "global"` ```yaml -Type: TrunkConfiguration +Type: PstnRoutingSettings Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -TargetNumber + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +PSTN telephone number to be called when conducting the test. +The target phone number should specified using the E.164 format, which means that the number will look something like this: + +`-TargetNumber "tel:+12065551219"` + +The phone number should include the "tel:" prefix followed by a plus sign (+), the country/region calling code (1), the area code (206) and the phone number (5551219). +Do not use dashes, parentheses, or any other characters when specifying the phone number. ```yaml -Type: SwitchParameter +Type: PhoneNumber Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RouteSettings -Object reference that enables you to specify a collection of voice routing configuration settings when calling `Test-CsInterTrunkRouting`. +### -TrunkConfiguration + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Object reference to the trunk configuration being tested. To create this object reference, use a command similar to this: -`$route = Get-CsRoutingConfiguration -Identity "global"` +`$trunk = Get-CsTrunkConfiguration -Identity "site:Redmond"` ```yaml -Type: PstnRoutingSettings +Type: TrunkConfiguration Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` @@ -127,13 +136,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None `Test-CsInterTrunkRouting` does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.InterTrunkRoutingTestResult `Test-CsInterTrunkRouting` returns instances of the Microsoft.Rtc.Management.Voice.InterTrunkRoutingTestResult object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsKerberosAccountAssignment.md b/skype/skype-ps/SkypeForBusiness/Test-CsKerberosAccountAssignment.md similarity index 84% rename from skype/skype-ps/skype/Test-CsKerberosAccountAssignment.md rename to skype/skype-ps/SkypeForBusiness/Test-CsKerberosAccountAssignment.md index f5ecfa9315..e5abb73365 100644 --- a/skype/skype-ps/skype/Test-CsKerberosAccountAssignment.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsKerberosAccountAssignment.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cskerberosaccountassignment applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsKerberosAccountAssignment -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-cskerberosaccountassignment +schema: 2.0.0 +title: Test-CsKerberosAccountAssignment --- # Test-CsKerberosAccountAssignment @@ -35,7 +36,7 @@ The `Test-CsKerberosAccountAssignment` cmdlet provides a way for you to verify t ## EXAMPLES -### -------------------------- Example 1 ------------------------ +### Example 1 ``` Test-CsKerberosAccountAssignment -Identity site:Redmond ``` @@ -46,14 +47,16 @@ The command shown in Example 1 verifies that the Kerberos account assigned to th ## PARAMETERS ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the site where the Kerberos account was assigned. For example: `-Identity "site:Redmond"`. ```yaml Type: XdsIdentity Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -63,30 +66,16 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: `-Report "C:\Logs\TestKerberos.html"`. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Aliases: Required: False Position: Named @@ -100,13 +89,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsKerberosAccountAssignment` cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Test-CsKerberosAccountAssignment` cmdlet does not return any objects or values. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsLisCivicAddress.md b/skype/skype-ps/SkypeForBusiness/Test-CsLisCivicAddress.md similarity index 81% rename from skype/skype-ps/skype/Test-CsLisCivicAddress.md rename to skype/skype-ps/SkypeForBusiness/Test-CsLisCivicAddress.md index 2ff376a8bc..3a41985306 100644 --- a/skype/skype-ps/skype/Test-CsLisCivicAddress.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsLisCivicAddress.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csliscivicaddress applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsLisCivicAddress -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csliscivicaddress +schema: 2.0.0 +title: Test-CsLisCivicAddress --- # Test-CsLisCivicAddress @@ -38,7 +39,7 @@ Use the `Get-CsLisCivicAddress` cmdlet to retrieve civic addresses. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsLisCivicAddress -HouseNumber 1234 -HouseNumberSuffix "" -PreDirectional "" -StreetName Main -StreetSuffix St -PostDirectional "" -City Redmond -State WA -PostalCode 99999 -Country US -UpdateValidationStatus ``` @@ -47,7 +48,7 @@ This command validates the address with the properties matching the values speci Notice the inclusion of the UpdateValidationStatus parameter at the end: this will update the MSAGValid property of the address. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsLisCivicAddress | Test-CsLisCivicAddress -UpdateValidationStatus ``` @@ -60,6 +61,9 @@ These addresses are piped to the `Test-CsLisCivicAddress` cmdlet, which uses the ## PARAMETERS ### -City + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The location city. Maximum length: 64 characters. @@ -67,8 +71,7 @@ Maximum length: 64 characters. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -78,6 +81,9 @@ Accept wildcard characters: False ``` ### -Country + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The country/region this location is in. Maximum length: 2 characters @@ -85,8 +91,7 @@ Maximum length: 2 characters ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -96,6 +101,9 @@ Accept wildcard characters: False ``` ### -HouseNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The house number of the location. For a company, this is the number on the street where the company is located. @@ -104,8 +112,7 @@ Maximum length: 10 characters ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -115,6 +122,9 @@ Accept wildcard characters: False ``` ### -HouseNumberSuffix + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Additional information for the house number, such as 1/2 or A. For example, 1234 1/2 Oak Street or 1234 A Elm Street. @@ -123,8 +133,7 @@ Maximum length: 5 characters ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -134,6 +143,9 @@ Accept wildcard characters: False ``` ### -PostalCode + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The postal code associated with this location. Maximum length: 10 characters @@ -141,8 +153,7 @@ Maximum length: 10 characters ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -152,6 +163,9 @@ Accept wildcard characters: False ``` ### -PostDirectional + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The directional designation of a street name. For example, NE or NW for Main Street NE or 7th Avenue NW. @@ -160,8 +174,7 @@ Maximum length: 2 characters ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -171,6 +184,9 @@ Accept wildcard characters: False ``` ### -PreDirectional + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The directional designation for a street name that precedes the name of the street. For example, NE or NW for NE Main Street or NW 7th Avenue. @@ -179,8 +195,7 @@ Maximum length: 2 characters ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -190,6 +205,9 @@ Accept wildcard characters: False ``` ### -State + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The state or province associated with this location. Maximum length: 2 characters @@ -197,8 +215,7 @@ Maximum length: 2 characters ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -208,6 +225,9 @@ Accept wildcard characters: False ``` ### -StreetName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The name of the street for this location. Maximum length: 60 characters @@ -215,8 +235,7 @@ Maximum length: 60 characters ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -226,6 +245,9 @@ Accept wildcard characters: False ``` ### -StreetSuffix + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The type of street designated in a street name, such as Street, Avenue, or Court. Maximum length: 10 characters @@ -233,8 +255,7 @@ Maximum length: 10 characters ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -244,6 +265,9 @@ Accept wildcard characters: False ``` ### -UpdateValidationStatus + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Including this parameter will change the MSAGValid property of the civic address depending on whether the address is validated through this cmdlet. If the address is valid, MSAGValid will be set to True. Omitting this parameter will leave the MSAGValid value unchanged. @@ -251,8 +275,7 @@ Omitting this parameter will leave the MSAGValid value unchanged. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -261,14 +284,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -277,14 +302,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -298,12 +325,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### +### System.String Accepts pipelined input containing a Location Information Server (LIS) civic address object. ## OUTPUTS -### +### None This cmdlet does not return a value. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsLisConfiguration.md b/skype/skype-ps/SkypeForBusiness/Test-CsLisConfiguration.md similarity index 83% rename from skype/skype-ps/skype/Test-CsLisConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Test-CsLisConfiguration.md index 40c2654be8..fb39a2563e 100644 --- a/skype/skype-ps/skype/Test-CsLisConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsLisConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cslisconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsLisConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-cslisconfiguration +schema: 2.0.0 +title: Test-CsLisConfiguration --- # Test-CsLisConfiguration @@ -53,7 +54,7 @@ In addition, if you call this cmdlet without supplying any of the optional param ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsLisConfiguration -TargetFqdn atl-cs-001.litwareinc.com -Subnet 192.168.0.0 ``` @@ -67,7 +68,7 @@ To see if a health monitoring configuration exists, run the `Get-CsHealthMonitor To create a new health monitoring configuration, run the `New-CsHealthMonitoringConfiguration` cmdlet. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Test-CsLisConfiguration -TargetFqdn atl-cs-001.litwareinc.com -Subnet 192.168.0.0 -UserSipAddress sip:kmyer@litwareinc.com ``` @@ -76,7 +77,7 @@ This example is identical to Example 1 but with the addition of the UserSipAddre Use this command when no synthetic transaction users have been set up, but where the computer on which the command is running has a server certificate. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $cred = Get-Credential @@ -90,7 +91,7 @@ The second line is identical to the command in Example 2 but with the addition o Use this command when no synthetic transaction users have been set up, and where the computer on which the command is running does not have a server certificate. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` $cred = Get-Credential @@ -107,7 +108,7 @@ If a location can be found that maps to the subnet IP address 192.168.0.0, the M Use this command when the computer on which the command is running does not have a server certificate. -### -------------------------- Example 5 -------------------------- +### Example 5 ``` Test-CsLisConfiguration -TargetUri https://atl-cs-001.litwareinc.com/locationinformation/lisservice.svc -UserSipAddress sip:kmyer@litwareinc.com -Subnet 192.168.0.0 -Mac 0A-23-00-00-00-AA -PortId 4500 -ChassisId 0A-23-00-00-00-AA ``` @@ -118,92 +119,82 @@ Use this command when the computer on which the command is running has a server ## PARAMETERS -### -TargetFqdn -The fully qualified domain name (FQDN) (in the form server.litwareinc.com) of the server against which you want to run the test. +### -Authentication -This parameter is required unless you specify the TargetUri parameter, in which case you cannot specify a TargetFqdn. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type of authentication used in the test. +Allowed values are: + +TrustedServer + +Negotiate + +ClientCertificate + +LiveID -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` ```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetUri -The Uniform Resource Identifier (URI) of the Location Information service. -You can retrieve the URI of the Location Information service by running the following command: `Get-CsService -WebServer | Select-Object LisServiceInternalUri` +### -BssId -If you specify a value for this parameter, the UserSipAddress parameter is also required. -If the computer you are running the command on does not have a server certificate, you must also specify a value for the WebCredential parameter. - -This parameter is required unless you specify the TargetFqdn parameter. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +The Basic Service Set Identifier (BSSID) of a wireless access point. +This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. ```yaml Type: String -Parameter Sets: TargetUri -Aliases: twsu -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: b -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserCredential -An object containing user credentials for accessing the Location Information service. -This object can be retrieved by calling the `Get-Credential` cmdlet and supplying the appropriate credentials. +### -ChassisId -This parameter is required if the TargetFqdn and UserSipAddress parameters are specified, and if the computer from which you're running the cmdlet does not have a server certificate. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Media Access Control (MAC) address of a network switch. +This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab, or an IP address. ```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: uc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: c -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -The SIP address of a remote user. +### -External -If you specify a value for this parameter, the TargetFqdn or TargetUri parameter is also required. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -This parameter is required when you specify the TargetFqdn parameter only if you have not set up synthetic transactions users. -To see if synthetic transaction users have been set up, run the `Get-CsHealthMonitoringConfiguration` cmdlet. +This parameter is not supported for Location Information Server. ```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: Required: False Position: Named @@ -212,28 +203,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + ```yaml -Type: String -Parameter Sets: ClientPlatform, TargetUri -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BssId -The Basic Service Set Identifier (BSSID) of a wireless access point. +### -Mac + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The MAC address of the port switch. This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. ```yaml Type: String Parameter Sets: (All) -Aliases: b -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: m Required: False Position: Named @@ -242,15 +240,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ChassisId -The Media Access Control (MAC) address of a network switch. -This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab, or an IP address. +### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. + +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml Type: String Parameter Sets: (All) -Aliases: c -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: olv Required: False Position: Named @@ -259,31 +271,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -External -This parameter is not supported for Location Information Server. +### -OutVerboseVariable -```yaml -Type: SwitchParameter -Parameter Sets: ServerPlatform, ClientPlatform -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. -### -Mac -The MAC address of the port switch. -This value must be in the form nn-nn-nn-nn-nn-nn, such as 12-34-56-78-90-ab. ```yaml Type: String Parameter Sets: (All) -Aliases: m -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: ovv Required: False Position: Named @@ -293,6 +296,9 @@ Accept wildcard characters: False ``` ### -PortId + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The ID of the port associated with the location to test. This can also contain a MAC address or IP address. @@ -300,7 +306,6 @@ This can also contain a MAC address or IP address. Type: String Parameter Sets: (All) Aliases: p -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -310,6 +315,9 @@ Accept wildcard characters: False ``` ### -PortIdSubType + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The subtype of the port. This value can be entered as a numeric value or a string, but it must be a valid subtype. Valid subtypes are: @@ -324,7 +332,6 @@ Valid subtypes are: Type: PortIDSubType Parameter Sets: (All) Aliases: ps -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -334,13 +341,15 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The port number of the Registrar service. ```yaml Type: Int32 Parameter Sets: ServerPlatform, ClientPlatform Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -350,6 +359,9 @@ Accept wildcard characters: False ``` ### -Subnet + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The IP address of a subnet. This value should be entered as an IPv4 address (digits separated by periods, such as 192.0.2.0). @@ -357,7 +369,6 @@ This value should be entered as an IPv4 address (digits separated by periods, su Type: String Parameter Sets: (All) Aliases: s -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -366,81 +377,87 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WebCredential -An object containing user credentials for accessing the Location Information service. -This object can be retrieved by calling the `Get-Credential` cmdlet and supplying the appropriate credentials. +### -TargetFqdn -This parameter is required if the TargetUri and UserSipAddress parameters are specified, and the computer on which the command is run does not have a server certificate. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The fully qualified domain name (FQDN) (in the form server.litwareinc.com) of the server against which you want to run the test. + +This parameter is required unless you specify the TargetUri parameter, in which case you cannot specify a TargetFqdn. ```yaml -Type: PSCredential -Parameter Sets: TargetUri -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +### -TargetUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The Uniform Resource Identifier (URI) of the Location Information service. +You can retrieve the URI of the Location Information service by running the following command: `Get-CsService -WebServer | Select-Object LisServiceInternalUri` + +If you specify a value for this parameter, the UserSipAddress parameter is also required. +If the computer you are running the command on does not have a server certificate, you must also specify a value for the WebCredential parameter. + +This parameter is required unless you specify the TargetFqdn parameter. + ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: TargetUri +Aliases: twsu -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: +### -UserCredential -`-OutVerboseVariable TestOutput` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Do not prepend a $ character when specifying the variable name. +An object containing user credentials for accessing the Location Information service. +This object can be retrieved by calling the `Get-Credential` cmdlet and supplying the appropriate credentials. +This parameter is required if the TargetFqdn and UserSipAddress parameters are specified, and if the computer from which you're running the cmdlet does not have a server certificate. ```yaml -Type: String -Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: uc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Authentication -Type of authentication used in the test. -Allowed values are: - -TrustedServer +### -UserSipAddress -Negotiate +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -ClientCertificate +The SIP address of a remote user. -LiveID +If you specify a value for this parameter, the TargetFqdn or TargetUri parameter is also required. +This parameter is required when you specify the TargetFqdn parameter only if you have not set up synthetic transactions users. +To see if synthetic transaction users have been set up, run the `Get-CsHealthMonitoringConfiguration` cmdlet. ```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ServerPlatform, ClientPlatform, TargetUri +Aliases: ua Required: False Position: Named @@ -449,27 +466,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: +### -WebCredential -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -To save the information stored in the logger variable to an XML file, use a command similar to this: +An object containing user credentials for accessing the Location Information service. +This object can be retrieved by calling the `Get-Credential` cmdlet and supplying the appropriate credentials. -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +This parameter is required if the TargetUri and UserSipAddress parameters are specified, and the computer on which the command is run does not have a server certificate. ```yaml -Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: TargetUri +Aliases: Required: False Position: Named @@ -483,12 +492,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsLisConfiguration` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsLocationPolicy.md b/skype/skype-ps/SkypeForBusiness/Test-CsLocationPolicy.md similarity index 84% rename from skype/skype-ps/skype/Test-CsLocationPolicy.md rename to skype/skype-ps/SkypeForBusiness/Test-CsLocationPolicy.md index a4881b7d5b..25da4f3b0a 100644 --- a/skype/skype-ps/skype/Test-CsLocationPolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsLocationPolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cslocationpolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsLocationPolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-cslocationpolicy +schema: 2.0.0 +title: Test-CsLocationPolicy --- # Test-CsLocationPolicy @@ -58,7 +59,7 @@ If a location policy for the subnet was not found, the LocationPolicyTagID will ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsLocationPolicy -TargetFqdn atl-cs-001.litwareinc.com ``` @@ -67,7 +68,7 @@ This example determines the location policy of the current user (or currently co The TargetFqdn is required. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred = Get-Credential "litwareinc\kenmyer" @@ -87,7 +88,7 @@ However, in this example rather than using the preconfigured user, we're going t We pass that value (with the sip: prefix) to the UserSipAddress parameter, and the credentials for that user (stored in the $cred variable) to the UserCredential parameter. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Test-CsLocationPolicy -TargetFqdn atl-cs-001.litwareinc.com -UserSipAddress "sip:kenmyer@litwareinc.com" ``` @@ -98,7 +99,7 @@ If the computer does not have a server certificate, you must specify credentials To find out whether there is a server certificate on the computer, call the `Get-CsCertificate` cmdlet. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` Test-CsLocationPolicy -TargetFqdn atl-cs-001.litwareinc.com -Subnet 172.15.11.0 ``` @@ -116,44 +117,40 @@ For example: ## PARAMETERS -### -TargetFqdn -The fully qualified domain name (FQDN) of the pool on which the specified user or subnet is homed. -(If no user is specified, the preconfigured or current user will be assumed.) +### -Authentication -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Type of authentication used in the test. +Allowed values are: + +* TrustedServer +* Negotiate +* ClientCertificate +* LiveID ```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RegistrarPort -The port number of the Registrar service. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml -Type: Int32 +Type: SwitchParameter Parameter Sets: (All) -Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,14 +159,29 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Subnet -The ID (the IP address) of the network subnet for which you want to test the location policy. +### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. + +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name.To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml Type: String Parameter Sets: (All) -Aliases: s -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: olv Required: False Position: Named @@ -178,33 +190,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserCredential -An object containing the user ID and password of the user account where the location policy is being tested. -A credential object can be retrieved by calling the `Get-Credential` cmdlet, filling in the appropriate information, and saving the output to a variable. +### -OutVerboseVariable +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: uc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. -### -UserSipAddress -The SIP address of the user whose location policy you want to test. -This must be in the format sip:\, for example, sip:kenmyer@litwareinc.com. ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: ovv Required: False Position: Named @@ -213,27 +214,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -RegistrarPort -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. +The port number of the Registrar service. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: rp Required: False Position: Named @@ -242,20 +232,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: - -`-OutVerboseVariable TestOutput` +### -Subnet -Do not prepend a $ character when specifying the variable name. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +The ID (the IP address) of the network subnet for which you want to test the location policy. ```yaml Type: String Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: s Required: False Position: Named @@ -264,49 +250,55 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Authentication -Type of authentication used in the test. -Allowed values are: +### -TargetFqdn -* TrustedServer -* Negotiate -* ClientCertificate -* LiveID +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The fully qualified domain name (FQDN) of the pool on which the specified user or subnet is homed. +(If no user is specified, the preconfigured or current user will be assumed.) ```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. +### -UserCredential -To store output in a logger variable named $TestOutput use the following syntax: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-OutLoggerVariable TestOutput` +An object containing the user ID and password of the user account where the location policy is being tested. +A credential object can be retrieved by calling the `Get-Credential` cmdlet, filling in the appropriate information, and saving the output to a variable. -Note: Do not use prepend a $ character when specifying the variable name.To save the information stored in the logger variable to an HTML file, use a command similar to this: +```yaml +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: uc -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` -To save the information stored in the logger variable to an XML file, use a command similar to this: +### -UserSipAddress -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The SIP address of the user whose location policy you want to test. +This must be in the format sip:\, for example, sip:kenmyer@litwareinc.com. ```yaml Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: ua Required: False Position: Named @@ -320,12 +312,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsLocationPolicy` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsManagementServer.md b/skype/skype-ps/SkypeForBusiness/Test-CsManagementServer.md similarity index 91% rename from skype/skype-ps/skype/Test-CsManagementServer.md rename to skype/skype-ps/SkypeForBusiness/Test-CsManagementServer.md index 3f9787e03b..9fab82dd28 100644 --- a/skype/skype-ps/skype/Test-CsManagementServer.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsManagementServer.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csmanagementserver applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsManagementServer -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csmanagementserver +schema: 2.0.0 +title: Test-CsManagementServer --- # Test-CsManagementServer @@ -32,7 +33,7 @@ The `Test-CsManagementServer` cmdlet enables you verify that the Management serv ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsManagementServer ``` @@ -44,6 +45,9 @@ Because there can only be a single instance of this service, no additional param ## PARAMETERS ### -Report + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: @@ -52,8 +56,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -67,13 +70,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `test-CsManagementServer` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsManagementServer` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsMcxConference.md b/skype/skype-ps/SkypeForBusiness/Test-CsMcxConference.md similarity index 90% rename from skype/skype-ps/skype/Test-CsMcxConference.md rename to skype/skype-ps/SkypeForBusiness/Test-CsMcxConference.md index ead7987bb7..2bc90d8807 100644 --- a/skype/skype-ps/skype/Test-CsMcxConference.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsMcxConference.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csmcxconference applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015 -title: Test-CsMcxConference -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csmcxconference +schema: 2.0.0 +title: Test-CsMcxConference --- # Test-CsMcxConference @@ -63,13 +64,15 @@ After the credentials objects have been created, you can then call the `Test-CsM ## PARAMETERS ### -Authentication + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Allowed values are: TrustedServer; Negotiate; ClientCertificate; and LiveID. ```yaml Type: AuthenticationMechanism Parameter Sets: (All) Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: Named @@ -78,7 +81,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -OrganizerCredential + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + User credential object for the user account acting as the meeting organizer. The value passed to OrganizerCredential should be an object reference obtained by using the `Get-Credential` cmdlet. For example, this code returns a credentials object for the user litwareinc\adelaney and stores that object in a variable named $z: @@ -91,7 +115,6 @@ You need to supply the user password when running this command. Type: PSCredential Parameter Sets: (All) Aliases: oc -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: Named @@ -101,6 +124,9 @@ Accept wildcard characters: False ``` ### -OrganizerSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + SIP address for the user account acting as the meeting organizer. For example: @@ -112,7 +138,6 @@ The OrganizerSipAddress parameter must reference the same user account as the Or Type: String Parameter Sets: (All) Aliases: oa -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: Named @@ -121,187 +146,187 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. +### -OutLoggerVariable -```yaml -Type: String -Parameter Sets: (All) -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. -### -User2Credential -User credential object for the second of the two user accounts to be tested. -The value passed to Use2rCredential should be an object reference obtained by using the`Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $y: +To store output in a logger variable named $TestOutput use the following syntax: -`$y = Get-Credential "litwareinc\kenmyer"` +`-OutLoggerVariable TestOutput` -You need to supply the user password when running this command. +Note: Do not use prepend a $ character when specifying the variable name. + +To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml -Type: PSCredential +Type: String Parameter Sets: (All) -Aliases: spc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: olv -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -User2SipAddress -SIP address for the second of the two user accounts to be tested. -For example: +### -OutVerboseVariable -`-User2SipAddress "sip:pilar@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The User2SipAddress parameter must reference the same user account as the User2Credential parameter. +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax + +`-OutVerboseVariable TestOutput` + +Do not use prepend a $ character when specifying the variable name. ```yaml Type: String Parameter Sets: (All) -Aliases: spa -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: ovv -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserCredential -User credentials object for the first of the two user accounts to be tested. -The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $x: +### -RegistrarPort -`$x = Get-Credential "litwareinc\pilar"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You need to supply the user password when running this command. +SIP port used by the Registrar service. +This parameter is not required if the Registrar uses the default port 5061. ```yaml -Type: PSCredential +Type: Int32 Parameter Sets: (All) -Aliases: fpc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: rp -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address for the first of the two user accounts to be tested. -For example: +### -TargetFqdn -`-UserSipAddress "sip:kenmyer@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -The UserSipAddress parameter must reference the same user account as the UserCredential parameter. +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml Type: String Parameter Sets: (All) -Aliases: fpa -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: t Required: True -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -User2Credential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for the second of the two user accounts to be tested. +The value passed to Use2rCredential should be an object reference obtained by using the`Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $y: + +`$y = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. ```yaml -Type: SwitchParameter +Type: PSCredential Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: spc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not use prepend a $ character when specifying the variable name. +### -User2SipAddress -To save the information stored in the logger variable to an HTML file, use a command similar to this: +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +SIP address for the second of the two user accounts to be tested. +For example: -To save the information stored in the logger variable to an XML file, use a command similar to this: +`-User2SipAddress "sip:pilar@litwareinc.com"` -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +The User2SipAddress parameter must reference the same user account as the User2Credential parameter. ```yaml Type: String Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: spa -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax +### -UserCredential -`-OutVerboseVariable TestOutput` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Do not use prepend a $ character when specifying the variable name. +User credentials object for the first of the two user accounts to be tested. +The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $x: + +`$x = Get-Credential "litwareinc\pilar"` + +You need to supply the user password when running this command. ```yaml -Type: String +Type: PSCredential Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: fpc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RegistrarPort -SIP port used by the Registrar service. -This parameter is not required if the Registrar uses the default port 5061. +### -UserSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the first of the two user accounts to be tested. +For example: + +`-UserSipAddress "sip:kenmyer@litwareinc.com"` + +The UserSipAddress parameter must reference the same user account as the UserCredential parameter. ```yaml -Type: Int32 +Type: String Parameter Sets: (All) -Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: fpa -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False diff --git a/skype/skype-ps/skype/Test-CsMcxP2PIM.md b/skype/skype-ps/SkypeForBusiness/Test-CsMcxP2PIM.md similarity index 92% rename from skype/skype-ps/skype/Test-CsMcxP2PIM.md rename to skype/skype-ps/SkypeForBusiness/Test-CsMcxP2PIM.md index b56a148b8b..0c81dbce50 100644 --- a/skype/skype-ps/skype/Test-CsMcxP2PIM.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsMcxP2PIM.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csmcxp2pim applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015 -title: Test-CsMcxP2PIM -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csmcxp2pim +schema: 2.0.0 +title: Test-CsMcxP2PIM --- # Test-CsMcxP2PIM @@ -41,7 +42,7 @@ Instead, the cmdlet verifies that the two users are able to log on to Skype for ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $credential1 = Get-Credential "litwareinc\kenmyer" @@ -59,13 +60,15 @@ After the credential objects have been created, the final command calls the `Tes ## PARAMETERS ### -Authentication + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Allowed values are: TrustedServer; Negotiate; ClientCertificate; and LiveID. ```yaml Type: AuthenticationMechanism Parameter Sets: (All) Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: Named @@ -74,84 +77,96 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceiverCredential -User credentials object for the first of the two user accounts to be tested. -The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: +### -Force -`$y = Get-Credential "litwareinc\pilar"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -You need to supply the user password when running this command. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSCredential +Type: SwitchParameter Parameter Sets: (All) -Aliases: rc -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceiverSipAddress -SIP address for the first of the two user accounts to be tested. -For example: +### -OutLoggerVariable -`-ReceiverSipAddress "sip:pilar@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -The ReceiverSipAddress parameter must reference the same user account as the ReceiverCredential parameter. +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. + +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name. + +To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml Type: String Parameter Sets: (All) -Aliases: ra -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: olv -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SenderCredential -User credentials object for the second of the two user accounts to be tested. -The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: +### -OutVerboseVariable -`$x = Get-Credential "litwareinc\kenmyer"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -You need to supply the user password when running this command. +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not use prepend a $ character when specifying the variable name. ```yaml -Type: PSCredential +Type: String Parameter Sets: (All) -Aliases: sc -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: ovv -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SenderSipAddress -SIP address for the second of the two user accounts to be tested. -For example: +### -ReceiverCredential -`-SenderSipAddress "sip:kenmyer@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -The SenderSipAddress parameter must reference the same user account as the SenderCredential parameter. +User credentials object for the first of the two user accounts to be tested. +The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: + +`$y = Get-Credential "litwareinc\pilar"` + +You need to supply the user password when running this command. ```yaml -Type: String +Type: PSCredential Parameter Sets: (All) -Aliases: sa -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: rc Required: True Position: Named @@ -160,30 +175,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. +### -ReceiverSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +SIP address for the first of the two user accounts to be tested. +For example: + +`-ReceiverSipAddress "sip:pilar@litwareinc.com"` + +The ReceiverSipAddress parameter must reference the same user account as the ReceiverCredential parameter. ```yaml Type: String Parameter Sets: (All) -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: ra Required: True -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -RegistrarPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +SIP port used by the Registrar service. +This parameter is not required if the Registrar uses the default port 5061. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: rp Required: False Position: Named @@ -192,70 +217,66 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not use prepend a $ character when specifying the variable name. +### -SenderCredential -To save the information stored in the logger variable to an HTML file, use a command similar to this: +> Applicable: Lync Server 2013, Skype for Business Server 2015 -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +User credentials object for the second of the two user accounts to be tested. +The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: -To save the information stored in the logger variable to an XML file, use a command similar to this: +`$x = Get-Credential "litwareinc\kenmyer"` -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +You need to supply the user password when running this command. ```yaml -Type: String +Type: PSCredential Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: sc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: +### -SenderSipAddress -`-OutVerboseVariable TestOutput` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -Do not use prepend a $ character when specifying the variable name. +SIP address for the second of the two user accounts to be tested. +For example: + +`-SenderSipAddress "sip:kenmyer@litwareinc.com"` + +The SenderSipAddress parameter must reference the same user account as the SenderCredential parameter. ```yaml Type: String Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: sa -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -RegistrarPort -SIP port used by the Registrar service. -This parameter is not required if the Registrar uses the default port 5061. +### -TargetFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml -Type: Int32 +Type: String Parameter Sets: (All) -Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -266,13 +287,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsMcxP2PIM` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsMcxP2PIM` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsMcxPushNotification.md b/skype/skype-ps/SkypeForBusiness/Test-CsMcxPushNotification.md similarity index 92% rename from skype/skype-ps/skype/Test-CsMcxPushNotification.md rename to skype/skype-ps/SkypeForBusiness/Test-CsMcxPushNotification.md index cc044294c2..0268b9c325 100644 --- a/skype/skype-ps/skype/Test-CsMcxPushNotification.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsMcxPushNotification.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csmcxpushnotification applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015 -title: Test-CsMcxPushNotification -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csmcxpushnotification +schema: 2.0.0 +title: Test-CsMcxPushNotification --- # Test-CsMcxPushNotification @@ -42,7 +43,7 @@ When using this cmdlet, make sure that the AccessEdgeFqdn parameter points to th ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsMcxPushNotification -AccessEdgeFqdn "atl-edge-001.litwareinc.com" ``` @@ -54,13 +55,15 @@ The AccessEdgeFqdn must point to the internal edge of the proxy server to which ## PARAMETERS ### -AccessEdgeFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Fully qualified domain name of the Access Edge server used to connect to the push notification service. ```yaml Type: String Parameter Sets: (All) Aliases: fqdn -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: True Position: 2 @@ -70,13 +73,15 @@ Accept wildcard characters: False ``` ### -Certificate + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables you to specify an X509 certificate to use for authentication purposes ```yaml Type: X509Certificate2 Parameter Sets: (All) Aliases: cert -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -86,13 +91,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -102,6 +109,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -123,7 +133,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -133,6 +142,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax @@ -144,7 +156,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -158,13 +169,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsMcxPushNotification` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsMcxPushNotification` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsOUPermission.md b/skype/skype-ps/SkypeForBusiness/Test-CsOUPermission.md similarity index 82% rename from skype/skype-ps/skype/Test-CsOUPermission.md rename to skype/skype-ps/SkypeForBusiness/Test-CsOUPermission.md index 1dfd1ab566..20ebd35390 100644 --- a/skype/skype-ps/skype/Test-CsOUPermission.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsOUPermission.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csoupermission applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsOUPermission -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csoupermission +schema: 2.0.0 +title: Test-CsOUPermission --- # Test-CsOUPermission @@ -36,7 +37,7 @@ If the cmdlet returns False, you will then need to run the `Grant-CsOUPermission ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsOUPermission -OU "ou=Redmond,dc=litwareinc,dc=com" -ObjectType "user" ``` @@ -46,70 +47,58 @@ The command shown in Example 1 verifies that user permissions have been set on t ## PARAMETERS -### -ObjectType -Type of object to be checked. -Valid values are: - -User - -Computer - -Contact - -AppContact - -InetOrgPerson +### -Domain -To check multiple objects in the same kind, separate the object types by using commas: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`-ObjectType "user","computer","contact"` +Name of the domain where the OU to be checked is located. +If this parameter is not included, then the `Test-CsOUPermission` cmdlet will look for the OU on the current domain. ```yaml -Type: ObjectType +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OU -Distinguished name of the organizational unit (OU) to be checked. -For example: +### -DomainController -`-OU "ou=Redmond,dc=litwareinc,dc=com"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note that you can only check a single OU per command. +Fully qualified domain name (FQDN) of a domain controller in your domain. +This parameter is not required if you are running the `Test-CsOUPermission` cmdlet on a computer with an account in your domain. ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Domain -Name of the domain where the OU to be checked is located. -If this parameter is not included, then the `Test-CsOUPermission` cmdlet will look for the OU on the current domain. +### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +FQDN of a global catalog server in your domain. +This parameter is not required if you are running the `Test-CsOUPermission` cmdlet on a computer with an account in your domain. ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -118,36 +107,58 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Fully qualified domain name (FQDN) of a domain controller in your domain. -This parameter is not required if you are running the `Test-CsOUPermission` cmdlet on a computer with an account in your domain. +### -ObjectType + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of object to be checked. +Valid values are: + +User + +Computer + +Contact + +AppContact + +InetOrgPerson + +To check multiple objects in the same kind, separate the object types by using commas: + +`-ObjectType "user","computer","contact"` ```yaml -Type: Fqdn +Type: ObjectType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -GlobalCatalog -FQDN of a global catalog server in your domain. -This parameter is not required if you are running the `Test-CsOUPermission` cmdlet on a computer with an account in your domain. +### -OU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Distinguished name of the organizational unit (OU) to be checked. +For example: + +`-OU "ou=Redmond,dc=litwareinc,dc=com"` + +Note that you can only check a single OU per command. ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -155,6 +166,9 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: @@ -166,24 +180,7 @@ If this file already exists, it will be overwritten when you run the cmdlet. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Aliases: Required: False Position: Named @@ -197,13 +194,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsOUPermission` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsOUPermission` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsP2PAV.md b/skype/skype-ps/SkypeForBusiness/Test-CsP2PAV.md similarity index 82% rename from skype/skype-ps/skype/Test-CsP2PAV.md rename to skype/skype-ps/SkypeForBusiness/Test-CsP2PAV.md index 8c3e9d9900..4ff45484c2 100644 --- a/skype/skype-ps/skype/Test-CsP2PAV.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsP2PAV.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csp2pav applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsP2PAV -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csp2pav +schema: 2.0.0 +title: Test-CsP2PAV --- # Test-CsP2PAV @@ -58,7 +59,7 @@ Instead, the cmdlet simply verifies that the appropriate connections can be made ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsP2PAV -TargetFqdn atl-cs-001.litwareinc.com ``` @@ -72,7 +73,7 @@ If you have not defined test users for a pool, then you must include the SenderS The `Test-CsP2PAV` cmdlet will then conduct its checks using the two specified users. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred1 = Get-Credential "litwareinc\pilar" @@ -92,75 +93,75 @@ To carry out this task, the `Test-CsP2PAV` cmdlet is called, along with the foll ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. +### -Authentication -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of authentication used in the test. +Allowed values are: + +TrustedServer + +Negotiate + +ClientCertificate + +LiveID -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` ```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceiverCredential -User credential object for the first of the two user accounts to be tested. -The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: - -`$y = Get-Credential "litwareinc\pilar"` +### -Force -You need to supply the user password when running this command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: rc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceiverSipAddress -SIP address for the first of the two user accounts to be tested. -For example: +### -OutLoggerVariable -`-ReceiverSipAddress "sip:pilar@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The ReceiverSipAddress parameter must reference the same user account as ReceiverCredential. +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. -The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` +Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: ra -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: olv Required: False Position: Named @@ -169,28 +170,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: ra -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -OutVerboseVariable -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. -### -RegistrarPort -SIP port used by the Registrar service. -This parameter is not required if the Registrar uses the default port 5061. ```yaml -Type: Int32 +Type: String Parameter Sets: (All) -Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: ovv Required: False Position: Named @@ -199,22 +194,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SenderCredential -User credential object for the second of the two user accounts to be tested. -The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: +### -ReceiverCredential -`$x = Get-Credential "litwareinc\kenmyer"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for the first of the two user accounts to be tested. +The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: + +`$y = Get-Credential "litwareinc\pilar"` You need to supply the user password when running this command. -The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool. +The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml Type: PSCredential Parameter Sets: ClientPlatform -Aliases: sc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: rc Required: True Position: Named @@ -223,22 +220,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SenderSipAddress -SIP address for the second of the two user accounts to be tested. +### -ReceiverSipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the first of the two user accounts to be tested. For example: -`-SenderSipAddress "sip:kenmyer@litwareinc.com"` +`-ReceiverSipAddress "sip:pilar@litwareinc.com"` -The SenderSipAddress parameter must reference the same user account as SenderCredential. +The ReceiverSipAddress parameter must reference the same user account as ReceiverCredential. The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. - ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: ra Required: False Position: Named @@ -247,27 +245,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -RegistrarPort -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +SIP port used by the Registrar service. +This parameter is not required if the Registrar uses the default port 5061. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: rp Required: False Position: Named @@ -276,62 +264,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +### -SenderCredential -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: +User credential object for the second of the two user accounts to be tested. +The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: -`-OutVerboseVariable TestOutput` +`$x = Get-Credential "litwareinc\kenmyer"` -Do not prepend a $ character when specifying the variable name. +You need to supply the user password when running this command. +The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: String -Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: sc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Authentication -Type of authentication used in the test. -Allowed values are: +### -SenderSipAddress -TrustedServer +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Negotiate +SIP address for the second of the two user accounts to be tested. +For example: -ClientCertificate +`-SenderSipAddress "sip:kenmyer@litwareinc.com"` -LiveID +The SenderSipAddress parameter must reference the same user account as SenderCredential. + +The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: sa Required: False Position: Named @@ -340,30 +316,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: - -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +### -TargetFqdn -To save the information stored in the logger variable to an XML file, use a command similar to this: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -374,13 +339,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsP2PAV` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsP2PAV` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsP2PVideoInteropServerSipTrunkAV.md b/skype/skype-ps/SkypeForBusiness/Test-CsP2PVideoInteropServerSipTrunkAV.md similarity index 88% rename from skype/skype-ps/skype/Test-CsP2PVideoInteropServerSipTrunkAV.md rename to skype/skype-ps/SkypeForBusiness/Test-CsP2PVideoInteropServerSipTrunkAV.md index 73035ead45..0eb0f5eeda 100644 --- a/skype/skype-ps/skype/Test-CsP2PVideoInteropServerSipTrunkAV.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsP2PVideoInteropServerSipTrunkAV.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csp2pvideointeropserversiptrunkav applicable: Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsP2PVideoInteropServerSipTrunkAV -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csp2pvideointeropserversiptrunkav +schema: 2.0.0 +title: Test-CsP2PVideoInteropServerSipTrunkAV --- # Test-CsP2PVideoInteropServerSipTrunkAV @@ -70,7 +71,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $cred1 = Get-Credential "contoso\user1" @@ -82,57 +83,10 @@ This example creates a credential variable and passes the credential and SIP add ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. - -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserCredential -User credentials object for the account to be tested. -The value passed to UserCredential must be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credential object for the user litwareinc\kenmyer and stores that object in a variable named `$x: $x = Get-Credential "litwareinc\kenmyer"`. -You need to supply the user password when running `Get-Credential`. - -This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. - -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: uc -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +### -Authentication -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -### -Authentication Type of authentication used in the test. Allowed values are: @@ -148,7 +102,6 @@ LiveID Type: AuthenticationMechanism Parameter Sets: (All) Aliases: Ath -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -158,13 +111,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error messages and completes the cmdlet operation. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -174,6 +129,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + When present, the transaction log for the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -195,7 +153,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -205,6 +162,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -216,7 +176,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -226,6 +185,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -233,7 +195,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -242,32 +203,62 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address for user account to be tested; for example: `-UserSipAddress "sip:kenmyer@contoso.com"`. +### -TargetFqdn -The UserSipAddress parameter must reference the same user account as UserCredential. -This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: ua -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserCredential + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +User credentials object for the account to be tested. +The value passed to UserCredential must be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credential object for the user litwareinc\kenmyer and stores that object in a variable named `$x: $x = Get-Credential "litwareinc\kenmyer"`. +You need to supply the user password when running `Get-Credential`. + +This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. + +```yaml +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: uc + +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -UserSipAddress + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for user account to be tested; for example: `-UserSipAddress "sip:kenmyer@contoso.com"`. + +The UserSipAddress parameter must reference the same user account as UserCredential. +This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. + ```yaml Type: String -Parameter Sets: ClientPlatform +Parameter Sets: ServerPlatform, ClientPlatform Aliases: ua -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -279,13 +270,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None +### None ## OUTPUTS -### -None +### None ## NOTES diff --git a/skype/skype-ps/skype/Test-CsPersistentChatMessage.md b/skype/skype-ps/SkypeForBusiness/Test-CsPersistentChatMessage.md similarity index 86% rename from skype/skype-ps/skype/Test-CsPersistentChatMessage.md rename to skype/skype-ps/SkypeForBusiness/Test-CsPersistentChatMessage.md index d670ad8f25..46228b65b9 100644 --- a/skype/skype-ps/skype/Test-CsPersistentChatMessage.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsPersistentChatMessage.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cspersistentchatmessage applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsPersistentChatMessage -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-cspersistentchatmessage +schema: 2.0.0 +title: Test-CsPersistentChatMessage --- # Test-CsPersistentChatMessage @@ -46,7 +47,7 @@ Skype for Business Server Control Panel : The functions carried out by the `Test ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $cred1 = Get-Credential "litwareinc\pilar" @@ -66,84 +67,10 @@ To carry out this task, the `Test-CsPersistentChatMessage` cmdlet is called, alo ## PARAMETERS -### -ReceiverCredential -User credential object for the first of the two user accounts to be tested. -The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: - -`$y = Get-Credential "litwareinc\pilar"` - -You need to supply the user password when running this command. - -The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool. - -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: rc -Applicable: Lync Server 2013, Skype for Business Server 2015 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -SenderCredential -User credential object for the second of the two user accounts to be tested. -The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: - -`$x = Get-Credential "litwareinc\kenmyer"` - -You need to supply the user password when running this command. - -The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool. - -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: sc -Applicable: Lync Server 2013, Skype for Business Server 2015 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetFqdn -Fully qualified domain name (FQDN) of the Registrar pool to be tested. - -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015 +### -Authentication -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -### -Authentication Type of authentication used when running the test. Allowed values are: @@ -160,7 +87,6 @@ LiveID Type: AuthenticationMechanism Parameter Sets: (All) Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -170,6 +96,9 @@ Accept wildcard characters: False ``` ### -ChatRoomUri + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Chat room location, consisting of the fully qualified domain name of the Persistent Chat Server and the name of the chat room. For example: @@ -178,8 +107,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -189,13 +117,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -205,6 +135,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -228,7 +161,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -238,6 +170,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -249,7 +184,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -258,21 +192,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceiverSipAddress -SIP address for the first of the two user accounts to be tested. -For example: +### -ReceiverCredential -`-ReceiverSipAddress "sip:pilar@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -The ReceiverSIPAddress parameter must reference the same user account as ReceiverCredential. +User credential object for the first of the two user accounts to be tested. +The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: -The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. +`$y = Get-Credential "litwareinc\pilar"` + +You need to supply the user password when running this command. + +The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: String +Type: PSCredential Parameter Sets: ClientPlatform -Aliases: ra -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: rc Required: True Position: Named @@ -281,13 +218,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ReceiverSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +SIP address for the first of the two user accounts to be tested. +For example: + +`-ReceiverSipAddress "sip:pilar@litwareinc.com"` + +The ReceiverSIPAddress parameter must reference the same user account as ReceiverCredential. + +The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. + ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ClientPlatform, ServerPlatform Aliases: ra -Applicable: Lync Server 2013, Skype for Business Server 2015 -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -295,6 +244,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -302,7 +254,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -311,21 +262,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SenderSipAddress -SIP address for the second of the two user accounts to be tested. -For example: +### -SenderCredential -`-SenderSipAddress "sip:kenmyer@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015 -The SenderSipAddress parameter must reference the same user account as SenderCredential. +User credential object for the second of the two user accounts to be tested. +The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: -The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. +`$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. + +The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: String +Type: PSCredential Parameter Sets: ClientPlatform -Aliases: sa -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: sc Required: True Position: Named @@ -334,13 +288,25 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -SenderSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +SIP address for the second of the two user accounts to be tested. +For example: + +`-SenderSipAddress "sip:kenmyer@litwareinc.com"` + +The SenderSipAddress parameter must reference the same user account as SenderCredential. + +The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. + ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ClientPlatform, ServerPlatform Aliases: sa -Applicable: Lync Server 2013, Skype for Business Server 2015 -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -348,6 +314,9 @@ Accept wildcard characters: False ``` ### -Setup + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Enables the cmdlet to be run on a watcher node computer that does not have access to the Skype for Business Server topology. To allow for this, first run the `Test-CsPersistentChatMessage` along with the Setup parameter from a computer which does have access to the topology. After that, you will be able to run the cmdlet on your watcher node computers. @@ -358,8 +327,7 @@ If you use the Setup parameter you must also use the TestUser1SipAddress and Tes ```yaml Type: Boolean Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -368,14 +336,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TargetFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Fully qualified domain name (FQDN) of the Registrar pool to be tested. + +```yaml +Type: String +Parameter Sets: ClientPlatform, ServerPlatform +Aliases: t + +Required: False +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -TestUser1SipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + SIP address of the first test user used in conjunction with the Setup parameter. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -385,13 +373,15 @@ Accept wildcard characters: False ``` ### -TestUser2SipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + SIP address of the second test user used in conjunction with the Setup parameter. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -405,13 +395,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsPersistentChatMessage` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsPersistentChatMessage` cmdlet returns instances of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsPhoneBootstrap.md b/skype/skype-ps/SkypeForBusiness/Test-CsPhoneBootstrap.md similarity index 84% rename from skype/skype-ps/skype/Test-CsPhoneBootstrap.md rename to skype/skype-ps/SkypeForBusiness/Test-CsPhoneBootstrap.md index d6cb06ded2..a58bae6135 100644 --- a/skype/skype-ps/skype/Test-CsPhoneBootstrap.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsPhoneBootstrap.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csphonebootstrap applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsPhoneBootstrap -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csphonebootstrap +schema: 2.0.0 +title: Test-CsPhoneBootstrap --- # Test-CsPhoneBootstrap @@ -38,7 +39,7 @@ This can also be done by using Enterprise DHCP Server and configuring the Skype ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsPhoneBootstrap -PhoneOrExtension "+14255551219" -Pin "0712" ``` @@ -47,7 +48,7 @@ The command shown in Example 1 verifies that the user with the specified phone n In order to run the test, the user's phone number (+14255551219) and the user's PIN (0712) must be supplied. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Test-CsPhoneBootstrap -PhoneOrExtension "+14255551219" -Pin "0712" -UserSipAddress "sip:kenmyer@litwareinc.com" ``` @@ -58,48 +59,47 @@ In this example, the UserSipAddress parameter is included as an additional check ## PARAMETERS -### -PhoneOrExt -Telephone number or extension of the user account being tested. -For example: -PhoneOrExt "+14255551219". +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: ph -Applicable: Lync Server 2010, Lync Server 2013 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PIN -PIN of the user account being tested. +### -OutLoggerVariable -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. -### -RegistrarPort -SIP port used by the Registrar service. -This parameter is not required if the Registrar uses the default port 5061. +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml -Type: Int32 +Type: String Parameter Sets: (All) -Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: olv Required: False Position: Named @@ -108,86 +108,97 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetFqdn -Fully qualified domain name (FQDN) of the Registrar pool that hosts the user account to be tested. -If not specified, then DHCP discovery will be used to locate the Registrar pool. +### -OutVerboseVariable + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. + ```yaml Type: String Parameter Sets: (All) -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: ovv Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetUri -URL of the certificate provisioning service. -If this parameter is not included, then the DHCP discovery will be used to locate the target URI. +### -PhoneOrExt + +> Applicable: Lync Server 2010, Lync Server 2013 + +Telephone number or extension of the user account being tested. +For example: -PhoneOrExt "+14255551219". ```yaml Type: String Parameter Sets: (All) -Aliases: twsu -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: ph -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address for the user account used in the text; for example: - -`-UserSipAddress "sip:kenmyer@litwareinc.com"` +### -PhoneOrExtension -The UserSipAddress parameter must reference the supplied phone number and PIN; the test will fail if the included phone number and PIN do not belong to the user specified by the UserSipAddress parameter. -Note that the SIP address must include the "sip:" prefix. +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Telephone number or extension of the user account being tested. +For example: -PhoneOrExt "+14255551219". ```yaml Type: String Parameter Sets: (All) -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: ph -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -PIN + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +PIN of the user account being tested. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. +### -RegistrarPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP port used by the Registrar service. +This parameter is not required if the Registrar uses the default port 5061. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Aliases: rp Required: False Position: Named @@ -196,49 +207,36 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: - -`-OutVerboseVariable TestOutput` +### -TargetFqdn -Do not prepend a $ character when specifying the variable name. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Fully qualified domain name (FQDN) of the Registrar pool that hosts the user account to be tested. +If not specified, then DHCP discovery will be used to locate the Registrar pool. ```yaml Type: String Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: t Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: - -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +### -TargetUri -To save the information stored in the logger variable to an XML file, use a command similar to this: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +URL of the certificate provisioning service. +If this parameter is not included, then the DHCP discovery will be used to locate the target URI. ```yaml Type: String Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: twsu Required: False Position: Named @@ -247,17 +245,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -PhoneOrExtension -Telephone number or extension of the user account being tested. -For example: -PhoneOrExt "+14255551219". +### -UserSipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the user account used in the text; for example: + +`-UserSipAddress "sip:kenmyer@litwareinc.com"` + +The UserSipAddress parameter must reference the supplied phone number and PIN; the test will fail if the included phone number and PIN do not belong to the user specified by the UserSipAddress parameter. +Note that the SIP address must include the "sip:" prefix. + ```yaml Type: String Parameter Sets: (All) -Aliases: ph -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: ua -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -269,13 +274,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsPhoneBootstrap` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsPhoneBootstrap` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsPresence.md b/skype/skype-ps/SkypeForBusiness/Test-CsPresence.md similarity index 83% rename from skype/skype-ps/skype/Test-CsPresence.md rename to skype/skype-ps/SkypeForBusiness/Test-CsPresence.md index 8a2d1f60ca..e43be2c53c 100644 --- a/skype/skype-ps/skype/Test-CsPresence.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsPresence.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cspresence applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsPresence -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-cspresence +schema: 2.0.0 +title: Test-CsPresence --- # Test-CsPresence @@ -64,7 +65,7 @@ After the exchange of presence information, the two test users are then logged o ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsPresence -TargetFqdn atl-cs-001.litwareinc.com ``` @@ -78,7 +79,7 @@ If you have not defined test users for a pool, then you must include the Subscri The `Test-CsPresence` cmdlet will then conduct its checks using the two specified users. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred1 = Get-Credential "litwareinc\pilar" @@ -98,75 +99,71 @@ To carry out this task, the `Test-CsPresence` cmdlet is called, along with the f ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. +### -Authentication -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Type of authentication used in the test. +Allowed values are: + +* TrustedServer +* Negotiate +* ClientCertificate +* LiveID ```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PublisherCredential -User credential object for the first of the two user accounts to be tested. -The value passed to PublisherCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: - -`$x = Get-Credential "litwareinc\kenmyer"` +### -Force -You need to supply the user password when running this command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The publisher credential is not required if you are running the test under the health monitoring configuration settings for the pool. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: pc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -PublisherSipAddress -SIP address for the first of the two user accounts to be tested. -For example: +### -OutLoggerVariable -`-PublisherSipAddress "sip:kenmyer@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The PublisherSipAddress parameter must reference the same user account as PublisherCredential. +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. -The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: pa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: olv Required: False Position: Named @@ -175,35 +172,48 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OutVerboseVariable + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. + + ```yaml Type: String -Parameter Sets: ClientPlatform -Aliases: pa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: ovv -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SubscriberCredential -User credential object for the second of the two user accounts to be tested. -The value passed to SubscriberCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: +### -PublisherCredential -`$y = Get-Credential "litwareinc\pilar"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for the first of the two user accounts to be tested. +The value passed to PublisherCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: + +`$x = Get-Credential "litwareinc\kenmyer"` You need to supply the user password when running this command. -The subscriber credential is not required if you are running the test under the health monitoring configuration settings for the pool. +The publisher credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml Type: PSCredential Parameter Sets: ClientPlatform -Aliases: sc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: pc Required: True Position: Named @@ -212,22 +222,23 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SubscriberSipAddress -SIP address for the second of the two user accounts to be tested. +### -PublisherSipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the first of the two user accounts to be tested. For example: -`-SubscriberSipAddress "sip:pilar@litwareinc.com"` +`-PublisherSipAddress "sip:kenmyer@litwareinc.com"` -The SubscriberSipAddress parameter must reference the same user account as SubscriberCredential. +The PublisherSipAddress parameter must reference the same user account as PublisherCredential. The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. - ```yaml Type: String -Parameter Sets: ServerPlatform, TargetUri -Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: pa Required: False Position: Named @@ -236,20 +247,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -RegistrarPort -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -RegistrarPort SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -257,7 +258,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: ServerPlatform, ClientPlatform Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -266,74 +266,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -SubscriberCredential -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +User credential object for the second of the two user accounts to be tested. +The value passed to SubscriberCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. +`$y = Get-Credential "litwareinc\pilar"` + +You need to supply the user password when running this command. + +The subscriber credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: SwitchParameter -Parameter Sets: ServerPlatform, ClientPlatform -Aliases: vb -Applicable: Lync Server 2010 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: sc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: - -`-OutVerboseVariable TestOutput` +### -SubscriberSipAddress -Do not prepend a $ character when specifying the variable name. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +SIP address for the second of the two user accounts to be tested. +For example: -```yaml -Type: String -Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +`-SubscriberSipAddress "sip:pilar@litwareinc.com"` -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +The SubscriberSipAddress parameter must reference the same user account as SubscriberCredential. -### -Authentication -Type of authentication used in the test. -Allowed values are: +The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. -* TrustedServer -* Negotiate -* ClientCertificate -* LiveID ```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ServerPlatform, TargetUri, ClientPlatform +Aliases: sa Required: False Position: Named @@ -342,43 +318,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: +### -TargetFqdn -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -To save the information stored in the logger variable to an XML file, use a command similar to this: - -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -TimeoutInSeconds + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + PARAMVALUE: UInt32 ```yaml Type: UInt32 Parameter Sets: ServerPlatform, ClientPlatform -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -392,13 +359,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsPresence` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsPresence` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsPstnOutboundCall.md b/skype/skype-ps/SkypeForBusiness/Test-CsPstnOutboundCall.md similarity index 85% rename from skype/skype-ps/skype/Test-CsPstnOutboundCall.md rename to skype/skype-ps/SkypeForBusiness/Test-CsPstnOutboundCall.md index dad3350baa..94bff31c5a 100644 --- a/skype/skype-ps/skype/Test-CsPstnOutboundCall.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsPstnOutboundCall.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cspstnoutboundcall applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsPstnOutboundCall -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-cspstnoutboundcall +schema: 2.0.0 +title: Test-CsPstnOutboundCall --- # Test-CsPstnOutboundCall @@ -60,7 +61,7 @@ This call must also be manually ended by the administrator. ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsPstnOutboundCall -TargetFqdn atl-cs-001.litwareinc.com -TargetPstnPhoneNumber "+15551234567" ``` @@ -74,7 +75,7 @@ If you have not defined test users for a pool, then you must include the UserSip The `Test-CsPstnOutboundCall` cmdlet will then conduct its checks using the specified user. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred1 = Get-Credential "litwareinc\kenmyer" @@ -89,7 +90,7 @@ With the credential object in hand, the second command in the example determines To carry out this task, the `Test-CsPstnOutboundCall` cmdlet is called, along with the following parameters: TargetFqdn (the FQDN of the Registrar pool); UserSipAddress (the SIP address for the user making the call); UserCredential (the Windows PowerShell object containing the credentials for the test user); and TargetPstnPhoneNumber (the phone number being called). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Test-CsPstnOutboundCall -TargetFqdn atl-cs-001.litwareinc.com -UserSipAddress sip:kenmyer@litwareinc.com -TargetPstnPhoneNumber "+15551234567" ``` @@ -101,101 +102,95 @@ When run like this, Skype for Business Server uses certificates to authenticate ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. +### -Authentication -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Type of authentication used in the test. +Allowed values are: + +* TrustedServer +* Negotiate +* ClientCertificate +* LiveID ```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetPstnPhoneNumber -PSTN telephone number to be called when conducting the test. -The target phone number is best specified using the E.164 format, which means that the number will look something like this "+14255551298", with that number containing a plus sign (+) followed by the country/region calling code (1), the area code (425) and the phone number (5551298). -Do not use dashes, parentheses, or any other characters when specifying the phone number. +### -Force -If you do not use the E.164 format the dial plan of the test user will be appended to the number. -Skype for Business Server will then use that dial plan to normalize the number to the E.164 format. -If the number cannot be normalized then the call cannot be placed and the test will fail. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: rpn -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserCredential -User credentials object for the account to be tested. -The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: +### -OutLoggerVariable -`$x = Get-Credential "litwareinc\kenmyer"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -You need to supply the user password when running this command. +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. -This parameter is not needed if the command is using test users configured by using the `CsHealthMonitoringConfiguration` cmdlets. -You also do not need to specify this parameter if the test is being conducted in server platform mode. -In that case, Skype for Business Server will attempt to authenticate the user by using certificates. +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: sc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: (All) +Aliases: olv -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address for the user account to be tested. -For example: +### -OutVerboseVariable -`-SenderSipAddress "sip:kenmyer@litwareinc.com"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The UserSipAddress parameter must reference the same user account as UserCredential +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: -This parameter is not needed if the command is using test users configured by using the `CsHealthMonitoringConfiguration` cmdlets. +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: ovv Required: False Position: Named @@ -204,20 +199,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -RegistrarPort -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -RegistrarPort SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -225,7 +210,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -234,103 +218,95 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -TargetFqdn -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Type: String +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: +### -TargetPstnPhoneNumber -`-OutVerboseVariable TestOutput` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Do not prepend a $ character when specifying the variable name. +PSTN telephone number to be called when conducting the test. +The target phone number is best specified using the E.164 format, which means that the number will look something like this "+14255551298", with that number containing a plus sign (+) followed by the country/region calling code (1), the area code (425) and the phone number (5551298). +Do not use dashes, parentheses, or any other characters when specifying the phone number. + +If you do not use the E.164 format the dial plan of the test user will be appended to the number. +Skype for Business Server will then use that dial plan to normalize the number to the E.164 format. +If the number cannot be normalized then the call cannot be placed and the test will fail. ```yaml Type: String Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: rpn -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Authentication -Type of authentication used in the test. -Allowed values are: +### -UserCredential + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credentials object for the account to be tested. +The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: + +`$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. + +This parameter is not needed if the command is using test users configured by using the `CsHealthMonitoringConfiguration` cmdlets. +You also do not need to specify this parameter if the test is being conducted in server platform mode. +In that case, Skype for Business Server will attempt to authenticate the user by using certificates. -* TrustedServer -* Negotiate -* ClientCertificate -* LiveID ```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: sc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: +### -UserSipAddress -`-OutLoggerVariable TestOutput` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: +SIP address for the user account to be tested. +For example: -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +`-SenderSipAddress "sip:kenmyer@litwareinc.com"` -To save the information stored in the logger variable to an XML file, use a command similar to this: +The UserSipAddress parameter must reference the same user account as UserCredential -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +This parameter is not needed if the command is using test users configured by using the `CsHealthMonitoringConfiguration` cmdlets. ```yaml Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: sa Required: False Position: Named @@ -344,13 +320,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsPstnOutboundCall` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsPstnOutboundCall` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsPstnPeerToPeerCall.md b/skype/skype-ps/SkypeForBusiness/Test-CsPstnPeerToPeerCall.md similarity index 84% rename from skype/skype-ps/skype/Test-CsPstnPeerToPeerCall.md rename to skype/skype-ps/SkypeForBusiness/Test-CsPstnPeerToPeerCall.md index 58c8bf1766..b7496968f1 100644 --- a/skype/skype-ps/skype/Test-CsPstnPeerToPeerCall.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsPstnPeerToPeerCall.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cspstnpeertopeercall applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsPstnPeerToPeerCall -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-cspstnpeertopeercall +schema: 2.0.0 +title: Test-CsPstnPeerToPeerCall --- # Test-CsPstnPeerToPeerCall @@ -61,7 +62,7 @@ However, the call is answered by the cmdlet itself, and no manual termination of ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsPstnPeerToPeerCall -TargetFqdn atl-cs-001.litwareinc.com ``` @@ -75,7 +76,7 @@ If you have not defined test users for a pool, and if you are not running in ser The `Test-CsPstnPeerToPeerCall` cmdlet will then conduct its checks using the two specified users. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred1 = Get-Credential "litwareinc\pilar" @@ -93,7 +94,7 @@ With the two credential objects in hand, the third command in the example determ To carry out this task, the `Test-CsPstnPeerToPeerCall` cmdlet is called, along with the following parameters: TargetFqdn (the FQDN of the Registrar pool); SenderSipAddress (the SIP address for the first test user); SenderCredential (the Windows PowerShell object containing the credentials for this same user); ReceiverSipAddress (the SIP address for the other test user); and ReceiverCredential (the Windows PowerShell object containing the credentials for the other user). -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Test-CsPstnPeerToPeerCall -TargetFqdn atl-cs-001.litwareinc.com -SenderSipAddress "sip:jhaas@litwareinc.com" -ReceiverSipAddress "sip:kenmyer@litwareinc.com" ``` @@ -105,75 +106,75 @@ When run like this, Skype for Business Server uses certificates to authenticate ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. +### -Authentication -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of authentication used in the test. +Allowed values are: + +TrustedServer + +Negotiate + +ClientCertificate + +LiveID -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` ```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceiverCredential -User credential object for the first of the two user accounts to be tested. -The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: - -`$y = Get-Credential "litwareinc\pilar"` +### -Force -You need to supply the user password when running this command. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool, or if you are running in server platform mode. +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: rc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -ReceiverSipAddress -SIP address for the first of the two user accounts to be tested. -For example: +### -OutLoggerVariable -`-ReceiverSipAddress "sip:pilar@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The ReceiverSipAddress parameter must reference the same user account as ReceiverCredential +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. -The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` +Note: Do not use prepend a $ character when specifying the variable name.To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: ra -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: olv Required: False Position: Named @@ -182,28 +183,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: ra -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -OutVerboseVariable -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not prepend a $ character when specifying the variable name. -### -RegistrarPort -SIP port used by the Registrar service. -This parameter is not required if the Registrar uses the default port 5061. ```yaml -Type: Int32 +Type: String Parameter Sets: (All) -Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: ovv Required: False Position: Named @@ -212,22 +207,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SenderCredential -User credential object for the second of the two user accounts to be tested. -The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: +### -ReceiverCredential -`$x = Get-Credential "litwareinc\kenmyer"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for the first of the two user accounts to be tested. +The value passed to ReceiverCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: + +`$y = Get-Credential "litwareinc\pilar"` You need to supply the user password when running this command. -The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool, or if you are running in server platform mode. +The receiver credential is not required if you are running the test under the health monitoring configuration settings for the pool, or if you are running in server platform mode. ```yaml Type: PSCredential Parameter Sets: ClientPlatform -Aliases: sc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: rc Required: True Position: Named @@ -236,22 +233,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SenderSipAddress -SIP address for the second of the two user accounts to be tested. +### -ReceiverSipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the first of the two user accounts to be tested. For example: -`-SenderSipAddress "sip:kenmyer@litwareinc.com"` +`-ReceiverSipAddress "sip:pilar@litwareinc.com"` -The SenderSipAddress parameter must reference the same user account as SenderCredential +The ReceiverSipAddress parameter must reference the same user account as ReceiverCredential The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: ra Required: False Position: Named @@ -260,27 +259,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -RegistrarPort -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +SIP port used by the Registrar service. +This parameter is not required if the Registrar uses the default port 5061. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: rp Required: False Position: Named @@ -289,62 +278,50 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +### -SenderCredential -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: +User credential object for the second of the two user accounts to be tested. +The value passed to SenderCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: -`-OutVerboseVariable TestOutput` +`$x = Get-Credential "litwareinc\kenmyer"` -Do not prepend a $ character when specifying the variable name. +You need to supply the user password when running this command. +The sender credential is not required if you are running the test under the health monitoring configuration settings for the pool, or if you are running in server platform mode. ```yaml -Type: String -Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: sc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Authentication -Type of authentication used in the test. -Allowed values are: +### -SenderSipAddress -TrustedServer +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Negotiate +SIP address for the second of the two user accounts to be tested. +For example: -ClientCertificate +`-SenderSipAddress "sip:kenmyer@litwareinc.com"` -LiveID +The SenderSipAddress parameter must reference the same user account as SenderCredential + +The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: sa Required: False Position: Named @@ -353,30 +330,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not use prepend a $ character when specifying the variable name.To save the information stored in the logger variable to an HTML file, use a command similar to this: - -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +### -TargetFqdn -To save the information stored in the logger variable to an XML file, use a command similar to this: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -387,13 +353,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsPstnPeerToPeerCall` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsPstnPeerToPeerCall` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsRegistration.md b/skype/skype-ps/SkypeForBusiness/Test-CsRegistration.md similarity index 84% rename from skype/skype-ps/skype/Test-CsRegistration.md rename to skype/skype-ps/SkypeForBusiness/Test-CsRegistration.md index 6310aa0ec1..57bc356070 100644 --- a/skype/skype-ps/skype/Test-CsRegistration.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsRegistration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csregistration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsRegistration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csregistration +schema: 2.0.0 +title: Test-CsRegistration --- # Test-CsRegistration @@ -66,7 +67,7 @@ Adding the Verbose parameter enables you to get a detailed account of all the ac ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsRegistration -TargetFqdn atl-cs-001.litwareinc.com ``` @@ -79,7 +80,7 @@ If test users have not been defined, then the command will fail because it will If you have not defined test users for a pool, then you must include the UserSipAddress parameter and the credentials of the user that the command should use when trying to log on. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred1 = Get-Credential "litwareinc\pilar" @@ -96,44 +97,26 @@ To carry out this task, the `Test-CsRegistration` cmdlet is called, along with t ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. +### -Authentication -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Type of authentication used in the test. +Allowed values are: -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +TrustedServer -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +Negotiate + +ClientCertificate + +LiveID -### -RegistrarPort -SIP port used by the Registrar service. -This parameter is not required if the Registrar uses the default port 5061. ```yaml -Type: Int32 +Type: AuthenticationMechanism Parameter Sets: (All) -Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Ath Required: False Position: Named @@ -142,44 +125,47 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserCredential -User credentials object for the account to be tested. -The value passed to UserCredential must be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credential object for the user litwareinc\kenmyer and stores that object in a variable named - -`$x: $x = Get-Credential "litwareinc\kenmyer"` +### -Force -You need to supply the user password when running this command. -This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: uc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address for user account to be tested; for example: +### -OutLoggerVariable -`-UserSipAddress "sip:kenmyer@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The UserSipAddress parameter must reference the same user account as UserCredential. -This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: (All) +Aliases: olv Required: False Position: Named @@ -188,27 +174,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -OutVerboseVariable -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +For example, to store output in a variable named $TestOutput use the following syntax: + +`-OutVerboseVariable TestOutput` + +Do not use prepend a $ character when specifying the variable name. -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: ovv Required: False Position: Named @@ -217,14 +198,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. +### -RegistrarPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP port used by the Registrar service. +This parameter is not required if the Registrar uses the default port 5061. ```yaml -Type: SwitchParameter +Type: Int32 Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Aliases: rp Required: False Position: Named @@ -233,75 +217,65 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OutVerboseVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -For example, to store output in a variable named $TestOutput use the following syntax: +### -TargetFqdn -`-OutVerboseVariable TestOutput` - -Do not use prepend a $ character when specifying the variable name. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml Type: String -Parameter Sets: (All) -Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Authentication -Type of authentication used in the test. -Allowed values are: +### -UserCredential -TrustedServer +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Negotiate +User credentials object for the account to be tested. +The value passed to UserCredential must be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credential object for the user litwareinc\kenmyer and stores that object in a variable named -ClientCertificate +`$x: $x = Get-Credential "litwareinc\kenmyer"` -LiveID +You need to supply the user password when running this command. +This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. ```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: uc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` +### -UserSipAddress -Note: Do not use prepend a $ character when specifying the variable name. To save the information stored in the logger variable to an HTML file, use a command similar to this: +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` +SIP address for user account to be tested; for example: -To save the information stored in the logger variable to an XML file, use a command similar to this: +`-UserSipAddress "sip:kenmyer@litwareinc.com"` -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` +The UserSipAddress parameter must reference the same user account as UserCredential. +This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. ```yaml Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: ua Required: False Position: Named @@ -315,13 +289,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsRegistration` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsRegistration` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsReplica.md b/skype/skype-ps/SkypeForBusiness/Test-CsReplica.md similarity index 89% rename from skype/skype-ps/skype/Test-CsReplica.md rename to skype/skype-ps/SkypeForBusiness/Test-CsReplica.md index fa960e4ed6..ebfa11a00d 100644 --- a/skype/skype-ps/skype/Test-CsReplica.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsReplica.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csreplica applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsReplica -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csreplica +schema: 2.0.0 +title: Test-CsReplica --- # Test-CsReplica @@ -37,7 +38,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Test- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsReplica -Verbose ``` @@ -46,7 +47,7 @@ The command shown in Example 1 tests the Skype for Business Server replica servi In this example the Verbose parameter is used to ensure that information about the test - including the eventual failure or success of the test as well as the location of the report generated by the test - is displayed on screen. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Test-CsReplica -Verbose -Report C:\Logs\ReplicaTest.html ``` @@ -61,6 +62,9 @@ C:\Users\Administrator.Litwareinc\AppData\Local\Temp\1\Test-Cs-Replica-3db40ee0- ## PARAMETERS ### -GlobalCatalog + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of a global catalog server in your domain. This parameter is not required if you are running the `Test-CsReplica` cmdlet on a computer with an account in your domain. @@ -68,8 +72,7 @@ This parameter is not required if you are running the `Test-CsReplica` cmdlet on ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -79,6 +82,9 @@ Accept wildcard characters: False ``` ### -GlobalSettingsDomainController + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name of a domain controller in your domain. This parameter is not required if you are running the `Test-CsReplica` cmdlet on a computer with an account in your domain. @@ -86,8 +92,7 @@ This parameter is not required if you are running the `Test-CsReplica` cmdlet on ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -97,6 +102,9 @@ Accept wildcard characters: False ``` ### -Report + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: @@ -105,8 +113,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -120,13 +127,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsReplica` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsReplica` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsSetupPermission.md b/skype/skype-ps/SkypeForBusiness/Test-CsSetupPermission.md similarity index 82% rename from skype/skype-ps/skype/Test-CsSetupPermission.md rename to skype/skype-ps/SkypeForBusiness/Test-CsSetupPermission.md index d3a68325b5..52243d5279 100644 --- a/skype/skype-ps/skype/Test-CsSetupPermission.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsSetupPermission.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cssetuppermission applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsSetupPermission -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-cssetuppermission +schema: 2.0.0 +title: Test-CsSetupPermission --- # Test-CsSetupPermission @@ -37,7 +38,7 @@ If the cmdlet returns False, you will need to run the `Grant-CsSetupPermission` ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsSetupPermission -ComputerOU "ou=CsServers,dc=litwareinc,dc=com" ``` @@ -48,6 +49,9 @@ The command shown in Example 1 checks to see if the required setup permissions h ## PARAMETERS ### -ComputerOU + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Distinguished name of the organizational unit (OU) that contains the accounts for the computers running Skype for Business Server. For example: "ou=CsServers,dc=litwareinc,dc=com". @@ -55,8 +59,7 @@ For example: "ou=CsServers,dc=litwareinc,dc=com". ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -66,6 +69,9 @@ Accept wildcard characters: False ``` ### -Domain + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Name of the domain where the OU to be checked is located. If this parameter is not included, then the `Test-CsSetupPermission` cmdlet will look for the OU in the current domain. @@ -73,8 +79,7 @@ If this parameter is not included, then the `Test-CsSetupPermission` cmdlet will ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -84,6 +89,9 @@ Accept wildcard characters: False ``` ### -DomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of a domain controller in your domain. This parameter is not required if you are running the `Test-CsSetupPermission` cmdlet on a computer with an account in your domain. @@ -91,8 +99,7 @@ This parameter is not required if you are running the `Test-CsSetupPermission` c ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -102,6 +109,9 @@ Accept wildcard characters: False ``` ### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a global catalog server in your domain. This parameter is not required if you are running the `Test-CsSetupPermission` cmdlet on a computer with an account in your domain. @@ -109,8 +119,7 @@ This parameter is not required if you are running the `Test-CsSetupPermission` c ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -120,29 +129,15 @@ Accept wildcard characters: False ``` ### -Report -Reports detailed activity to the screen as the cmdlet runs. -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Verbose Reports detailed activity to the screen as the cmdlet runs. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Aliases: Required: False Position: Named @@ -156,13 +151,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsSetupPermission` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsSetupPermission` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsTopology.md b/skype/skype-ps/SkypeForBusiness/Test-CsTopology.md similarity index 82% rename from skype/skype-ps/skype/Test-CsTopology.md rename to skype/skype-ps/SkypeForBusiness/Test-CsTopology.md index 09df3bc984..c62154b59d 100644 --- a/skype/skype-ps/skype/Test-CsTopology.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsTopology.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cstopology applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsTopology -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-cstopology +schema: 2.0.0 +title: Test-CsTopology --- # Test-CsTopology @@ -36,7 +37,7 @@ For example, this command checks the state of the A/V Conferencing Server on the ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsTopology ``` @@ -44,7 +45,7 @@ Test-CsTopology Example 1 validates the entire Skype for Business Server topology. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Test-CsTopology -Report "C:\Logs\Topology.xml" ``` @@ -53,7 +54,7 @@ The command shown in Example 2 is a variation of the command shown in Example 1. In this case, however, the Report parameter is included to specify the location (C:\Logs\Topology.xml) where the output file should be written. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Test-CsTopology -Service "Registrar:atl-cs-001.litwareinc.com" ``` @@ -64,6 +65,9 @@ In Example 3, the `Test-CsTopology` cmdlet is used to validate a single service: ## PARAMETERS ### -GlobalCatalog + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of a global catalog server in your domain. This parameter is not required if you are running the `Test-CsTopology` cmdlet on a computer with an account in your domain. @@ -71,8 +75,7 @@ This parameter is not required if you are running the `Test-CsTopology` cmdlet o ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -82,6 +85,9 @@ Accept wildcard characters: False ``` ### -GlobalSettingsDomainController + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + FQDN of a domain controller where global settings are stored. If global settings are stored in the System container in Active Directory Domain Services, then this parameter must point to the root domain controller. If global settings are stored in the Configuration container, then any domain controller can be used and this parameter can be omitted. @@ -90,8 +96,7 @@ If global settings are stored in the Configuration container, then any domain co ```yaml Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -100,20 +105,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Service -When present, the `Test-CsTopology` cmdlet limits its validation checks to the specified service. -(Note that you can only specify one service at a time when using the Service parameter.) Services should be specified using the appropriate service ID; for example, this syntax refers to the Registrar service on the atl-cs-001.litwareinc.com pool: +### -Report -`-Service "Registrar:atl-cs-001.litwareinc.com"` - -If this parameter is not included then the entire topology will be validated. +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: `-Report "C:\Logs\Topology.html"` ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -122,31 +124,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: `-Report "C:\Logs\Topology.html"` +### -Service -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +When present, the `Test-CsTopology` cmdlet limits its validation checks to the specified service. +(Note that you can only specify one service at a time when using the Service parameter.) Services should be specified using the appropriate service ID; for example, this syntax refers to the Registrar service on the atl-cs-001.litwareinc.com pool: + +`-Service "Registrar:atl-cs-001.litwareinc.com"` + +If this parameter is not included then the entire topology will be validated. -### -Verbose -Reports detailed activity to the screen as the cmdlet runs. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: vb -Applicable: Lync Server 2010 +Aliases: Required: False Position: Named @@ -160,13 +153,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsTopology` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsTopology` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsTrunkConfiguration.md b/skype/skype-ps/SkypeForBusiness/Test-CsTrunkConfiguration.md similarity index 87% rename from skype/skype-ps/skype/Test-CsTrunkConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Test-CsTrunkConfiguration.md index 7cbb042b1c..e8aeb6150e 100644 --- a/skype/skype-ps/skype/Test-CsTrunkConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsTrunkConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cstrunkconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsTrunkConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-cstrunkconfiguration +schema: 2.0.0 +title: Test-CsTrunkConfiguration --- # Test-CsTrunkConfiguration @@ -32,7 +33,7 @@ These settings configure such things as whether media bypass is enabled on this ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $tc = Get-CsTrunkConfiguration -Identity Site:Redmond @@ -48,55 +49,61 @@ In line 2 we call the `Test-CsTrunkConfiguration` cmdlet, passing the phone numb ## PARAMETERS -### -DialedNumber -The phone number against which to test the configuration. +### -CallingNumber + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When specified, returns the matched outbound translation rules for the specified phone number. +For example: + +`-CallingNumber "tel:+14255551219"` ```yaml Type: PhoneNumber Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -TrunkConfiguration -A reference to a trunk configuration object against which to run the test. -Trunk configuration objects can be retrieved by calling the `Get-CsTrunkConfiguration` cmdlet. +### -DialedNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The phone number against which to test the configuration. ```yaml -Type: TrunkConfiguration +Type: PhoneNumber Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -CallingNumber -When specified, returns the matched outbound translation rules for the specified phone number. -For example: +### -TrunkConfiguration -`-CallingNumber "tel:+14255551219"` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A reference to a trunk configuration object against which to run the test. +Trunk configuration objects can be retrieved by calling the `Get-CsTrunkConfiguration` cmdlet. ```yaml -Type: PhoneNumber +Type: TrunkConfiguration Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` @@ -105,13 +112,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TrunkConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Settings.TrunkConfiguration.TrunkConfiguration + Accepts pipelined input of a trunk configuration object. ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.TrunkConfigurationTestResult Returns a value of type Microsoft.Rtc.Management.Voice.TrunkConfigurationTestResult. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsUcwaConference.md b/skype/skype-ps/SkypeForBusiness/Test-CsUcwaConference.md similarity index 84% rename from skype/skype-ps/skype/Test-CsUcwaConference.md rename to skype/skype-ps/SkypeForBusiness/Test-CsUcwaConference.md index c94960225f..cd0a4dc098 100644 --- a/skype/skype-ps/skype/Test-CsUcwaConference.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsUcwaConference.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csucwaconference applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsUcwaConference -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csucwaconference +schema: 2.0.0 +title: Test-CsUcwaConference --- # Test-CsUcwaConference @@ -57,7 +58,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Test- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsUcwaConference -TargetFqdn "atl-cs-001.litwareinc.com" ``` @@ -66,7 +67,7 @@ The command shown in Example 1 verifies that a pair of test users can participat Note that this command will fail if you have not predefined a pair of health monitoring configuration test users for atl-cs-001.litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred1 = Get-Credential "litwareinc\pilar" @@ -86,84 +87,10 @@ To carry out this task, the `Test-CsUcwaConference` cmdlet is called, along with ## PARAMETERS -### -OrganizerCredential -User credential object for user account acting as the meeting organizer. -The value passed to OrganizerCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: - -`$x = Get-Credential "litwareinc\kenmyer"` - -You need to supply the user password when running this command. - -The organizer credential is not required if you are running the test under the health monitoring configuration settings for the pool. - -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: pc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -ParticipantCredential -User credential object for the user account acting as the meeting participant. -The value passed to ParticipantCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: - -`$y = Get-Credential "litwareinc\pilar"` - -You need to supply the user password when running this command. - -The participant credential is not required if you are running the test under the health monitoring configuration settings for the pool. - -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: sc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. - -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +### -Authentication -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Authentication Type of authentication used when running the test. Allowed values are: @@ -180,7 +107,6 @@ LiveID Type: AuthenticationMechanism Parameter Sets: (All) Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -190,13 +116,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -205,18 +133,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -OrganizerSipAddress -SIP address for the meeting organizer. -For example: `-OrganizerSipAddress "sip:pilar@litwareinc.com"`. -The OrganizerSIPAddress parameter must reference the same user account as OrganizerCredential. +### -OrganizerCredential -The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for user account acting as the meeting organizer. +The value passed to OrganizerCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: + +`$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. + +The organizer credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: String +Type: PSCredential Parameter Sets: ClientPlatform -Aliases: pa -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: pc Required: True Position: Named @@ -225,13 +159,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -OrganizerSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the meeting organizer. +For example: `-OrganizerSipAddress "sip:pilar@litwareinc.com"`. +The OrganizerSIPAddress parameter must reference the same user account as OrganizerCredential. + +The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. + ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ClientPlatform, ServerPlatform Aliases: pa -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -239,6 +182,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -260,7 +206,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -270,6 +215,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -281,7 +229,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -290,19 +237,24 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ParticipantSipAddress -SIP address for the meeting participant. -For example: `-ParticipantSipAddress "sip:kenmyer@litwareinc.com"`. -The ParticipantSipAddress parameter must reference the same user account as ParticipantCredential. +### -ParticipantCredential -The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for the user account acting as the meeting participant. +The value passed to ParticipantCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $y: +`$y = Get-Credential "litwareinc\pilar"` + +You need to supply the user password when running this command. + +The participant credential is not required if you are running the test under the health monitoring configuration settings for the pool. ```yaml -Type: String +Type: PSCredential Parameter Sets: ClientPlatform -Aliases: sa -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: sc Required: True Position: Named @@ -311,13 +263,22 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -ParticipantSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for the meeting participant. +For example: `-ParticipantSipAddress "sip:kenmyer@litwareinc.com"`. +The ParticipantSipAddress parameter must reference the same user account as ParticipantCredential. + +The SIP address is not required if you are running the test under the health monitoring configuration settings for the pool. + ```yaml Type: String -Parameter Sets: ServerPlatform, TargetUri +Parameter Sets: ClientPlatform, ServerPlatform, TargetUri Aliases: sa -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -325,6 +286,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -332,7 +296,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: ClientPlatform, ServerPlatform Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -341,18 +304,35 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TargetFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the pool to be tested. + +```yaml +Type: String +Parameter Sets: ClientPlatform, ServerPlatform +Aliases: t + +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 -### -None. +### None The `Test-CsUcwaConference` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.WebTaskOutput The `Test-CsUcwaConference` cmdlet returns instances of the Microsoft.Rtc.SyntheticTransactions.WebTaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsUnifiedContactStore.md b/skype/skype-ps/SkypeForBusiness/Test-CsUnifiedContactStore.md similarity index 84% rename from skype/skype-ps/skype/Test-CsUnifiedContactStore.md rename to skype/skype-ps/SkypeForBusiness/Test-CsUnifiedContactStore.md index e4e5ffea71..3a04ee977c 100644 --- a/skype/skype-ps/skype/Test-CsUnifiedContactStore.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsUnifiedContactStore.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csunifiedcontactstore applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsUnifiedContactStore -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csunifiedcontactstore +schema: 2.0.0 +title: Test-CsUnifiedContactStore --- # Test-CsUnifiedContactStore @@ -53,7 +54,7 @@ Lync Server Control Panel: The functions carried out by the `Test-csUnifiedConta ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $credential = Get-Credential "litwareinc\kenmyer" @@ -69,61 +70,10 @@ The second command in the example uses the supplied credentials object ($x) and ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. - - -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserCredential -User credentials object for the user account to be used in the test. -The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: - -`$x = Get-Credential "litwareinc\kenmyer"` - -You need to supply the user password when running this command. +### -Authentication -This parameter is not required if you are running the test by using test users configured via the `CsHealthMonitoringConfiguration` cmdlets +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: uc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Authentication Type of authentication used when running the test. Allowed values are: @@ -136,7 +86,6 @@ Allowed values are: Type: AuthenticationMechanism Parameter Sets: (All) Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -146,13 +95,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -162,6 +113,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -183,7 +137,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -193,6 +146,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -204,7 +160,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -214,6 +169,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -221,7 +179,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -230,19 +187,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address of the user to be used in the test. -For example: +### -Setup -`-UserSipAddress "sip:kenmyer@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -This parameter is not required if you are running the test by using test users configured via the `CsHealthMonitoringConfiguration` cmdlets. +{{Fill Setup Description}} ```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: ua -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -SetupAndRun + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +{{Fill SetupAndRun Description}} + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -251,43 +223,66 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -TargetFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the pool to be tested. + + ```yaml Type: String -Parameter Sets: ClientPlatform -Aliases: ua -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t Required: True -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Setup -{{Fill Setup Description}} +### -UserCredential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credentials object for the user account to be used in the test. +The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: + +`$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. + +This parameter is not required if you are running the test by using test users configured via the `CsHealthMonitoringConfiguration` cmdlets ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: uc -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SetupAndRun -{{Fill SetupAndRun Description}} +### -UserSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address of the user to be used in the test. +For example: + +`-UserSipAddress "sip:kenmyer@litwareinc.com"` + +This parameter is not required if you are running the test by using test users configured via the `CsHealthMonitoringConfiguration` cmdlets. ```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Type: String +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: ua Required: False Position: Named @@ -301,13 +296,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsUnifiedContactStore` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.WebTaskOutput The `Test-CsUnifiedContactStore` cmdlet returns instances of the Microsoft.Rtc.SyntheticTransactions.WebTaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsVoiceNormalizationRule.md b/skype/skype-ps/SkypeForBusiness/Test-CsVoiceNormalizationRule.md similarity index 90% rename from skype/skype-ps/skype/Test-CsVoiceNormalizationRule.md rename to skype/skype-ps/SkypeForBusiness/Test-CsVoiceNormalizationRule.md index 7506be3ac9..ab0ea5b261 100644 --- a/skype/skype-ps/skype/Test-CsVoiceNormalizationRule.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsVoiceNormalizationRule.md @@ -1,12 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csvoicenormalizationrule applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsVoiceNormalizationRule -schema: 2.0.0 -manager: bulenteg author: jenstrier +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: serdars +online version: https://learn.microsoft.com/powershell/module/skype/test-csvoicenormalizationrule +schema: 2.0.0 +title: Test-CsVoiceNormalizationRule --- # Test-CsVoiceNormalizationRule @@ -34,7 +36,7 @@ Use this cmdlet to troubleshoot dialing issues or to verify that rules will work ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVoiceNormalizationRule -Identity "global/11 digit number rule" | Test-CsVoiceNormalizationRule -DialedNumber 14255559999 ``` @@ -46,7 +48,7 @@ The output will be the DialedNumber after the voice normalization rule "global/1 If this rule does not apply to the DialedNumber value (for example, if the normalization rule matches the pattern for an 11-digit number and you supply a 7-digit number) no value will be returned. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $a = Get-CsVoiceNormalizationRule -Identity "global/11 digit number rule" Test-CsVoiceNormalizationRule -DialedNumber 5551212 -NormalizationRule $a @@ -57,7 +59,7 @@ object is first stored in the variable $a and then is passed as the value to the test will run. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVoiceNormalizationRule | Test-CsVoiceNormalizationRule -DialedNumber 2065559999 ``` @@ -69,7 +71,7 @@ number 2065559999. The output will be a list of translated numbers, one for each If a rule does not apply to the DialedNumber value (for example, if the normalization rule matches the pattern for an 11-digit number and you supply a 7-digit number) there will be a blank line in the list for that rule. -### -------------------------- Example 4 -------------------------- +### Example 4 ```powershell $nr=(Get-CsTenantDialPlan -Identity dp1).NormalizationRules $nr[0] @@ -97,6 +99,9 @@ dialed number 1234. The output shows that the rule normalize the dialed number t ## PARAMETERS ### -DialedNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + The phone number against which you want to test the normalization rule specified in the NormalizationRule parameter. Full Data Type: Microsoft.Rtc.Management.Voice.PhoneNumber @@ -105,8 +110,7 @@ Full Data Type: Microsoft.Rtc.Management.Voice.PhoneNumber ```yaml Type: PhoneNumber Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams +Aliases: Required: True Position: Named @@ -116,6 +120,9 @@ Accept wildcard characters: False ``` ### -NormalizationRule + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams + An object containing a reference to the normalization rule against which you want to test the number specified in the DialedNumber parameter. For Lync and Skype for Business Server, you can retrieve voice normalization rules by calling the `Get-CsVoiceNormalizationRule` cmdlet. @@ -124,8 +131,7 @@ For Microsoft Teams, you can retrieve voice normalization rules by calling the ` ```yaml Type: NormalizationRule Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019, Microsoft Teams +Aliases: Required: True Position: Named @@ -139,13 +145,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.NormalizationRule + Accepts pipelined input of voice normalization rule objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.NormalizationRuleTestResult Returns an object of type Microsoft.Rtc.Management.Voice.NormalizationRuleTestResult. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsVoicePolicy.md b/skype/skype-ps/SkypeForBusiness/Test-CsVoicePolicy.md similarity index 86% rename from skype/skype-ps/skype/Test-CsVoicePolicy.md rename to skype/skype-ps/SkypeForBusiness/Test-CsVoicePolicy.md index 9e26043f76..0c5ee4abc5 100644 --- a/skype/skype-ps/skype/Test-CsVoicePolicy.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsVoicePolicy.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csvoicepolicy applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsVoicePolicy -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csvoicepolicy +schema: 2.0.0 +title: Test-CsVoicePolicy --- # Test-CsVoicePolicy @@ -32,7 +33,7 @@ Call the `Test-CsVoicePolicy` cmdlet to determine which (if any) route will be u ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVoicePolicy -Identity site:Redmond | Test-CsVoicePolicy -TargetNumber "+14255559999" ``` @@ -44,7 +45,7 @@ The output will be the first voice route (based on the Priority property of the If no matching route is found (for example, if the number pattern matches the pattern for an 11-digit number and you supply a 7-digit number) a null value will be returned. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $a = Get-CsVoicePolicy -Identity site:Redmond @@ -54,7 +55,7 @@ Test-CsVoicePolicy -TargetNumber "+14255559999" -VoicePolicy $a Example 2 is identical to Example 1 except that instead of piping the results of the Get operation directly to the `Test-CsVoicePolicy` cmdlet, the object is first stored in the variable $a and then is passed as the value to the parameter VoicePolicy to be used as the policy against which the test will run. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVoicePolicy | Test-CsVoicePolicy -TargetNumber "+12065559999" ``` @@ -67,74 +68,82 @@ The output will be a list of matching routes along with the phone usages that we ## PARAMETERS -### -TargetNumber -The phone number against which to run the test. -This number should be in E.164 format (such as +14255551212). +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. ```yaml -Type: PhoneNumber +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -VoicePolicy -A reference to the voice policy object against which to run the test. -Voice policy objects can be retrieved by calling the `Get-CsVoicePolicy` cmdlet. +### -RouteSettings + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Route settings against which to run the test. +The route settings can be retrieved with a call to the `Get-CsRoutingConfiguration` cmdlet. ```yaml -Type: VoicePolicy +Type: PstnRoutingSettings Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -RouteSettings -Route settings against which to run the test. -The route settings can be retrieved with a call to the `Get-CsRoutingConfiguration` cmdlet. +### -TargetNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The phone number against which to run the test. +This number should be in E.164 format (such as +14255551212). ```yaml -Type: PstnRoutingSettings +Type: PhoneNumber Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. +### -VoicePolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A reference to the voice policy object against which to run the test. +Voice policy objects can be retrieved by calling the `Get-CsVoicePolicy` cmdlet. ```yaml -Type: SwitchParameter +Type: VoicePolicy Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` @@ -143,13 +152,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoicePolicy object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.VoicePolicy + Accepts pipelined input of voice policy objects. ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.VoicePolicyTestResult Returns an object of type Microsoft.Rtc.Management.Voice.VoicePolicyTestResult. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsVoiceRoute.md b/skype/skype-ps/SkypeForBusiness/Test-CsVoiceRoute.md similarity index 89% rename from skype/skype-ps/skype/Test-CsVoiceRoute.md rename to skype/skype-ps/SkypeForBusiness/Test-CsVoiceRoute.md index 4291233efd..eb50169153 100644 --- a/skype/skype-ps/skype/Test-CsVoiceRoute.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsVoiceRoute.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csvoiceroute applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsVoiceRoute -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csvoiceroute +schema: 2.0.0 +title: Test-CsVoiceRoute --- # Test-CsVoiceRoute @@ -32,7 +33,7 @@ You can use this cmdlet to troubleshoot routing issues or to simply try out phon ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` $vr = Get-CsVoiceRoute -Identity testroute @@ -46,7 +47,7 @@ We also include the number we want to test in the TargetNumber parameter. The output is a Boolean value stating whether the target number matches the pattern for that route. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsVoiceRoute -Identity testroute | Test-CsVoiceRoute -TargetNumber "+14255551212" ``` @@ -58,7 +59,7 @@ We pipe that voice route to the `Test-CsVoiceRoute` cmdlet and test the route ag Note that we do not need to supply the Route parameter because the route was piped in to the cmdlet. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` Get-CsVoiceRoute | Test-CsVoiceRoute -TargetNumber "+14255551212" ``` @@ -67,7 +68,7 @@ This example retrieves a collection of all the voice routes defined within a Sky The output will be a True or False value for each route tested. -### -------------------------- Example 4 -------------------------- +### Example 4 ``` $z = Get-CsVoiceRoute @@ -89,7 +90,29 @@ The final output will be a (not very nicely formatted) list of voice route ident ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. + + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Route + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + An object containing a reference to the voice route against which you want to test the number specified in the TargetNumber parameter. You can retrieve a voice route object by calling the `Get-CsVoiceRoute` cmdlet. @@ -98,8 +121,7 @@ Full Data Type: Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route ```yaml Type: Route Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -109,6 +131,9 @@ Accept wildcard characters: False ``` ### -TargetNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The phone number against which you want to test the voice route specified in the Route parameter. This number should be in E.164 format (such as +14255551212). @@ -117,8 +142,7 @@ Full Data Type: Microsoft.Rtc.Management.Voice.PhoneNumber ```yaml Type: PhoneNumber Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -127,35 +151,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. - - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -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.Rtc.Management.WritableConfig.Policy.Voice.Route object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.Route + Accepts pipelined input of a voice route object. ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.VoiceRouteTestResult Returns an object of type Microsoft.Rtc.Management.Voice.VoiceRouteTestResult. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsVoiceTestConfiguration.md b/skype/skype-ps/SkypeForBusiness/Test-CsVoiceTestConfiguration.md similarity index 83% rename from skype/skype-ps/skype/Test-CsVoiceTestConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Test-CsVoiceTestConfiguration.md index ff6c869062..7343c7c1fe 100644 --- a/skype/skype-ps/skype/Test-CsVoiceTestConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsVoiceTestConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csvoicetestconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsVoiceTestConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csvoicetestconfiguration +schema: 2.0.0 +title: Test-CsVoiceTestConfiguration --- # Test-CsVoiceTestConfiguration @@ -44,7 +45,7 @@ If instead you enter a value for the TestCaseInputObject parameter, you can also ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Get-CsVoiceTestConfiguration -Identity TestConfig1 | Test-CsVoiceTestConfiguration ``` @@ -54,7 +55,7 @@ First the `Get-CsVoiceTestConfiguration` cmdlet is run to retrieve the configura That configuration object is then piped to the `Test-CsVoiceTestConfiguration` cmdlet. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $a = Get-CsVoiceTestConfiguration -Identity TestConfig1 @@ -64,7 +65,7 @@ Test-CsVoiceTestConfiguration -TestCaseInputObject $a Example 2 is identical to Example 1 except that instead of piping the results of the Get operation directly to the Test cmdlet, the object is first stored in the variable $a, and then is passed as the value to the parameter TestCaseInputObject to be used as the test configuration. -### -------------------------- Example 3 -------------------------- +### Example 3 ``` $dp = Get-CsDialPlan -Identity Global @@ -90,6 +91,9 @@ If you want to test the results against expectations you must define those expec ## PARAMETERS ### -DialedNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The phone number to run the test against. Based on the dial plan, route, and policy, this number will be normalized and displayed as output. @@ -100,8 +104,7 @@ You cannot supply a DialedNumber and a TestCaseInputObject. ```yaml Type: PhoneNumber Parameter Sets: AdhocTest -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -111,6 +114,9 @@ Accept wildcard characters: False ``` ### -Dialplan + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A reference to a dial plan object of the dial plan to use when running the test. Dial plan objects can be retrieved by calling the `Get-CsDialPlan` cmdlet. @@ -120,9 +126,8 @@ If you do, the object in this parameter must match the dial plan specified in th ```yaml Type: LocationProfile -Parameter Sets: AdhocTest -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: AdhocTest, StoredTest +Aliases: Required: True Position: Named @@ -131,11 +136,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts that would otherwise be displayed before making changes. + ```yaml -Type: LocationProfile -Parameter Sets: StoredTest -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -RouteSettings + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +A reference to an object containing all the voice routes available on the Skype for Business Server installation. +You can retrieve this object by calling the `Get-CsRoutingConfiguration` cmdlet. + +You can use this parameter with either the DialedNumber parameter or with the TestCaseInputObject parameter. + + +```yaml +Type: PstnRoutingSettings +Parameter Sets: (All) +Aliases: Required: False Position: Named @@ -145,6 +177,9 @@ Accept wildcard characters: False ``` ### -TestCaseInputObject + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + An object containing a reference to the voice configuration to test. This object reference can be retrieved by calling the `Get-CsVoiceTestConfiguration` cmdlet. @@ -154,8 +189,7 @@ You should also not specify a Dialplan or VoicePolicy, as those would be redunda ```yaml Type: TestConfiguration Parameter Sets: StoredTest -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -165,6 +199,9 @@ Accept wildcard characters: False ``` ### -VoicePolicy + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + A reference to a voice policy object of the voice policy to use when running the test. Voice policy objects can be retrieved by calling the `Get-CsVoicePolicy` cmdlet. @@ -174,9 +211,8 @@ If you do, the object in this parameter must match the voice policy specified in ```yaml Type: VoicePolicy -Parameter Sets: AdhocTest -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: AdhocTest, StoredTest +Aliases: Required: True Position: Named @@ -185,67 +221,18 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: VoicePolicy -Parameter Sets: StoredTest -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -RouteSettings -A reference to an object containing all the voice routes available on the Skype for Business Server installation. -You can retrieve this object by calling the `Get-CsRoutingConfiguration` cmdlet. - -You can use this parameter with either the DialedNumber parameter or with the TestCaseInputObject parameter. - - -```yaml -Type: PstnRoutingSettings -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Force -Suppresses any confirmation prompts that would otherwise be displayed before making changes. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -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.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration object. +### Microsoft.Rtc.Management.WritableConfig.Policy.Voice.TestConfiguration + Accepts pipelined input of a voice test configuration object. ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.OcsVoiceTestResult This cmdlet returns an object of type Microsoft.Rtc.Management.Voice.OcsVoiceTestResult. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsVoiceUser.md b/skype/skype-ps/SkypeForBusiness/Test-CsVoiceUser.md similarity index 90% rename from skype/skype-ps/skype/Test-CsVoiceUser.md rename to skype/skype-ps/SkypeForBusiness/Test-CsVoiceUser.md index d31c01af75..0b72fce029 100644 --- a/skype/skype-ps/skype/Test-CsVoiceUser.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsVoiceUser.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csvoiceuser applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsVoiceUser -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csvoiceuser +schema: 2.0.0 +title: Test-CsVoiceUser --- # Test-CsVoiceUser @@ -32,7 +33,7 @@ This cmdlet can be used to determine whether a specific phone number will route ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsVoiceUser -DialedNumber "+14255559999" -SipUri "sip:kmyer@litwareinc.com" -Verbose ``` @@ -44,7 +45,7 @@ Notice that we've also included the Verbose parameter. Verbose is a common Windows PowerShell parameter that will display additional information as the test is being conducted, such as which dial plan and voice policy are being loaded for the test. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUser | ForEach-Object {$_.DisplayName; Test-CsVoiceUser -DialedNumber "+14255559999" -SipUri $_.SipAddress} | Format-List ``` @@ -65,6 +66,9 @@ Finally, because the output by default is in table format and can get cut off to ## PARAMETERS ### -DialedNumber + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The phone number to test. Full data type: Microsoft.Rtc.Management.Voice.PhoneNumber @@ -72,8 +76,7 @@ Full data type: Microsoft.Rtc.Management.Voice.PhoneNumber ```yaml Type: PhoneNumber Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -82,40 +85,44 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SipUri -The SIP URI of the user against which the test is taking place. -This is the Identity of the user as used in the CsUser cmdlets. -You can specify a user's identity using one of four formats: 1) The user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). -Note that the SamAccountName cannot be used as an identity. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. ```yaml -Type: UserIdParameter +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: True +Required: False Position: Named Default value: None -Accept pipeline input: True (ByPropertyName, ByValue) +Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. +### -SipUri + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The SIP URI of the user against which the test is taking place. +This is the Identity of the user as used in the CsUser cmdlets. +You can specify a user's identity using one of four formats: 1) The user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). +Note that the SamAccountName cannot be used as an identity. ```yaml -Type: SwitchParameter +Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None -Accept pipeline input: False +Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` @@ -124,12 +131,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### Microsoft.Rtc.Management.Voice.OcsVoiceUserTestResult Returns an object of type Microsoft.Rtc.Management.Voice.OcsVoiceUserTestResult. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsWatcherNodeConfiguration.md b/skype/skype-ps/SkypeForBusiness/Test-CsWatcherNodeConfiguration.md similarity index 92% rename from skype/skype-ps/skype/Test-CsWatcherNodeConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Test-CsWatcherNodeConfiguration.md index ab6e773b6e..fc56293ce1 100644 --- a/skype/skype-ps/skype/Test-CsWatcherNodeConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsWatcherNodeConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cswatchernodeconfiguration applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsWatcherNodeConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-cswatchernodeconfiguration +schema: 2.0.0 +title: Test-CsWatcherNodeConfiguration --- # Test-CsWatcherNodeConfiguration @@ -39,7 +40,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Test- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsWatcherNodeConfiguration ``` @@ -50,6 +51,9 @@ The command shown in Example 1 verifies the configuration settings for each watc ## PARAMETERS ### -FileName + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to specify a file path for the log file created when the cmdlet runs. For example: @@ -58,8 +62,7 @@ For example: ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -69,6 +72,9 @@ Accept wildcard characters: False ``` ### -ReadCredentialsFromCurrentUserStore + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, instructs the `Test-CsWatcherNodeConfiguration` cmdlet to retrieve the user credentials from the user's credentials store. By default, the `Test-CsWatcherNodeConfiguration` cmdlet looks for credentials in the network service account's credentials store. @@ -76,8 +82,7 @@ By default, the `Test-CsWatcherNodeConfiguration` cmdlet looks for credentials i ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -91,13 +96,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsWatcherNodeConfiguration` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsWatcherNodeConfiguration` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsWebApp.md b/skype/skype-ps/SkypeForBusiness/Test-CsWebApp.md similarity index 83% rename from skype/skype-ps/skype/Test-CsWebApp.md rename to skype/skype-ps/SkypeForBusiness/Test-CsWebApp.md index fc6945a42c..3205c94c42 100644 --- a/skype/skype-ps/skype/Test-CsWebApp.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsWebApp.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cswebapp applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsWebApp -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-cswebapp +schema: 2.0.0 +title: Test-CsWebApp --- # Test-CsWebApp @@ -57,7 +58,7 @@ If you decide to conduct the test using actual user accounts you will need to su ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsWebApp -TargetFqdn atl-cs-001.litwareinc.com ``` @@ -66,7 +67,7 @@ Example 1 verifies whether or not a pair of test users configured for the pool a This command will only succeed if you have configured test users for the pool by using the `CsHealthMonitoringConfiguration` cmdlets. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred1 = Get-Credential "litwareinc\kenmyer" @@ -83,7 +84,38 @@ In addition to the user credential parameters, the UserSipAddress and User2SipAd ## PARAMETERS +### -Authentication + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of authentication used when running the test. +Allowed values are: + +TrustedServer + +Negotiate + +ClientCertificate + +LiveID + + +```yaml +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -External + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, causes the `Test-CsWebApp` cmdlet to test the Reach server's external web relay. If this parameter is not present, the cmdlet will test the internal web relay. The web relay serves as an intermediary between the internal network and the Internet. @@ -92,8 +124,7 @@ The web relay serves as an intermediary between the internal network and the Int ```yaml Type: SwitchParameter Parameter Sets: ServerPlatform, ClientPlatform -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -103,14 +134,49 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. + +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not prepend a $ character when specifying the variable name. + +To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` + +```yaml +Type: String +Parameter Sets: (All) +Aliases: olv Required: False Position: Named @@ -120,6 +186,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -132,7 +201,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -142,6 +210,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -150,7 +221,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: ServerPlatform, ClientPlatform Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -160,17 +230,18 @@ Accept wildcard characters: False ``` ### -TargetFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the pool to be tested. For example: `-TargetFqdn atl-cs-001.litwareinc.com` - ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ServerPlatform, ClientPlatform Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 1 @@ -179,20 +250,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -TargetUri -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -TargetUri Uniform Resource Identifier (URI) of the Reach server. For example: @@ -200,12 +261,10 @@ For example: You cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command. - ```yaml Type: String Parameter Sets: TargetUri Aliases: twsu -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -215,6 +274,9 @@ Accept wildcard characters: False ``` ### -User2Credential + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + User credential object for the second of the two user accounts to be tested. The value passed to User2Credential should be an object reference obtained by using the `Get-Credential` cmdlet. For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $y: @@ -228,7 +290,6 @@ You need to supply the user password when running this command. Type: PSCredential Parameter Sets: ClientPlatform Aliases: sc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -238,6 +299,9 @@ Accept wildcard characters: False ``` ### -User2SipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address for the second of the two user accounts to be tested. For example: @@ -250,7 +314,6 @@ This parameter is not required if you are running the test by using test users c Type: String Parameter Sets: ClientPlatform Aliases: sa -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -260,6 +323,9 @@ Accept wildcard characters: False ``` ### -UserCredential + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + User credentials object for the first of the two user accounts to be tested. The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $x: @@ -273,7 +339,6 @@ You need to supply the user password when running this command. Type: PSCredential Parameter Sets: ClientPlatform Aliases: uc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -283,6 +348,9 @@ Accept wildcard characters: False ``` ### -UserSipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address for the first of the two user accounts to be tested. For example: @@ -290,12 +358,10 @@ For example: This parameter is not required if you are running the test by using test users configured via the `CsHealthMonitoringConfiguration` cmdlets. - ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ServerPlatform, ClientPlatform, TargetUri Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -304,20 +370,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform, TargetUri -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WebCredential -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WebCredential User credential object for the user account to be used in the test. The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: @@ -330,65 +386,7 @@ This parameter is required if either the TargetUri parameter or the UserSipAddre ```yaml Type: PSCredential Parameter Sets: TargetUri -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Authentication -Type of authentication used when running the test. -Allowed values are: - -TrustedServer - -Negotiate - -ClientCertificate - -LiveID - - -```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not prepend a $ character when specifying the variable name. - -To save the information stored in the logger variable to an HTML file, use a command similar to this: - -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` - -To save the information stored in the logger variable to an XML file, use a command similar to this: - -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -402,14 +400,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS ### System.Object -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The Test-CsWebApp cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsWebAppAnonymous.md b/skype/skype-ps/SkypeForBusiness/Test-CsWebAppAnonymous.md similarity index 83% rename from skype/skype-ps/skype/Test-CsWebAppAnonymous.md rename to skype/skype-ps/SkypeForBusiness/Test-CsWebAppAnonymous.md index 56fef6875f..1130a5a1ec 100644 --- a/skype/skype-ps/skype/Test-CsWebAppAnonymous.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsWebAppAnonymous.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cswebappanonymous applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsWebAppAnonymous -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-cswebappanonymous +schema: 2.0.0 +title: Test-CsWebAppAnonymous --- # Test-CsWebAppAnonymous @@ -56,7 +57,7 @@ If you decide to conduct the test using an actual user account you will need to ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsWebAppAnonymous -TargetFqdn atl-cs-001.litwareinc.com ``` @@ -65,7 +66,7 @@ The command shown in Example 1 verifies whether or not a test user configured fo This command will only succeed if you have configured a test user for the pool by using the `CsHealthMonitoringConfiguration` cmdlets. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $cred1 = Get-Credential "litwareinc\kenmyer" @@ -80,7 +81,34 @@ In addition to the UserCredential parameter, the UserSipAddress parameter is als ## PARAMETERS +### -Authentication + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Type of authentication used when running the test. +Allowed values are: + +* TrustedServer +* Negotiate +* ClientCertificate +* LiveID + +```yaml +Type: AuthenticationMechanism +Parameter Sets: (All) +Aliases: Ath + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -External + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, causes the `Test-CsWebAppAnonymous` cmdlet to test the Reach server's external web relay. If this parameter is not present, the cmdlet will test the internal web relay. The web relay serves as an intermediary between the internal network and the Internet. @@ -89,8 +117,7 @@ The web relay serves as an intermediary between the internal network and the Int ```yaml Type: SwitchParameter Parameter Sets: ServerPlatform, ClientPlatform -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -100,14 +127,49 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +When present, detailed output from running the cmdlet will be stored in the specified variable. +This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. + +To store output in a logger variable named $TestOutput use the following syntax: + +`-OutLoggerVariable TestOutput` + +Note: Do not prepend a $ character when specifying the variable name. + +To save the information stored in the logger variable to an HTML file, use a command similar to this: + +`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` + +To save the information stored in the logger variable to an XML file, use a command similar to this: + +`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` + +```yaml +Type: String +Parameter Sets: (All) +Aliases: olv Required: False Position: Named @@ -117,6 +179,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -129,7 +194,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -139,6 +203,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -147,7 +214,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: ServerPlatform, ClientPlatform Aliases: rp -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -157,17 +223,18 @@ Accept wildcard characters: False ``` ### -TargetFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Fully qualified domain name (FQDN) of the pool to be tested. For example: `-TargetFqdn atl-cs-001.litwareinc.com` - ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ServerPlatform, ClientPlatform Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: 1 @@ -176,20 +243,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -TargetUri -Required: False -Position: 1 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -TargetUri Uniform Resource Identifier (URI) of the Reach server. For example: @@ -202,7 +259,6 @@ You cannot use both the TargetUri parameter and the TargetFqdn parameter in the Type: String Parameter Sets: TargetUri Aliases: twsu -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -212,6 +268,9 @@ Accept wildcard characters: False ``` ### -UserCredential + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + User credentials object for the first of the two user accounts to be tested. The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. For example, this code returns a credentials object for the user litwareinc\pilar and stores that object in a variable named $x: @@ -227,7 +286,6 @@ This parameter is not required if you are running the test by using test users c Type: PSCredential Parameter Sets: ClientPlatform Aliases: uc -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: True Position: Named @@ -237,6 +295,9 @@ Accept wildcard characters: False ``` ### -UserSipAddress + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP address for the first of the two user accounts to be tested. For example: @@ -244,12 +305,10 @@ For example: This parameter is not required if you are running the test by using test users configured via the `CsHealthMonitoringConfiguration` cmdlets. - ```yaml Type: String -Parameter Sets: ServerPlatform +Parameter Sets: ServerPlatform, ClientPlatform, TargetUri Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -258,20 +317,10 @@ Accept pipeline input: False Accept wildcard characters: False ``` -```yaml -Type: String -Parameter Sets: ClientPlatform, TargetUri -Aliases: ua -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -WebCredential -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -WebCredential User credential object for the user account to be used in the test. The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: @@ -284,61 +333,7 @@ This parameter is required if either the TargetUri parameter or the UserSipAddre ```yaml Type: PSCredential Parameter Sets: TargetUri -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -Authentication -Type of authentication used when running the test. -Allowed values are: - -* TrustedServer -* Negotiate -* ClientCertificate -* LiveID - -```yaml -Type: AuthenticationMechanism -Parameter Sets: (All) -Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -OutLoggerVariable -When present, detailed output from running the cmdlet will be stored in the specified variable. -This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. - -To store output in a logger variable named $TestOutput use the following syntax: - -`-OutLoggerVariable TestOutput` - -Note: Do not prepend a $ character when specifying the variable name. - -To save the information stored in the logger variable to an HTML file, use a command similar to this: - -`$TestOutput.ToHTML() \> C:\Logs\TestOutput.html` - -To save the information stored in the logger variable to an XML file, use a command similar to this: - -`$TestOutput.ToXML() \> C:\Logs\TestOutput.xml` - -```yaml -Type: String -Parameter Sets: (All) -Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -352,14 +347,13 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS ### System.Object -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsWebAppAnonymous` cmdlet returns an instance of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsWebScheduler.md b/skype/skype-ps/SkypeForBusiness/Test-CsWebScheduler.md similarity index 84% rename from skype/skype-ps/skype/Test-CsWebScheduler.md rename to skype/skype-ps/SkypeForBusiness/Test-CsWebScheduler.md index 8339aaae79..5ddba063b4 100644 --- a/skype/skype-ps/skype/Test-CsWebScheduler.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsWebScheduler.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-cswebscheduler applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsWebScheduler -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-cswebscheduler +schema: 2.0.0 +title: Test-CsWebScheduler --- # Test-CsWebScheduler @@ -63,7 +64,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Test- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsWebScheduler -TargetFqdn "atl-cs-001.litwareinc.com" ``` @@ -76,7 +77,7 @@ If test users have not been defined, then the command will fail because it will If you have not defined test users for a pool, then you must include the UserSipAddress parameter and the credentials of the user that the command should use when trying to log on. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $credential = Get-Credential "litwareinc\kenmyer" @@ -93,75 +94,10 @@ To carry out this task, the `Test-CsWebScheduler` cmdlet is called, along with t ## PARAMETERS -### -TargetFqdn -Fully qualified domain name (FQDN) of the pool to be tested. - -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetUri -Uniform Resource Identifier (URI) of the Web scheduler.Note that you cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command. - -```yaml -Type: String -Parameter Sets: TargetUri -Aliases: twsu -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserCredential -User credential object for the account to be tested. -The value passed to UserCredential must be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credential object for the user litwareinc\kenmyer and stores that object in a variable named - -`$x = Get-Credential "litwareinc\kenmyer"` - -You need to supply the user password when running this command. -This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. - -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: uc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Authentication -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Authentication Allowed values are: * TrustedServer @@ -173,7 +109,6 @@ Allowed values are: Type: AuthenticationMechanism Parameter Sets: (All) Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -183,13 +118,15 @@ Accept wildcard characters: False ``` ### -External + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to verify that external users can use the web scheduler/ ```yaml Type: SwitchParameter Parameter Sets: ServerPlatform, ClientPlatform -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -199,13 +136,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -215,6 +154,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -236,7 +178,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -246,6 +187,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -257,7 +201,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -267,6 +210,9 @@ Accept wildcard characters: False ``` ### -RegistrarPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061. @@ -274,7 +220,6 @@ This parameter is not required if the Registrar uses the default port 5061. Type: Int32 Parameter Sets: ServerPlatform, ClientPlatform Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -283,34 +228,84 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address for user account to be tested; for example: +### -TargetFqdn -`-UserSipAddress "sip:kenmyer@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The UserSipAddress parameter must reference the same user account as UserCredential. -This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. +Fully qualified domain name (FQDN) of the pool to be tested. ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: ua -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -TargetUri + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Uniform Resource Identifier (URI) of the Web scheduler.Note that you cannot use both the TargetUri parameter and the TargetFqdn parameter in the same command. + +```yaml +Type: String +Parameter Sets: TargetUri +Aliases: twsu + +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -UserCredential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for the account to be tested. +The value passed to UserCredential must be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credential object for the user litwareinc\kenmyer and stores that object in a variable named + +`$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. +This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. + +```yaml +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: uc + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for user account to be tested; for example: + +`-UserSipAddress "sip:kenmyer@litwareinc.com"` + +The UserSipAddress parameter must reference the same user account as UserCredential. +This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. + ```yaml Type: String -Parameter Sets: ClientPlatform, TargetUri +Parameter Sets: ServerPlatform, ClientPlatform, TargetUri Aliases: ua -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -318,6 +313,9 @@ Accept wildcard characters: False ``` ### -WebCredential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + User credential object for the user account to be used in the test. The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named $x: @@ -329,8 +327,7 @@ This parameter is required if the TargetUri parameter or the UserSipAddress para ```yaml Type: PSCredential Parameter Sets: TargetUri -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -344,13 +341,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsWebScheduler` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.WebTaskOutput The `Test-CsWebScheduler` cmdlet returns instances of the Microsoft.Rtc.SyntheticTransactions.WebTaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Test-CsXmppIM.md b/skype/skype-ps/SkypeForBusiness/Test-CsXmppIM.md similarity index 85% rename from skype/skype-ps/skype/Test-CsXmppIM.md rename to skype/skype-ps/SkypeForBusiness/Test-CsXmppIM.md index 2f3d174cf0..218298d071 100644 --- a/skype/skype-ps/skype/Test-CsXmppIM.md +++ b/skype/skype-ps/SkypeForBusiness/Test-CsXmppIM.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/test-csxmppim applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Test-CsXmppIM -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/test-csxmppim +schema: 2.0.0 +title: Test-CsXmppIM --- # Test-CsXmppIM @@ -45,7 +46,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Test- ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Test-CsXmppIM -TargetFqdn "atl-cs-001.litwareinc.com" -Receiver "adelany@contoso.com" ``` @@ -58,7 +59,7 @@ If test users have not been defined, then the command will fail because it will If you have not defined test users for a pool, then you must include the UserSipAddress parameter and the credentials of the user that the command should use when trying to log on. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` $credential = Get-Credential "litwareinc\kenmyer" @@ -75,74 +76,10 @@ To carry out this task, the `Test-CsXmppIm` cmdlet is called, along with four pa ## PARAMETERS -### -Receiver -SIP address of the user who the test message is addressed to. - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -TargetFqdn -Fully qualified domain name of the pool being tested. - -```yaml -Type: String -Parameter Sets: ServerPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -```yaml -Type: String -Parameter Sets: ClientPlatform -Aliases: t -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 - -Required: False -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -UserCredential -User credential object for the user account to be tested. -The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. -For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named `$x:$x = Get-Credential "litwareinc\kenmyer"` - -You need to supply the user password when running this command. - -This parameter is not required if you are conducting the test using the health monitoring configuration settings. - -```yaml -Type: PSCredential -Parameter Sets: ClientPlatform -Aliases: uc -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -Authentication -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Authentication User credential object for the account to be tested. The value passed to UserCredential must be an object reference obtained by using the `Get-Credential` cmdlet. For example, this code returns a credential object for the user litwareinc\kenmyer and stores that object in a variable named @@ -156,7 +93,6 @@ This parameter is not required if you are conducting the test under the health m Type: AuthenticationMechanism Parameter Sets: (All) Aliases: Ath -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -166,13 +102,15 @@ Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -182,6 +120,9 @@ Accept wildcard characters: False ``` ### -OutLoggerVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. This variable includes a pair of methods - ToHTML and ToXML - that can then be used to save that output to either an HTML or an XML file. @@ -203,7 +144,6 @@ To save the information stored in the logger variable to an XML file, use a comm Type: String Parameter Sets: (All) Aliases: olv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -213,6 +153,9 @@ Accept wildcard characters: False ``` ### -OutVerboseVariable + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + When present, detailed output from running the cmdlet will be stored in the specified variable. For example, to store output in a variable named $TestOutput use the following syntax: @@ -224,7 +167,6 @@ Do not prepend a $ character when specifying the variable name. Type: String Parameter Sets: (All) Aliases: ovv -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -233,7 +175,28 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Receiver + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address of the user who the test message is addressed to. + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -RegistrarPort + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + SIP port used by the Registrar service. This parameter is not required if the Registrar uses the default port 5061 @@ -241,7 +204,6 @@ This parameter is not required if the Registrar uses the default port 5061 Type: Int32 Parameter Sets: (All) Aliases: rp -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -250,34 +212,65 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserSipAddress -SIP address for user account to be tested; for example: +### -TargetFqdn -`-UserSipAddress "sip:kenmyer@litwareinc.com"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -The UserSipAddress parameter must reference the same user account as UserCredential. -This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. +Fully qualified domain name of the pool being tested. ```yaml Type: String -Parameter Sets: ServerPlatform -Aliases: ua -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Parameter Sets: ServerPlatform, ClientPlatform +Aliases: t -Required: False +Required: True +Position: 2 +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -UserCredential + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +User credential object for the user account to be tested. +The value passed to UserCredential should be an object reference obtained by using the `Get-Credential` cmdlet. +For example, this code returns a credentials object for the user litwareinc\kenmyer and stores that object in a variable named `$x:$x = Get-Credential "litwareinc\kenmyer"` + +You need to supply the user password when running this command. + +This parameter is not required if you are conducting the test using the health monitoring configuration settings. + +```yaml +Type: PSCredential +Parameter Sets: ClientPlatform +Aliases: uc + +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` +### -UserSipAddress + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +SIP address for user account to be tested; for example: + +`-UserSipAddress "sip:kenmyer@litwareinc.com"` + +The UserSipAddress parameter must reference the same user account as UserCredential. +This parameter is not required if you are conducting the test under the health monitoring configuration settings for the pool. + ```yaml Type: String -Parameter Sets: ClientPlatform +Parameter Sets: ServerPlatform, ClientPlatform Aliases: ua -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False @@ -289,13 +282,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Test-CsXmppIM` cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.SyntheticTransactions.TaskOutput The `Test-CsXmppIM` cmdlet returns instances of the Microsoft.Rtc.SyntheticTransactions.TaskOutput object. ## NOTES diff --git a/skype/skype-ps/skype/Uninstall-CsDatabase.md b/skype/skype-ps/SkypeForBusiness/Uninstall-CsDatabase.md similarity index 82% rename from skype/skype-ps/skype/Uninstall-CsDatabase.md rename to skype/skype-ps/SkypeForBusiness/Uninstall-CsDatabase.md index 5963d866fb..39ec12dc7d 100644 --- a/skype/skype-ps/skype/Uninstall-CsDatabase.md +++ b/skype/skype-ps/SkypeForBusiness/Uninstall-CsDatabase.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/uninstall-csdatabase applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Uninstall-CsDatabase -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/uninstall-csdatabase +schema: 2.0.0 +title: Uninstall-CsDatabase --- # Uninstall-CsDatabase @@ -42,7 +43,7 @@ Regardless of the reason, the `Uninstall-CsDatabase` cmdlet provides a way for y ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Uninstall-CsDatabase -CentralManagementDatabase -SqlServerFqdn atl-sql-001.litwareinc.com ``` @@ -50,7 +51,7 @@ Uninstall-CsDatabase -CentralManagementDatabase -SqlServerFqdn atl-sql-001.litwa The command shown in Example 1 deletes the Central Management store from the computer atl-sql-001.litwareinc.com. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Uninstall-CsDatabase -DatabaseType User -SqlServerFqdn atl-sql-001.litwareinc.com ``` @@ -61,32 +62,17 @@ When you use the DatabaseType parameter, all stores related to the specified dat ## PARAMETERS -### -SqlServerFqdn -Fully qualified domain name (FQDN) of the computer or SQL Server cluster where the database is located. -For example: `-SqlServer atl-sql-001.litwareinc.com`. +### -CentralManagementDatabase -```yaml -Type: Fqdn -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` - -### -CentralManagementDatabase If present, uninstalls the Central Management store. You cannot use both CentralManagementDatabase and DatabaseType in the same command. ```yaml Type: SwitchParameter Parameter Sets: ByCMS -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -96,6 +82,9 @@ Accept wildcard characters: False ``` ### -DatabaseType + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Database to be deleted. Valid values are: @@ -131,8 +120,7 @@ To delete the Central Management store, use the CentralManagementDatabase parame ```yaml Type: DatabaseNameType Parameter Sets: ByDatabase -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: Named @@ -142,6 +130,9 @@ Accept wildcard characters: False ``` ### -Detach + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + If present, detaches the specified database. When a database is detached, all the file locks imposed by SQL Server are removed. This enables you to directly access the database files in order to do such things as copy those files to another computer. @@ -149,8 +140,7 @@ This enables you to directly access the database files in order to do such thing ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -159,15 +149,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlInstanceName -Name of the database instance containing the database to be removed. -A database instance is a set of running processes that provides access to database files. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +If present, forces removal of the database even if that database is currently in use. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -176,14 +167,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -If present, forces removal of the database even if that database is currently in use. +### -Report + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: `-Report "C:\Logs\UninstallDatabase.html"` ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -192,15 +186,17 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. -For example: `-Report "C:\Logs\UninstallDatabase.html"` +### -SqlInstanceName + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Name of the database instance containing the database to be removed. +A database instance is a set of running processes that provides access to database files. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -209,16 +205,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -SqlServerFqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the computer or SQL Server cluster where the database is located. +For example: `-SqlServer atl-sql-001.litwareinc.com`. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False @@ -226,13 +225,33 @@ Accept wildcard characters: False ``` ### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: wi Required: False Position: Named @@ -246,13 +265,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Uninstall-CsDatabase cmdlet does not accept pipelined input. ## OUTPUTS -### +### None The `Uninstall-CsDatabase` cmdlet does not return any values or objects. ## NOTES diff --git a/skype/skype-ps/skype/Uninstall-CsMirrorDatabase.md b/skype/skype-ps/SkypeForBusiness/Uninstall-CsMirrorDatabase.md similarity index 89% rename from skype/skype-ps/skype/Uninstall-CsMirrorDatabase.md rename to skype/skype-ps/SkypeForBusiness/Uninstall-CsMirrorDatabase.md index 882ce126eb..ab3d745906 100644 --- a/skype/skype-ps/skype/Uninstall-CsMirrorDatabase.md +++ b/skype/skype-ps/SkypeForBusiness/Uninstall-CsMirrorDatabase.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/uninstall-csmirrordatabase applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Uninstall-CsMirrorDatabase -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/uninstall-csmirrordatabase +schema: 2.0.0 +title: Uninstall-CsMirrorDatabase --- # Uninstall-CsMirrorDatabase @@ -37,7 +38,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Unins ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Uninstall-CsMirrorDatabase -SqlServerFqdn "atl-mirror-001.litwareinc.com" -SqlInstanceName "RTC" -DatabaseType "User" -DropExistingDatabasesOnMirror ``` @@ -49,6 +50,9 @@ Because the DropExistingDatabaseOnMirror parameter was included, the command wil ## PARAMETERS ### -DatabaseType + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Type of mirror database to be installed. Allowed values are: @@ -82,8 +86,7 @@ User ```yaml Type: DatabaseNameType Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: True Position: Named @@ -92,36 +95,38 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlServerFqdn -Fully qualified domain name (FQDN) of the computer containing the database is to be uninstalled. -For example: - -`-SqlServerFqdn atl-sql-001.litwareinc.com` +### -DropExistingDatabasesOnMirror -This should be the FQDN of the primary SQL Server computer. +> Applicable: Lync Server 2013, Skype for Business Server 2015 +When present, deletes any existing copies of the mirrored databases from the mirror server. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: True +Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -Report + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Enables you to specify a file path for the log file created when the cmdlet runs. +For example: + +`-Report "C:\Logs\UnInstallDatabaseMirror.html"` + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -130,14 +135,19 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DropExistingDatabasesOnMirror -When present, deletes any existing copies of the mirrored databases from the mirror server. +### -SqlInstanceName + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Name of the database instance where the database is to be installed. +A database instance is simply a set of running processes that provides access to database files. +If this parameter is omitted, the `Uninstall-CsMirrorDatabase` cmdlet will use the default SQL Server instance. + ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: Required: False Position: Named @@ -146,37 +156,40 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Report -Enables you to specify a file path for the log file created when the cmdlet runs. +### -SqlServerFqdn + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Fully qualified domain name (FQDN) of the computer containing the database is to be uninstalled. For example: -`-Report "C:\Logs\UnInstallDatabaseMirror.html"` +`-SqlServerFqdn atl-sql-001.litwareinc.com` + +This should be the FQDN of the primary SQL Server computer. ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: -Required: False +Required: True Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -SqlInstanceName -Name of the database instance where the database is to be installed. -A database instance is simply a set of running processes that provides access to database files. -If this parameter is omitted, the `Uninstall-CsMirrorDatabase` cmdlet will use the default SQL Server instance. +### -Confirm +> Applicable: Lync Server 2013, Skype for Business Server 2015 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015 +Aliases: cf Required: False Position: Named @@ -186,13 +199,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015 + Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015 Required: False Position: Named @@ -206,14 +221,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The `Uninstall-CsMirrorDatabase` cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Unlock-CsClientPin.md b/skype/skype-ps/SkypeForBusiness/Unlock-CsClientPin.md similarity index 89% rename from skype/skype-ps/skype/Unlock-CsClientPin.md rename to skype/skype-ps/SkypeForBusiness/Unlock-CsClientPin.md index 9e0e115c1e..9a30af5d22 100644 --- a/skype/skype-ps/skype/Unlock-CsClientPin.md +++ b/skype/skype-ps/SkypeForBusiness/Unlock-CsClientPin.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/unlock-csclientpin applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Unlock-CsClientPin -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/unlock-csclientpin +schema: 2.0.0 +title: Unlock-CsClientPin --- # Unlock-CsClientPin @@ -41,7 +42,7 @@ That means that you will not be able to run the `Unlock-CsClientPin` cmdlet from ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Unlock-CsClientPin -Identity "litwareinc\kenmyer" ``` @@ -49,7 +50,7 @@ Unlock-CsClientPin -Identity "litwareinc\kenmyer" In Example 1, the `Unlock-CsClientPin` cmdlet is used to unlock the PIN belonging to the user litwareinc\kenmyer. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Get-CsUser | Get-CsClientPinInfo | Where-Object {$_.IsLockedOut -eq $True} | Unlock-CsClientPin ``` @@ -63,7 +64,28 @@ The resulting filtered collection is then piped to the `Unlock-CsClientPin` cmdl ## PARAMETERS +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Identity + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Identity of the user account for which the PIN should be unlocked. User Identities can be specified by using one of four formats: 1) the user's SIP address; 2) the user's user principal name (UPN); 3) the user's domain name and logon name, in the form domain\logon (for example, litwareinc\kenmyer); and, 4) the user's Active Directory display name (for example, Ken Myer). User Identities can also be referenced by using the user's Active Directory distinguished name. @@ -74,8 +96,7 @@ For example, the Identity "* Smith" returns all the users who have a display nam ```yaml Type: UserIdParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: True Position: 1 @@ -84,14 +105,16 @@ Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -101,29 +124,15 @@ Accept wildcard characters: False ``` ### -WhatIf -Describes what would happen if you executed the command without actually executing the command. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -Confirm -Prompts you for confirmation before executing the command. +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -137,14 +146,14 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -String value or Microsoft.Rtc.Management.ADConnect.Schema.ADUser object. +### System.String +### Microsoft.Rtc.Management.ADConnect.Schema.ADUser The `Unlock-CsClientPin` cmdlet accepts pipelined input of string values representing the Identity of a user account. The cmdlet also accepts pipelined input of user objects. ## OUTPUTS -### +### None The `Unlock-CsClientPin` cmdlet does not return a value or object. Instead, the cmdlet configures one or more instances of the Microsoft.Rtc.Management.UserPinService.PinInfoDetails object. diff --git a/skype/skype-ps/skype/Unpublish-CsLisConfiguration.md b/skype/skype-ps/SkypeForBusiness/Unpublish-CsLisConfiguration.md similarity index 88% rename from skype/skype-ps/skype/Unpublish-CsLisConfiguration.md rename to skype/skype-ps/SkypeForBusiness/Unpublish-CsLisConfiguration.md index 6b754867cf..e0308a78cd 100644 --- a/skype/skype-ps/skype/Unpublish-CsLisConfiguration.md +++ b/skype/skype-ps/SkypeForBusiness/Unpublish-CsLisConfiguration.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/unpublish-cslisconfiguration applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Unpublish-CsLisConfiguration -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/unpublish-cslisconfiguration +schema: 2.0.0 +title: Unpublish-CsLisConfiguration --- # Unpublish-CsLisConfiguration @@ -33,7 +34,7 @@ The `Unpublish-CsLisConfiguration` cmdlet removes the LIS configuration from the ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Unpublish-CsLisConfiguration ``` @@ -44,13 +45,15 @@ This command removes the LIS configuration from the Central Management store. ## PARAMETERS ### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses any confirmation prompts that would otherwise be displayed before making changes. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -59,14 +62,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -Describes what would happen if you executed the command without actually executing the command. +### -Confirm + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -75,14 +80,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -Prompts you for confirmation before executing the command. +### -WhatIf + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Describes what would happen if you executed the command without actually executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -96,12 +103,11 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None ## OUTPUTS -### +### None This cmdlet does not return a value. ## NOTES diff --git a/skype/skype-ps/skype/Unregister-CsHybridPSTNAppliance.md b/skype/skype-ps/SkypeForBusiness/Unregister-CsHybridPSTNAppliance.md similarity index 90% rename from skype/skype-ps/skype/Unregister-CsHybridPSTNAppliance.md rename to skype/skype-ps/SkypeForBusiness/Unregister-CsHybridPSTNAppliance.md index 458d44b4aa..ffe905ba42 100644 --- a/skype/skype-ps/skype/Unregister-CsHybridPSTNAppliance.md +++ b/skype/skype-ps/SkypeForBusiness/Unregister-CsHybridPSTNAppliance.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/unregister-cshybridpstnappliance applicable: Skype for Business Online -title: Unregister-CsHybridPSTNAppliance -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/unregister-cshybridpstnappliance +schema: 2.0.0 +title: Unregister-CsHybridPSTNAppliance --- # Unregister-CsHybridPSTNAppliance @@ -36,7 +38,7 @@ To return a list of all the Role-Based Access Control (RBAC) roles a cmdlet has ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Insert example commands for example 1. ``` @@ -47,30 +49,36 @@ Insert descriptive text for example 1. ## PARAMETERS -### -Identity -Specifies the identity of the Skype for Business Cloud Connector Edition appliance. +### -BypassDualWrite + +> Applicable: Skype for Business Online + +PARAMVALUE: $true | $false ```yaml Type: Object Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -BypassDualWrite -PARAMVALUE: $true | $false +### -Force + +> Applicable: Skype for Business Online + +The Force switch specifies whether to suppress warning and confirmation messages. +It can be useful in scripting to suppress interactive prompts. +If the Force switch isn't provided in the command, you're prompted for administrative input if required. ```yaml -Type: Object +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -79,32 +87,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Confirm -PARAMVALUE: SwitchParameter +### -Identity + +> Applicable: Skype for Business Online + +Specifies the identity of the Skype for Business Cloud Connector Edition appliance. ```yaml -Type: SwitchParameter +Type: Object Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -The Force switch specifies whether to suppress warning and confirmation messages. -It can be useful in scripting to suppress interactive prompts. -If the Force switch isn't provided in the command, you're prompted for administrative input if required. +### -Instance + +> Applicable: Skype for Business Online + +PARAMVALUE: PSObject ```yaml -Type: SwitchParameter +Type: Object Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -113,14 +123,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Instance -PARAMVALUE: PSObject +### -Tenant + +> Applicable: Skype for Business Online + +PARAMVALUE: Guid ```yaml Type: Object Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -129,14 +141,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Tenant -PARAMVALUE: Guid +### -Confirm + +> Applicable: Skype for Business Online + +PARAMVALUE: SwitchParameter ```yaml -Type: Object +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: cf Required: False Position: Named @@ -146,13 +160,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + PARAMVALUE: SwitchParameter ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named diff --git a/skype/skype-ps/skype/Update-CsAddressBook.md b/skype/skype-ps/SkypeForBusiness/Update-CsAddressBook.md similarity index 89% rename from skype/skype-ps/skype/Update-CsAddressBook.md rename to skype/skype-ps/SkypeForBusiness/Update-CsAddressBook.md index 3db49c7148..e4b06a6a81 100644 --- a/skype/skype-ps/skype/Update-CsAddressBook.md +++ b/skype/skype-ps/SkypeForBusiness/Update-CsAddressBook.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/update-csaddressbook applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Update-CsAddressBook -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/update-csaddressbook +schema: 2.0.0 +title: Update-CsAddressBook --- # Update-CsAddressBook @@ -36,7 +37,7 @@ If you can't wait for synchronization to take place or if it appears that, for s ## EXAMPLES -### -------------------------- EXAMPLE 1 -------------------------- +### EXAMPLE 1 ``` Update-CsAddressBook ``` @@ -45,7 +46,7 @@ In Example 1, the `Update-CsAddressBook` cmdlet is called without any parameters This synchronizes all the Address Book servers in the organization. -### -------------------------- EXAMPLE 2 -------------------------- +### EXAMPLE 2 ``` Update-CsAddressBook -Fqdn atl-abs-001.litwareinc.com ``` @@ -55,37 +56,41 @@ In Example 2, only a single Address Book server is synchronized: the server with ## PARAMETERS -### -Fqdn -Enables you to specify an individual Address Book to be updated. -If this parameter is not included then all of your Address Book servers will be synchronized with the User database. -Individual Address Book servers should be referenced by their fully qualified domain name (FQDN); for example, atl-abs-001.litwareinc.com. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. + + ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses any confirmation prompts or non-fatal error messages that might occur when you run the cmdlet. +### -Fqdn +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Enables you to specify an individual Address Book to be updated. +If this parameter is not included then all of your Address Book servers will be synchronized with the User database. +Individual Address Book servers should be referenced by their fully qualified domain name (FQDN); for example, atl-abs-001.litwareinc.com. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -96,14 +101,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Update-CsAddressBook cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None Instead, the Update-CsAddressBook cmdlet updates existing instances of the Microsoft.Rtc.Management.WritableConfig.Settings.AddressBook.AddressBookSettings object. ## NOTES diff --git a/skype/skype-ps/skype/Update-CsAdminRole.md b/skype/skype-ps/SkypeForBusiness/Update-CsAdminRole.md similarity index 86% rename from skype/skype-ps/skype/Update-CsAdminRole.md rename to skype/skype-ps/SkypeForBusiness/Update-CsAdminRole.md index 6b1a812753..ed4d9fe5ce 100644 --- a/skype/skype-ps/skype/Update-CsAdminRole.md +++ b/skype/skype-ps/SkypeForBusiness/Update-CsAdminRole.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/update-csadminrole applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Update-CsAdminRole -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/update-csadminrole +schema: 2.0.0 +title: Update-CsAdminRole --- # Update-CsAdminRole @@ -32,7 +33,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Updat ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Update-CsAdminRole ``` @@ -42,14 +43,16 @@ The command shown in Example 1 updates the RBAC definitions stored in the Centra ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. +### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -58,14 +61,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might occur when running the command. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: cf Required: False Position: Named @@ -75,13 +80,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 Required: False Position: Named @@ -95,14 +102,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Update-CsAdminRole cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None The Update-CsAdminRole cmdlet does not return any data or objects. ## NOTES diff --git a/skype/skype-ps/skype/Update-CsClsLogging.md b/skype/skype-ps/SkypeForBusiness/Update-CsClsLogging.md similarity index 90% rename from skype/skype-ps/skype/Update-CsClsLogging.md rename to skype/skype-ps/SkypeForBusiness/Update-CsClsLogging.md index 1478045d95..f86b1b65f3 100644 --- a/skype/skype-ps/skype/Update-CsClsLogging.md +++ b/skype/skype-ps/SkypeForBusiness/Update-CsClsLogging.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/update-csclslogging applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Update-CsClsLogging -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/update-csclslogging +schema: 2.0.0 +title: Update-CsClsLogging --- # Update-CsClsLogging @@ -43,7 +44,7 @@ In addition, administrators can also use the `Update-CsClsLogging` cmdlet to cha ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Update-CsClsLogging -Duration 60 ``` @@ -52,7 +53,7 @@ The command shown in Example 1 modifies the logging duration time for servers in In this example, the duration time is set to 1 hour (60 minutes). -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Update-CsClsLogging -Duration 60 -Pools "atl-cs-001.litwareinc.com" ``` @@ -62,45 +63,16 @@ In Example 2, the duration time is modified for all the servers in the pool atl- ## PARAMETERS -### -Duration -Amount of time that the logging operation should run. -For example, this syntax causes the logging operation to run for 2 hours (120 minutes) and then stop: - -`-Duration 120` - -This following syntax would specify a duration of 3 hours and 14 minutes: - -`-Duration 3:15` - -The following syntax would specify a duration of 6 days, 5 hours and 12 minutes: - -`-Duration 6.5:12` - -The default value is 30 minutes. - - - -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +### -AsXml -Required: True -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -### -AsXml When specified, information is returned using XML. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -110,6 +82,9 @@ Accept wildcard characters: False ``` ### -Computers + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to updates the centralized logging service on a specified server or set of servers. To update a single server, specify the fully qualified domain name of that server. For example: @@ -125,8 +100,7 @@ If you do not the Computers parameter or the Pools parameter, `Update-CsClsLoggi ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -135,7 +109,43 @@ Accept pipeline input: False Accept wildcard characters: False ``` +### -Duration + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Amount of time that the logging operation should run. +For example, this syntax causes the logging operation to run for 2 hours (120 minutes) and then stop: + +`-Duration 120` + +This following syntax would specify a duration of 3 hours and 14 minutes: + +`-Duration 3:15` + +The following syntax would specify a duration of 6 days, 5 hours and 12 minutes: + +`-Duration 6.5:12` + +The default value is 30 minutes. + + + +```yaml +Type: String +Parameter Sets: (All) +Aliases: + +Required: True +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + ### -Pools + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables administrators to update the centralized logging service on each server in a pool. To update the servers in a pool, specify the fully qualified domain name of that pool. For example: @@ -149,8 +159,7 @@ Multiple pools can be specified by separating the pool FQDNs using commas: ```yaml Type: String[] Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -164,14 +173,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Update-CsClsLogging cmdlet does not accept pipelined input. ## OUTPUTS -### -String value. +### System.Stringvalue. ## NOTES diff --git a/skype/skype-ps/skype/Update-CsTenantMeetingUrl.md b/skype/skype-ps/SkypeForBusiness/Update-CsTenantMeetingUrl.md similarity index 95% rename from skype/skype-ps/skype/Update-CsTenantMeetingUrl.md rename to skype/skype-ps/SkypeForBusiness/Update-CsTenantMeetingUrl.md index 03dc67a577..929af575e4 100644 --- a/skype/skype-ps/skype/Update-CsTenantMeetingUrl.md +++ b/skype/skype-ps/SkypeForBusiness/Update-CsTenantMeetingUrl.md @@ -1,13 +1,15 @@ --- -external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/update-cstenantmeetingurl applicable: Skype for Business Online -title: Update-CsTenantMeetingUrl -schema: 2.0.0 -manager: bulenteg author: tomkau +external help file: Microsoft.Rtc.Management.Hosted.dll-help.xml +Locale: en-US +manager: bulenteg +Module Name: SkypeForBusiness ms.author: tomkau ms.reviewer: williamlooney +online version: https://learn.microsoft.com/powershell/module/skype/update-cstenantmeetingurl +schema: 2.0.0 +title: Update-CsTenantMeetingUrl --- # Update-CsTenantMeetingUrl @@ -70,7 +72,7 @@ Meeting URL configuration will be updated! ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Update-CsTenantMeetingUrl -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" ``` @@ -79,7 +81,7 @@ The command shown in Example 1 updates the meeting URL for the tenant with the t (Note that you must supply the tenant ID in order for this command to complete.) After pressing ENTER to run the command, you will be asked if you are sure you want to update the meeting URL. You must answer yes to this prompt before `Update-CsTenantMeetingUrl` will actually make any changes to your Skype for Business Online configuration settings. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Update-CsTenantMeetingUrl -Tenant "38aad667-af54-4397-aaa7-e94c79ec2308" -Force ``` @@ -90,33 +92,16 @@ In this case, as soon as you press ENTER the command will run and your Skype for ## PARAMETERS -### -Confirm -Prompts you for confirmation before executing the command. - -Note that the default behavior of the `Update-CsMeetingUrl` is to display the confirmation prompt before making any updates. -That means that, if you want to display the confirmation prompt, you do not need to include the Confirm parameter. - -```yaml -Type: SwitchParameter -Parameter Sets: (All) -Aliases: cf -Applicable: Skype for Business Online +### -Force -Required: False -Position: Named -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` +> Applicable: Skype for Business Online -### -Force Suppresses the display of the confirmation prompt which would otherwise appear before `Update-CsMeetingUrl` makes any updates. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: Required: False Position: Named @@ -126,6 +111,9 @@ Accept wildcard characters: False ``` ### -Tenant + +> Applicable: Skype for Business Online + Globally unique identifier (GUID) of the tenant account whose federation settings are being returned. For example: @@ -140,8 +128,28 @@ If you do not include the Tenant parameter then `Update-CsMeetingUrl` will promp ```yaml Type: Guid Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Online +Aliases: + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -Confirm + +> Applicable: Skype for Business Online + +Prompts you for confirmation before executing the command. + +Note that the default behavior of the `Update-CsMeetingUrl` is to display the confirmation prompt before making any updates. +That means that, if you want to display the confirmation prompt, you do not need to include the Confirm parameter. + +```yaml +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf Required: False Position: Named @@ -151,13 +159,15 @@ Accept wildcard characters: False ``` ### -WhatIf + +> Applicable: Skype for Business Online + The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. ```yaml Type: SwitchParameter Parameter Sets: (All) Aliases: wi -Applicable: Skype for Business Online Required: False Position: Named @@ -171,14 +181,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None `Update-CsMeetingUrl` does not accept pipelined input. ## OUTPUTS -### -None. +### None ## NOTES diff --git a/skype/skype-ps/skype/Update-CsUserData.md b/skype/skype-ps/SkypeForBusiness/Update-CsUserData.md similarity index 83% rename from skype/skype-ps/skype/Update-CsUserData.md rename to skype/skype-ps/SkypeForBusiness/Update-CsUserData.md index 1002d5a2b2..b258d35f8b 100644 --- a/skype/skype-ps/skype/Update-CsUserData.md +++ b/skype/skype-ps/SkypeForBusiness/Update-CsUserData.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/update-csuserdata applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Update-CsUserData -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/update-csuserdata +schema: 2.0.0 +title: Update-CsUserData --- # Update-CsUserData @@ -35,7 +36,7 @@ Skype for Business Server Control Panel: The functions carried out by the `Updat ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Update-CsUserData -Filename "C:\Logs\ExportedUserData.zip" ``` @@ -43,7 +44,7 @@ Update-CsUserData -Filename "C:\Logs\ExportedUserData.zip" The command shown in Example 1 updates Skype for Business Server user data based on information stored in the file C:\Logs\ExportedUserData.zip. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Update-CsUserData -Filename "C:\Logs\ExportedUserData.zip" -UserFilter "kenmyer@litwareinc.com" ``` @@ -54,33 +55,19 @@ This is done by including the UserFilter parameter followed by the user's SIP ad ## PARAMETERS -### -FileName -Full path to the .ZIP file or .XML file containing the user data to be updated. -For example: +### -DomainController -`-FileName "C:\Data\Lync2010.zip"` +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -```yaml -Type: String -Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Enables administrators to specify the FQDN of the domain controller to be used when running the `Update-CsUserData` cmdlet. +If not specified, the cmdlet will use the first available domain controller. -Required: True -Position: 2 -Default value: None -Accept pipeline input: False -Accept wildcard characters: False -``` -### -Confirm -Prompts you for confirmation before executing the command. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: cf -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -89,33 +76,37 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -DomainController -Enables administrators to specify the FQDN of the domain controller to be used when running the `Update-CsUserData` cmdlet. -If not specified, the cmdlet will use the first available domain controller. +### -FileName +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Full path to the .ZIP file or .XML file containing the user data to be updated. +For example: + +`-FileName "C:\Data\Lync2010.zip"` ```yaml -Type: Fqdn +Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: -Required: False -Position: Named +Required: True +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False ``` ### -Force + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Suppresses the display of any non-fatal error message that might occur when running the command. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -125,14 +116,16 @@ Accept wildcard characters: False ``` ### -RoutingGroupFilter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + Enables you to update data only for the specified routing groups. Routing groups are used to indicate the Front End server that users register with. ```yaml Type: String Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -141,18 +134,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserFilter -Enables you to update data for a single user. -That user specified by using his or her SIP address, minus the sip: prefix. -For example: +### -TargetPoolFqdn -`-UserFilter "kenmyer@litwareinc.com"` +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Registrar pool containing the user accounts to be updated. ```yaml -Type: String +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -161,14 +152,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -WhatIf -The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. +### -TestMode + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +When included in a command, `Update-CsUserData` will verify that the data can be updated, but will not actually update that data. ```yaml Type: SwitchParameter Parameter Sets: (All) -Aliases: wi -Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -177,14 +170,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TargetPoolFqdn -Registrar pool containing the user accounts to be updated. +### -ThreadCount + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Number of threads that can be devoted to the update task. ```yaml -Type: Fqdn +Type: Int32 Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -193,14 +188,16 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -TestMode -When included in a command, `Update-CsUserData` will verify that the data can be updated, but will not actually update that data. +### -UserFileFilter + +> Applicable: Skype for Business Server 2015, Skype for Business Server 2019 + +Full path to a text file containing a list of user URIs for whom data should be exported. ```yaml -Type: SwitchParameter +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -209,14 +206,20 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -ThreadCount -Number of threads that can be devoted to the update task. +### -UserFilter + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Enables you to update data for a single user. +That user specified by using his or her SIP address, minus the sip: prefix. +For example: + +`-UserFilter "kenmyer@litwareinc.com"` ```yaml -Type: Int32 +Type: String Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False Position: Named @@ -225,14 +228,34 @@ Accept pipeline input: False Accept wildcard characters: False ``` -### -UserFileFilter -Full path to a text file containing a list of user URIs for whom data should be exported. +### -Confirm + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Prompts you for confirmation before executing the command. ```yaml -Type: String +Type: SwitchParameter +Parameter Sets: (All) +Aliases: cf + +Required: False +Position: Named +Default value: None +Accept pipeline input: False +Accept wildcard characters: False +``` + +### -WhatIf + +> Applicable: Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +The WhatIf switch causes the command to simulate its results. By using this switch, you can view what changes would occur without having to commit those changes. + +```yaml +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: wi Required: False Position: Named @@ -246,13 +269,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Update-CsUserData cmdlet does not accept pipelined input. ## OUTPUTS -### +### Microsoft.Rtc.Management.User.UserData The Update-CsUserData cmdlet updates Skype for Business Server 2015 user information. ## NOTES diff --git a/skype/skype-ps/skype/Update-CsUserDatabase.md b/skype/skype-ps/SkypeForBusiness/Update-CsUserDatabase.md similarity index 89% rename from skype/skype-ps/skype/Update-CsUserDatabase.md rename to skype/skype-ps/SkypeForBusiness/Update-CsUserDatabase.md index e4b3514b60..696f72c97e 100644 --- a/skype/skype-ps/skype/Update-CsUserDatabase.md +++ b/skype/skype-ps/SkypeForBusiness/Update-CsUserDatabase.md @@ -1,13 +1,14 @@ --- -external help file: Microsoft.Rtc.Management.dll-help.xml -online version: https://learn.microsoft.com/powershell/module/skype/update-csuserdatabase applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 -title: Update-CsUserDatabase -schema: 2.0.0 -manager: rogupta author: hirenshah1 +external help file: Microsoft.Rtc.Management.dll-help.xml +Locale: en-US +manager: rogupta +Module Name: SkypeForBusiness ms.author: hirshah -ms.reviewer: +online version: https://learn.microsoft.com/powershell/module/skype/update-csuserdatabase +schema: 2.0.0 +title: Update-CsUserDatabase --- # Update-CsUserDatabase @@ -37,14 +38,14 @@ You might also need to run this cmdlet if a product update ever includes a chang ## EXAMPLES -### -------------------------- Example 1 -------------------------- +### Example 1 ``` Update-CsUserDatabase ``` The command shown in Example 1 locates the user database for the pool where the local computer is located, then forces that database to connect to and return complete user information from Active Directory. -### -------------------------- Example 2 -------------------------- +### Example 2 ``` Update-CsUserDatabase -Fqdn atl-cs-001.litwareinc.com ``` @@ -55,34 +56,38 @@ In this case, that's the user database for the pool atl-cs-001.litwareinc.com. ## PARAMETERS -### -Fqdn -Fully qualified domain name (FQDN) of the computer hosting the user database. -If this parameter is not specified then the `Update-CsUserDatabase` cmdlet will update the user database for the pool that the local computer belongs to. +### -Force + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Suppresses the display of any non-fatal error message that might arise when running the command. ```yaml -Type: Fqdn +Type: SwitchParameter Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: 2 +Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False ``` -### -Force -Suppresses the display of any non-fatal error message that might arise when running the command. +### -Fqdn + +> Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 + +Fully qualified domain name (FQDN) of the computer hosting the user database. +If this parameter is not specified then the `Update-CsUserDatabase` cmdlet will update the user database for the pool that the local computer belongs to. ```yaml -Type: SwitchParameter +Type: Fqdn Parameter Sets: (All) -Aliases: -Applicable: Lync Server 2010, Lync Server 2013, Skype for Business Server 2015, Skype for Business Server 2019 +Aliases: Required: False -Position: Named +Position: 2 Default value: None Accept pipeline input: False Accept wildcard characters: False @@ -93,14 +98,12 @@ This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable ## INPUTS -### -None. +### None The Update-CsUserDatabase cmdlet does not accept pipelined input. ## OUTPUTS -### -None. +### None Instead, the `Update-CsUserDatabase` cmdlet updates instances of the Microsoft.Rtc.Management.Xds.DisplayUserDatabase object. ## NOTES