glm¶
Set GLM Connection values
glm Specification¶
Parameter Value Type Configuration Resource Element Name glm Element URI /axapi/v3/glm Element Attributes glm_attributes Partition Visibility shared Schema glm schemaOperations Allowed:
| Operation | Method | URI | Payload | |
|---|---|---|---|---|
Create Object | POST | /axapi/v3/glm | ||
Get Object | GET | /axapi/v3/glm | ||
Modify Object | POST | /axapi/v3/glm | ||
Replace Object | PUT | /axapi/v3/glm | ||
Delete Object | DELETE | /axapi/v3/glm | ||
glm attributes¶
allocate-bandwidth
Description Enter the requested bandwidth in Mbps for Capacity Pool
Type: number
Range: 2-204800
appliance-name
Description Helpful identifier for this appliance
Type: string
Maximum Length: 60 characters
Maximum Length: 1 characters
burst
Description Enable Burst License
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
check-expiration
Description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
create-license-request
Description: create-license-request is a JSON Block. Please see below for create-license-request
Type: Object
Reference Object: /axapi/v3/glm/create-license-request
enable-requests
Description Turn on periodic GLM license requests (default license retrieval interval is every 24 hours)
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
enterprise
Description Enter the ELM hostname, IP or [IPV6]
Type: string
Format: string-rlx
Maximum Length: 65 characters
Maximum Length: 4 characters
enterprise-ha-host-list
Type: List
Reference Object: /axapi/v3/glm/enterprise-ha-host/{host-entry}
enterprise-request-type
Description ‘fqdn’: TLS verified with FQDN; ‘self-signed’: TLS verified with self signed certificate(Default); ‘self-signed-pull-cert’: Request and use self signed certificate;
Type: string
Supported Values: fqdn, self-signed, self-signed-pull-cert
host
Description
Type: string
Maximum Length: 60 characters
Maximum Length: 4 characters
interval
Description GLM license request interval (in hours)
Type: number
Range: 1-8760
new-license
Description: new-license is a JSON Block. Please see below for new-license
Type: Object
Reference Object: /axapi/v3/glm/new-license
port
Description License request port (default 443)
Type: number
Range: 1-65535
proxy-server
Description: proxy-server is a JSON Block. Please see below for proxy-server
Type: Object
Reference Object: /axapi/v3/glm/proxy-server
send
Description: send is a JSON Block. Please see below for send
Type: Object
Reference Object: /axapi/v3/glm/send
thunder-capacity-license
Description
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
token
Description License entitlement token
Type: string
Maximum Length: 60 characters
Maximum Length: 8 characters
use-mgmt-port
Description Use management port to connect to GLM
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
create-license-request¶
Specification Value Type object create-license-request
Description Create a GLM trial or license request
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
new-license¶
Specification Value Type object account-name
Description Account Name
Type: string
Format: string-rlx
Maximum Length: 99 characters
Maximum Length: 1 characters
country
Description Country
Type: string
Format: string-rlx
Maximum Length: 99 characters
Maximum Length: 1 characters
existing-org
Description Use existing account with organization ID
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
existing-user
Description Use an existing account with email and password
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
first-name
Description First Name
Type: string
Format: string-rlx
Maximum Length: 99 characters
Maximum Length: 1 characters
glm-email
Description GLM email
Type: string
Format: string-rlx
Maximum Length: 99 characters
Maximum Length: 1 characters
glm-password
Description GLM password
Type: string
Format: string-rlx
Maximum Length: 99 characters
Maximum Length: 1 characters
last-name
Description Last Name
Type: string
Format: string-rlx
Maximum Length: 99 characters
Maximum Length: 1 characters
name
Description License name (Configure license name)
Type: string
Format: string-rlx
Maximum Length: 99 characters
Maximum Length: 1 characters
new-email
Description GLM email
Type: string
Format: string-rlx
Maximum Length: 99 characters
Maximum Length: 1 characters
new-password
Description GLM password
Type: string
Format: string-rlx
Maximum Length: 99 characters
Maximum Length: 1 characters
new-user
Description Create a new account
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
org-id
Description GLM organization id
Type: number
Range: 1-899760
phone
Description Phone
Type: string
Format: string-rlx
Maximum Length: 99 characters
Maximum Length: 1 characters
type
Description ‘webroot’: webroot; ‘webroot_trial’: webroot_trial; ‘webroot_ti’: webroot_ti; ‘webroot_ti_trial’: webroot_ti_trial; ‘qosmos’: qosmos; ‘qosmos_trial’: qosmos_trial; ‘ipsec_vpn’: ipsec_vpn;
Type: string
Supported Values: webroot, webroot_trial, webroot_ti, webroot_ti_trial, qosmos, qosmos_trial, ipsec_vpn
send¶
Specification Value Type object ha-status
Description Send a ELM HA status request
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
license-request
Description Immediately send a single GLM license request
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
enterprise-ha-host-list¶
Specification Value Type list Block object keys host-entry
Description Enter the ELM hostname, IP or [IPV6]
Type: string
Format: string-rlx
Maximum Length: 60 characters
Maximum Length: 4 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters
proxy-server¶
Specification Value Type object encrypted
Description Do NOT use this option manually. (This is an A10 reserved keyword.) (The ENCRYPTED secret string)host
Description Proxy server hostname or IP address
Type: string
Maximum Length: 255 characters
Maximum Length: 1 characters
password
Description Password for proxy authentication
Type: boolean
Supported Values: true, false, 1, 0
Default: 0
port
Description Proxy server port
Type: number
Range: 1-65535
secret-string
Description password value
Type: string
Format: password
Maximum Length: 127 characters
Maximum Length: 1 characters
username
Description Username for proxy authentication
Type: string
Maximum Length: 127 characters
Maximum Length: 1 characters
uuid
Description uuid of the object
Type: string
Maximum Length: 64 characters
Maximum Length: 1 characters