View system
This method combines the (View System Status) and (View System Configuration) method output.
Request
Security
| Any | Super User | System Admin | Security Admin | Operator |
|---|---|---|---|---|
| superUser | systemAdmin (readOnly and read/write) |
securityAdmin (readOnly and read/write) |
operator |
HTTP method
GET /manager/api/{apiResponseType}/1.0/viewSystem.adm HTTP/1.1 Host:{manager.dsnet}
itemType={type}&id={id}&rel={item}.{relatedItem}
Curl method
curl -u {admin}:{password} -k
”https://{manager.dsnet}/manager/api/{apiResponseType}/1.0/viewSystem.adm“ -d
”itemType={type}&id={id}&rel={item}.{relatedItem}“
Parameters
| Parameter | Type | Usage | Default | Description |
|---|---|---|---|---|
| itemType | Optional | none |
Any entity the View System can output except Settings, Root Organization, or Event Categories. It represents the starting point of the request and must be used in tandem with the id parameter to return any results (except for dsnet, since it does not have an ID). If itemType is excluded, all the default data is returned. If an invalid option is supplied, no data is returned. Valid values include:
|
|
| id | long | Optional | none |
Used in tandem with itemType. The ID of the items to request. Multiple id parameters can be added to the request to create more complex relationships and add more items to the output. |
| rel | String | Optional | none |
It is used to look up relationships between elements in the Manager Web Interface. This querying aspect allows the user to get more items based on their relationship to other elements in the system. |
Example 1. Relating Items in the Request
An example relationship is site.devices. Adding this relationship includes all devices in any sites requested.
Most relationships are in the form ITEM.RELATED_ITEMS where site = ITEM and devices = RELATED_ITEMS in the example. Each itemType can be chosen as ITEM and then each one has 0 or more available RELATED_FIELD options.
| Item | Related Field |
|---|---|
| accesspool | devices, vaults, mirrors, mirroredvaults |
| account | vaults |
| cabinet | devices |
| device | storagepools, vaults, mirrors, hardwareprofiles |
| dsnet | accounts, accesspools, cabinets, devices, eventcategories, groups, mirrors, deviceswithoutsite, rootorganization, settings, sites, storagepools, storagepoolgroups, tags, vaults devicesnotinaccesspool, devicesnotinstoragepool, deviceswithoutsite |
| group | vaults |
| mirror | accessdevices, accounts, devices, groups, storagedevices, vaults |
| site | cabinets, devices, storagedevices, accessdevices, vaults, mirrors, storagepools, accesspools |
| storagepool | devices, vaults, sites, cabinets |
| storagepoolgroup | storagepools, vaulttemplates |
| tag | vaults |
| vault | accessdevices, storagedevices, devices, accounts, groups, storagepools, accesspools, tags |
| fileserverpool | devices, shares |
| filesystem | shares, vaults |
| share | fileserverpools, filesystems |
Response
The viewSystem method merges the responses of (View System Status) and (View System Configuration) methods.
| Parameter | Type | Description |
|---|---|---|
| ldapServiceName | String | The site-specific code that maps to the site's name in Active Directory. |
| ldap.dynamic | Boolean | Dynamically identify LDAP controller names from DNS SRV records. |
| ldap.dnsDomainName | String | Base DNS domain name to use for LDAP service location (needed when ldap.dynamic is True) |
| ldap.dynamicProviderUrl | String | A template for building an LDAP URL when given an LDAP service host name,
where the special string $host is replaced with the host name
(optional, default is ldaps://$host:636) |