• Configuration Properties

Get Prop Metadata

Gets the meta data for each of the configuration properties. Metatdata includes the possible values for the property, a description of the property, whether a reboot is required when it is changed, etc.

Required Roles

Requires one of the following roles:

• SYSTEM_ADMIN

• SYSTEM_MONITOR

Response Body

Configuration meta data for the system

Examples

GET https://192.168.0.0:4443/config/object/properties/metadata HTTP/1.1

Content-Type: application/xml
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

HTTP/1.1 200 OKContent-Type: application/xml<?xml version="1.0" encoding="UTF-8" ?>	<properties_metadata>		<metadata>			<entry>				<key>user_scope</key>				<value>					<advanced>false</advanced>					<allowedValues>NAMESPACE</allowedValues>					<allowedValues>GLOBAL</allowedValues>					<controlNodeOnly>false</controlNodeOnly>					<description>Declares the scope for user name uniqueness</description>					<hidden>false</hidden>					<label>User scope</label>					<maxLen>65534</maxLen>					<minLen>0</minLen>					<rebootRequired>false</rebootRequired>					<reconfigRequired>false</reconfigRequired>					<type>string</type>					<userConfigurable>false</userConfigurable>					<userMutable>false</userMutable>					<value>GLOBAL</value>				</value>			</entry>		</metadata>	</properties_metadata>

GET https://192.168.0.0:4443/config/object/properties/metadata.json HTTP/1.1
 
Content-Type: application/json
X-SDS-AUTH-TOKEN: <AUTH_TOKEN>

HTTP/1.1 200 OKContent-Type: application/json{  "properties_metadata": {    "metadata": {      "entry": {        "key": "user_scope",        "value": {          "advanced": "false",          "allowedValues": [            "NAMESPACE",            "GLOBAL"          ],          "controlNodeOnly": "false",          "description": "Declares the scope for user name uniqueness",          "hidden": "false",          "label": "User scope",          "maxLen": "65534",          "minLen": "0",          "rebootRequired": "false",          "reconfigRequired": "false",          "type": "string",          "userConfigurable": "false",          "userMutable": "false",          "value": "GLOBAL"        }      }    }  }}

curl -H $token -H "Content-Type: application/xml" -X GET https://$nodeIp:4443/config/object/properties/metadata

HTTP/1.1 200 OK
Content-Type: application/xml

<?xml version="1.0" encoding="UTF-8" ?>
	<properties_metadata>
		<metadata>
			<entry>
				<key>user_scope</key>
				<value>
					<advanced>false</advanced>
					<allowedValues>NAMESPACE</allowedValues>
					<allowedValues>GLOBAL</allowedValues>
					<controlNodeOnly>false</controlNodeOnly>
					<description>Declares the scope for user name uniqueness</description>
					<hidden>false</hidden>
					<label>User scope</label>
					<maxLen>65534</maxLen>
					<minLen>0</minLen>
					<rebootRequired>false</rebootRequired>
					<reconfigRequired>false</reconfigRequired>
					<type>string</type>
					<userConfigurable>false</userConfigurable>
					<userMutable>false</userMutable>
					<value>GLOBAL</value>
				</value>
			</entry>
		</metadata>
	</properties_metadata>