cm_next_deploy_f5os – Module to manage deployments of BIG-IP Next instances on F5OS devices

New in version 1.0.0.

Synopsis

  • Module to manage deployments of BIG-IP Next instances on F5OS using f5os provider.

Parameters

Parameter Choices/Defaults Configuration Comments
instance
dictionary
Settings related to BIG-IP Next instance provisioning.
cpus
integer
Default:
4
The number of cpus to allocate for deployed instance.
disk_size
integer
Default:
20
The amount of disk space in gigabytes to allocate for deployed instance.
external_ip_address
string
The non-floating IP address for external network in the BIG-IP Next instance.
When provided this parameter requires external_vlan_name to be defined.
The IP address must be provided in CIDR format e.g. 192.168.1.1/24.
external_network_name
string / required
The name of the network that will be used as an external network in deployed BIG-IP Next instance.
external_vlan_name
string
The name of the VLAN to configure for external network in the BIG-IP Next instance.
This name is unique to the instance and does not correspond to the name of vlan as configured on the host.
external_vlan_tag
integer
The vlan tag for external vlan, must be one of the IDs specified by vlans parameter.
When provided this parameter requires external_vlan_name to be defined.
ha_cp_vlan_name
string
The name of the vlan that will be used as a control plane network for HA in deployed BIG-IP Next instance.
This name is unique to the instance and does not correspond to the name of vlan as configured on the host.
ha_cp_vlan_tag
integer
The vlan tag for control plane vlan, must be one of the IDs specified by vlans parameter.
When provided this parameter requires ha_cp_vlan_name to be defined.
ha_dp_vlan_name
string
The name of the vlan that will be used as a dataplane network for HA in deployed BIG-IP Next instance.
This name is unique to the instance and does not correspond to the name of vlan as configured on the host.
ha_dp_vlan_tag
integer
The vlan tag for data plane vlan, must be one of the IDs specified by vlans parameter.
When provided this parameter requires ha_dp_vlan_name to be defined.
instance_hostname
string / required
Hostname for the deployed BIG-IP Next instance.
internal_ip_address
string
The non-floating IP address for internal network in the BIG-IP Next instance.
When provided this parameter requires internal_vlan_name to be defined.
The IP address must be provided in CIDR format e.g. 192.168.1.1/24.
internal_vlan_name
string
The name of the VLAN to configure for internal network in the BIG-IP Next instance.
This name is unique for the instance and does not correspond to the name of vlan as configured on the host.
internal_vlan_tag
integer
The vlan tag for internal vlan, must be one of the IDs specified by vlans parameter.
When provided this parameter requires internal_vlan_name to be defined.
mgmt_address
string / required
The desired management IP address for the BIG-IP Next instance.
The IP address must be provided in CIDR format e.g. 192.168.1.1/24.
mgmt_gateway
string / required
The gateway to set so that mgmt_address can be reached.
The address must be in the provided mgmt_address CIDR range, otherwise deployment will fail.
mgmt_password
string / required
The desired password used by CM to manage BIG-IP Next instance.
mgmt_user
string / required
The desired username used by CM to manage BIG-IP Next instance.
vlans
list / elements=integer
The IDs of vlans to use for deployed instance.
The IDs must be the same as configured on the F5OS host.
provider
dictionary
Settings related to f5os environment.
image_name
string / required
The name of the BIG-IP Next image on the target F5OS host to use to deploy the instance.
provider_name
string / required
Name of the configured F5OS provider as it exists on CM.
type
string / required
    Choices:
  • rseries
The type of the F5OS provider to use to deploy the instance.
state
string
    Choices:
  • present
  • deploy ←
When state is deploy, ensures the deployment task is started.
When state is present, checks for status of existing deployment task.
task_id
string
The unique id to identify the deployment task.
Parameter required when state is present.
timeout
integer
Default:
900
The amount of time to wait for the deployment task to finish, in seconds.
The accepted value range is between 10 and 3600 seconds.
wait_for_finish
boolean
    Choices:
  • no
  • yes ←
Allows the user to specify if the module should wait for task with the given task_id to finish.
If yes the module will wait for the given timeout period for the deployment task to finish running.
If no the module will check for the status of the deployment task and return the result.
If the task has finished running successfully, the module will indicate a change and return a message.
If the task has failed the module will throw an exception and return the failure reason.

Notes

Note

  • Module runs asynchronously, this means it is not IDEMPOTENT until the desired BIG-IP Next instance has been provisioned and registered in CM. Repeating the same deployment task twice will produce unexpected results.
  • To check the results of deploy task use the provided task_id and state set to present.

Examples

- name: Deploy BIG-IP Next instance on rSeries
  cm_next_deploy_f5os:
    state: "deploy"
    provider:
      provider_name: "vCenterDemo"
      type: "rseries"
      image_name: "BIG-IP-Next-20.0.1-2.139.10-0.0.136-VM"
    instance:
      instance_hostname: "demoVM01.lab.local"
      vlans:
        - 21
        - 22
        - 23
        - 24
      mgmt_address: "172.16.1.1/24"
      mgmt_gateway: "172.16.1.254"
      mgmt_user: "admin"
      mgmt_password: "s3KrI!T"
      ha_dp_vlan_name: "dp-demo-ha"
      ha_cp_vlan_name: "cp-demo-ha"
      ha_dp_vlan_tag: 23
      ha_cp_vlan_tag: 24
      external_network_name: "DemoNet123"
      external_vlan_name: "ExtDemoVlan"
      external_vlan_tag: 21
      external_ip_address: "192.168.1.1/24"
      internal_vlan_name: "IntDemoVlan"
      internal_vlan_tag: 22
      internal_ip_address: "192.168.2.1/24"
  register: task

- name: Check the deployment status
  cm_next_deploy_f5os:
    state: "present"
    task_id: "{{ task.task_id }}"
    timeout: 1000

Return Values

The following are the fields unique to this module:

Key Returned Description
message
string
changed
Informative message about the deployment task.

Sample:
Deployment has started
task_id
string
changed
The unique task id returned when deployment task has started.

Sample:
6a0c8602-a115-4d16-b684-103318e703fc


Status

Authors

  • Ravinder Reddy (@RavinderReddyF5)
  • Wojciech Wypior (@wojtek0806)