msserver:adsites:site : Active Directory Site object.

This object provides information about the Active Directory Site.

Object Reference

References to msserver:adsites:site are object references. The name part of an Active Directory Site properties object reference has the following components:

• Name of the Active Directory Site properties object
• Name of the Active Directory Domain to which the Site belongs

Example: msserver:adsites:site/ZG5zLmJpbmRfY25h:somesite/somedomain

Restrictions

The object does not support the following operations:

• Scheduling
• CSV export

The object cannot be managed on Cloud Platform members.

Fields

These fields are actual members of the object; thus, they can be requested by using _return_fields, if the fields are readable.

The basic version of the object contains the field(s): domain, name.

The following fields are required to create this object:

Field	Notes
domain
name

domain

domain

The reference to the Active Directory Domain to which the site belongs.

Type

String.

This field supports nested return fields as described here.

Create

The field is required on creation.

Search

The field is available for search via

• ‘=’ (exact equality)

Notes

The domain is part of the base object.

name

name

The name of the site properties object for the Active Directory Sites.

Type

String.

Values with leading or trailing white space are not valid for this field.

Create

The field is required on creation.

Search

The field is available for search via

• ‘:=’ (case insensitive search)
• ‘=’ (exact equality)
• ‘~=’ (regular expression)

Notes

The name is part of the base object.

networks

networks

The list of networks to which the device interfaces belong.

Type

An array of the following objects: network, networkcontainer.

This field supports nested return fields as described here.

Create

The default value is empty.

Search

The field is not available for search.

Function Calls

move_subnets

This function is used to move subnets to the site for the Active Directory Sites.

This function does not support multiple object matches when called as part of an atomic insertion operation.

Input fields

networks ( An array of the following objects: network, networkcontainer. ). This parameter is mandatory. The list of networks associated to this site.

Output fields

None

Fields List

Field	Type	Req	R/O	Base	Search
domain	String	Y	N	Y	=
name	String	Y	N	Y	: = ~
networks	obj	N	N	N	N/A