mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
New module to setup IP address group. (#22224)
* New module to setup IP address group. * Updated descriptions for Avi 17.1.1 release and Fixed metadata
This commit is contained in:
Gaurav Rastogi
John R Barker
parent
b0465a2fbd
commit
91f255a07b
1 changed files with 159 additions and 0 deletions
159
lib/ansible/modules/network/avi/avi_ipaddrgroup.py
Normal file
159
lib/ansible/modules/network/avi/avi_ipaddrgroup.py
Normal file
|
|
@ -0,0 +1,159 @@
|
|||
#!/usr/bin/python
|
||||
#
|
||||
# Created on Aug 25, 2016
|
||||
# @author: Gaurav Rastogi (grastogi@avinetworks.com)
|
||||
# Eric Anderson (eanderson@avinetworks.com)
|
||||
# module_check: supported
|
||||
# Avi Version: 17.1.1
|
||||
#
|
||||
#
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
#
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.0',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: avi_ipaddrgroup
|
||||
author: Gaurav Rastogi (grastogi@avinetworks.com)
|
||||
|
||||
short_description: Module for setup of IpAddrGroup Avi RESTful Object
|
||||
description:
|
||||
- This module is used to configure IpAddrGroup object
|
||||
- more examples at U(https://github.com/avinetworks/devops)
|
||||
requirements: [ avisdk ]
|
||||
version_added: "2.4"
|
||||
options:
|
||||
state:
|
||||
description:
|
||||
- The state that should be applied on the entity.
|
||||
default: present
|
||||
choices: ["absent","present"]
|
||||
addrs:
|
||||
description:
|
||||
- Configure ip address(es).
|
||||
apic_epg_name:
|
||||
description:
|
||||
- Populate ip addresses from members of this cisco apic epg.
|
||||
country_codes:
|
||||
description:
|
||||
- Populate the ip address ranges from the geo database for this country.
|
||||
description:
|
||||
description:
|
||||
- User defined description for the object.
|
||||
ip_ports:
|
||||
description:
|
||||
- Configure (ip address, port) tuple(s).
|
||||
marathon_app_name:
|
||||
description:
|
||||
- Populate ip addresses from tasks of this marathon app.
|
||||
marathon_service_port:
|
||||
description:
|
||||
- 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:
|
||||
description:
|
||||
- Name of the ip address group.
|
||||
required: true
|
||||
prefixes:
|
||||
description:
|
||||
- Configure ip address prefix(es).
|
||||
ranges:
|
||||
description:
|
||||
- Configure ip address range(s).
|
||||
tenant_ref:
|
||||
description:
|
||||
- It is a reference to an object of type tenant.
|
||||
url:
|
||||
description:
|
||||
- Avi controller URL of the object.
|
||||
uuid:
|
||||
description:
|
||||
- Uuid of the ip address group.
|
||||
extends_documentation_fragment:
|
||||
- avi
|
||||
'''
|
||||
|
||||
|
||||
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 = '''
|
||||
obj:
|
||||
description: IpAddrGroup (api/ipaddrgroup) object
|
||||
returned: success, changed
|
||||
type: dict
|
||||
'''
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
try:
|
||||
from ansible.module_utils.avi import (
|
||||
avi_common_argument_spec, HAS_AVI, avi_ansible_api)
|
||||
except ImportError:
|
||||
HAS_AVI = False
|
||||
|
||||
|
||||
def main():
|
||||
argument_specs = dict(
|
||||
state=dict(default='present',
|
||||
choices=['absent', 'present']),
|
||||
addrs=dict(type='list',),
|
||||
apic_epg_name=dict(type='str',),
|
||||
country_codes=dict(type='list',),
|
||||
description=dict(type='str',),
|
||||
ip_ports=dict(type='list',),
|
||||
marathon_app_name=dict(type='str',),
|
||||
marathon_service_port=dict(type='int',),
|
||||
name=dict(type='str', required=True),
|
||||
prefixes=dict(type='list',),
|
||||
ranges=dict(type='list',),
|
||||
tenant_ref=dict(type='str',),
|
||||
url=dict(type='str',),
|
||||
uuid=dict(type='str',),
|
||||
)
|
||||
argument_specs.update(avi_common_argument_spec())
|
||||
module = AnsibleModule(
|
||||
argument_spec=argument_specs, supports_check_mode=True)
|
||||
if not HAS_AVI:
|
||||
return module.fail_json(msg=(
|
||||
'Avi python API SDK (avisdk>=17.1) is not installed. '
|
||||
'For more details visit https://github.com/avinetworks/sdk.'))
|
||||
return avi_ansible_api(module, 'ipaddrgroup',
|
||||
set([]))
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Reference in a new issue