appliance vcenter settings v1 config: get
Returns information about a profile. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.
Request:
HTTP request
GET https://{server}/api/appliance/vcenter/settings/v1/config
Response:
HTTP Status Code: 200
Response Body Structure:
{
"creation_time" : "2015-01-01T22:13:05.651Z",
"owner" : "string",
"profile" : "obj-103",
"name" : "string",
"description" : "string",
"desired_state" : {
"authmgmt" : {
"global_permission_list" : [
{
"principal" : {
"name" : "string",
"group" : true
},
"propagate" : true,
"role_ids" : [
1,
1
]
},
{
"principal" : {
"name" : "string",
"group" : true
},
"propagate" : true,
"role_ids" : [
1,
1
]
}
],
"token_policy" : {
"clock_tolerance" : 1,
"token_delegation" : 1,
"token_renewal" : 1,
"bearer_refresh" : 1,
"hok_refresh" : 1
},
"lockout_policy" : {
"failed_login_attempts" : 1,
"failure_interval" : 1,
"unlock_time" : 1
},
"password_policy" : {
"uppercase_chars" : 1,
"min_length" : 1,
"alpha_chars" : 1,
"max_life" : 1,
"special_chars" : 1,
"lowercase_chars" : 1,
"numeric_chars" : 1,
"adj_identical_chars" : 1,
"password_reuse" : 1,
"max_length" : 1
},
"role_list" : [
{
"privilege_id" : [
"string",
"string"
],
"name" : "string",
"description" : "string",
"id" : 1
},
{
"privilege_id" : [
"string",
"string"
],
"name" : "string",
"description" : "string",
"id" : 1
}
],
"privileges_list" : [
{
"is_on_parent" : true,
"description" : "string",
"id" : "string",
"group" : "string"
},
{
"is_on_parent" : true,
"description" : "string",
"id" : "string",
"group" : "string"
}
]
},
"appliance" : {
"software_update_policy" : {
"password" : "secret string",
"auto_stage" : "DISABLED",
"certificate_check" : true,
"default_URL" : "string",
"check_schedule" : {
"hour" : "string",
"day" : "MONDAY",
"minute" : "string"
},
"custom_URL" : "string",
"username" : "string"
},
"time_sync" : {
"mode" : "DISABLED"
},
"smtp" : {
"relay_port" : "string",
"mail_server" : "string"
},
"ssh" : {
"enabled" : true
},
"local_accounts_policy" : {
"warn_days" : 1,
"max_days" : 1,
"min_days" : 1
},
"console_cli" : {
"enabled" : true
},
"ntp" : {
"servers" : [
"string",
"string"
]
},
"syslog" : [
{
"hostname" : "string",
"protocol" : "TLS",
"port" : 1
},
{
"hostname" : "string",
"protocol" : "TLS",
"port" : 1
}
],
"time_zone" : {
"name" : "string"
},
"network" : {
"dns_server_configuration" : {
"mode" : "DHCP",
"servers" : [
"string",
"string"
]
},
"firewall_rule_policies" : [
{
"address" : "string",
"prefix" : 1,
"interface_name" : "string",
"policy" : "IGNORE"
},
{
"address" : "string",
"prefix" : 1,
"interface_name" : "string",
"policy" : "IGNORE"
}
],
"proxy_configuration" : [
{
"server" : "string",
"protocol" : "HTTP",
"password" : "secret string",
"port" : 1,
"enabled" : true,
"username" : "string"
},
{
"server" : "string",
"protocol" : "HTTP",
"password" : "secret string",
"port" : 1,
"enabled" : true,
"username" : "string"
}
]
},
"backup_schedules" : [
{
"recurrence_info" : {
"hour" : 1,
"days" : [
"MONDAY",
"MONDAY"
],
"minute" : 1
},
"backup_password" : "secret string",
"enable" : true,
"parts" : [
"string",
"string"
],
"location" : "http://myurl.com",
"location_password" : "secret string",
"schedule_id" : "string",
"location_user" : "string",
"retention_info" : {
"max_count" : 1
}
},
{
"recurrence_info" : {
"hour" : 1,
"days" : [
"MONDAY",
"MONDAY"
],
"minute" : 1
},
"backup_password" : "secret string",
"enable" : true,
"parts" : [
"string",
"string"
],
"location" : "http://myurl.com",
"location_password" : "secret string",
"schedule_id" : "string",
"location_user" : "string",
"retention_info" : {
"max_count" : 1
}
}
],
"shell" : {
"enabled" : true,
"timeout" : 1
},
"root_local_account" : {
"warn_days_before_password_expiration" : 1,
"password" : "secret string",
"min_days_between_password_change" : 1,
"roles" : [
"string",
"string"
],
"password_expires_at" : "2015-01-01T22:13:05.651Z",
"fullname" : "string",
"last_password_change" : "2015-01-01T22:13:05.651Z",
"enabled" : true,
"email" : "string",
"has_password" : true,
"max_days_between_password_change" : 1
},
"dcui" : {
"enabled" : true
}
}
},
"version" : "obj-103"
}
"creation_time" : "2015-01-01T22:13:05.651Z",
"owner" : "string",
"profile" : "obj-103",
"name" : "string",
"description" : "string",
"desired_state" : {
"authmgmt" : {
"global_permission_list" : [
{
"principal" : {
"name" : "string",
"group" : true
},
"propagate" : true,
"role_ids" : [
1,
1
]
},
{
"principal" : {
"name" : "string",
"group" : true
},
"propagate" : true,
"role_ids" : [
1,
1
]
}
],
"token_policy" : {
"clock_tolerance" : 1,
"token_delegation" : 1,
"token_renewal" : 1,
"bearer_refresh" : 1,
"hok_refresh" : 1
},
"lockout_policy" : {
"failed_login_attempts" : 1,
"failure_interval" : 1,
"unlock_time" : 1
},
"password_policy" : {
"uppercase_chars" : 1,
"min_length" : 1,
"alpha_chars" : 1,
"max_life" : 1,
"special_chars" : 1,
"lowercase_chars" : 1,
"numeric_chars" : 1,
"adj_identical_chars" : 1,
"password_reuse" : 1,
"max_length" : 1
},
"role_list" : [
{
"privilege_id" : [
"string",
"string"
],
"name" : "string",
"description" : "string",
"id" : 1
},
{
"privilege_id" : [
"string",
"string"
],
"name" : "string",
"description" : "string",
"id" : 1
}
],
"privileges_list" : [
{
"is_on_parent" : true,
"description" : "string",
"id" : "string",
"group" : "string"
},
{
"is_on_parent" : true,
"description" : "string",
"id" : "string",
"group" : "string"
}
]
},
"appliance" : {
"software_update_policy" : {
"password" : "secret string",
"auto_stage" : "DISABLED",
"certificate_check" : true,
"default_URL" : "string",
"check_schedule" : {
"hour" : "string",
"day" : "MONDAY",
"minute" : "string"
},
"custom_URL" : "string",
"username" : "string"
},
"time_sync" : {
"mode" : "DISABLED"
},
"smtp" : {
"relay_port" : "string",
"mail_server" : "string"
},
"ssh" : {
"enabled" : true
},
"local_accounts_policy" : {
"warn_days" : 1,
"max_days" : 1,
"min_days" : 1
},
"console_cli" : {
"enabled" : true
},
"ntp" : {
"servers" : [
"string",
"string"
]
},
"syslog" : [
{
"hostname" : "string",
"protocol" : "TLS",
"port" : 1
},
{
"hostname" : "string",
"protocol" : "TLS",
"port" : 1
}
],
"time_zone" : {
"name" : "string"
},
"network" : {
"dns_server_configuration" : {
"mode" : "DHCP",
"servers" : [
"string",
"string"
]
},
"firewall_rule_policies" : [
{
"address" : "string",
"prefix" : 1,
"interface_name" : "string",
"policy" : "IGNORE"
},
{
"address" : "string",
"prefix" : 1,
"interface_name" : "string",
"policy" : "IGNORE"
}
],
"proxy_configuration" : [
{
"server" : "string",
"protocol" : "HTTP",
"password" : "secret string",
"port" : 1,
"enabled" : true,
"username" : "string"
},
{
"server" : "string",
"protocol" : "HTTP",
"password" : "secret string",
"port" : 1,
"enabled" : true,
"username" : "string"
}
]
},
"backup_schedules" : [
{
"recurrence_info" : {
"hour" : 1,
"days" : [
"MONDAY",
"MONDAY"
],
"minute" : 1
},
"backup_password" : "secret string",
"enable" : true,
"parts" : [
"string",
"string"
],
"location" : "http://myurl.com",
"location_password" : "secret string",
"schedule_id" : "string",
"location_user" : "string",
"retention_info" : {
"max_count" : 1
}
},
{
"recurrence_info" : {
"hour" : 1,
"days" : [
"MONDAY",
"MONDAY"
],
"minute" : 1
},
"backup_password" : "secret string",
"enable" : true,
"parts" : [
"string",
"string"
],
"location" : "http://myurl.com",
"location_password" : "secret string",
"schedule_id" : "string",
"location_user" : "string",
"retention_info" : {
"max_count" : 1
}
}
],
"shell" : {
"enabled" : true,
"timeout" : 1
},
"root_local_account" : {
"warn_days_before_password_expiration" : 1,
"password" : "secret string",
"min_days_between_password_change" : 1,
"roles" : [
"string",
"string"
],
"password_expires_at" : "2015-01-01T22:13:05.651Z",
"fullname" : "string",
"last_password_change" : "2015-01-01T22:13:05.651Z",
"enabled" : true,
"email" : "string",
"has_password" : true,
"max_days_between_password_change" : 1
},
"dcui" : {
"enabled" : true
}
}
},
"version" : "obj-103"
}
Headers:
NoneType:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| - | info | Information about the specified profile. |
| -.profile | string | The identifier of the profile. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.appliance.vcenter.settings.v1.config.profile. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.appliance.vcenter.settings.v1.config.profile. |
| -.version | string | Version of the profile. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.appliance.vcenter.settings.v1.config.version. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.appliance.vcenter.settings.v1.config.version. |
| -.name | string | Name of the profile. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. |
| -.creation_time | date_time | Creation time of the profile. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. |
| -.owner | string | Owner of the profile, the one who created. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. |
| -.description | string | Custom description provided by the user. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Optional. If unset description will be empty. |
| -.desired_state | desired_state | The desired state. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. |
| -.desired_state.appliance | appliance_management | Appliance Management component desired spec. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Optional. |
| -.desired_state.appliance.software_update_policy | software_update_policy | Policy to update vCenter. Optional. Only set if the SoftwareUpdatePolicy is set inside vCenter. |
| -.desired_state.appliance.software_update_policy.custom_URL | string | Current appliance update repository URL. Enter "default" to reset the url to the default url. Optional. Only set if custom URL required. |
| -.desired_state.appliance.software_update_policy.default_URL | string | Default appliance update repository URL. Optional. Only set if default URL required. |
| -.desired_state.appliance.software_update_policy.auto_stage | string | Check for update at the pre-configured repository URL. Defines state for automatic update notification. auto_update_notification enumerated type Value is one of:DISABLED: Automatic update notification is disabled. Disable periodically query the configured url for updates. ENABLED: Automatic update notification is enabled. Enable periodically query the configured url for updates.Only set if auto stage is enable. |
| -.desired_state.appliance.software_update_policy.check_schedule | time | The time structure defines day and time the automatic check for new updates will be run. Optional. Only set if Time required. |
| -.desired_state.appliance.software_update_policy.check_schedule.hour | string | Time to query for updates Format: HH:MM:SS Military (24 hour) Time Format Optional. Only set if hour is present in SoftwareUpdatePolicy. |
| -.desired_state.appliance.software_update_policy.check_schedule.minute | string | Time to query for updates Format: HH:MM:SS Military (24 hour) Time Format Optional. Only set if minute is present in SoftwareUpdatePolicy. |
| -.desired_state.appliance.software_update_policy.check_schedule.day | string | Day to query for updates Optional. Only set if minute is present in SoftwareUpdatePolicy. |
| -.desired_state.appliance.software_update_policy.username | string | Username for the url update repository Optional. Only set if SoftwareUpdatePolicy requires username. |
| -.desired_state.appliance.software_update_policy.password | secret | Password for the url update repository Optional. Only set if SoftwareUpdatePolicy requires password. |
| -.desired_state.appliance.software_update_policy.certificate_check | boolean | Indicates whether certificates will be checked during patching. Warning: If this field is set to false, an insecure connection is made to the update repository which can potentially put the appliance security at risk. |
| -.desired_state.appliance.backup_schedules | backup_schedule[] | Backup schedule of vCenter. Optional. Only set if the Backup is schedule for vCenter. |
| -.desired_state.appliance.ssh | ssh | Get/Set enabled state of SSH-based controlled CLI. ssh service provides operations |
| -.desired_state.appliance.ssh.enabled | boolean | Set enabled state of the SSH-based controlled CLI. |
| -.desired_state.appliance.dcui | dcui | Get/Set enabled of Direct Console User Interface (DCUI TTY2). dcui service provides operations |
| -.desired_state.appliance.dcui.enabled | boolean | Set enabled state of Direct Console User Interface (DCUI). |
| -.desired_state.appliance.console_cli | consolecli | Get/Set enabled state of the console-based controlled CLI. consolecli service provides operations |
| -.desired_state.appliance.console_cli.enabled | boolean | Set enabled state of the console-based controlled CLI (TTY1). |
| -.desired_state.appliance.shell | shell | Get/Set enabled state of BASH. shell service provides operations |
| -.desired_state.appliance.shell.enabled | boolean | Enabled can be set to true or false |
| -.desired_state.appliance.shell.timeout | long | The timeout (in seconds) specifies how long you enable the Shell access. The maximum timeout is 86400 seconds(1 day). |
| -.desired_state.appliance.time_zone | timezone | The timezone service provides operations to get and set the appliance timezone. Optional. Only set if the Timezone is set in vCenter. |
| -.desired_state.appliance.time_zone.name | string | Set time zone. Optional. |
| -.desired_state.appliance.time_sync | timesync | timesync service provides operations Performs time synchronization configuration. Optional. Only set if the time sync mode is set in vCenter. |
| -.desired_state.appliance.time_sync.mode | string | Defines time synchronization modes Value is one of: DISABLED: Time synchronization is disabled. NTP: NTP-based time synchronization. HOST: VMware Tool-based time synchronization. |
| -.desired_state.appliance.ntp | ntp | ntp service provides operations Gets NTP configuration status and tests connection to ntp servers. Optional. Only set if the ntp server are set in vCenter. |
| -.desired_state.appliance.ntp.servers | string[] | Set NTP servers. This variable updates old NTP servers from configuration and sets the input NTP servers in the configuration. |
| -.desired_state.appliance.syslog | log_forwarding[] | The syslog service provides operations to manage forwarding of log messages to remote logging servers. Optional. Only set if log forwarding to remote server are set in vCenter. |
| -.desired_state.appliance.local_accounts_policy | local_accounts_policy | The localAccountsPolicy service provides operations to manage local user accounts. Optional. Only set if Password Policy is set to manage local user accounts. |
| -.desired_state.appliance.local_accounts_policy.max_days | long | Maximum number of days a password may be used. If the password is older than this, a password change will be forced. Optional. If unset then the restriction will be ignored. |
| -.desired_state.appliance.local_accounts_policy.min_days | long | Minimum number of days allowed between password changes. Any password changes attempted sooner than this will be rejected. Optional. If unset then the restriction will be ignored. |
| -.desired_state.appliance.local_accounts_policy.warn_days | long | Number of days warning given before a password expires. A zero means warning is given only upon the day of expiration. Optional. If unset then no warning will be provided. |
| -.desired_state.appliance.root_local_account | local_accounts | The local_accounts service provides operations to manage local user account. Optional. |
| -.desired_state.appliance.root_local_account.fullname | string | Full name of the user Optional. If unset, the value was never set. |
| -.desired_state.appliance.root_local_account.roles | string[] | User roles Optional. |
| -.desired_state.appliance.root_local_account.enabled | boolean | Flag indicating if the account is enabled |
| -.desired_state.appliance.root_local_account.has_password | boolean | Is the user password set. |
| -.desired_state.appliance.root_local_account.last_password_change | date_time | Date and time password was changed. Optional. If unset, the password was never set. |
| -.desired_state.appliance.root_local_account.password_expires_at | date_time | Date when the account's password will expire Optional. If unset, the password never expires. |
| -.desired_state.appliance.root_local_account.min_days_between_password_change | long | Minimum number of days between password change Optional. If unset, pasword can be changed any time. |
| -.desired_state.appliance.root_local_account.max_days_between_password_change | long | Maximum number of days between password change Optional. If unset, password never expires. |
| -.desired_state.appliance.root_local_account.warn_days_before_password_expiration | long | Number of days of warning before password expires Optional. If unset, a user is never warned. |
| -.desired_state.appliance.root_local_account.password | secret | Password Optional. If unset, value will not be changed. |
| -.desired_state.appliance.root_local_account.email | string | Email address of the local account Optional. If unset, value will not be changed. |
| -.desired_state.appliance.smtp | smtp | The local_accounts service provides operations to manage local user account. Optional. |
| -.desired_state.appliance.smtp.mail_server | string | Mail server IP address. Optional. If unset then the value will be ignored. |
| -.desired_state.appliance.smtp.relay_port | string | Relay port number. Optional. If unset then the value will be ignored. |
| -.desired_state.appliance.network | appliance_network | Network configurations to be applied. Optional. Only set if the network configurations are set in vCenter. |
| -.desired_state.appliance.network.firewall_rule_policies | firewall_rule_policy[] | List of Firewall Rules to be applied. Optional. Only set if the FirewallRulePolicy is set in vCenter. |
| -.desired_state.appliance.network.dns_server_configuration | dns_server_configuration | DNS configuration to be applied. Optional. Only set if the DnsServerConfiguration is set in vCenter. |
| -.desired_state.appliance.network.dns_server_configuration.mode | string | Define how to determine the DNS servers. Leave the servers argument empty if the mode argument is "DHCP". Set the servers argument to a comma-separated list of DNS servers if the mode argument is "static". The DNS server are assigned from the specified list. Describes DNS Server source (DHCP,static). Value is one of: DHCP: DNS address is automatically assigned by a DHCP server. STATIC: DNS address is static. |
| -.desired_state.appliance.network.dns_server_configuration.servers | string[] | List of the currently used DNS servers. DNS server configuration. |
| -.desired_state.appliance.network.proxy_configuration | proxy_configuration[] | Proxy configuration to be applied. Optional. Only set if the Proxy server configuration is set in vCenter. |
| -.desired_state.authmgmt | authentication_management | Authentication Management component desired spec. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments. Optional. |
| -.desired_state.authmgmt.privileges_list | privileges[] | List of Privileges. |
| -.desired_state.authmgmt.global_permission_list | global_permission[] | List of Global Permission. |
| -.desired_state.authmgmt.role_list | roles[] | List of Roles. |
| -.desired_state.authmgmt.password_policy | password_policy | Password Policy. Optional. |
| -.desired_state.authmgmt.password_policy.special_chars | long | Minimum special characters. |
| -.desired_state.authmgmt.password_policy.alpha_chars | long | Minimum alphabetic characters. |
| -.desired_state.authmgmt.password_policy.uppercase_chars | long | Minimum uppercase characters. |
| -.desired_state.authmgmt.password_policy.lowercase_chars | long | Minimum lowercase characters. |
| -.desired_state.authmgmt.password_policy.numeric_chars | long | Minimum numeric characters. |
| -.desired_state.authmgmt.password_policy.adj_identical_chars | long | Maximum adjacent identical characters. |
| -.desired_state.authmgmt.password_policy.password_reuse | long | Previous password reuse restriction. |
| -.desired_state.authmgmt.password_policy.max_life | long | Maximum lifetime. |
| -.desired_state.authmgmt.password_policy.max_length | long | Maximum length. |
| -.desired_state.authmgmt.password_policy.min_length | long | Minimum length. |
| -.desired_state.authmgmt.token_policy | token_policy | Token Policy. Optional. |
| -.desired_state.authmgmt.token_policy.clock_tolerance | long | Clock tolerance ms. |
| -.desired_state.authmgmt.token_policy.token_renewal | long | Maximum token renewal count. |
| -.desired_state.authmgmt.token_policy.token_delegation | long | Maximum token delegation count. |
| -.desired_state.authmgmt.token_policy.bearer_refresh | long | Maximum Bearer RefreshToken lifetime. |
| -.desired_state.authmgmt.token_policy.hok_refresh | long | Maximum HoK RefreshToken lifetime. |
| -.desired_state.authmgmt.lockout_policy | lockout_policy | Lockout Policy. Optional. |
| -.desired_state.authmgmt.lockout_policy.failed_login_attempts | long | Maximum number of failed login attempts. |
| -.desired_state.authmgmt.lockout_policy.failure_interval | long | Time interval between failures. |
| -.desired_state.authmgmt.lockout_policy.unlock_time | long | Unlock time. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 500 | error | if the system reports an error while responding to the request. |
| 400 | invalid_argument | If given version is different than the latest one. |
| 404 | not_found | If there is no profile or version associated with profile or version in the system. |
| 503 | service_unavailable | if the system is unable to communicate with a service to complete the request. |
| 401 | unauthenticated | if the user can not be authenticated. |