.. _cloud_services_cloud_provider: cloud-services cloud-provider ============================= Cloud provider configuration cloud-provider Specification ---------------------------- ===================================== ====================================================================== **Parameter** **Value** ===================================== ====================================================================== **Type** *Intermediate Resource* **Element Name** cloud-provider **Element URI** /axapi/v3/cloud-services/cloud-provider **Element Attributes** cloud-provider_attributes **Partition Visibility** shared **Schema** :download:`cloud-provider schema ` ===================================== ====================================================================== **Operations Allowed:** .. raw:: html .. raw:: html .. raw:: html .. raw:: html
OperationMethodURIPayload
Get Object .. raw:: html GET .. raw:: html /axapi/v3/cloud-services/cloud-provider .. raw:: html cloud-provider_attributes .. raw:: html
.. _652_cloud-provider_attributes: cloud-provider attributes ------------------------- **aws** **Description:** aws is a **JSON Block**. Please see below for :ref:`652_aws` **Type:** Object **Reference Object:** :doc:`/axapi/v3/cloud-services/cloud-provider/aws ` **azure** **Description:** azure is a **JSON Block**. Please see below for :ref:`652_azure` **Type:** Object **Reference Object:** :doc:`/axapi/v3/cloud-services/cloud-provider/azure ` **vmware** **Description:** vmware is a **JSON Block**. Please see below for :ref:`652_vmware` **Type:** Object **Reference Object:** :doc:`/axapi/v3/cloud-services/cloud-provider/vmware ` .. _652_azure: azure ^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **log** **Description:** log is a **JSON Block**. Please see below for :ref:`652_azure_log` **Type:** Object **Reference Object:** :doc:`/axapi/v3/cloud-services/cloud-provider/azure/log ` **metrics** **Description:** metrics is a **JSON Block**. Please see below for :ref:`652_azure_metrics` **Type:** Object **Reference Object:** :doc:`/axapi/v3/cloud-services/cloud-provider/azure/metrics ` .. _652_azure_metrics: 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 **ddos** **Description:** ddos is a **JSON Block**. Please see below for :ref:`652_azure_metrics_ddos` **Type:** Object **Reference Object:** :doc:`/axapi/v3/cloud-services/cloud-provider/azure/metrics/ddos ` **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 .. _652_azure_metrics_ddos: azure_metrics_ddos ^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **entry-zone** **Description** 'enable': Enable All DDoS Entries and Zones Stats; 'disable': Disable All DDoS Entries and Zones Stats; **Type:** string **Supported Values:** enable, disable **Default:** disable **port** **Description** 'enable': Enable All Port Metrics; 'disable': Disable All Port Metrics; **Type:** string **Supported Values:** enable, disable **Default:** disable **tcp** **Description** 'enable': Enable All TCP Metrics; 'disable': Disable All TCP Metrics; **Type:** string **Supported Values:** enable, disable **Default:** disable **udp** **Description** 'enable': Enable All UDP Metrics; 'disable': Disable All UDP 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 .. _652_azure_log: 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 .. _652_aws: aws ^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **log** **Description:** log is a **JSON Block**. Please see below for :ref:`652_aws_log` **Type:** Object **Reference Object:** :doc:`/axapi/v3/cloud-services/cloud-provider/aws/log ` **metrics** **Description:** metrics is a **JSON Block**. Please see below for :ref:`652_aws_metrics` **Type:** Object **Reference Object:** :doc:`/axapi/v3/cloud-services/cloud-provider/aws/metrics ` **multi-az-failover** **Description:** multi-az-failover is a **JSON Block**. Please see below for :ref:`652_aws_multi-az-failover` **Type:** Object **Reference Object:** :doc:`/axapi/v3/cloud-services/cloud-provider/aws/multi-az-failover ` .. _652_aws_metrics: 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 .. _652_aws_multi-az-failover: aws_multi-az-failover ^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **vrid-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/cloud-services/cloud-provider/aws/multi-az-failover/vrid/{vrid-number} ` .. _652_aws_multi-az-failover_vrid-list: aws_multi-az-failover_vrid-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **fip-dest** **Description** Alien FIP Destination CIDR Block **Type:** string **Format:** string-rlx **Maximum Length:** 64 characters **Maximum Length:** 1 characters **fip-interface-id** **Description** Data-Out Interface ID **Type:** string **Format:** string-rlx **Maximum Length:** 64 characters **Maximum Length:** 1 characters **route-table-id** **Description** Specifies the route table id of the interface **Type:** string **Format:** string-rlx **Maximum Length:** 64 characters **Maximum Length:** 1 characters **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **vip-dest** **Description** Alien VIP Destination CIDR Block **Type:** string **Format:** string-rlx **Maximum Length:** 64 characters **Maximum Length:** 1 characters **vip-interface-id** **Description** Data-In Interface ID **Type:** string **Format:** string-rlx **Maximum Length:** 64 characters **Maximum Length:** 1 characters **vip-list** **Type:** List **Reference Object:** :doc:`/axapi/v3/cloud-services/cloud-provider/aws/multi-az-failover/vrid/{vrid-number}/vip/{vip-number} ` **vrid-number** **Description** Specify ha VRRP-A vrid Number **Type:** number **Range:** 0-31 .. _652_aws_multi-az-failover_vrid-list_vip-list: aws_multi-az-failover_vrid-list_vip-list ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *list* **Block object keys** =============================== =================================================== **elastic-ip** **Description** Elastic IP address of VIP **Type:** string **Format:** ipv4-address **private-ip** **Description** Private IP address of VIP **Type:** string **Format:** ipv4-address **user-tag** **Description** Customized tag **Type:** string **Format:** string-rlx **Maximum Length:** 127 characters **Maximum Length:** 1 characters **uuid** **Description** uuid of the object **Type:** string **Maximum Length:** 64 characters **Maximum Length:** 1 characters **vip-number** **Description** Specify ha vip Number **Type:** number **Range:** 0-2147483647 .. _652_aws_log: 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 .. _652_vmware: vmware ^^^^^^ =============================== =================================================== **Specification** **Value** =============================== =================================================== **Type** *object* =============================== =================================================== **log** **Description:** log is a **JSON Block**. Please see below for :ref:`652_vmware_log` **Type:** Object **Reference Object:** :doc:`/axapi/v3/cloud-services/cloud-provider/vmware/log ` **metrics** **Description:** metrics is a **JSON Block**. Please see below for :ref:`652_vmware_metrics` **Type:** Object **Reference Object:** :doc:`/axapi/v3/cloud-services/cloud-provider/vmware/metrics ` .. _652_vmware_metrics: 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 .. _652_vmware_log: 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