REST API - add_check

vcenter hlm community: add check spec

The add_check_spec structure is the specification used for specifying how to perform network checks within a community before adding a new peer. Warning: This structure is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Representation:

JSON

{
    "check_all" : true,
    "add_spec" : {
        "hostname" : "string",
        "port" : "string",
        "ssl_thumbprint" : "string",
        "ssl_verify" : true,
        "token" : "string",
        "admin_groups" : [
            "string",
            "string"
        ]
    }
}

Attributes:

Name	Type	Description
Required
add_spec	add_spec	The specification used to add a node to the community. This will be used to verify pre-add that all network requirements have been met. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
add_spec.hostname	string	The hostname for the target node. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
add_spec.token	string	The base64 encoded authentication token usable in the target node's domain and issued by its Security Token Service service. The token should be prefixed with a type. Currently, only saml tokens are supported. For example: "sign=LKJSDLKDJ..." where prefix is "sign=" for a saml token. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
check_all	boolean	If true, network checks will be done between all nodes in the existing community with the node to be added. Otherwise, the checks will only be done between the local and target nodes. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Optional
add_spec.port	string	The HTTPS port of the target node. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset 443 will be used as default.
add_spec.ssl_thumbprint	string	The SHA-256 thumbprint of the SSL certificate of the target node. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. This field is only relevant if `ssl_verify` is set and has the value true.
add_spec.ssl_verify	boolean	SSL verification should be enabled or disabled. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. If unset, verification will be enabled.
add_spec.admin_groups	string[]	The list of groups to be added to which administrator access should be granted. Group names should be un UPN format. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Optional. if unset no groups will have administrator access.