REST API - check-task

vcenter hlm community: check-task

Performs network checks between nodes in the community. This can be called before the add to validate network requirements prior to performing the action or after adding to check network connectivity within a peers of a community. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

POST https://{server}/rest/vcenter/hlm/community?vmw-task=true&action=check

Request Body Structure:

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

Request Body Parameters:

Name	Type	Description
bold = required
spec	add_check_spec	Optional. Specification for defining how to perform a network check.
spec.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.
spec.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.
spec.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.
spec.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.
spec.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.
spec.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.
spec.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.
spec.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.

Response:

HTTP Status Code: 200

Representation:

{
"value" : "obj-103"
}

Response Type:

Name	Type	Description
bold = required
value	string	list of vcenter.hlm.community.check_info objects. Contains results aggregated per pair of nodes.

Errors:

HTTP Status Code	Type	Description
401	unauthenticated	If unable to authenticate to target node.
403	unauthorized	If the caller is not authorized.
400	unverified_peer	If the SSL certificate of the target node cannot be validated by comparing with the thumbprint provided in vcenter.hlm.community.add_spec.ssl_thumbprint or if vcenter.hlm.community.add_spec.ssl_thumbprint is unset and vcenter.hlm.community.add_spec.ssl_verify is true. The value of the {@link UnverifiedPeer#data) field will be a structure that contains all the fields defined in vcenter.hlm.community.certificate_info.
500	error	If the system reports an error while responding to the request.