host_secret

Host account secret

metadata objectrequired

rotating password object

host_idstring<uuid>required

once host object saved, added by backend

access_group_idstring<uuid>

Specify ID of access group, default access group will be used if ID is not specified. Access group will be checked for WinRM trust anchors if certificate validation option is set to enabled.

addressstringrequired

address of server

portintegerrequired

operating_systemstringrequired

Possible values: [windows, linux]

certificate_validation_optionsstringrequired

Disable or enable password rotation certificate validation

Possible values: [DISABLED, ENABLED]

winrm_host_certificate_trust_anchorsstring

WinRM host certificate trust anchors in PEM format

use_main_accountbooleanrequired

rotate passwords of all accounts in host through one account

main_accountstringrequired

rotate passwords of all accounts in host through this account

winrm_main_account_passwordstring

if protocol winrm and main account set, this password is stored to vault-v2

password_policy_idstring<uuid>required

password policy to be applied

script_template_idstring<uuid>required

script template to be run in host

createdstring<date-time>

When the object was created. Added by backend

Example: 2017-01-01T15:05:05Z

updatedstring<date-time>

When the object was updated. Added by backend

Example: 2017-01-01T15:05:05Z

created_bystring

added by backend

updated_bystring

added by backend

accounts object[]

Array [

accountstringrequired

username

last_rotatedstring<date-time>

When last successful rotation. Added by backend

Example: 2017-01-01T15:05:05Z

last_errorstring<date-time>

When last rotation error. Added by backend

Example: 2017-01-01T15:05:05Z

last_error_detailsstring

Last rotation error details. Added by backend

initial_passwordstring

initial password to store in vault to start rotation

]

host_secret

{
  "metadata": {
    "host_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "access_group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "address": "string",
    "port": 0,
    "operating_system": "windows",
    "certificate_validation_options": "DISABLED",
    "winrm_host_certificate_trust_anchors": "string",
    "use_main_account": true,
    "main_account": "string",
    "winrm_main_account_password": "string",
    "password_policy_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "script_template_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "created": "2017-01-01T15:05:05Z",
    "updated": "2017-01-01T15:05:05Z",
    "created_by": "string",
    "updated_by": "string"
  },
  "accounts": [
    {
      "account": "string",
      "last_rotated": "2017-01-01T15:05:05Z",
      "last_error": "2017-01-01T15:05:05Z",
      "last_error_details": "string",
      "initial_password": "string"
    }
  ]
}