Export (0) Print
Expand All
Expand Minimize
This topic has not yet been rated - Rate this topic

MSFT_SIPRgsAgentData (New)

Defines Response Group settings for an agent.

The property values for the MSFT_SIPRgsAgentData class map to the settings found in the Agents node of the Response Group Service snap-in. You can access these values in the Office Communications Server 2007 R2 Administration Tool by right-clicking the name of a Standard Edition server or Enterprise Edition pool, pointing to Properties, pointing to Applications, and then clicking Response Group Service Properties. In the Response Group Service snap-in, click the Agents node.

An instance of this class is created for each agent.

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_SIPRgsAgentData
{
  [key] string Backend;
  string DisplayName;
  string[] DistributionListIds;
  boolean Enabled;
  boolean IndividualAgent;
  [key] string InstanceId;
  string SipAddress;
  string UserSid;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPRgsAgentData class has the following properties.

Backend

Data type: [key] string

Access type: Read-only

For Enterprise Edition, computername identifies either the FQDN or the NetBIOS name of the host computer for SQL Server and instancename identifies a named instance of SQL Server on the host computer. The value computername by itself specifies the default instance of SQL Server on the host computer.

The value for this property depends on the topology of Office Communications Server.

Topology

Value

Standard Edition

(local)\rtc

Enterprise Edition

(consolidated or expanded configuration)

computername\instancename

or

computername

You can specify computername using either the FQDN or the NetBIOS name of the host computer for SQL Server and instancename identifies a named instance of SQL Server on the specified computer. Use computername by itself only if the Back-End Database Server uses the default instance of SQL Server on the host computer.

The Backend property does not map to the Agents node in the Response Group Service snap-in.

DisplayName

Data type: string

Access type: Read/Write

Optional. Specifies the agent name as it is displayed in clients (for example, Office Communicator) or reports.

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

The DisplayName property maps to the Display name setting in the Agents node.

DistributionListIds

Data type: string[]

Access type: Read/Write

Optional. A string array of Microsoft Exchange Server e-mail distribution list IDs to which the agent belongs.

The value of this property is not case-sensitive.

The DistributionListIds property does not map to the Agents node in the Response Group Service snap-in.

Enabled

Data type: boolean

Access type: Read/Write

Required. Specifies whether an agent is enabled to receive calls.

The Enabled property maps to the Enabled setting in the Agents node.

IndividualAgent

Data type: boolean

Access type: Read/Write

Required. Specify True when an agent is added individually (for example, as a custom agent). Specify False when an agent is added as a member of a Microsoft Exchange Server distribution list.

If a distribution list is deleted, the False setting flags the server to remove the agent.

The IndividualAgent property does not map to the Agents node in the Response Group Service snap-in.

InstanceId

Data type: [key] string

Access type: Read-only

Required. A GUID value that uniquely identifies an instance of this class.

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

The InstanceID property does not map to the Agents node in the Response Group Service snap-in.

SipAddress

Data type: string

Access type: Read/Write

Required. The Session Initiation Protocol (SIP) address for the agent.

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

The SipAddress property maps to the SIP URI setting in the Agents node.

UserSid

Data type: string

Access type: Read/Write

Required. The security identifier (SID) for the user.

NoteNote

The RTC database on the Office Communications Server back-end database maps Active Directory user globally unique identifiers (GUIDs) and security identifiers (SIDs) to users and SIP URIs.

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

The UserSID property does not map to the Agents node in the Response Group Service snap-in.

Remarks

This class gets and sets information at the following level: SQL.

Instances of this class support the following interface methods:

  • Provider::DeleteInstance();

  • Provider::EnumerateInstances();

  • Provider::GetObject();

  • Provider::PutInstance();

    Where PutInstance() supports the following flags:

    • WBEM_FLAG_CREATE_ONLY

    • WBEM_FLAG_UPDATE_ONLY

    • WBEM_FLAG_CREATE_OR_UPDATE

Requirements

Server: Installed on computers serving the following roles: Administrative Tools Server and Application Host.

Namespace: Defined in \root\cimv2.

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.