Documentation

avi_network - Module for setup of Network Avi RESTful Object

New in version 2.4.

Synopsis

Options

parameter required default choices comments
api_version
no
Avi API version of to use for Avi API and objects.
cloud_ref
no
It is a reference to an object of type cloud.
configured_subnets
no
List of subnet.
controller
no
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
dhcp_enabled
no
Select the ip address management scheme for this network.
Default value when not specified in API or module is interpreted by Avi Controller as True.
exclude_discovered_subnets
no
When selected, excludes all discovered subnets in this network from consideration for virtual service placement.
Default value when not specified in API or module is interpreted by Avi Controller as False.
name
yes
Name of the object.
password
no
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
state
no present
  • absent
  • present
The state that should be applied on the entity.
synced_from_se
no
Boolean flag to set synced_from_se.
Default value when not specified in API or module is interpreted by Avi Controller as False.
tenant
no admin
Name of tenant used for all Avi API calls and context of object.
tenant_ref
no
It is a reference to an object of type tenant.
tenant_uuid
no
UUID of tenant used for all Avi API calls and context of object.
url
no
Avi controller URL of the object.
username
no
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.
uuid
no
Unique object identifier of the object.
vcenter_dvs
no
Boolean flag to set vcenter_dvs.
Default value when not specified in API or module is interpreted by Avi Controller as True.
vimgrnw_ref
no
It is a reference to an object of type vimgrnwruntime.
vrf_context_ref
no
It is a reference to an object of type vrfcontext.

Examples

- name: Example to create Network object
  avi_network:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_network

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
obj Network (api/network) object success, changed dict


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.