MSFT_SIPESUserACEData

Article
05/23/2014

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

MSFT_SIPESUserACEData

Defines SIP-level allow and block access for a homed Office Communications Server user.

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties. Properties are listed in alphabetic order, not MOF order.

Syntax

class MSFT_SIPESUserACEData
{
  string Communication;
  [key] string Mask;
  string Presence;
  [key] string Type;
  [key] string UserInstanceID;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPESUserACEData class has the following properties.

Communication
Data type: string

Access type: Read/Write

Required. Specifies the action that the client should take upon receiving a SIP INVITE message from the entity specified by the Mask property.

Value

Description

"Allow"

Allow all INVITE messages from entities that match the mask.

"Deny"

Deny all INVITE messages from entities that match the mask.

The value of this property is not case-sensitive.
Mask
Data type: [key] string

Access type: Read/Write

Optional. The mask used when the Type property is set to either Domain or User.

The mask is used to determine the domains or users upon which the actions specified in the Presence and Communication properties are enforced.

If the Type property is set to Domain, the mask must be a valid fully qualified domain name (FQDN) or IP address. If the Type property is set to User, the mask must be a valid SIP URI (for example, "sip:someone@example.com"). If the Type property is set to All, this value is NULL.

The value of this property is not case-sensitive. The maximum length of the string is 454 characters.

Presence
Data type: string

Access type: Read/Write

Required. Specifies the action that the Office Communications Server takes upon receiving a SIP SUBSCRIBE message from the entity specified by the Mask property.

Value	Description
"Allow"	Allow all SUBSCRIBE messages from entities that match the mask.
"Deny"	Deny all SUBSCRIBE messages from entities that match the mask.
"Prompt"	Prompt the user before allowing any SUBSCRIBE messages from entities that match the mask.
"Block"	Block all SUBSCRIBE messages from entities that match the mask and respond with a 404 (User Not Found) status code.

The value of this property is not case-sensitive.

Type
Data type: [key] string

Access type: Read/Write

Required. The type of filtration for access.

Value	Description
"All"	The allow and block entry applies to all messages.
"Domain"	The allow and block entry applies to messages from users in a specific domain.
"User"	The allow and block entry applies to messages from a specific user.

The value of this property is not case-sensitive.

UserInstanceID
Data type: [key] string

Access type: Read-only

Required. A GUID value that uniquely identifies this SIP user.

The GUID must be encapsulated between the "{" and "}" braces; for example: "{01234567-0123-4567-89AB-CDEF01234567}".

Remarks

This class gets and sets information at the following level(s): USERDCOM.

Uniqueness is guaranteed by a combination of the GUID representing the Active Directory user, the ACE type, and the allow and block entry mask.

Communication is enforced by the client and Presence is enforced by the server. Following are the four valid combinations of the Communication and Presence properties:

Communication Setting	Presence Setting	Effect
Allow	Allow	The user can be invited to sessions by entities that match the mask, and can receive presence updates.
Allow	Prompt	The user can be invited to sessions by entities that match the mask, but must be prompted for presence updates.
Deny	Deny	The user will not accept session invitations from entities that match the mask, and will also not accept presence updates.
Deny	Block	The user will not accept session invitations from entities that match the mask, and will actively block presence updates.

To perform operations on this class, connect to local WMI. In turn, WMI contacts the home server of the user and retrieves or updates the data for the instance of this class associated with the user. Office Communications Server must be running and available on the user's home server.

Instances of this class support the following interface methods:

Provider::DeleteInstance(); Provider::PutInstance();

Where PutInstance() supports the following flag(s):

WBEM_FLAG_CREATE_OR_UPDATE

Requirements

Server: Installed on computers serving the following role(s): Administrative Tools Server, Front End Server, Proxy Server.Namespace: Defined in \root\cimv2.

Reference

[<LinkCreatedDuringXmlConversion>]

Concepts

Office Communications Server WMI Reference

Share via