This API has a deprecated equivalent from v7.0U1.
Get Policy
Get the global password policy.
Request
URLURL
https://{api_host}/api/appliance/local-accounts/global-policy
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
LocalAccountsPolicyInfo
of type application/json
Global password policy
{
"max_days": 0,
"min_days": 0,
"warn_days": 0
}
integer
max_days
Optional
Maximum number of days a password may be used. If the password is older than this, a password change will be forced. If unset then the restriction will be ignored.
integer
min_days
Optional
Minimum number of days allowed between password changes. Any password changes attempted sooner than this will be rejected. If unset then the restriction will be ignored.
integer
warn_days
Optional
Number of days warning given before a password expires. A zero means warning is given only upon the day of expiration. If unset then no warning will be provided.
Errors
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetLocalAccountsGlobalPolicy
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/appliance/local-accounts/global-policy
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/appliance/local-accounts/global-policy
x-vmw-doc-operation: get
Availability
Added in 7.0U2
On This Page
Policy Operations
get
put
