On this page
avi_ipaddrgroup - Module for setup of IpAddrGroup Avi RESTful Object
New in version 2.4.
Synopsis
- This module is used to configure IpAddrGroup object
 - more examples at https://github.com/avinetworks/devops
 
Requirements (on host that executes module)
- avisdk
 
Options
| parameter | required | default | choices | comments | 
|---|---|---|---|---|
| addrs | 
      no | 
        
        Configure ip address(es).
         | 
     ||
| api_version | 
      no | 
        
        Avi API version of to use for Avi API and objects.
         | 
     ||
| apic_epg_name | 
      no | 
        
        Populate ip addresses from members of this cisco apic epg.
         | 
     ||
| controller | 
      no | 
        
        IP address or hostname of the controller. The default value is the environment variable  AVI_CONTROLLER.
        | 
     ||
| country_codes | 
      no | 
        
        Populate the ip address ranges from the geo database for this country.
         | 
     ||
| description | 
      no | 
        
        User defined description for the object.
         | 
     ||
| ip_ports | 
      no | 
        
        Configure (ip address, port) tuple(s).
         | 
     ||
| marathon_app_name | 
      no | 
        
        Populate ip addresses from tasks of this marathon app.
         | 
     ||
| marathon_service_port | 
      no | 
        
        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 | 
      yes | 
        
        Name of the ip address group.
         | 
     ||
| password | 
      no | 
        
        Password of Avi user in Avi controller. The default value is the environment variable  AVI_PASSWORD.
        | 
     ||
| prefixes | 
      no | 
        
        Configure ip address prefix(es).
         | 
     ||
| ranges | 
      no | 
        
        Configure ip address range(s).
         | 
     ||
| state | 
      no | present | 
       
  | 
      
        
        The state that should be applied on the entity.
         | 
     
| 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 | 
        
        Uuid of the ip address group.
         | 
     
Examples
- name: Create an IP Address Group configuration
  avi_ipaddrgroup:
    controller: ''
    username: ''
    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 Return Values, the following are the fields unique to this module:
| name | description | returned | type | sample | 
|---|---|---|---|---|
| obj | 
        
        IpAddrGroup (api/ipaddrgroup) object
         | 
      success, changed | dict | 
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
 https://docs.ansible.com/ansible/2.4/avi_ipaddrgroup_module.html