Avi HardwareSecurityModuleGroup Object API
CLI ``` - configure hardwaresecuritymodulegroup - show hardwaresecuritymodulegroup ```
Contact Info: support@avinetworks.com
Version: 20.1.9
BasePath:/api
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
- HTTP Basic Authentication
[ Jump to Models ]
Table of Contents
get /hardwaresecuritymodulegrouppost /hardwaresecuritymodulegroupdelete /hardwaresecuritymodulegroup/{uuid}get /hardwaresecuritymodulegroup/{uuid}patch /hardwaresecuritymodulegroup/{uuid}put /hardwaresecuritymodulegroup/{uuid}
Up
get /hardwaresecuritymodulegroup
(hardwaresecuritymodulegroupGet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
refers_to (optional)
Query Parameter — Filter to request all objects that refers to another Avi resource. Its syntax is refers_to=<obj_type>:<obj_uuid>. Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid
referred_by (optional)
Query Parameter — Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by=<obj_type>:<obj_uuid>. Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — 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.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"count" : 123,
"results" : [ {
"hsm" : {
"cloudhsm" : {
"crypto_user_password" : "aeiou",
"client_config" : "aeiou",
"cluster_cert" : "aeiou",
"mgmt_config" : "aeiou",
"crypto_user_name" : "aeiou",
"hsm_ip" : [ "aeiou" ]
},
"sluna" : {
"server" : [ {
"server_cert" : "aeiou",
"partition_serial_number" : "aeiou",
"remote_ip" : "aeiou",
"index" : 123,
"partition_passwd" : "aeiou"
} ],
"is_ha" : true,
"server_pem" : "aeiou",
"ha_group_num" : 123456789,
"node_info" : [ {
"client_priv_key" : "aeiou",
"chrystoki_conf" : "aeiou",
"client_cert" : "aeiou",
"client_ip" : "aeiou",
"session_minor_number" : 123,
"session_major_number" : 123
} ],
"use_dedicated_network" : true
},
"type" : "aeiou",
"rfs" : {
"port" : 123,
"ip" : ""
},
"nethsm" : [ {
"esn" : "aeiou",
"keyhash" : "aeiou",
"module_id" : 123,
"remote_ip" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"remote_port" : 123,
"priority" : 123
} ]
},
"tenant_ref" : "aeiou",
"name" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ]
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
HardwareSecurityModuleGroupApiResponse
401
log in failed
Up
post /hardwaresecuritymodulegroup
(hardwaresecuritymodulegroupPost)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — HardwareSecurityModuleGroup object creation
Return type
Example data
Content-Type: application/json
{
"hsm" : {
"cloudhsm" : {
"crypto_user_password" : "aeiou",
"client_config" : "aeiou",
"cluster_cert" : "aeiou",
"mgmt_config" : "aeiou",
"crypto_user_name" : "aeiou",
"hsm_ip" : [ "aeiou" ]
},
"sluna" : {
"server" : [ {
"server_cert" : "aeiou",
"partition_serial_number" : "aeiou",
"remote_ip" : "aeiou",
"index" : 123,
"partition_passwd" : "aeiou"
} ],
"is_ha" : true,
"server_pem" : "aeiou",
"ha_group_num" : 123456789,
"node_info" : [ {
"client_priv_key" : "aeiou",
"chrystoki_conf" : "aeiou",
"client_cert" : "aeiou",
"client_ip" : "aeiou",
"session_minor_number" : 123,
"session_major_number" : 123
} ],
"use_dedicated_network" : true
},
"type" : "aeiou",
"rfs" : {
"port" : 123,
"ip" : ""
},
"nethsm" : [ {
"esn" : "aeiou",
"keyhash" : "aeiou",
"module_id" : 123,
"remote_ip" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"remote_port" : 123,
"priority" : 123
} ]
},
"tenant_ref" : "aeiou",
"name" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
HardwareSecurityModuleGroup
401
log in failed
Up
delete /hardwaresecuritymodulegroup/{uuid}
(hardwaresecuritymodulegroupUuidDelete)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
Return type
String
Example data
Content-Type: application/json
"aeiou"
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
204
object deleted
String
404
not found
Up
get /hardwaresecuritymodulegroup/{uuid}
(hardwaresecuritymodulegroupUuidGet)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
name (optional)
Query Parameter — object name
fields (optional)
Query Parameter — List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.
include_name (optional)
Query Parameter — 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.
skip_default (optional)
Query Parameter — Default values are not set.
join_subresources (optional)
Query Parameter — It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.
Return type
Example data
Content-Type: application/json
{
"hsm" : {
"cloudhsm" : {
"crypto_user_password" : "aeiou",
"client_config" : "aeiou",
"cluster_cert" : "aeiou",
"mgmt_config" : "aeiou",
"crypto_user_name" : "aeiou",
"hsm_ip" : [ "aeiou" ]
},
"sluna" : {
"server" : [ {
"server_cert" : "aeiou",
"partition_serial_number" : "aeiou",
"remote_ip" : "aeiou",
"index" : 123,
"partition_passwd" : "aeiou"
} ],
"is_ha" : true,
"server_pem" : "aeiou",
"ha_group_num" : 123456789,
"node_info" : [ {
"client_priv_key" : "aeiou",
"chrystoki_conf" : "aeiou",
"client_cert" : "aeiou",
"client_ip" : "aeiou",
"session_minor_number" : 123,
"session_major_number" : 123
} ],
"use_dedicated_network" : true
},
"type" : "aeiou",
"rfs" : {
"port" : 123,
"ip" : ""
},
"nethsm" : [ {
"esn" : "aeiou",
"keyhash" : "aeiou",
"module_id" : 123,
"remote_ip" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"remote_port" : 123,
"priority" : 123
} ]
},
"tenant_ref" : "aeiou",
"name" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
HardwareSecurityModuleGroup
401
log in failed
Up
patch /hardwaresecuritymodulegroup/{uuid}
(hardwaresecuritymodulegroupUuidPatch)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — HardwareSecurityModuleGroup object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"hsm" : {
"cloudhsm" : {
"crypto_user_password" : "aeiou",
"client_config" : "aeiou",
"cluster_cert" : "aeiou",
"mgmt_config" : "aeiou",
"crypto_user_name" : "aeiou",
"hsm_ip" : [ "aeiou" ]
},
"sluna" : {
"server" : [ {
"server_cert" : "aeiou",
"partition_serial_number" : "aeiou",
"remote_ip" : "aeiou",
"index" : 123,
"partition_passwd" : "aeiou"
} ],
"is_ha" : true,
"server_pem" : "aeiou",
"ha_group_num" : 123456789,
"node_info" : [ {
"client_priv_key" : "aeiou",
"chrystoki_conf" : "aeiou",
"client_cert" : "aeiou",
"client_ip" : "aeiou",
"session_minor_number" : 123,
"session_major_number" : 123
} ],
"use_dedicated_network" : true
},
"type" : "aeiou",
"rfs" : {
"port" : 123,
"ip" : ""
},
"nethsm" : [ {
"esn" : "aeiou",
"keyhash" : "aeiou",
"module_id" : 123,
"remote_ip" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"remote_port" : 123,
"priority" : 123
} ]
},
"tenant_ref" : "aeiou",
"name" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
HardwareSecurityModuleGroup
401
log in failed
Up
put /hardwaresecuritymodulegroup/{uuid}
(hardwaresecuritymodulegroupUuidPut)
Path parameters
uuid (required)
Path Parameter — UUID of the object to fetch
Consumes
This API call consumes the following media types via the
Content-Type request header:
Request body
body (required)
Body Parameter — HardwareSecurityModuleGroup object creation
Query parameters
name (optional)
Query Parameter — object name
Return type
Example data
Content-Type: application/json
{
"hsm" : {
"cloudhsm" : {
"crypto_user_password" : "aeiou",
"client_config" : "aeiou",
"cluster_cert" : "aeiou",
"mgmt_config" : "aeiou",
"crypto_user_name" : "aeiou",
"hsm_ip" : [ "aeiou" ]
},
"sluna" : {
"server" : [ {
"server_cert" : "aeiou",
"partition_serial_number" : "aeiou",
"remote_ip" : "aeiou",
"index" : 123,
"partition_passwd" : "aeiou"
} ],
"is_ha" : true,
"server_pem" : "aeiou",
"ha_group_num" : 123456789,
"node_info" : [ {
"client_priv_key" : "aeiou",
"chrystoki_conf" : "aeiou",
"client_cert" : "aeiou",
"client_ip" : "aeiou",
"session_minor_number" : 123,
"session_major_number" : 123
} ],
"use_dedicated_network" : true
},
"type" : "aeiou",
"rfs" : {
"port" : 123,
"ip" : ""
},
"nethsm" : [ {
"esn" : "aeiou",
"keyhash" : "aeiou",
"module_id" : 123,
"remote_ip" : {
"addr" : "aeiou",
"type" : "aeiou"
},
"remote_port" : 123,
"priority" : 123
} ]
},
"tenant_ref" : "aeiou",
"name" : "aeiou",
"markers" : [ {
"values" : [ "aeiou" ],
"key" : "aeiou"
} ],
"uuid" : "aeiou",
"url" : "aeiou",
"_last_modified" : "aeiou",
"labels" : [ {
"value" : "aeiou",
"key" : "aeiou"
} ]
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
OK
HardwareSecurityModuleGroup
401
log in failed
[ Jump to Methods ]
Table of Contents
HSMAwsCloudHsmHSMSafenetClientInfoHSMSafenetLunaHSMSafenetLunaServerHSMThalesNetHsmHSMThalesRFSHardwareSecurityModuleHardwareSecurityModuleGroupHardwareSecurityModuleGroupApiResponseIpAddrKeyValueRoleFilterMatchLabel
client_config (optional)
String Field introduced in 17.2.7.
cluster_cert (optional)
String AWS CloudHSM Cluster Certificate. Field introduced in 17.2.7.
crypto_user_name (optional)
String Username of the Crypto User. This will be used to access the keys on the HSM . Field introduced in 17.2.7.
crypto_user_password (optional)
String Password of the Crypto User. This will be used to access the keys on the HSM . Field introduced in 17.2.7.
hsm_ip (optional)
array[String] IP address of the HSM in the cluster. If there are more than one HSMs, only one is sufficient. Field introduced in 17.2.7.
mgmt_config (optional)
String Field introduced in 17.2.7.
chrystoki_conf (optional)
String Generated File - Chrystoki.conf .
client_cert (optional)
String Client Certificate generated by createCert.
client_ip
String Name prepended to client key and certificate filename.
client_priv_key (optional)
String Client Private Key generated by createCert.
session_major_number (optional)
Integer Major number of the sesseion. format: int32
session_minor_number (optional)
Integer Minor number of the sesseion. format: int32
ha_group_num (optional)
Long Group Number of generated HA Group. format: int64
is_ha
Boolean Set to indicate HA across more than one servers.
node_info (optional)
server (optional)
server_pem (optional)
String Generated File - server.pem.
use_dedicated_network (optional)
Boolean If enabled, dedicated network is used to communicate with HSM,else, the management network is used.
index
Integer Field introduced in 16.5.2,17.2.3. format: int32
partition_passwd (optional)
String Password of the partition assigned to this client.
partition_serial_number (optional)
String Serial number of the partition assigned to this client. Field introduced in 16.5.2,17.2.3.
remote_ip
String IP address of the Safenet/Gemalto HSM device.
server_cert
String CA certificate of the server.
esn
String Electronic serial number of the netHSM device. Use Thales anonkneti utility to find the netHSM ESN.
keyhash
String Hash of the key that netHSM device uses to authenticate itself. Use Thales anonkneti utility to find the netHSM keyhash.
module_id (optional)
Integer Local module id of the netHSM device. format: int32
priority
Integer Priority class of the nethsm in an high availability setup. 1 is the highest priority and 100 is the lowest priority. Allowed values are 1-100. format: int32
remote_ip
IpAddr IP address of the netHSM device.
remote_port (optional)
Integer Port at which the netHSM device accepts the connection. Allowed values are 1-65535. format: int32
ip
IpAddr IP address of the RFS server from where to sync the Thales encrypted private key.
port (optional)
Integer Port at which the RFS server accepts the sync request from clients for Thales encrypted private key. Allowed values are 1-65535. format: int32
cloudhsm (optional)
HSMAwsCloudHsm AWS CloudHSM specific configuration. Field introduced in 17.2.7.
nethsm (optional)
rfs (optional)
HSMThalesRFS Thales Remote File Server (RFS), used for the netHSMs, configuration.
sluna (optional)
type
String HSM type to use. Enum options - HSM_TYPE_THALES_NETHSM, HSM_TYPE_SAFENET_LUNA, HSM_TYPE_AWS_CLOUDHSM.
_last_modified (optional)
String UNIX time since epoch in microseconds. Units(MICROSECONDS).
hsm
labels (optional)
array[KeyValue] Key value pairs for granular object access control. Also allows for classification and tagging of similar objects. Field deprecated in 20.1.5. Field introduced in 20.1.2. Maximum of 4 items allowed.
markers (optional)
array[RoleFilterMatchLabel] List of labels to be used for granular RBAC. Field introduced in 20.1.5. Allowed in Basic edition, Essentials edition, Enterprise edition.
name
String Name of the HSM Group configuration object.
tenant_ref (optional)
String It is a reference to an object of type Tenant.
url (optional)
uuid (optional)
String UUID of the HSM Group configuration object.
count
results
next (optional)
addr
type
String Enum options - V4, DNS, V6.
key
String Key for filter match. Field introduced in 20.1.3.
values (optional)
array[String] Values for filter match. Multiple values will be evaluated as OR. Example key = value1 OR key = value2. Behavior for match is key = * if this field is empty. Field introduced in 20.1.3.