APIRef_tm_cm_trust-domainΒΆ
mgmt/tm/cm/trust-domain
Trust domain configuration
REST Endpoints
- Collection URI
/mgmt/tm/cm/trust-domain- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/cm/trust-domain/~resource id- Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST- Resource Natural Key
name, partition, subPath
Properties
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
appService |
string | optional | read/write | The application service that the object belongs to. | |
caCert |
string | optional | read/write | The certificate authority device trust certificate. | |
caCertBundle |
string | optional | read/write | Bundle of CA certificates used to authenticate incoming connections. | |
caDevices |
string | optional | read/write | Modify operations deprecated since v13.0.0. Set of certificate authority devices in the trust domain. | |
caKey |
string | optional | read/write | The certificate authority device trust key. Only present for certificate authorities. | |
devices |
string | optional | read/write | Specify the name of one or more devices to remove from the trust. | |
guid |
string | optional | read/write | ||
md5Fingerprint |
string | optional | read/write | Deprecated since v13.0.0. The SSL certificate md5 fingerprint. | |
tmName |
string | optional | read/write | Deprecated since v13.0.0. Option used to specify the name of a new device. | |
nonCaDevices |
string | optional | read/write | Modify operations deprecated since v13.0.0. Set of subordinate devices in the trust domain. | |
tmPartition |
string | Common | optional | read/write | Device administrative partition |
password |
string | optional | read/write | Deprecated since v13.0.0. Option used to specify the password when adding a new device. | |
removeDevice |
string | optional | read/write | Specify the name of the device to remove from the trust. | |
serial |
string | optional | read/write | Deprecated since v13.0.0. The SSL certificate serial number. | |
sha1Fingerprint |
string | optional | read/write | The SSL certificate sha1 fingerprint. | |
signature |
string | optional | read/write | Deprecated since v13.0.0. The SSL certificate signature. | |
status |
string | not-set | optional | read/write | Trust domainitialization status. |
trustGroup |
string | optional | read/write | The device-group associated with the trust-domain. | |
username |
string | optional | read/write | Deprecated since v13.0.0. Option used to specify the username when adding a new device. |
Structures
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
/add-device |
array_structure | optional | read/write | ||
/add-device/ca-device |
string | optional | read/write | Specify whether the device has certificate authority. | |
/add-device/device-ip |
string | optional | read/write | Specify the FQDN or management-ip of the new device. | |
/add-device/device-name |
string | optional | read/write | Specify the name of the new device. | |
/add-device/device-port |
string | optional | read/write | Option to specify the port of the new device if other than default HTTPS 443. | |
/add-device/password |
string | optional | read/write | Specify the password to validate credentials when adding the new device. | |
/add-device/sha1-fingerprint |
string | optional | read/write | Option to specify the ssl certificate sha1 fingerprint to validate remote device identity. | |
/add-device/username |
string | optional | read/write | Specify the username to validate credentials when adding the new device. | |
/add-device/ca-device |
string | optional | read/write | Specify whether the device has certificate authority. | |
/add-device/device-ip |
string | optional | read/write | Specify the FQDN or management-ip of the new device. | |
/add-device/device-name |
string | optional | read/write | Specify the name of the new device. | |
/add-device/device-port |
string | optional | read/write | Option to specify the port of the new device if other than default HTTPS 443. | |
/add-device/password |
string | optional | read/write | Specify the password to validate credentials when adding the new device. | |
/add-device/sha1-fingerprint |
string | optional | read/write | Option to specify the ssl certificate sha1 fingerprint to validate remote device identity. | |
/add-device/username |
string | optional | read/write | Specify the username to validate credentials when adding the new device. |
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.