GET /gslbhsm/{uuid}

GET /gslbhsm/{uuid}

/gslbhsm/{uuid}

Request
URI
GET
https://{api_host}/api/gslbhsm/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

string
fields
Optional

List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

boolean
include_name
Optional

All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

boolean
skip_default
Optional

Default values are not set.

string
join_subresources
Optional

It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.


Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns GslbHSMRuntime of type(s) application/json
{
    "_last_modified": "string",
    "cluster_uuid": "string",
    "enabled": false,
    "events": [
        {
            "msg": [
                "string"
            ],
            "name": "string",
            "timestamp": {
                "secs": 0,
                "usecs": 0
            },
            "uuid": "string"
        }
    ],
    "local_info": {
        "gs_status": {
            "last_changed_time": {
                "secs": 0,
                "usecs": 0
            },
            "num_partial_updates": 0,
            "partial_update_threshold": 0,
            "state": "string",
            "type": "string"
        },
        "gslb_info": {
            "repl_state": {
                "cfg_version": 0,
                "cfg_version_in_flight": 0,
                "last_changed_time": {
                    "secs": 0,
                    "usecs": 0
                },
                "local_config": {
                    "vsgs_info": [
                        {
                            "dnsvs_uuid": "string",
                            "ops": "string",
                            "timestamp": {
                                "secs": 0,
                                "usecs": 0
                            }
                        }
                    ]
                },
                "reason": "string",
                "site_uuid": "string",
                "status": "string",
                "uuid": "string"
            }
        }
    },
    "name": "string",
    "obj_uuid": "string",
    "oper_status": {
        "last_changed_time": {
            "secs": 0,
            "usecs": 0
        },
        "reason": [
            "string"
        ],
        "reason_code": 0,
        "reason_code_string": "string",
        "state": "string"
    },
    "remote_info": {
        "gslb_info": {
            "repl_state": {
                "cfg_version": 0,
                "cfg_version_in_flight": 0,
                "last_changed_time": {
                    "secs": 0,
                    "usecs": 0
                },
                "local_config": {
                    "vsgs_info": [
                        {
                            "dnsvs_uuid": "string",
                            "ops": "string",
                            "timestamp": {
                                "secs": 0,
                                "usecs": 0
                            }
                        }
                    ]
                },
                "reason": "string",
                "site_uuid": "string",
                "status": "string",
                "uuid": "string"
            }
        },
        "ops_info": {
            "rrtoken": [
                "string"
            ]
        },
        "sync_info": {
            "errored_objects": [
                {
                    "ds_name": "string",
                    "name": "string",
                    "ops": "string",
                    "reason": "string",
                    "status": 0,
                    "uuid": "string"
                }
            ],
            "last_changed_time": {
                "secs": 0,
                "usecs": 0
            },
            "last_fail_obj": {
                "event_type": "string",
                "obj_name": "string",
                "obj_uuid": "string"
            },
            "prev_target_version": 0,
            "reason": "string",
            "recommendation": "string",
            "site_version": 0,
            "sync_state": "string",
            "target_version": 0
        },
        "sync_stats": {
            "acknowledged_version": 0,
            "pending_object_count": 0,
            "received_version": 0
        }
    },
    "send_interval": 0,
    "site_name": "string",
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

string
cluster_uuid
Optional

The site controller cluster UUID. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

boolean
enabled
Optional

Represents whether HSM is Enabled/disabled. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

array of object
events
Optional

Events Captured wrt to config replication. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

object
local_info
Optional

local_info

string
name
Optional

The name of DB entry. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
obj_uuid
Optional

GSLB HSM Runtime object uuid. Points to the GSLB to which this belongs. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

object
oper_status
Optional

oper_status

object
remote_info
Optional

remote_info

integer As uint32 As uint32
send_interval
Optional

Frequency with which group members communicate. This field shadows glb_cfg.send_interval. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
site_name
Optional

The Gslb site name. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

Uuid of the tenant. It is a reference to an object of type Tenant. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

The uuid of DB entry. Field introduced in 31.1.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/gslbhsm/{uuid}