Share via


MSFT_SIPGlobalArchivingSetting

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.

Defines the global archiving settings for all the users in your organization and all federated users, or for certain users as specified by user settings. The settings on this tab take effect only if the Archiving Server has already been deployed. To deploy Archiving Server, see the Archiving Server deployment documentation.

The property values for the MSFT_SIPGlobalArchivingSetting class map to the settings found on the Archiving tab of the Office Communications Server Global Properties dialog box. You can access these values in the Office Communications Server 2007 R2 Administration Tool by right-clicking Forest, pointing to Properties, and then clicking Global Properties. In the Office Communications Server Global Properties dialog box, click the Archiving tab.

MSFT_SIPGlobalArchivingSetting

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_SIPGlobalArchivingSetting
{
  string ArchiveFederatedCommunications;
  string ArchiveInternalCommunications;
  [key] string InstanceID;
};

Methods

This class does not define any methods.

Properties

The MSFT_SIPGlobalArchivingSetting class has the following properties.

  • ArchiveFederatedCommunications
    Data type: string

    Access type: Read/Write

    Required. Specifies whether to archive communications for no users, every user, or only certain users who are members of a federated network that is outside of the organization's network.

    Value

    Description

    None

    Archive communications for none of the users who are members of a federated network that is outside of the organization's network.

    Everyone

    Archive communications for all users who are members of a federated network that is outside of the organization's network.

    UsePerUserSetting

    Archive communications on a per-user basis according to the settings in the instance of MSFT_SIPESUserSetting for each user.

    The value of this property is not case-sensitive.

    The ArchiveExternalCommunications property maps to the External communications option buttons in the Office Communications Server Global Properties dialog box.

  • ArchiveInternalCommunications
    Data type: string

    Access type: Read/Write

    Required. Specifies whether to archive internal communications for no users, every user, or only certain users who are inside of the organization's network.

    Value

    Description

    None

    Archive communications for none of the users who are inside of the organization's network.

    Everyone

    Archive communications for all users who are inside of the organization's network.

    UsePerUserSetting

    Archive communications on a per-user basis according to the settings in the instance of MSFT_SIPESUserSetting for each user.

    The value of this property is not case-sensitive.

    The ArchiveInternalCommunications property maps to the Internal communications option buttons in the Office Communications Server Global Properties dialog box.

  • 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 Office Communications Server Global Properties dialog box.

Remarks

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

Only one instance of this class can be present in the forest.

The settings in this class do not apply to group instant messaging conversations.

When global archiving is configured for None or for Everyone, archiving settings at the user level are not configurable. To implement user-level archiving, use the UsePerUserSetting value and then configure user-level archiving settings using properties of the MSFT_SIPESUserSetting class.

Instances of this class support the following interface methods:

  • Provider::EnumerateInstances();

  • Provider::GetObject();

  • Provider::PutInstance();

    Where PutInstance() supports the following flag:

    • WBEM_FLAG_UPDATE_ONLY

Requirements

Server: Installed on computers serving the following roles: Administrative Tools Server, Front End Server, and Proxy Server.

Namespace: Defined in \root\cimv2.

See Also

Concepts

Office Communications Server WMI Reference