POST /hardwaresecuritymodulegroup

POST /hardwaresecuritymodulegroup

/hardwaresecuritymodulegroup

Request
URI
POST
https://{api_host}/api/hardwaresecuritymodulegroup
COPY
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.

Request Body

HardwareSecurityModuleGroup object creation

HardwareSecurityModuleGroup of type(s) application/json
Optional

Show optional properties

{
    "hsm": {
        "type": "string"
    },
    "name": "string"
}
{
    "_last_modified": "string",
    "configpb_attributes": {
        "version": 0
    },
    "hsm": {
        "cloudhsm": {
            "client_config": "string",
            "cluster_cert": "string",
            "crypto_user_name": "string",
            "crypto_user_password": "string",
            "hsm_ip": [
                "string"
            ],
            "mgmt_config": "string"
        },
        "nethsm": [
            {
                "esn": "string",
                "keyhash": "string",
                "module_id": 0,
                "priority": 0,
                "remote_ip": {
                    "addr": "string",
                    "type": "string"
                },
                "remote_port": 0
            }
        ],
        "rfs": {
            "ip": {
                "addr": "string",
                "type": "string"
            },
            "port": 0
        },
        "sluna": {
            "ha_group_num": 0,
            "is_ha": false,
            "node_info": [
                {
                    "chrystoki_conf": "string",
                    "client_cert": "string",
                    "client_ip": "string",
                    "client_priv_key": "string",
                    "session_major_number": 0,
                    "session_minor_number": 0
                }
            ],
            "server": [
                {
                    "index": 0,
                    "partition_passwd": "string",
                    "partition_serial_number": "string",
                    "remote_ip": "string",
                    "server_cert": "string"
                }
            ],
            "server_pem": "string",
            "use_dedicated_network": false
        },
        "type": "string"
    },
    "markers": [
        {
            "key": "string",
            "values": [
                "string"
            ]
        }
    ],
    "name": "string",
    "tenant_ref": "string",
    "url": "string",
    "uuid": "string"
}
Responses
200

OK

Returns HardwareSecurityModuleGroup of type(s) application/json 
"HardwareSecurityModuleGroup Object"
string
_last_modified
Optional

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

object
configpb_attributes
Optional

configpb_attributes

object
hsm
Required

hsm

array of object
markers
Optional

List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Enterprise edition with any value, Essentials edition with any value, Basic edition with any value, Enterprise with Cloud Services edition.

string
name
Required

Name of the HSM Group configuration object. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

It is a reference to an object of type Tenant. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

UUID of the HSM Group configuration object. Allowed in Enterprise edition with any value, Essentials, Basic, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"hsm:"object","name:"string"}' https://{api_host}/api/hardwaresecuritymodulegroup
On This Page
Hardware Security Module Group Operations
GET
GET /hardwaresecuritymodulegroup
POST
POST /hardwaresecuritymodulegroup
GET
GET /hardwaresecuritymodulegroup/{uuid}
PUT
PUT /hardwaresecuritymodulegroup/{uuid}
PATCH
PATCH /hardwaresecuritymodulegroup/{uuid}
DELETE
DELETE /hardwaresecuritymodulegroup/{uuid}