avi_ipaddrgroup - Module for setup of IpAddrGroup Avi RESTful Object

New in version 2.4.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
- Author

Synopsis

This module is used to configure IpAddrGroup object
more examples at https://github.com/avinetworks/devops

Requirements

The below requirements are needed on the host that executes this module.

avisdk

Parameters

Parameter	Choices/Defaults	Comments
addrs		Configure ip address(es).
api_context (added in 2.5)		Avi API context that includes current session ID and CSRF Token. This allows user to perform single login and re-use the session.
api_version	Default: 16.4.4	Avi API version of to use for Avi API and objects.
apic_epg_name		Populate ip addresses from members of this cisco apic epg.
avi_api_patch_op (added in 2.5)	Choices: add replace delete	Patch operation to use when using avi_api_update_method as patch.
avi_api_update_method (added in 2.5)	Choices: put ← patch	Default method for object update is HTTP PUT. Setting to patch will override that behavior to use HTTP PATCH.
avi_credentials (added in 2.5)		Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.
controller	Default:	IP address or hostname of the controller. The default value is the environment variable `AVI_CONTROLLER`.
country_codes		Populate the ip address ranges from the geo database for this country.
description		User defined description for the object.
ip_ports		Configure (ip address, port) tuple(s).
marathon_app_name		Populate ip addresses from tasks of this marathon app.
marathon_service_port		Task port associated with marathon service port. If marathon app has multiple service ports, this is required. Else, the first task port is used.
name required		Name of the ip address group.
password	Default:	Password of Avi user in Avi controller. The default value is the environment variable `AVI_PASSWORD`.
prefixes		Configure ip address prefix(es).
ranges		Configure ip address range(s).
state	Choices: absent present ←	The state that should be applied on the entity.
tenant	Default: admin	Name of tenant used for all Avi API calls and context of object.
tenant_ref		It is a reference to an object of type tenant.
tenant_uuid	Default:	UUID of tenant used for all Avi API calls and context of object.
url		Avi controller URL of the object.
username	Default:	Username used for accessing Avi controller. The default value is the environment variable `AVI_USERNAME`.
uuid		Uuid of the ip address group.

Notes

Note

For more information on using Ansible to manage Avi Network devices see https://www.ansible.com/ansible-avi-networks.

Examples

- name: Create an IP Address Group configuration
  avi_ipaddrgroup:
    controller: '{{ controller }}'
    username: '{{ username }}'
    password: '{{ password }}'
    name: Client-Source-Block
    prefixes:
    - ip_addr:
        addr: 10.0.0.0
        type: V4
      mask: 8
    - ip_addr:
        addr: 172.16.0.0
        type: V4
      mask: 12
    - ip_addr:
        addr: 192.168.0.0
        type: V4
      mask: 16

Return Values

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

Key	Returned	Description
obj dict	success, changed	IpAddrGroup (api/ipaddrgroup) object

Status

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

Author

Gaurav Rastogi (grastogi@avinetworks.com)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/avi_ipaddrgroup_module.html