This object represents the Microsoft Server.
References to msserver are object references. The name part of a Microsoft Server object reference has the following components:
- The address of the Microsoft Server.
Example: msserver/ZG5zLm5ldHdvcmtfdmlldyQxMTk:1.0.0.1
The object does not support the following operations:
The object cannot be managed on Cloud Platform members.
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): address.
The following fields are required to create this object:
| Field | Notes |
|---|---|
| address |
The Active Directory domain to which this server belongs (if applicable).
Type
String.
Search
The field is not available for search.
Notes
The ad_domain cannot be updated.
ad_domain cannot be written.
The Active Directory Sites information
Type
A/An Microsoft Server AD Sites struct.
Create
The default value is undefined.
Search
The field is not available for search.
The Active Directory User synchronization information.
Type
A/An Microsoft Server AD user struct.
Create
The default value is undefined.
Search
The field is not available for search.
The address or FQDN of the server.
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
Notes
The address is part of the base object.
User comments for this Microsoft Server
Type
String.
Create
The default value is empty.
Search
The field is not available for search.
Result of the last RPC connection attempt made
Type
String.
Search
The field is not available for search.
Notes
The connection_status cannot be updated.
connection_status cannot be written.
Detail of the last connection attempt made
Type
String.
Search
The field is not available for search.
Notes
The connection_status_detail cannot be updated.
connection_status_detail cannot be written.
RW fields needed for DHCP purposes at Microsoft Server level
Type
A/An Microsoft Server DHCP Properties struct for MsServer Object struct.
Create
The default value is undefined.
Search
The field is not available for search.
Allow/forbids usage of this Microsoft Server
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Structure containing DNS information
Type
A/An Microsoft server DNS struct.
Create
The default value is undefined.
Search
The field is not available for search.
Reference to the DNS view
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
Extensible attributes associated with the object.
For valid values for extensible attributes, see the following information.
Type
Extensible attributes.
This field allows +/- to be specified as part of the field name when updating the object, see the following information.
Create
The default value is empty.
Search
For how to search extensible attributes, see the following information.
eference to the assigned grid member
Type
String.
Create
The default value is undefined.
Search
The field is available for search via
Timestamp of the last message received
Type
Timestamp.
Search
The field is not available for search.
Notes
The last_seen cannot be updated.
last_seen cannot be written.
Directs logging of sync messages either to syslog or mslog
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
Notes
log_destination is associated with the field use_log_destination (see use flag).
Log level for this Microsoft Server
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
Microsoft Server login name, with optional domainname
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
Microsoft Server login password
Type
String.
Create
The default value is undefined.
Search
The field is not available for search.
Notes
login_password is not readable.
Hostname of grid member managing this Microsoft Server
Type
String.
Search
The field is not available for search.
Notes
The managing_member cannot be updated.
managing_member cannot be written.
Maximum number of connections to MS server
Type
Unsigned integer.
Create
The default value is 10.
Search
The field is not available for search.
Notes
ms_max_connection is associated with the field use_ms_max_connection (see use flag).
Timeout in seconds of RPC connections for this MS Server
Type
Unsigned integer.
Create
The default value is 60.
Search
The field is not available for search.
Notes
ms_rpc_timeout_in_seconds is associated with the field use_ms_rpc_timeout_in_seconds (see use flag).
Reference to the network view
Type
String.
Create
The default value is default.
Search
The field is not available for search.
Enable read-only management for this Microsoft Server
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
The root Active Directory domain to which this server belongs (if applicable).
Type
String.
Search
The field is not available for search.
Notes
The root_ad_domain cannot be updated.
root_ad_domain cannot be written.
Gives the server name as reported by itself
Type
String.
Search
The field is not available for search.
Notes
The server_name cannot be updated.
server_name cannot be written.
Minimum number of minutes between two synchronizations
Type
Unsigned integer.
Create
The default value is 2.
Search
The field is not available for search.
Synchronization status summary
Type
String.
Search
The field is not available for search.
Notes
The synchronization_status cannot be updated.
synchronization_status cannot be written.
Detail status if synchronization_status is ERROR
Type
String.
Search
The field is not available for search.
Notes
The synchronization_status_detail cannot be updated.
synchronization_status_detail cannot be written.
Override log_destination inherited from grid level
Type
Bool.
Create
The default value is False.
Search
The field is not available for search.
Override grid ms_max_connection setting
Type
Bool.
Create
The default value is undefined.
Search
The field is not available for search.
| Field | Type | Req | R/O | Base | Search |
|---|---|---|---|---|---|
| ad_domain | String | N | Y | N | N/A |
| ad_sites | struct | N | N | N | N/A |
| ad_user | struct | N | N | N | N/A |
| address | String | Y | N | Y | : = ~ |
| comment | String | N | N | N | N/A |
| connection_status | String | N | Y | N | N/A |
| connection_status_detail | String | N | Y | N | N/A |
| dhcp_server | struct | N | N | N | N/A |
| disabled | Bool | N | N | N | N/A |
| dns_server | struct | N | N | N | N/A |
| dns_view | String | N | N | N | N/A |
| extattrs | Extattr | N | N | N | ext |
| grid_member | String | N | N | N | = |
| last_seen | Timestamp | N | Y | N | N/A |
| log_destination | String | N | N | N | N/A |
| log_level | String | N | N | N | N/A |
| login_name | String | N | N | N | N/A |
| login_password | String | N | N | N | N/A |
| managing_member | String | N | Y | N | N/A |
| ms_max_connection | Unsigned int | N | N | N | N/A |
| ms_rpc_timeout_in_seconds | Unsigned int | N | N | N | N/A |
| network_view | String | N | N | N | N/A |
| read_only | Bool | N | N | N | N/A |
| root_ad_domain | String | N | Y | N | N/A |
| server_name | String | N | Y | N | N/A |
| synchronization_min_delay | Unsigned int | N | N | N | N/A |
| synchronization_status | String | N | Y | N | N/A |
| synchronization_status_detail | String | N | Y | N | N/A |
| use_log_destination | Bool | N | N | N | N/A |
| use_ms_max_connection | Bool | N | N | N | N/A |
| use_ms_rpc_timeout_in_seconds | Bool | N | N | N | N/A |
| version | String | N | Y | N | N/A |
