cloud-services¶

Cloud Services configuration

cloud-services Specification¶

Parameter Value

Type Intermediate Resource

Element Name cloud-services

Element URI /axapi/v3/cloud-services

Element Attributes cloud-services_attributes

Partition Visibility shared

Schema cloud-services schema

Operations Allowed:

Operation	Method	URI	Payload
Get Object	GET	/axapi/v3/cloud-services	cloud-services_attributes

cloud-services attributes¶

cloud-provider

Description: cloud-provider is a JSON Block. Please see below for cloud-provider

Type: Object

Reference Object: /axapi/v3/cloud-services/cloud-provider

kafka-server-profile

Description: kafka-server-profile is a JSON Block. Please see below for kafka-server-profile

Type: Object

Reference Object: /axapi/v3/cloud-services/kafka-server-profile

meta-data

Description: meta-data is a JSON Block. Please see below for meta-data

Type: Object

Reference Object: /axapi/v3/cloud-services/meta-data

meta-data¶

Specification Value

Type object

action

Description ‘enable’: enable; ‘disable’: disable;

Type: string

Supported Values: enable, disable

Default: disable

prevent-admin-passwd

Description Prevents admin password from being changed if in YAML config

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

prevent-admin-ssh-key

Description Prevents admin ssh-key from being added if in YAML config

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

prevent-autofill

Description prevents use of meta-data to complete user_data configuration

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

prevent-blob

Description Prevents a10_blob from loading in YAML config

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

prevent-cloud-service

Description Prevents cloud-service configuration in YAML config

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

prevent-license

Description Prevents a10_license configuration in YAML config

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

prevent-user-ops

Description Prevents user from being added command is in user-data

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

prevent-webservice

Description Prevents a10_license configuration in YAML config

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

provider

Description ‘aws’: AWS user-data services; ‘openstack’: OpenStack user-data services;

Type: string

Supported Values: openstack

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

kafka-server-profile¶

Specification Value

Type object

action

Description ‘register’: Register the device to the cloud; ‘deregister’: Deregister the device from the cloud;

Type: string

Supported Values: register, deregister

active_ns

Description Set active_ns in cloud credentials file

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

alias_ns

Description Set active_ns in cloud credentials file

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

bootstrap_servers

Description Set bootstrap_servers in cloud credentials file

Type: string

Format: password

Maximum Length: 63 characters

Maximum Length: 1 characters

client_id

Description Set client_id in cloud credentials file

Type: string

Format: password

Maximum Length: 63 characters

Maximum Length: 1 characters

client_secret

Description Set client_secret in cloud credentials file

Type: string

Format: password

Maximum Length: 63 characters

Maximum Length: 1 characters

primary_ns

Description Set active_ns in cloud credentials file

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

resource_group

Description Set resource_group in cloud credentials file

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

sasl_mechanisms

Description Set sasl_mechanisms in cloud credentials file

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

sasl_password

Description Set sasl_password in cloud credentials file

Type: string

Format: password

Maximum Length: 256 characters

Maximum Length: 1 characters

schema_group_name

Description Set schema_group_name in cloud credentials file

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

secondary_ns

Description Set active_ns in cloud credentials file

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

security_protocol

Description Set security_protocol in cloud credentials file

Type: string

Maximum Length: 128 characters

Maximum Length: 1 characters

subscription_id

Description Set subscription_id in cloud credentials file

Type: string

Format: password

Maximum Length: 63 characters

Maximum Length: 1 characters

tenant_id

Description Set tenant_id in cloud credentials file

Type: string

Format: password

Maximum Length: 63 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

cloud-provider¶

Specification Value

Type object

aws

Description: aws is a JSON Block. Please see below for cloud-provider_aws

Type: Object

Reference Object: /axapi/v3/cloud-services/cloud-provider/aws

azure

Description: azure is a JSON Block. Please see below for cloud-provider_azure

Type: Object

Reference Object: /axapi/v3/cloud-services/cloud-provider/azure

vmware

Description: vmware is a JSON Block. Please see below for cloud-provider_vmware

Type: Object

Reference Object: /axapi/v3/cloud-services/cloud-provider/vmware

cloud-provider_azure¶

Specification Value

Type object

log

Description: log is a JSON Block. Please see below for cloud-provider_azure_log

Type: Object

Reference Object: /axapi/v3/cloud-services/cloud-provider/azure/log

metrics

Description: metrics is a JSON Block. Please see below for cloud-provider_azure_metrics

Type: Object

Reference Object: /axapi/v3/cloud-services/cloud-provider/azure/metrics

cloud-provider_azure_metrics¶

Specification Value

Type object

action

Description ‘enable’: Enable Azure Application Insights; ‘disable’: Disable Azure Application Insights (default);

Type: string

Supported Values: enable, disable

Default: disable

active-partitions

Description Specifies the thunder active partition name separated by a comma for multiple values

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

cps

Description ‘enable’: Enable CPS Metrics; ‘disable’: Disable CPS Metrics;

Type: string

Supported Values: enable, disable

Default: disable

cpu

Description ‘enable’: Enable CPU Metrics; ‘disable’: Disable CPU Metrics;

Type: string

Supported Values: enable, disable

Default: disable

disk

Description ‘enable’: Enable Disk Metrics; ‘disable’: Disable Disk Metrics;

Type: string

Supported Values: enable, disable

Default: disable

interfaces

Description ‘enable’: Enable Interfaces Metrics; ‘disable’: Disable Interfaces Metrics;

Type: string

Supported Values: enable, disable

Default: disable

memory

Description ‘enable’: Enable Memory Metrics; ‘disable’: Disable Memory Metrics;

Type: string

Supported Values: enable, disable

Default: disable

packet-drop

Description ‘enable’: Enable Packet Drop Metrics; ‘disable’: Disable Packet Drop Metrics;

Type: string

Supported Values: enable, disable

Default: disable

packet-rate

Description ‘enable’: Enable Packet Rate Metrics; ‘disable’: Disable Packet Rate Metrics;

Type: string

Supported Values: enable, disable

Default: disable

resource-id

Description Specifies the Azure Application Insights resource ID or Instance Resource ID

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

server-down-count

Description ‘enable’: Enable Server Down Count Metrics; ‘disable’: Disable Server Down Count Metrics;

Type: string

Supported Values: enable, disable

Default: disable

server-down-percentage

Description ‘enable’: Enable Server Down Percentage Metrics; ‘disable’: Disable Server Down Percentage Metrics;

Type: string

Supported Values: enable, disable

Default: disable

server-error

Description ‘enable’: Enable Server Error Metrics; ‘disable’: Disable Server Error Metrics;

Type: string

Supported Values: enable, disable

Default: disable

sessions

Description ‘enable’: Enable Sessions Metrics; ‘disable’: Disable Sessions Metrics;

Type: string

Supported Values: enable, disable

Default: disable

ssl-cert

Description ‘enable’: Enable SSL Cert Metrics; ‘disable’: Disable SSL Cert Metrics;

Type: string

Supported Values: enable, disable

Default: disable

throughput

Description ‘enable’: Enable Throughput Metrics; ‘disable’: Disable Throughput Metrics;

Type: string

Supported Values: enable, disable

Default: disable

tps

Description ‘enable’: Enable TPS Metrics; ‘disable’: Disable TPS Metrics;

Type: string

Supported Values: enable, disable

Default: disable

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

cloud-provider_azure_log¶

Specification Value

Type object

action

Description ‘enable’: Enable Azure Log Analytics Workspace; ‘disable’: Disable Azure Log Analytics Workspace (default);

Type: string

Supported Values: enable, disable

Default: disable

active-partitions

Description Specifies the thunder active partition name separated by a comma for multiple values

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

resource-id

Description Specifies the compute instance resource ID/Instance on which thunder is deployed

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

workspace-id

Description Specifies the Azure Log Analytics Workspace ID

Type: string

Format: string-rlx

Maximum Length: 64 characters

Maximum Length: 1 characters

cloud-provider_aws¶

Specification Value

Type object

log

Description: log is a JSON Block. Please see below for cloud-provider_aws_log

Type: Object

Reference Object: /axapi/v3/cloud-services/cloud-provider/aws/log

metrics

Description: metrics is a JSON Block. Please see below for cloud-provider_aws_metrics

Type: Object

Reference Object: /axapi/v3/cloud-services/cloud-provider/aws/metrics

cloud-provider_aws_metrics¶

Specification Value

Type object

action

Description ‘enable’: Enable AWS CloudWatch; ‘disable’: Disable AWS CloudWatch (default);

Type: string

Supported Values: enable, disable

Default: disable

active-partitions

Description Specifies the thunder active partition name separated by a comma for multiple values

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

cps

Description ‘enable’: Enable CPS Metrics; ‘disable’: Disable CPS Metrics;

Type: string

Supported Values: enable, disable

Default: disable

cpu

Description ‘enable’: Enable CPU Metrics; ‘disable’: Disable CPU Metrics;

Type: string

Supported Values: enable, disable

Default: disable

disk

Description ‘enable’: Enable Disk Metrics; ‘disable’: Disable Disk Metrics;

Type: string

Supported Values: enable, disable

Default: disable

interfaces

Description ‘enable’: Enable Interfaces Metrics; ‘disable’: Disable Interfaces Metrics;

Type: string

Supported Values: enable, disable

Default: disable

memory

Description ‘enable’: Enable Memory Metrics; ‘disable’: Disable Memory Metrics;

Type: string

Supported Values: enable, disable

Default: disable

namespace

Description Specifies the AWS namespace where all the metrics must be published

Type: string

Format: string-rlx

Maximum Length: 64 characters

Maximum Length: 1 characters

packet-drop

Description ‘enable’: Enable Packet Drop Metrics; ‘disable’: Disable Packet Drop Metrics;

Type: string

Supported Values: enable, disable

Default: disable

packet-rate

Description ‘enable’: Enable Packet Rate Metrics; ‘disable’: Disable Packet Rate Metrics;

Type: string

Supported Values: enable, disable

Default: disable

server-down-count

Description ‘enable’: Enable Server Down Count Metrics; ‘disable’: Disable Server Down Count Metrics;

Type: string

Supported Values: enable, disable

Default: disable

server-down-percentage

Description ‘enable’: Enable Server Down Percentage Metrics; ‘disable’: Disable Server Down Percentage Metrics;

Type: string

Supported Values: enable, disable

Default: disable

server-error

Description ‘enable’: Enable Server Error Metrics; ‘disable’: Disable Server Error Metrics;

Type: string

Supported Values: enable, disable

Default: disable

sessions

Description ‘enable’: Enable Sessions Metrics; ‘disable’: Disable Sessions Metrics;

Type: string

Supported Values: enable, disable

Default: disable

ssl-cert

Description ‘enable’: Enable SSL Cert Metrics; ‘disable’: Disable SSL Cert Metrics;

Type: string

Supported Values: enable, disable

Default: disable

throughput

Description ‘enable’: Enable Throughput Metrics; ‘disable’: Disable Throughput Metrics;

Type: string

Supported Values: enable, disable

Default: disable

tps

Description ‘enable’: Enable TPS Metrics; ‘disable’: Disable TPS Metrics;

Type: string

Supported Values: enable, disable

Default: disable

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

cloud-provider_aws_log¶

Specification Value

Type object

action

Description ‘enable’: Enable AWS CloudWatch; ‘disable’: Disable AWS CloudWatch (default);

Type: string

Supported Values: enable, disable

Default: disable

active-partitions

Description Specifies the thunder active partition name separated by a comma for multiple values

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

log-group-name

Description Specifies the log group name under which all logs are sent to AWS CloudWatch

Type: string

Format: string-rlx

Maximum Length: 64 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

cloud-provider_vmware¶

Specification Value

Type object

log

Description: log is a JSON Block. Please see below for cloud-provider_vmware_log

Type: Object

Reference Object: /axapi/v3/cloud-services/cloud-provider/vmware/log

metrics

Description: metrics is a JSON Block. Please see below for cloud-provider_vmware_metrics

Type: Object

Reference Object: /axapi/v3/cloud-services/cloud-provider/vmware/metrics

cloud-provider_vmware_metrics¶

Specification Value

Type object

action

Description ‘enable’: Enable VMware vRealize Operations Manager; ‘disable’: Disable VMware vRealize Operations Manager (default);

Type: string

Supported Values: enable, disable

Default: disable

active-partitions

Description Specifies the thunder active partition name separated by a comma for multiple values

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

cps

Description ‘enable’: Enable CPS Metrics; ‘disable’: Disable CPS Metrics;

Type: string

Supported Values: enable, disable

Default: disable

cpu

Description ‘enable’: Enable CPU Metrics; ‘disable’: Disable CPU Metrics;

Type: string

Supported Values: enable, disable

Default: disable

disk

Description ‘enable’: Enable Disk Metrics; ‘disable’: Disable Disk Metrics;

Type: string

Supported Values: enable, disable

Default: disable

interfaces

Description ‘enable’: Enable Interfaces Metrics; ‘disable’: Disable Interfaces Metrics;

Type: string

Supported Values: enable, disable

Default: disable

memory

Description ‘enable’: Enable Memory Metrics; ‘disable’: Disable Memory Metrics;

Type: string

Supported Values: enable, disable

Default: disable

packet-drop

Description ‘enable’: Enable Packet Drop Metrics; ‘disable’: Disable Packet Drop Metrics;

Type: string

Supported Values: enable, disable

Default: disable

packet-rate

Description ‘enable’: Enable Packet Rate Metrics; ‘disable’: Disable Packet Rate Metrics;

Type: string

Supported Values: enable, disable

Default: disable

resource-id

Description Specifies the compute instance resource ID on which thunder is deployed

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

server-down-count

Description ‘enable’: Enable Server Down Count Metrics; ‘disable’: Disable Server Down Count Metrics;

Type: string

Supported Values: enable, disable

Default: disable

server-down-percentage

Description ‘enable’: Enable Server Down Percentage Metrics; ‘disable’: Disable Server Down Percentage Metrics;

Type: string

Supported Values: enable, disable

Default: disable

server-error

Description ‘enable’: Enable Server Error Metrics; ‘disable’: Disable Server Error Metrics;

Type: string

Supported Values: enable, disable

Default: disable

sessions

Description ‘enable’: Enable Sessions Metrics; ‘disable’: Disable Sessions Metrics;

Type: string

Supported Values: enable, disable

Default: disable

ssl-cert

Description ‘enable’: Enable SSL Cert Metrics; ‘disable’: Disable SSL Cert Metrics;

Type: string

Supported Values: enable, disable

Default: disable

throughput

Description ‘enable’: Enable Throughput Metrics; ‘disable’: Disable Throughput Metrics;

Type: string

Supported Values: enable, disable

Default: disable

tps

Description ‘enable’: Enable TPS Metrics; ‘disable’: Disable TPS Metrics;

Type: string

Supported Values: enable, disable

Default: disable

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vrops-host

Description Specifies the VMware vROps host IP address

Type: string

Format: string-rlx

Maximum Length: 64 characters

Maximum Length: 1 characters

cloud-provider_vmware_log¶

Specification Value

Type object

action

Description ‘enable’: Enable VMware vRealize Log Insight; ‘disable’: Disable VMware vRealize Log Insight (default);

Type: string

Supported Values: enable, disable

Default: disable

active-partitions

Description Specifies the thunder active partition name separated by a comma for multiple values

Type: string

Format: string-rlx

Maximum Length: 255 characters

Maximum Length: 1 characters

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

vrli-host

Description Specifies the VMware vRLI host IP address

Type: string

Format: string-rlx

Maximum Length: 64 characters

Maximum Length: 1 characters