milestonexprotectrestpython.xprsite

Module: xprsite.py

Revision History

Date Version Description
2023/07/11 1.0.0.0 Initial Version.

@export
class XPRSite:

Site information.

Threadsafety:

This class is fully thread-safe.

More information about Site configuration can be found on the vendor documentation page.

XPRSite()

Initializes a new instance of the class.

ComputerName: str

Computer name that is hosting the site.

Returns:

The ComputerName property value.

DateLastStatusHandshake: datetime.datetime

Date and time (in UTC format) of the last synchronization of the hierarchy.

Returns:

The DateLastStatusHandshake property value.

DateModified: datetime.datetime

Date and time (in UTC format) that the site entry was last modified.

Returns:

The DateModified property value.

Description: str

A description of the site.

Returns:

The Description property value.

DisplayName: str

User-friendly display name used in various user-interface displays.

Returns:

The DisplayName property value.

DomainName: str

Domain name of the computer that is hosting the site.

Returns:

The DomainName property value.

Id: str

The globally unique identifier of the site.

Returns:

The Id property value.

Name: str

Name of the site.

Returns:

The Name property value.

MasterSiteAddress: str

URL of the parent site, if this site is defined as a child site.
Value is an empty string if this is the master site.

Returns:

The MasterSiteAddress property value.

PhysicalMemory: int

Host computer physical memory amount that the site is limited to using.
A value of zero indicates no limit.

Returns:

The PhysicalMemory property value.

Platform: str

Host computer platform that the site is running under.
A "[Not available]" value is returned if the platform is unavailable.

Returns:

The Platform property value.

Processors: int

Host computer number of processors that the site is limited to using.
A value of zero indicates no limit.

Returns:

The Processors property value.

ServiceAccount: str

Service account under which the management server is running.

Returns:

The ServiceAccount property value.

SynchronizationStatus: int

Status of the last synchronization of the hierarchy.
It can be either Successful (0) or Failed (1).

Returns:

The SynchronizationStatus property value.

TimeZoneName: str

Time zone of the computer that is hosting the site.

Returns:

The TimeZoneName property value.

Version: str

Version number of the site's management server.

Returns:

The Version property value.