Sample payloads

Mon, 01 Jan 0001 00:00:00 +0000

F5 BIG-IP

To learn more about this OneFuse Pluggable Module, refer to F5 BIG-IP.

Replace the value of f5Endpoint in the samples below with the name of the Connection info created for the F5 Endpoint.

F5 sample 1: Using OneFuse modules

Sample payload below uses OneFuse Modules: Naming, IPAM, and DNS.

Policy parameters:

Sample payload for Policy Parameters for consuming this Module Policy via VMware vRealize Automation.

{% set vip_name = resource.onefuse_naming.vip.name | default("none", true) %}
{% set vip_ip = resource.onefuse_ipam.vip.ipAddress | default("none", true) %}
{% set dns_zone = "example.com" %}
{% set vip_dns_fqdn = resource.onefuse_dns.vip.records[0].name | default("none", true) %}
{% set tenant_name = "tenant_" + vip_name %}
{% set app_name = "application_" + vip_name %}
{% set pool_name = "pool_" + vip_name %}
{% set service_name = "service_" + vip_name %}

{
  "provisioningPayload": {
    "deploymentItems": {
      "plugin-bdi-54mjrf9h": {
        "parameters": {
          "resource_name": "{{vip_name}}",
          "skip_as3_install_check": false,
          "provisioning_as3_method": "POST",
          "provisioning_as3_path": "/mgmt/shared/appsvcs/declare?show=expanded",
          "provisioning_as3_data": {
            "class": "AS3",
            "action": "deploy",
            "persist": true,
            "declaration": {
              "class": "ADC",
              "schemaVersion": "3.0.0",
              "label": "{{vip_dns_fqdn}}",
              "remark": "Simple HTTP application with RR pool",
              "{{tenant_name}}": {
                "class": "Tenant",
                "{{app_name}}": {
                  "class": "Application",
                  "{{service_name}}": {
                    "class": "Service_HTTP",
                    "virtualAddresses": [
                      "{{vip_ip}}"
                    ],
                    "pool": "{{pool_name}}"
                  },
                  "{{pool_name}}": {
                    "class": "Pool",
                    "monitors": [
                      "http"
                    ],
                    "members": [
                      {
                        "servicePort": 80,
                        "serverAddresses": [
                          {% for key in members %}"{{ key.ip_address }}"{{ ", " if not loop.last else "" }}{% endfor %}
                        ]
                      }
                    ]
                  }
                }
              }
            }
          },
          "deprovisioning_as3_method": "DELETE",
          "deprovisioning_as3_path": "/mgmt/shared/appsvcs/declare/{{tenant_name}}",
          "deprovisioning_as3_data": "",
          "f5_endpoint": "F5_BIGIP_14",
          "onefuse_naming": [
            {
              "label": "vip",
              "endpoint": "onefuse",
              "policy": "vip_naming",
              "template_properties_override": {
                "text": "test2"
              }
            },
            {
              "label": "pool",
              "endpoint": "onefuse",
              "policy": "pool_naming",
              "template_properties_override": {}
            }
          ],
          "onefuse_ipam": [
            {
              "label": "vip",
              "endpoint": "onefuse",
              "policy": "F5_VIP",
              "template_properties_override": {},
              "hostname": "{{vip_name}}"
            }
          ],
          "onefuse_dns": [
            {
              "label": "vip",
              "endpoint": "onefuse",
              "policy": "F5_VIP",
              "template_properties_override": {
                "text": "test2"
              },
              "name": "{{vip_name}}",
              "value": "{{vip_ip}}",
              "zones": [
                "{{dns_zone}}"
              ]
            }
          ],
          "onefuse_property_sets": [
            {
              "label": "machine_naming_properties",
              "property_set_name": "template_portland_prod_windows_web",
              "template_properties_override": {
                "text": "test"
              }
            }
          ],
          "additive_key": "{{inputProperties.deploymentId | required("missing inputProperties.deploymentId")}}-{{OneFuse_Suffix | required("missing OneFuse_Suffix")}}",
          "additive_resource_name": "(member {{OneFuse_VmNic0.target}})",
          "additive_data": {
            "members": {
                "hostname": "{{OneFuse_VmNic0.target | required("missing OneFuse_VmNic0.target")}}",
                "ip_address": "{{OneFuse_VmNic0.ipAddress | required("missing OneFuse_VmNic0.ipAddress")}}"
            }
          },
          "f5_outputs": {
            "app_name": "{{app_name}}",
            "vip_name": "{{vip_name}}",
            "tenant_name": "{{tenant_name}}",
            "pool_name": "{{pool_name}}",
            "service_name": "{{service_name}}",
            "member_ips": "{{as3_results.declaration[tenant_name][app_name][pool_name].members.0.serverAddresses | default ([]) | tojson}}"
           }
        }
      }
    }
  }
}

The following snippet from the sample payload above can be modified to have the correct properties for the machine hostname/IP address.

Pluggable modules on CloudBolt Documentation

Sample payloads

F5 BIG-IP

F5 sample 1: Using OneFuse modules