[Index]

Model: device/skypeforbusiness/CsCommonAreaPhone

Model Details

Title Description Details
DN 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". Note that your command will fail if the specified contact does not exist. Your command will also fail if the specified contact has already been enabled for Skype for Business Server 2015. In that case, you must first disable the contact using the Disable-CsUser and cmdlet then run the New-CsCommonAreaPhone cmdlet. The DN parameter is particularly useful in organizations that have already created contact objects for conference rooms and other entities. These contacts are often used for scheduling purposes. By using the DN parameter you can create a new common area phone using one of these pre-existing contact objects. You cannot use the OU and the DN parameters in the same command.
  • Field Name: DN
  • Type: String
VoiceRoutingPolicy
  • Field Name: VoiceRoutingPolicy
  • Type: String
  • Target: device/skypeforbusiness/CsVoiceRoutingPolicy
  • Target attr: Identity
  • Format: uri
DisplayName Enables you to set the Active Directory display name of the common area phone.
  • Field Name: DisplayName
  • Type: String
TargetServerIfMoving
  • Field Name: TargetServerIfMoving
  • Type: String
HostingProvider
  • Field Name: HostingProvider
  • Type: String
UserServicesPolicy
  • Field Name: UserServicesPolicy
  • Type: String
TenantId
  • Field Name: TenantId
  • Type: String
MobilityPolicy
  • Field Name: MobilityPolicy
  • Type: String
  • Target: device/skypeforbusiness/CsMobilityPolicy
  • Target attr: Identity
  • Format: uri
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; 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. (Normalization is the process of translating number strings into a standard phone number format.) If a normalization rule does not exist for the phone number format used when configuring the display number, the display screen of the common area phone will show the value of the LineUri property rather than the value of the DisplayNumber property.
  • Field Name: DisplayNumber
  • Type: String
UserRoutingGroupId
  • Field Name: UserRoutingGroupId
  • Type: String
WhenChanged
  • Field Name: WhenChanged
  • Type: String
  • Format: date-time
ExternalAccessPolicy
  • Field Name: ExternalAccessPolicy
  • Type: String
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.
  • Field Name: Description
  • Type: String
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.
  • Field Name: EnterpriseVoiceEnabled
  • Type: Boolean
ObjectClass
  • Field Name: ObjectClass.[n]
  • Type: Array
ClientVersionPolicy
  • Field Name: ClientVersionPolicy
  • Type: String
EnabledForFederation
  • Field Name: EnabledForFederation
  • Type: Boolean
VoicePolicy
  • Field Name: VoicePolicy
  • Type: String
  • Target: device/skypeforbusiness/CsVoicePolicy
  • Target attr: Identity
  • Format: uri
PinPolicy
  • Field Name: PinPolicy
  • Type: String
  • Target: device/skypeforbusiness/CsPinPolicy
  • Target attr: Identity
  • Format: uri
ObjectState
  • Field Name: ObjectState
  • Type: Integer
ThirdPartyVideoSystemPolicy
  • Field Name: ThirdPartyVideoSystemPolicy
  • Type: String
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:[email protected].
  • Field Name: SipAddress
  • Type: String
PersistentChatPolicy
  • Field Name: PersistentChatPolicy
  • Type: String
  • Target: device/skypeforbusiness/CsPersistentChatPolicy
  • Target attr: Identity
  • Format: uri
ConferencingPolicy
  • Field Name: ConferencingPolicy
  • Type: String
  • Target: device/skypeforbusiness/CsConferencingPolicy
  • Target attr: Identity
  • Format: uri
LocationPolicy
  • Field Name: LocationPolicy
  • Type: String
ArchivingPolicy
  • Field Name: ArchivingPolicy
  • Type: String
DistinguishedName
  • Field Name: DistinguishedName
  • Type: String
OriginatingServer
  • Field Name: OriginatingServer
  • Type: String
Name
  • Field Name: Name
  • Type: String
ObjectId
  • Field Name: ObjectId
  • Type: String
Created
  • Field Name: Created
  • Type: Boolean
Enabled Indicates whether or not the contact object for the common area phone has been enabled for Skype for Business Server 2015. 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.
  • Field Name: Enabled
  • Type: Boolean
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".
  • Field Name: RegistrarPool
  • Type: String
ExchangeArchivingPolicy Indicates where the contact's instant messaging sessions are archived. Allowed values are: Uninitialized UseLyncArchivingPolicy ArchivingToExchange NoArchiving
  • Field Name: ExchangeArchivingPolicy
  • Type: Integer
  • Choices: ["Uninitialized", "Use Lync Archiving Policy", "Archiving To Exchange", "No Archiving"]
WhenCreated
  • Field Name: WhenCreated
  • Type: String
  • Format: date-time
TargetRegistrarPool
  • Field Name: TargetRegistrarPool
  • Type: String
DialPlan
  • Field Name: DialPlan
  • Type: String
ExUmEnabled
  • Field Name: ExUmEnabled
  • Type: Boolean
ExperiencePolicy
  • Field Name: ExperiencePolicy
  • Type: String
IsByPassValidation
  • Field Name: IsByPassValidation
  • Type: Boolean
AddressBookPolicy
  • Field Name: AddressBookPolicy
  • Type: String
ClientPolicy
  • Field Name: ClientPolicy
  • Type: String
  • Target: device/skypeforbusiness/CsClientPolicy
  • Target attr: Identity
  • Format: uri
HostedVoicemailPolicy
  • Field Name: HostedVoicemailPolicy
  • Type: String
PublicNetworkEnabled
  • Field Name: PublicNetworkEnabled
  • Type: Boolean
ObjectCategory
  • Field Name: ObjectCategory
  • Type: String
EnabledForInternetAccess
  • Field Name: EnabledForInternetAccess
  • Type: Boolean
PresencePolicy
  • Field Name: PresencePolicy
  • Type: String
GraphPolicy
  • Field Name: GraphPolicy
  • Type: String
ProxyAddresses
  • Field Name: ProxyAddresses.[n]
  • Type: Array
LineURI *
  • Field Name: LineURI
  • Type: String
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.
  • Field Name: Identity
  • Type: String
IsValid
  • Field Name: IsValid
  • Type: Boolean
OU 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". If you include the OU parameter, a new contact will be created in the specified OU, and the contact will automatically be assigned a globally unique identifier (GUID) as its common name. As a result, the contact object will have a name similar to this: {ce84964a-c4da-4622-ad34-c54ff3ed361f}.
  • Field Name: OU
  • Type: String
Guid
  • Field Name: Guid
  • Type: String
CallViaWorkPolicy
  • Field Name: CallViaWorkPolicy
  • Type: String
LegalInterceptPolicy
  • Field Name: LegalInterceptPolicy
  • Type: String
HomeServer
  • Field Name: HomeServer
  • Type: String
EnabledForRichPresence
  • Field Name: EnabledForRichPresence
  • Type: Boolean
API reference for device/skypeforbusiness/CsCommonAreaPhone