[Index]

Model: device/skypeforbusinesshybrid/CsClientVersionPolicyRule

Model Details: device/skypeforbusinesshybrid/CsClientVersionPolicyRule

Title Description Details
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.
  • Field Name: MajorVersion
  • Type: String
QfeNumber 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.
  • Field Name: QfeNumber
  • Type: String
Description 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.
  • Field Name: Description
  • Type: String
Parent * 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". To create a new rule for a service policy, use syntax similar to this: -parent "Registrar:atl-cs-001.litwareinc.com". To create a new rule for a per-user policy, use syntax similar to this: -Parent "RedmondClientVersionPolicy". You must use either the Identity parameter or both the Parent and RuleId parameters when creating a new rule.
  • Field Name: Parent
  • Type: String
RuleId * Globally unique identifier (GUID) for the rule. In Windows PowerShell, you can create a GUID by using the following command: $x = [guid]::NewGuid()
  • Field Name: RuleId
  • Type: String
Enabled 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.
  • Field Name: Enabled
  • Type: Boolean
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.
  • Field Name: MinorVersion
  • Type: String
Element
  • Field Name: Element
  • Type: String
Priority 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.
  • Field Name: Priority
  • Type: Integer
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: Allow. The user will be allowed to log on. AllowWithUrl. The user will be allowed to log on, and a message will be displayed pointing him or her to a URL where the latest version of Lync can be downloaded and installed. AllowAndUpgrade. The user will be allowed to log on, and his or her copy of Communicator will automatically be upgraded to the latest version of Lync. Block. The user will not be allowed to log on. 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 Lync can be downloaded and installed. BlockAndUpgrade. The user will not be allowed to log on, but his or her copy of Communicator will automatically be upgraded to the latest version of Lync. The user can then try to log on by using the new client application.
  • Field Name: Action
  • Type: String
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.
  • Field Name: UserAgentFullName
  • Type: String
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.
  • Field Name: Identity
  • Type: String
CompareOp 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: EQL (equal to) NEQ (not equal to) GTR (greater than) GEQ (greater than or equal to) LSS (less than) LEQ (less than or equal to)
  • Field Name: CompareOp
  • Type: String
ActionUrl URL where users can download the latest version of Lync. This property is required if the Action is set to BlockWithUrl or AllowWithUrl.
  • Field Name: ActionUrl
  • Type: String
UserAgent Designator used to identify the software client. For example, OC is the user agent designation for Communicator.
  • Field Name: UserAgent
  • Type: String
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>.
  • Field Name: InMemory
  • Type: Boolean
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" 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
  • Field Name: Tenant
  • Type: String
BuildNumber 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.
  • Field Name: BuildNumber
  • Type: String