Retrieval of the current values of advanced server settings

Edit online

9.2.3 Available from 9.2.3.

You use the GET operation on the api/sam/configs element to request information about the current values of the License Metric Tool server settings. The output is returned in the JSON format.

Permissions

An icon representing a user. You must be an Administrator to perform this task.

Resource URL

https://hostname:port/api/sam/configs

Resource information

Table 1. Resource information
Operation details	Description
Purpose	Returns information about the current values of the License Metric Tool server settings.
HTTP method	`GET`
Resource URI	https://`hostname`:`port`/api/sam/configs
URL query parameters	For a list of query parameters, see: Query parameters.
Request headers	`Accept-Language` (optional) Use: Used to negotiate the language of the response. If this header is not specified, the content is returned in the server language. Values: `en-US` (only English is supported) `Token` Use: Used to authenticate REST API requests. The header is required when you set the value of the api_token_in_url_enabled parameter to false. Otherwise, you can specify the token in the request header or in the URL. For more information, see: Authenticating REST API requests. Values: an alphanumeric string that is generated in License Metric Tool
Request payload	n/a
Request `Content-Type`	`Application/json`
Response headers	`Content-Type` Use: Specifies the content type of the response. Values: `application/json` `Content-Language` Use: Specifies the language of the response content. If this header is not specified, the content is returned in the server language. Values: en-US, …
Response payload	`configs` element
Response `Content-Type`	`Application/json`
Normal HTTP response codes	n/a
Error HTTP response codes	n/a

Query parameters

The following table presents query parameters that you can use for the configs element.

Table 2. Query parameters for retrieving current values of server settings
Parameter	Description	Required	Value
name	Returns the configuration of a single parameter. For a complete list of possible values and their explanation, see: Advanced server settings.	No	Name of the parameter

Example HTTP conversation

Checking the current value of all parameters.

Request

GET https://hostname:port/api/sam/configs

Request header

Accept: application/json
Accept-Language: en-US
Token: <token>

Excerpt for the response body (JSON)

[
{"valueMax":10080,
"valueMin":0,
"valueType":"minutes",
"name":"vmman_transfer_period","value":"720"},

{"valueType":"boolean",
"name":"vmman_check_uniqueness_enabled",
"value":"true"},

{"valueType":"boolean",
"name":"blockUiBundlingComputations",
"value":"false"},

{"valueType":"boolean",
"name":"storeHwDataForAllVMManagerNodes",
"value":"false"},
]

Checking the current value of a single parameter.

Request

GET https://hostname:port/api/sam/configs?name=maxVMManagerInactivity

Request header

Accept: application/json
Accept-Language: en-US
Token: <token>

Response body (JSON)

[
{"valueMax":90,
"valueMin":1,
"valueType":"days",
"name":"maxVMManagerInactivity",
"value":"3"}
]