Skip to main content
Version: v41

rotation_metadata

password rotation settings for host

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.

use_main_accountbooleanrequired

rotate passwords of all accounts in host through one account

operating_systemstringrequired

Bash for Linux, Powershell for windows for shell access

Possible values: [LINUX, WINDOWS]

winrm_addressstring

IPv4 address or FQDN to use for winrm connections

winrm_portinteger

port to use for password rotation with winrm, zero for winrm default

protocolstringrequired

Possible values: [SSH, WINRM]

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

password_policy_idstring<uuid>required

password policy to be applied

script_template_idstring<uuid>required

script template to be run in host

rotation_status object[]

Filled by backend. Rotation status per account to be shown in UI

  • Array [
  • principalstring
    last_rotatedstring<date-time>

    When last successful rotation. Added by backend

    Example: 2017-01-01T15:05:05Z
    last_errorstring<date-time>

    Last rotation error. Cleared when rotation successful, updated by backend

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

    information of rotation error, updated by backend

  • ]
  • 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

    rotation_metadata
    {
    "access_group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "use_main_account": true,
    "operating_system": "LINUX",
    "winrm_address": "string",
    "winrm_port": 0,
    "protocol": "SSH",
    "certificate_validation_options": "DISABLED",
    "winrm_host_certificate_trust_anchors": "string",
    "password_policy_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "script_template_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "rotation_status": [
    {
    "principal": "string",
    "last_rotated": "2017-01-01T15:05:05Z",
    "last_error": "2017-01-01T15:05:05Z",
    "last_error_details": "string"
    }
    ],
    "created": "2017-01-01T15:05:05Z",
    "updated": "2017-01-01T15:05:05Z",
    "created_by": "string",
    "updated_by": "string"
    }