mirror of
https://github.com/ansible-collections/community.general.git
synced 2026-05-07 22:02:50 +00:00
Initial commit
This commit is contained in:
Ansible Core Team
155
plugins/modules/network/avi/avi_vsvip.py
Normal file
155
plugins/modules/network/avi/avi_vsvip.py
Normal file
@@ -0,0 +1,155 @@
|
||||
#!/usr/bin/python
|
||||
#
|
||||
# @author: Gaurav Rastogi (grastogi@avinetworks.com)
|
||||
# Eric Anderson (eanderson@avinetworks.com)
|
||||
# module_check: supported
|
||||
# Avi Version: 17.1.2
|
||||
#
|
||||
# Copyright: (c) 2017 Gaurav Rastogi, <grastogi@avinetworks.com>
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
#
|
||||
|
||||
ANSIBLE_METADATA = {'metadata_version': '1.1',
|
||||
'status': ['preview'],
|
||||
'supported_by': 'community'}
|
||||
|
||||
DOCUMENTATION = '''
|
||||
---
|
||||
module: avi_vsvip
|
||||
author: Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>
|
||||
|
||||
short_description: Module for setup of VsVip Avi RESTful Object
|
||||
description:
|
||||
- This module is used to configure VsVip object
|
||||
- more examples at U(https://github.com/avinetworks/devops)
|
||||
requirements: [ avisdk ]
|
||||
options:
|
||||
state:
|
||||
description:
|
||||
- The state that should be applied on the entity.
|
||||
default: present
|
||||
choices: ["absent", "present"]
|
||||
avi_api_update_method:
|
||||
description:
|
||||
- Default method for object update is HTTP PUT.
|
||||
- Setting to patch will override that behavior to use HTTP PATCH.
|
||||
default: put
|
||||
choices: ["put", "patch"]
|
||||
avi_api_patch_op:
|
||||
description:
|
||||
- Patch operation to use when using avi_api_update_method as patch.
|
||||
choices: ["add", "replace", "delete"]
|
||||
cloud_ref:
|
||||
description:
|
||||
- It is a reference to an object of type cloud.
|
||||
- Field introduced in 17.1.1.
|
||||
dns_info:
|
||||
description:
|
||||
- Service discovery specific data including fully qualified domain name, type and time-to-live of the dns record.
|
||||
- Field introduced in 17.1.1.
|
||||
east_west_placement:
|
||||
description:
|
||||
- Force placement on all service engines in the service engine group (container clouds only).
|
||||
- Field introduced in 17.1.1.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||
type: bool
|
||||
name:
|
||||
description:
|
||||
- Name for the vsvip object.
|
||||
- Field introduced in 17.1.1.
|
||||
required: true
|
||||
tenant_ref:
|
||||
description:
|
||||
- It is a reference to an object of type tenant.
|
||||
- Field introduced in 17.1.1.
|
||||
url:
|
||||
description:
|
||||
- Avi controller URL of the object.
|
||||
use_standard_alb:
|
||||
description:
|
||||
- This overrides the cloud level default and needs to match the se group value in which it will be used if the se group use_standard_alb value is
|
||||
- set.
|
||||
- This is only used when fip is used for vs on azure cloud.
|
||||
- Field introduced in 18.2.3.
|
||||
type: bool
|
||||
uuid:
|
||||
description:
|
||||
- Uuid of the vsvip object.
|
||||
- Field introduced in 17.1.1.
|
||||
vip:
|
||||
description:
|
||||
- List of virtual service ips and other shareable entities.
|
||||
- Field introduced in 17.1.1.
|
||||
vrf_context_ref:
|
||||
description:
|
||||
- Virtual routing context that the virtual service is bound to.
|
||||
- This is used to provide the isolation of the set of networks the application is attached to.
|
||||
- It is a reference to an object of type vrfcontext.
|
||||
- Field introduced in 17.1.1.
|
||||
vsvip_cloud_config_cksum:
|
||||
description:
|
||||
- Checksum of cloud configuration for vsvip.
|
||||
- Internally set by cloud connector.
|
||||
- Field introduced in 17.2.9, 18.1.2.
|
||||
extends_documentation_fragment:
|
||||
- community.general.avi
|
||||
|
||||
'''
|
||||
|
||||
EXAMPLES = """
|
||||
- name: Example to create VsVip object
|
||||
avi_vsvip:
|
||||
controller: 10.10.25.42
|
||||
username: admin
|
||||
password: something
|
||||
state: present
|
||||
name: sample_vsvip
|
||||
"""
|
||||
|
||||
RETURN = '''
|
||||
obj:
|
||||
description: VsVip (api/vsvip) object
|
||||
returned: success, changed
|
||||
type: dict
|
||||
'''
|
||||
|
||||
from ansible.module_utils.basic import AnsibleModule
|
||||
try:
|
||||
from ansible_collections.community.general.plugins.module_utils.network.avi.avi import (
|
||||
avi_common_argument_spec, avi_ansible_api, HAS_AVI)
|
||||
except ImportError:
|
||||
HAS_AVI = False
|
||||
|
||||
|
||||
def main():
|
||||
argument_specs = dict(
|
||||
state=dict(default='present',
|
||||
choices=['absent', 'present']),
|
||||
avi_api_update_method=dict(default='put',
|
||||
choices=['put', 'patch']),
|
||||
avi_api_patch_op=dict(choices=['add', 'replace', 'delete']),
|
||||
cloud_ref=dict(type='str',),
|
||||
dns_info=dict(type='list',),
|
||||
east_west_placement=dict(type='bool',),
|
||||
name=dict(type='str', required=True),
|
||||
tenant_ref=dict(type='str',),
|
||||
url=dict(type='str',),
|
||||
use_standard_alb=dict(type='bool',),
|
||||
uuid=dict(type='str',),
|
||||
vip=dict(type='list',),
|
||||
vrf_context_ref=dict(type='str',),
|
||||
vsvip_cloud_config_cksum=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) or requests is not installed. '
|
||||
'For more details visit https://github.com/avinetworks/sdk.'))
|
||||
return avi_ansible_api(module, 'vsvip',
|
||||
set([]))
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Reference in New Issue
Block a user