New Avi Module to setup various controller properties. (#24811)
This commit is contained in:
Gaurav Rastogi
John R Barker
parent
fd94b5b20d
commit
788e2efe2a
1 changed files with 308 additions and 0 deletions
308
lib/ansible/modules/network/avi/avi_controllerproperties.py
Normal file
308
lib/ansible/modules/network/avi/avi_controllerproperties.py
Normal file
|
|
@ -0,0 +1,308 @@
|
|||
#!/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.2
|
||||
#
|
||||
#
|
||||
# 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_controllerproperties
|
||||
author: Gaurav Rastogi (grastogi@avinetworks.com)
|
||||
|
||||
short_description: Module for setup of ControllerProperties Avi RESTful Object
|
||||
description:
|
||||
- This module is used to configure ControllerProperties 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"]
|
||||
allow_ip_forwarding:
|
||||
description:
|
||||
- Field introduced in 17.1.1.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||
allow_unauthenticated_apis:
|
||||
description:
|
||||
- Allow unauthenticated access for special apis.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||
allow_unauthenticated_nodes:
|
||||
description:
|
||||
- Boolean flag to set allow_unauthenticated_nodes.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||
api_idle_timeout:
|
||||
description:
|
||||
- Allowed values are 0-1440.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 15.
|
||||
appviewx_compat_mode:
|
||||
description:
|
||||
- Export configuration in appviewx compatibility mode.
|
||||
- Field introduced in 17.1.1.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as False.
|
||||
attach_ip_retry_interval:
|
||||
description:
|
||||
- Number of attach_ip_retry_interval.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 360.
|
||||
attach_ip_retry_limit:
|
||||
description:
|
||||
- Number of attach_ip_retry_limit.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 4.
|
||||
cluster_ip_gratuitous_arp_period:
|
||||
description:
|
||||
- Number of cluster_ip_gratuitous_arp_period.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 60.
|
||||
crashed_se_reboot:
|
||||
description:
|
||||
- Number of crashed_se_reboot.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 900.
|
||||
dead_se_detection_timer:
|
||||
description:
|
||||
- Number of dead_se_detection_timer.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 360.
|
||||
dns_refresh_period:
|
||||
description:
|
||||
- Number of dns_refresh_period.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 60.
|
||||
dummy:
|
||||
description:
|
||||
- Number of dummy.
|
||||
fatal_error_lease_time:
|
||||
description:
|
||||
- Number of fatal_error_lease_time.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 120.
|
||||
max_dead_se_in_grp:
|
||||
description:
|
||||
- Number of max_dead_se_in_grp.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 1.
|
||||
max_pcap_per_tenant:
|
||||
description:
|
||||
- Maximum number of pcap files stored per tenant.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 4.
|
||||
max_seq_vnic_failures:
|
||||
description:
|
||||
- Number of max_seq_vnic_failures.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 3.
|
||||
persistence_key_rotate_period:
|
||||
description:
|
||||
- Allowed values are 1-1051200.
|
||||
- Special values are 0 - 'disabled'.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 60.
|
||||
query_host_fail:
|
||||
description:
|
||||
- Number of query_host_fail.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 180.
|
||||
se_create_timeout:
|
||||
description:
|
||||
- Number of se_create_timeout.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 900.
|
||||
se_failover_attempt_interval:
|
||||
description:
|
||||
- Interval between attempting failovers to an se.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 300.
|
||||
se_offline_del:
|
||||
description:
|
||||
- Number of se_offline_del.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 172000.
|
||||
se_vnic_cooldown:
|
||||
description:
|
||||
- Number of se_vnic_cooldown.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 120.
|
||||
secure_channel_cleanup_timeout:
|
||||
description:
|
||||
- Number of secure_channel_cleanup_timeout.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 60.
|
||||
secure_channel_controller_token_timeout:
|
||||
description:
|
||||
- Number of secure_channel_controller_token_timeout.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 60.
|
||||
secure_channel_se_token_timeout:
|
||||
description:
|
||||
- Number of secure_channel_se_token_timeout.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 60.
|
||||
seupgrade_fabric_pool_size:
|
||||
description:
|
||||
- Pool size used for all fabric commands during se upgrade.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 20.
|
||||
seupgrade_segroup_min_dead_timeout:
|
||||
description:
|
||||
- Time to wait before marking segroup upgrade as stuck.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 360.
|
||||
ssl_certificate_expiry_warning_days:
|
||||
description:
|
||||
- Number of days for ssl certificate expiry warning.
|
||||
unresponsive_se_reboot:
|
||||
description:
|
||||
- Number of unresponsive_se_reboot.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 300.
|
||||
upgrade_dns_ttl:
|
||||
description:
|
||||
- Time to account for dns ttl during upgrade.
|
||||
- This is in addition to vs_scalein_timeout_for_upgrade in se_group.
|
||||
- Field introduced in 17.1.1.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 5.
|
||||
upgrade_lease_time:
|
||||
description:
|
||||
- Number of upgrade_lease_time.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 360.
|
||||
url:
|
||||
description:
|
||||
- Avi controller URL of the object.
|
||||
uuid:
|
||||
description:
|
||||
- Unique object identifier of the object.
|
||||
vnic_op_fail_time:
|
||||
description:
|
||||
- Number of vnic_op_fail_time.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 180.
|
||||
vs_apic_scaleout_timeout:
|
||||
description:
|
||||
- Time to wait for the scaled out se to become ready before marking the scaleout done, applies to apic configuration only.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 360.
|
||||
vs_awaiting_se_timeout:
|
||||
description:
|
||||
- Number of vs_awaiting_se_timeout.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 60.
|
||||
vs_key_rotate_period:
|
||||
description:
|
||||
- Allowed values are 1-1051200.
|
||||
- Special values are 0 - 'disabled'.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 60.
|
||||
vs_se_bootup_fail:
|
||||
description:
|
||||
- Number of vs_se_bootup_fail.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 300.
|
||||
vs_se_create_fail:
|
||||
description:
|
||||
- Number of vs_se_create_fail.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 1500.
|
||||
vs_se_ping_fail:
|
||||
description:
|
||||
- Number of vs_se_ping_fail.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 60.
|
||||
vs_se_vnic_fail:
|
||||
description:
|
||||
- Number of vs_se_vnic_fail.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 300.
|
||||
vs_se_vnic_ip_fail:
|
||||
description:
|
||||
- Number of vs_se_vnic_ip_fail.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 120.
|
||||
warmstart_se_reconnect_wait_time:
|
||||
description:
|
||||
- Number of warmstart_se_reconnect_wait_time.
|
||||
- Default value when not specified in API or module is interpreted by Avi Controller as 300.
|
||||
extends_documentation_fragment:
|
||||
- avi
|
||||
'''
|
||||
|
||||
EXAMPLES = """
|
||||
- name: Example to create ControllerProperties object
|
||||
avi_controllerproperties:
|
||||
controller: 10.10.25.42
|
||||
username: admin
|
||||
password: something
|
||||
state: present
|
||||
name: sample_controllerproperties
|
||||
"""
|
||||
|
||||
RETURN = '''
|
||||
obj:
|
||||
description: ControllerProperties (api/controllerproperties) 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']),
|
||||
allow_ip_forwarding=dict(type='bool',),
|
||||
allow_unauthenticated_apis=dict(type='bool',),
|
||||
allow_unauthenticated_nodes=dict(type='bool',),
|
||||
api_idle_timeout=dict(type='int',),
|
||||
appviewx_compat_mode=dict(type='bool',),
|
||||
attach_ip_retry_interval=dict(type='int',),
|
||||
attach_ip_retry_limit=dict(type='int',),
|
||||
cluster_ip_gratuitous_arp_period=dict(type='int',),
|
||||
crashed_se_reboot=dict(type='int',),
|
||||
dead_se_detection_timer=dict(type='int',),
|
||||
dns_refresh_period=dict(type='int',),
|
||||
dummy=dict(type='int',),
|
||||
fatal_error_lease_time=dict(type='int',),
|
||||
max_dead_se_in_grp=dict(type='int',),
|
||||
max_pcap_per_tenant=dict(type='int',),
|
||||
max_seq_vnic_failures=dict(type='int',),
|
||||
persistence_key_rotate_period=dict(type='int',),
|
||||
query_host_fail=dict(type='int',),
|
||||
se_create_timeout=dict(type='int',),
|
||||
se_failover_attempt_interval=dict(type='int',),
|
||||
se_offline_del=dict(type='int',),
|
||||
se_vnic_cooldown=dict(type='int',),
|
||||
secure_channel_cleanup_timeout=dict(type='int',),
|
||||
secure_channel_controller_token_timeout=dict(type='int',),
|
||||
secure_channel_se_token_timeout=dict(type='int',),
|
||||
seupgrade_fabric_pool_size=dict(type='int',),
|
||||
seupgrade_segroup_min_dead_timeout=dict(type='int',),
|
||||
ssl_certificate_expiry_warning_days=dict(type='list',),
|
||||
unresponsive_se_reboot=dict(type='int',),
|
||||
upgrade_dns_ttl=dict(type='int',),
|
||||
upgrade_lease_time=dict(type='int',),
|
||||
url=dict(type='str',),
|
||||
uuid=dict(type='str',),
|
||||
vnic_op_fail_time=dict(type='int',),
|
||||
vs_apic_scaleout_timeout=dict(type='int',),
|
||||
vs_awaiting_se_timeout=dict(type='int',),
|
||||
vs_key_rotate_period=dict(type='int',),
|
||||
vs_se_bootup_fail=dict(type='int',),
|
||||
vs_se_create_fail=dict(type='int',),
|
||||
vs_se_ping_fail=dict(type='int',),
|
||||
vs_se_vnic_fail=dict(type='int',),
|
||||
vs_se_vnic_ip_fail=dict(type='int',),
|
||||
warmstart_se_reconnect_wait_time=dict(type='int',),
|
||||
)
|
||||
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, 'controllerproperties',
|
||||
set([]))
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
||||
Loading…
Reference in a new issue