{ "items": { "anyOf": [ { "required": [ "name" ], "type": "object", "properties": { "args": { "required": [], "type": "object", "properties": { "warn": { "type": "string" }, "creates": { "type": "string" }, "chdir": { "type": "string" }, "removes": { "type": "string" }, "stdin": { "type": "string" } } }, "command": { "type": "string" }, "name": { "type": "string" } } }, { "required": [ "name" ], "type": "object", "properties": { "shell": { "type": "string" }, "args": { "required": [], "type": "object", "properties": { "creates": { "type": "string" }, "executable": { "type": "string" }, "chdir": { "type": "string" }, "stdin": { "type": "string" }, "removes": { "type": "string" }, "warn": { "type": "boolean" } } }, "name": { "type": "string" } } }, { "required": [ "name" ], "type": "object", "properties": { "args": { "required": [], "type": "object", "properties": { "creates": { "type": "string" }, "chdir": { "type": "string" }, "removes": { "type": "string" } } }, "name": { "type": "string" }, "script": { "type": "string" } } }, { "required": [ "name" ], "type": "object", "properties": { "ecs_taskdefinition": { "required": [ "state" ], "type": "object", "description": "Registers or deregisters task definitions in the Amazon Web Services (AWS) EC2 Container Service (ECS)", "properties": { "family": { "type": "string" }, "task_role_arn": { "type": "string" }, "network_mode": { "type": "string" }, "state": { "type": "string" }, "arn": { "type": "string" }, "volumes": { "items": { "type": "string" }, "type": "array" }, "containers": { "items": { "type": "string" }, "type": "array" }, "revision": { "type": "string" } } }, "avi_alertscriptconfig": { "required": [ "name" ], "type": "object", "description": "This module is used to configure AlertScriptConfig object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "action_script": { "type": "string" }, "url": { "type": "string" }, "tenant_ref": { "type": "string" }, "uuid": { "type": "string" }, "state": { "type": "string" }, "name": { "type": "string" } } }, "azure_rm_acs": { "required": [ "linux_profile", "master_profile", "name", "resource_group", "orchestration_platform", "agent_pool_profiles", "diagnostics_profile" ], "type": "object", "description": "Create, update and delete an Azure Container Service Instance.", "properties": { "linux_profile": { "type": "string" }, "master_profile": { "type": "string" }, "name": { "type": "string" }, "resource_group": { "type": "string" }, "orchestration_platform": { "type": "string" }, "agent_pool_profiles": { "type": "string" }, "state": { "type": "string" }, "location": { "type": "string" }, "service_principal": { "type": "string" }, "diagnostics_profile": { "type": "boolean" } } }, "junos_rpc": { "required": [ "rpc" ], "type": "object", "description": "Sends a request to the remote device running JUNOS to execute the specified RPC using the NetConf transport. The reply is then returned to the playbook in the C(xml) key. If an alternate output format is requested, the reply is transformed to the requested output.", "properties": { "output": { "type": "string" }, "rpc": { "type": "string" }, "args": { "type": "string" }, "attrs": { "items": { "type": "string" }, "type": "array" } } }, "pn_ospf": { "required": [ "state", "pn_vrouter_name", "pn_network_ip" ], "type": "object", "description": "Execute vrouter-ospf-add, vrouter-ospf-remove command.\nThis command adds/removes Open Shortest Path First(OSPF) routing protocol to a virtual router(vRouter) service.", "properties": { "pn_ospf_area": { "type": "string" }, "pn_clipassword": { "type": "string" }, "pn_vrouter_name": { "type": "string" }, "pn_network_ip": { "type": "string" }, "pn_cliusername": { "type": "string" }, "state": { "type": "string" }, "pn_cliswitch": { "type": "string" } } }, "gcpubsub_facts": { "required": [ "view" ], "type": "object", "description": "List Topics/Subscriptions from Google PubSub. Use the gcpubsub module for topic/subscription management. See U(https://cloud.google.com/pubsub/docs) for an overview.", "properties": { "topic": { "type": "string" }, "state": { "items": { "type": "string" }, "type": "array" }, "view": { "type": "string" } } }, "cs_snapshot_policy": { "required": [], "type": "object", "description": "Create, update and delete volume snapshot policies.", "properties": { "project": { "type": "string" }, "domain": { "type": "string" }, "schedule": { "type": "string" }, "interval_type": { "type": "string" }, "vm": { "type": "string" }, "volume_type": { "type": "string" }, "time_zone": { "type": "string" }, "volume": { "type": "string" }, "state": { "type": "string" }, "vpc": { "type": "string" }, "account": { "type": "string" }, "max_snaps": { "type": "integer" }, "device_id": { "type": "string" } } }, "nxos_install_os": { "required": [ "system_image_file" ], "type": "object", "description": "Install an operating system by setting the boot options like boot image and kickstart image and optionally select to install using ISSU (In Server Software Upgrade).", "properties": { "issu": { "type": "string" }, "system_image_file": { "type": "string" }, "kickstart_image_file": { "type": "string" } } }, "os_user_facts": { "required": [ "name" ], "type": "object", "description": "Retrieve facts about a one or more OpenStack users", "properties": { "domain": { "type": "string" }, "name": { "type": "string" }, "filters": { "type": "string" }, "availability_zone": { "type": "string" } } }, "win_eventlog": { "required": [ "name" ], "type": "object", "description": "Allows the addition, clearing and removal of local Windows event logs, and the creation and removal of sources from a given event log. Also allows the specification of settings per log and source.", "properties": { "name": { "type": "string" }, "parameter_file": { "type": "string" }, "retention_days": { "type": "string" }, "sources": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "message_file": { "type": "string" }, "maximum_size": { "type": "string" }, "category_file": { "type": "string" }, "overflow_action": { "type": "string" } } }, "avi_cluster": { "required": [ "name" ], "type": "object", "description": "This module is used to configure Cluster object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "tenant_ref": { "type": "string" }, "state": { "type": "string" }, "virtual_ip": { "type": "string" }, "nodes": { "items": { "type": "string" }, "type": "array" }, "rejoin_nodes_automatically": { "type": "string" }, "uuid": { "type": "string" } } }, "avi_api_session": { "required": [ "http_method" ], "type": "object", "description": "This module can be used for calling any resources defined in Avi REST API. U(https://avinetworks.com/)\nThis module is useful for invoking HTTP Patch methods and accessing resources that do not have an REST object associated with them.", "properties": { "params": { "type": "string" }, "http_method": { "type": "string" }, "data": { "type": "string" }, "timeout": { "type": "string" }, "path": { "type": "string" } } }, "avi_networkprofile": { "required": [ "profile", "name" ], "type": "object", "description": "This module is used to configure NetworkProfile object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "profile": { "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "tenant_ref": { "type": "string" }, "uuid": { "type": "string" }, "state": { "type": "string" }, "name": { "type": "string" } } }, "avi_backup": { "required": [ "file_name" ], "type": "object", "description": "This module is used to configure Backup object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "scheduler_ref": { "type": "string" }, "uuid": { "type": "string" }, "local_file_url": { "type": "string" }, "url": { "type": "string" }, "file_name": { "type": "string" }, "remote_file_url": { "type": "string" }, "tenant_ref": { "type": "string" }, "backup_config_ref": { "type": "string" }, "state": { "type": "string" }, "timestamp": { "type": "string" } } }, "ce_evpn_global": { "required": [ "evpn_overlay_enable" ], "type": "object", "description": "Manages global configuration of EVPN on HUAWEI CloudEngine switches.", "properties": { "evpn_overlay_enable": { "type": "string" } } }, "ovirt_templates_facts": { "required": [], "type": "object", "description": "Retrieve facts about one or more oVirt/RHV templates.", "properties": { "pattern": { "type": "string" } } }, "iam_policy": { "required": [ "state", "iam_name", "iam_type", "policy_name" ], "type": "object", "description": "Allows uploading or removing IAM policies for IAM users, groups or roles.", "properties": { "policy_document": { "type": "string" }, "iam_name": { "type": "string" }, "iam_type": { "type": "string" }, "policy_name": { "type": "string" }, "state": { "type": "string" }, "policy_json": { "type": "string" }, "skip_duplicates": { "type": "string" } } }, "jenkins_plugin": { "required": [ "name" ], "type": "object", "description": "Ansible module which helps to manage Jenkins plugins.", "properties": { "jenkins_home": { "type": "string" }, "group": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "updates_url": { "type": "string" }, "with_dependencies": { "type": "string" }, "state": { "type": "string" }, "version": { "type": "string" }, "updates_expiration": { "type": "integer" }, "mode": { "type": "string" }, "timeout": { "type": "integer" }, "owner": { "type": "string" } } }, "supervisorctl": { "required": [ "state", "name" ], "type": "object", "description": "Manage the state of a program or group of programs running via supervisord", "properties": { "username": { "type": "string" }, "supervisorctl_path": { "type": "string" }, "name": { "type": "string" }, "server_url": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "password": { "type": "string" }, "config": { "type": "string" } } }, "rax_cbs_attachments": { "required": [ "volume", "state", "server" ], "type": "object", "description": "Manipulate Rackspace Cloud Block Storage Volume Attachments", "properties": { "server": { "type": "string" }, "volume": { "type": "string" }, "state": { "type": "string" }, "wait_timeout": { "type": "integer" }, "device": { "type": "string" }, "wait": { "type": "string" } } }, "parted": { "required": [ "device" ], "type": "object", "description": "This module allows configuring block device partition using the C(parted) command line tool. For a full description of the fields and the options check the GNU parted manual.", "properties": { "part_start": { "type": "string" }, "part_end": { "type": "string" }, "name": { "type": "string" }, "align": { "type": "string" }, "number": { "type": "string" }, "label": { "type": "string" }, "state": { "type": "string" }, "part_type": { "type": "string" }, "flags": { "items": { "type": "string" }, "type": "array" }, "device": { "type": "string" }, "unit": { "type": "string" } } }, "ec2_vpc_vgw": { "required": [], "type": "object", "description": "Creates AWS VPN Virtual Gateways\nDeletes AWS VPN Virtual Gateways\nAttaches Virtual Gateways to VPCs\nDetaches Virtual Gateways from VPCs", "properties": { "name": { "type": "string" }, "tags": { "type": "string" }, "state": { "type": "string" }, "wait_timeout": { "type": "integer" }, "vpc_id": { "type": "string" }, "vpn_gateway_id": { "type": "string" }, "type": { "type": "string" } } }, "vmware_maintenancemode": { "required": [ "esxi_hostname" ], "type": "object", "description": "Place an ESXI host into maintenance mode\nSupport for VSAN compliant maintenance mode when selected", "properties": { "state": { "type": "string" }, "timeout": { "type": "integer" }, "evacuate": { "type": "boolean" }, "esxi_hostname": { "type": "string" }, "vsan_mode": { "type": "string" } } }, "ec2_lc_find": { "required": [ "region", "name_regex" ], "type": "object", "description": "Returns list of matching Launch Configurations for a given name, along with other useful information\nResults can be sorted and sliced\nIt depends on boto\nBased on the work by Tom Bamford (https://github.com/tombamford)", "properties": { "limit": { "items": { "type": "string" }, "type": "array" }, "region": { "type": "string" }, "sort_order": { "type": "string" }, "name_regex": { "type": "string" } } }, "sf_snapshot_schedule_manager": { "required": [ "name", "state" ], "type": "object", "description": "Create, destroy, or update accounts on SolidFire", "properties": { "time_interval_days": { "type": "integer" }, "name": { "type": "string" }, "time_interval_minutes": { "type": "integer" }, "schedule_id": { "type": "string" }, "time_interval_hours": { "type": "integer" }, "paused": { "type": "string" }, "state": { "type": "string" }, "snapshot_name": { "type": "string" }, "volumes": { "type": "string" }, "starting_date": { "type": "string" }, "recurring": { "type": "string" }, "retention": { "type": "string" } } }, "ovirt_storage_domains_facts": { "required": [], "type": "object", "description": "Retrieve facts about one or more oVirt/RHV storage domains.", "properties": { "pattern": { "type": "string" } } }, "digital_ocean_block_storage": { "required": [ "region", "volume_name", "state", "command", "api_token" ], "type": "object", "description": "Create/destroy Block Storage volume in DigitalOcean, or attach/detach Block Storage volume to a droplet.", "properties": { "droplet_id": { "type": "string" }, "description": { "type": "string" }, "region": { "type": "string" }, "api_token": { "type": "string" }, "state": { "type": "string" }, "command": { "type": "string" }, "timeout": { "type": "integer" }, "volume_name": { "type": "string" }, "block_size": { "type": "string" } } }, "netscaler_cs_action": { "required": [], "type": "object", "description": "Manage content switching actions\nThis module is intended to run either on the ansible control node or a bastion (jumpserver) with access to the actual netscaler instance", "properties": { "comment": { "type": "string" }, "targetvserver": { "type": "string" }, "name": { "type": "string" }, "targetvserverexpr": { "type": "string" }, "targetlbvserver": { "type": "string" } } }, "ovirt_vmpools_facts": { "required": [], "type": "object", "description": "Retrieve facts about one or more oVirt/RHV vmpools.", "properties": { "pattern": { "type": "string" } } }, "avi_gslbapplicationpersistenceprofile": { "required": [ "name" ], "type": "object", "description": "This module is used to configure GslbApplicationPersistenceProfile object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "uuid": { "type": "string" }, "url": { "type": "string" }, "description": { "type": "string" }, "tenant_ref": { "type": "string" }, "state": { "type": "string" }, "name": { "type": "string" } } }, "zfs_facts": { "required": [ "name" ], "type": "object", "description": "Gather facts from ZFS dataset properties.", "properties": { "name": { "type": "string" }, "recurse": { "type": "boolean" }, "parsable": { "type": "boolean" }, "depth": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } }, "gce_instance_template": { "required": [ "name" ], "type": "object", "description": "Creates or destroy Google instance templates of Compute Engine of Google Cloud Platform.", "properties": { "automatic_restart": { "type": "string" }, "image": { "type": "string" }, "service_account_permissions": { "type": "string" }, "pem_file": { "type": "string" }, "subnetwork_region": { "type": "string" }, "size": { "type": "string" }, "network": { "type": "string" }, "service_account_email": { "type": "string" }, "nic_gce_struct": { "type": "string" }, "disk_auto_delete": { "type": "boolean" }, "source": { "type": "string" }, "state": { "type": "string" }, "project_id": { "type": "string" }, "preemptible": { "type": "string" }, "metadata": { "type": "string" }, "description": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "image_family": { "type": "string" }, "can_ip_forward": { "type": "boolean" }, "disk_type": { "type": "string" }, "name": { "type": "string" }, "external_ip": { "type": "string" }, "disks": { "items": { "type": "string" }, "type": "array" }, "disks_gce_struct": { "type": "string" }, "credentials_file": { "type": "string" }, "subnetwork": { "type": "string" } } }, "aix_inittab": { "required": [ "action", "command", "name", "runlevel" ], "type": "object", "description": "Manages the inittab on AIX.", "properties": { "name": { "type": "string" }, "insertafter": { "type": "string" }, "state": { "type": "string" }, "command": { "type": "string" }, "runlevel": { "type": "string" }, "action": { "type": "string" } } }, "aci_intf_policy_fc": { "required": [ "fc_policy" ], "type": "object", "description": "Manage ACI Fiber Channel interface policies on Cisco ACI fabrics.\nMore information from the internal APIC class I(fc:IfPol) at U(https://developer.cisco.com/media/mim-ref/MO-fcIfPol.html).", "properties": { "state": { "items": { "type": "string" }, "type": "array" }, "fc_policy": { "type": "string" }, "port_mode": { "type": "string" }, "description": { "type": "string" } } }, "aireos_config": { "required": [], "type": "object", "description": "AireOS does not use a block indent file syntax, so there are no sections or parents. This module provides an implementation for working with AireOS configurations in a deterministic way.", "properties": { "src": { "type": "string" }, "diff_ignore_lines": { "items": { "type": "string" }, "type": "array" }, "after": { "type": "string" }, "lines": { "type": "string" }, "diff_against": { "type": "string" }, "intended_config": { "type": "string" }, "running_config": { "type": "string" }, "save": { "type": "boolean" }, "backup": { "type": "boolean" }, "match": { "type": "string" }, "before": { "type": "string" } } }, "ipa_role": { "required": [ "cn" ], "type": "object", "description": "Add, modify and delete a role within FreeIPA server using FreeIPA API", "properties": { "group": { "items": { "type": "string" }, "type": "array" }, "cn": { "type": "string" }, "service": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "hostgroup": { "items": { "type": "string" }, "type": "array" }, "host": { "items": { "type": "string" }, "type": "array" }, "user": { "items": { "type": "string" }, "type": "array" }, "privilege": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" } } }, "ovirt_disk_facts": { "required": [], "type": "object", "description": "Retrieve facts about one or more oVirt/RHV disks.", "properties": { "pattern": { "type": "string" } } }, "nxos_logging": { "required": [], "type": "object", "description": "This module provides declarative management of logging on Cisco NX-OS devices.", "properties": { "facility_level": { "type": "string" }, "name": { "type": "string" }, "facility": { "type": "string" }, "dest": { "type": "string" }, "dest_level": { "type": "string" }, "purge": { "type": "boolean" }, "state": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" } } }, "bigip_gtm_datacenter": { "required": [ "name" ], "type": "object", "description": "Manage BIG-IP data center configuration. A data center defines the location where the physical network components reside, such as the server and link objects that share the same subnet on the network. This module is able to manipulate the data center definitions in a BIG-IP", "properties": { "description": { "type": "string" }, "enabled": { "type": "string" }, "state": { "type": "string" }, "contact": { "type": "string" }, "location": { "type": "string" }, "name": { "type": "string" } } }, "replace": { "required": [ "path", "regexp" ], "type": "object", "description": "This module will replace all instances of a pattern within a file.\nIt is up to the user to maintain idempotence by ensuring that the same pattern would never match any replacements made.", "properties": { "encoding": { "type": "string" }, "after": { "type": "string" }, "replace": { "type": "string" }, "regexp": { "type": "string" }, "path": { "type": "string" }, "backup": { "type": "string" }, "others": { "type": "string" }, "before": { "type": "string" } } }, "hipchat": { "required": [ "room", "token", "msg" ], "type": "object", "description": "Send a message to a Hipchat room, with options to control the formatting.", "properties": { "from": { "type": "string" }, "room": { "type": "string" }, "color": { "type": "string" }, "msg_format": { "type": "string" }, "token": { "type": "string" }, "api": { "type": "string" }, "notify": { "type": "string" }, "msg": { "type": "string" }, "validate_certs": { "type": "string" } } }, "dnf": { "required": [ "name" ], "type": "object", "description": "Installs, upgrade, removes, and lists packages and groups with the I(dnf) package manager.", "properties": { "autoremove": { "type": "string" }, "name": { "items": { "type": "string" }, "type": "array" }, "list": { "type": "string" }, "disable_gpg_check": { "type": "string" }, "conf_file": { "type": "string" }, "state": { "type": "string" }, "disablerepo": { "type": "string" }, "enablerepo": { "type": "string" }, "installroot": { "type": "string" } } }, "win_nssm": { "required": [ "name" ], "type": "object", "description": "nssm is a service helper which doesn't suck. See U(https://nssm.cc/) for more information.", "properties": { "name": { "type": "string" }, "start_mode": { "type": "string" }, "stderr_file": { "type": "string" }, "app_parameters_free_form": { "type": "string" }, "application": { "type": "string" }, "state": { "type": "string" }, "dependencies": { "type": "string" }, "user": { "type": "string" }, "password": { "type": "string" }, "stdout_file": { "type": "string" }, "app_parameters": { "type": "string" } } }, "avi_cloudconnectoruser": { "required": [ "name" ], "type": "object", "description": "This module is used to configure CloudConnectorUser object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "public_key": { "type": "string" }, "private_key": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "tenant_ref": { "type": "string" }, "state": { "type": "string" }, "uuid": { "type": "string" } } }, "bundler": { "required": [], "type": "object", "description": "Manage installation and Gem version dependencies for Ruby using the Bundler gem", "properties": { "executable": { "type": "string" }, "chdir": { "type": "string" }, "gemfile": { "type": "string" }, "deployment_mode": { "type": "string" }, "user_install": { "type": "string" }, "extra_args": { "type": "string" }, "state": { "type": "string" }, "clean": { "type": "string" }, "binstub_directory": { "type": "string" }, "exclude_groups": { "items": { "type": "string" }, "type": "array" }, "local": { "type": "string" }, "gem_path": { "type": "string" } } }, "udm_group": { "required": [ "name" ], "type": "object", "description": "This module allows to manage user groups on a univention corporate server (UCS). It uses the python API of the UCS to create a new object or edit it.", "properties": { "description": { "type": "string" }, "subpath": { "type": "string" }, "state": { "type": "string" }, "position": { "type": "string" }, "ou": { "type": "string" }, "name": { "type": "string" } } }, "urpmi": { "required": [ "pkg" ], "type": "object", "description": "Manages packages with I(urpmi) (such as for Mageia or Mandriva)", "properties": { "force": { "type": "boolean" }, "state": { "type": "string" }, "no-recommends": { "type": "boolean" }, "update_cache": { "type": "boolean" }, "pkg": { "type": "string" }, "root": { "type": "string" } } }, "cs_router": { "required": [ "name" ], "type": "object", "description": "Start, restart, stop and destroy routers.\nC(state=present) is not able to create routers, use M(cs_network) instead.", "properties": { "account": { "type": "string" }, "name": { "type": "string" }, "zone": { "type": "string" }, "domain": { "type": "string" }, "project": { "type": "string" }, "state": { "type": "string" }, "service_offering": { "type": "string" } } }, "vmware_cluster": { "required": [ "cluster_name", "datacenter_name" ], "type": "object", "description": "Add or remove VMware vSphere clusters.", "properties": { "enable_ha": { "type": "string" }, "enable_vsan": { "type": "string" }, "datacenter_name": { "type": "string" }, "cluster_name": { "type": "string" }, "state": { "type": "string" }, "enable_drs": { "type": "string" } } }, "aci_filter_entry": { "required": [], "type": "object", "description": "Manage filter entries for a filter on Cisco ACI fabrics.\nMore information from the internal APIC class I(vz:Entry) at U(https://developer.cisco.com/media/mim-ref/MO-vzEntry.html).", "properties": { "stateful": { "type": "string" }, "dst_port_start": { "type": "string" }, "dst_port_end": { "type": "string" }, "description": { "type": "string" }, "icmp6_msg_type": { "type": "string" }, "icmp_msg_type": { "type": "string" }, "arp_flag": { "type": "string" }, "ip_protocol": { "type": "string" }, "filter": { "type": "string" }, "state": { "type": "string" }, "dst_port": { "type": "string" }, "entry": { "type": "string" }, "tenant": { "type": "string" }, "ether_type": { "type": "string" } } }, "tower_job_launch": { "required": [ "job_template" ], "type": "object", "description": "Launch an Ansible Tower jobs. See U(https://www.ansible.com/tower) for an overview.", "properties": { "credential": { "type": "string" }, "use_job_endpoint": { "type": "boolean" }, "job_template": { "type": "string" }, "tags": { "type": "string" }, "extra_vars": { "type": "string" }, "job_explanation": { "type": "string" }, "job_type": { "type": "string" }, "limit": { "type": "string" }, "inventory": { "type": "string" } } }, "fortios_address": { "required": [ "name", "state" ], "type": "object", "description": "This module provide management of firewall addresses on FortiOS devices.", "properties": { "comment": { "type": "string" }, "name": { "type": "string" }, "country": { "type": "string" }, "value": { "type": "string" }, "interface": { "type": "string" }, "state": { "type": "string" }, "end_ip": { "type": "string" }, "start_ip": { "type": "string" }, "type": { "type": "string" } } }, "setup": { "required": [], "type": "object", "description": "This module is automatically called by playbooks to gather useful variables about remote hosts that can be used in playbooks. It can also be executed directly by C(/usr/bin/ansible) to check what variables are available to a host. Ansible provides many I(facts) about the system, automatically.\nThis module is also supported for Windows targets.", "properties": { "filter": { "type": "string" }, "gather_subset": { "items": { "type": "string" }, "type": "array" }, "fact_path": { "type": "string" }, "gather_timeout": { "type": "integer" } } }, "ec2_vpc_nat_gateway_facts": { "required": [], "type": "object", "description": "Gets various details related to AWS VPC Managed Nat Gateways", "properties": { "nat_gateway_ids": { "type": "string" }, "filters": { "type": "string" } } }, "aws_ssm_parameter_store": { "required": [ "name" ], "type": "object", "description": "Manage key-value pairs in aws parameter store.", "properties": { "decryption": { "type": "boolean" }, "name": { "type": "string" }, "region": { "type": "string" }, "string_type": { "type": "string" }, "value": { "type": "string" }, "state": { "type": "string" }, "key_id": { "type": "string" }, "overwrite": { "type": "boolean" }, "description": { "type": "string" } } }, "lineinfile": { "required": [ "path" ], "type": "object", "description": "This module ensures a particular line is in a file, or replace an existing line using a back-referenced regular expression.\nThis is primarily useful when you want to change a single line in a file only. See the M(replace) module if you want to change multiple, similar lines or check M(blockinfile) if you want to insert/update/remove a block of lines in a file. For other cases, see the M(copy) or M(template) modules.", "properties": { "insertbefore": { "type": "string" }, "create": { "type": "string" }, "backrefs": { "type": "string" }, "state": { "type": "string" }, "others": { "type": "string" }, "insertafter": { "type": "string" }, "regexp": { "type": "string" }, "path": { "type": "string" }, "backup": { "type": "string" }, "line": { "type": "string" } } }, "asa_acl": { "required": [ "lines" ], "type": "object", "description": "This module allows you to work with access-lists on a Cisco ASA device.", "properties": { "force": { "type": "boolean" }, "after": { "type": "string" }, "lines": { "type": "string" }, "replace": { "type": "string" }, "config": { "type": "string" }, "match": { "type": "string" }, "before": { "type": "string" } } }, "avi_virtualservice": { "required": [ "name" ], "type": "object", "description": "This module is used to configure VirtualService object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "pool_ref": { "type": "string" }, "client_auth": { "type": "string" }, "auto_allocate_ip": { "type": "string" }, "port_uuid": { "type": "string" }, "weight": { "type": "string" }, "availability_zone": { "type": "string" }, "active_standby_se_tag": { "type": "string" }, "tenant_ref": { "type": "string" }, "flow_dist": { "type": "string" }, "ipam_network_subnet": { "type": "string" }, "floating_subnet_uuid": { "type": "string" }, "delay_fairness": { "type": "string" }, "vip": { "items": { "type": "string" }, "type": "array" }, "snat_ip": { "type": "string" }, "traffic_clone_profile_ref": { "items": { "type": "string" }, "type": "array" }, "dns_info": { "type": "string" }, "fqdn": { "type": "string" }, "avi_allocated_vip": { "type": "string" }, "enable_rhi_snat": { "type": "string" }, "service_metadata": { "type": "string" }, "sideband_profile": { "type": "string" }, "vsvip_ref": { "type": "string" }, "requests_rate_limit": { "type": "string" }, "analytics_profile_ref": { "type": "string" }, "ign_pool_net_reach": { "type": "string" }, "vrf_context_ref": { "type": "string" }, "cloud_type": { "type": "string" }, "uuid": { "type": "string" }, "vh_domain_name": { "type": "string" }, "cloud_ref": { "type": "string" }, "ip_address": { "type": "string" }, "se_group_ref": { "type": "string" }, "performance_limits": { "type": "string" }, "ssl_profile_ref": { "type": "string" }, "created_by": { "type": "string" }, "scaleout_ecmp": { "type": "string" }, "max_cps_per_client": { "type": "string" }, "state": { "type": "string" }, "nsx_securitygroup": { "items": { "type": "string" }, "type": "array" }, "subnet": { "type": "string" }, "network_ref": { "type": "string" }, "ssl_sess_cache_avg_size": { "type": "string" }, "vs_datascripts": { "type": "string" }, "remove_listening_port_on_vs_down": { "items": { "type": "string" }, "type": "array" }, "network_profile_ref": { "type": "string" }, "floating_ip": { "type": "string" }, "use_bridge_ip_as_vip": { "type": "string" }, "description": { "type": "string" }, "network_security_policy_ref": { "type": "string" }, "http_policies": { "type": "string" }, "application_profile_ref": { "type": "string" }, "microservice_ref": { "type": "string" }, "host_name_xlate": { "type": "string" }, "services": { "items": { "type": "string" }, "type": "array" }, "connections_rate_limit": { "type": "string" }, "auto_allocate_floating_ip": { "type": "string" }, "server_network_profile_ref": { "type": "string" }, "discovered_network_ref": { "type": "string" }, "pool_group_ref": { "type": "string" }, "east_west_placement": { "type": "string" }, "subnet_uuid": { "type": "string" }, "limit_doser": { "type": "string" }, "name": { "type": "string" }, "service_pool_select": { "type": "string" }, "url": { "type": "string" }, "type": { "type": "string" }, "enable_autogw": { "type": "string" }, "discovered_networks": { "type": "string" }, "enabled": { "type": "string" }, "content_rewrite": { "type": "string" }, "avi_allocated_fip": { "type": "string" }, "ssl_key_and_certificate_refs": { "type": "string" }, "dns_policies": { "type": "string" }, "static_dns_records": { "items": { "type": "string" }, "type": "array" }, "cloud_config_cksum": { "type": "string" }, "analytics_policy": { "type": "string" }, "enable_rhi": { "type": "string" }, "vh_parent_vs_uuid": { "type": "string" }, "discovered_subnet": { "type": "string" }, "flow_label_type": { "type": "string" } } }, "azure_rm_publicipaddress_facts": { "required": [], "type": "object", "description": "Get facts for a specific public IP or all public IPs within a resource group.", "properties": { "name": { "type": "string" }, "resource_group": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } } }, "netscaler_lb_vserver": { "required": [], "type": "object", "description": "Manage load balancing vserver configuration\nThis module is intended to run either on the ansible control node or a bastion (jumpserver) with access to the actual netscaler instance", "properties": { "servicebindings": { "items": { "type": "string" }, "type": "array" }, "rtspnat": { "type": "string" }, "disabled": { "type": "string" }, "macmoderetainvlan": { "type": "string" }, "dbslb": { "type": "string" }, "listenpolicy": { "type": "string" }, "ipmask": { "type": "string" }, "icmpvsrresponse": { "type": "string" }, "vipheader": { "type": "string" }, "pushvserver": { "type": "string" }, "dataoffset": { "type": "string" }, "datalength": { "type": "string" }, "td": { "type": "string" }, "appflowlog": { "type": "string" }, "disableprimaryondown": { "type": "string" }, "processlocal": { "type": "string" }, "minautoscalemembers": { "type": "string" }, "name": { "type": "string" }, "backuplbmethod": { "type": "string" }, "downstateflush": { "type": "string" }, "pushlabel": { "type": "string" }, "timeout": { "type": "string" }, "v6persistmasklen": { "type": "string" }, "recursionavailable": { "type": "string" }, "maxautoscalemembers": { "type": "string" }, "oracleserverversion": { "type": "string" }, "authnprofile": { "type": "string" }, "port": { "type": "string" }, "ssl_certkey": { "type": "string" }, "mysqlcharacterset": { "type": "string" }, "authn401": { "type": "string" }, "authnvsname": { "type": "string" }, "netprofile": { "type": "string" }, "pushmulticlients": { "type": "string" }, "lbmethod": { "type": "string" }, "resrule": { "type": "string" }, "connfailover": { "type": "string" }, "sothreshold": { "type": "string" }, "sopersistence": { "type": "string" }, "dns64": { "type": "string" }, "skippersistency": { "type": "string" }, "tosid": { "type": "string" }, "tcpprofilename": { "type": "string" }, "backuppersistencetimeout": { "type": "string" }, "newservicerequestunit": { "type": "string" }, "listenpriority": { "items": { "type": "string" }, "type": "array" }, "range": { "type": "string" }, "comment": { "type": "string" }, "insertvserveripport": { "type": "string" }, "redirectportrewrite": { "type": "string" }, "clttimeout": { "type": "string" }, "authenticationhost": { "type": "string" }, "servicetype": { "type": "string" }, "mysqlservercapabilities": { "type": "string" }, "httpprofilename": { "type": "string" }, "newservicerequestincrementinterval": { "type": "string" }, "netmask": { "type": "string" }, "somethod": { "type": "string" }, "persistmask": { "type": "string" }, "persistavpno": { "items": { "type": "string" }, "type": "array" }, "dnsprofilename": { "type": "string" }, "rhistate": { "type": "string" }, "bypassaaaa": { "type": "string" }, "cookiename": { "type": "string" }, "mysqlprotocolversion": { "type": "string" }, "redirurl": { "type": "string" }, "servicegroupbindings": { "items": { "type": "string" }, "type": "array" }, "cacheable": { "type": "string" }, "persistencebackup": { "type": "string" }, "mysqlserverversion": { "type": "string" }, "authentication": { "type": "string" }, "healththreshold": { "type": "string" }, "hashlength": { "type": "string" }, "sobackupaction": { "type": "string" }, "l2conn": { "type": "string" }, "v6netmasklen": { "type": "string" }, "sessionless": { "type": "string" }, "ipv46": { "type": "string" }, "persistencetype": { "type": "string" }, "ippattern": { "type": "string" }, "dbprofilename": { "type": "string" }, "m": { "type": "string" }, "mssqlserverversion": { "type": "string" }, "sopersistencetimeout": { "type": "string" }, "newservicerequest": { "type": "string" }, "push": { "type": "string" } } }, "cs_zone": { "required": [ "name" ], "type": "object", "description": "Create, update and remove zones.", "properties": { "internal_dns1": { "type": "string" }, "domain": { "type": "string" }, "name": { "type": "string" }, "dns2": { "type": "string" }, "dns1": { "type": "string" }, "internal_dns2": { "type": "string" }, "id": { "type": "string" }, "guest_cidr_address": { "type": "string" }, "state": { "type": "string" }, "dhcp_provider": { "type": "string" }, "network_domain": { "type": "string" }, "dns2_ipv6": { "type": "string" }, "network_type": { "type": "string" }, "dns1_ipv6": { "type": "string" } } }, "proxysql_query_rules": { "required": [], "type": "object", "description": "The M(proxysql_query_rules) module modifies query rules using the proxysql admin interface.", "properties": { "comment": { "type": "string" }, "flagOUT": { "type": "string" }, "login_user": { "type": "string" }, "login_password": { "type": "string" }, "match_pattern": { "type": "string" }, "mirror_flagOUT": { "type": "string" }, "apply": { "type": "string" }, "schemaname": { "type": "string" }, "replace_pattern": { "type": "string" }, "digest": { "type": "string" }, "match_digest": { "type": "string" }, "mirror_hostgroup": { "type": "string" }, "log": { "type": "string" }, "delay": { "type": "string" }, "state": { "type": "string" }, "proxy_addr": { "type": "string" }, "username": { "type": "string" }, "config_file": { "type": "string" }, "login_port": { "type": "integer" }, "login_host": { "type": "string" }, "destination_hostgroup": { "type": "string" }, "proxy_port": { "type": "string" }, "load_to_runtime": { "type": "boolean" }, "save_to_disk": { "type": "boolean" }, "active": { "type": "string" }, "cache_ttl": { "type": "string" }, "error_msg": { "type": "string" }, "retries": { "type": "string" }, "negate_match_pattern": { "type": "string" }, "flagIN": { "type": "string" }, "client_addr": { "type": "string" }, "timeout": { "type": "string" }, "force_delete": { "type": "boolean" }, "rule_id": { "type": "string" } } }, "ovirt_host_storage_facts": { "required": [ "host" ], "type": "object", "description": "Retrieve facts about one or more oVirt/RHV HostStorages (applicable only for block storage).", "properties": { "fcp": { "type": "string" }, "host": { "items": { "type": "string" }, "type": "array" }, "iscsi": { "type": "string" } } }, "aws_s3_bucket_facts": { "required": [], "type": "object", "description": "Lists S3 buckets in AWS", "properties": {} }, "iam_role": { "required": [ "state", "name", "managed_policy" ], "type": "object", "description": "Manage AWS IAM roles", "properties": { "description": { "type": "string" }, "managed_policy": { "items": { "type": "string" }, "type": "array" }, "assume_role_policy_document": { "type": "string" }, "state": { "type": "string" }, "path": { "type": "string" }, "name": { "type": "string" } } }, "win_psmodule": { "required": [ "name" ], "type": "object", "description": "This module helps to install Powershell modules and register custom modules repository on Windows Server.", "properties": { "url": { "type": "string" }, "allow_clobber": { "type": "boolean" }, "name": { "type": "string" }, "repository": { "type": "string" }, "state": { "type": "string" } } }, "purefa_host": { "required": [ "host" ], "type": "object", "description": "Create, delete or modify hosts on Pure Storage FlashArrays.", "properties": { "protocol": { "type": "string" }, "host": { "type": "string" }, "volume": { "type": "string" }, "state": { "type": "string" }, "iqn": { "items": { "type": "string" }, "type": "array" }, "wwns": { "items": { "type": "string" }, "type": "array" } } }, "ec2_vpc_endpoint_facts": { "required": [ "query" ], "type": "object", "description": "Gets various details related to AWS VPC Endpoints", "properties": { "query": { "type": "string" }, "vpc_endpoint_ids": { "items": { "type": "string" }, "type": "array" }, "filters": { "type": "string" } } }, "win_ping": { "required": [], "type": "object", "description": "Checks management connectivity of a windows host.\nThis is NOT ICMP ping, this is just a trivial test module.\nFor non-Windows targets, use the M(ping) module instead.", "properties": { "data": { "type": "string" } } }, "tower_project": { "required": [ "name" ], "type": "object", "description": "Create, update, or destroy Ansible Tower projects. See U(https://www.ansible.com/tower) for an overview.", "properties": { "scm_branch": { "type": "string" }, "name": { "type": "string" }, "scm_credential": { "type": "string" }, "scm_clean": { "type": "boolean" }, "scm_url": { "type": "string" }, "scm_delete_on_update": { "type": "boolean" }, "state": { "type": "string" }, "local_path": { "type": "string" }, "scm_type": { "type": "string" }, "scm_update_on_launch": { "type": "boolean" }, "organization": { "type": "string" }, "description": { "type": "string" } } }, "elb_classic_lb": { "required": [ "name", "state" ], "type": "object", "description": "Returns information about the load balancer.\nWill be marked changed when called only if state is changed.", "properties": { "purge_subnets": { "type": "boolean" }, "purge_instance_ids": { "type": "boolean" }, "connection_draining_timeout": { "type": "string" }, "access_logs": { "type": "string" }, "state": { "type": "string" }, "purge_listeners": { "items": { "type": "boolean" }, "type": "array" }, "scheme": { "type": "string" }, "subnets": { "items": { "type": "string" }, "type": "array" }, "health_check": { "type": "string" }, "tags": { "type": "string" }, "instance_ids": { "items": { "type": "boolean" }, "type": "array" }, "idle_timeout": { "type": "string" }, "wait_timeout": { "type": "integer" }, "cross_az_load_balancing": { "type": "string" }, "security_group_ids": { "items": { "type": "string" }, "type": "array" }, "purge_zones": { "type": "boolean" }, "wait": { "type": "boolean" }, "zones": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "listeners": { "items": { "type": "string" }, "type": "array" }, "security_group_names": { "items": { "type": "string" }, "type": "array" }, "validate_certs": { "type": "string" }, "stickiness": { "items": { "type": "string" }, "type": "array" } } }, "syslogger": { "required": [ "msg" ], "type": "object", "description": "Uses syslog to add log entries to the host.\nCan specify facility and priority.", "properties": { "msg": { "type": "string" }, "priority": { "type": "string" }, "log_pid": { "type": "string" }, "facility": { "type": "string" } } }, "os_keystone_service": { "required": [ "name", "service_type" ], "type": "object", "description": "Create, update, or delete OpenStack Identity service. If a service with the supplied name already exists, it will be updated with the new description and enabled attributes.", "properties": { "description": { "type": "string" }, "availability_zone": { "type": "string" }, "enabled": { "type": "boolean" }, "state": { "type": "string" }, "service_type": { "type": "string" }, "name": { "type": "string" } } }, "vca_nat": { "required": [ "nat_rules" ], "type": "object", "description": "Adds or removes nat rules from a gateway in a vca environment", "properties": { "nat_rules": { "items": { "type": "boolean" }, "type": "array" }, "purge_rules": { "type": "boolean" } } }, "oneview_enclosure_facts": { "required": [], "type": "object", "description": "Retrieve facts about one or more of the Enclosures from OneView.", "properties": { "name": { "type": "string" }, "options": { "items": { "type": "string" }, "type": "array" } } }, "nxos_acl": { "required": [ "name" ], "type": "object", "description": "Manages access list entries for ACLs.", "properties": { "seq": { "type": "string" }, "time-range": { "type": "string" }, "dest_port_op": { "type": "string" }, "established": { "type": "string" }, "precedence": { "type": "string" }, "proto": { "type": "string" }, "state": { "type": "string" }, "fragments": { "type": "string" }, "src_port1": { "type": "string" }, "src_port2": { "type": "string" }, "src_port_op": { "type": "string" }, "psh": { "type": "string" }, "dest": { "type": "string" }, "syn": { "type": "string" }, "dscp": { "type": "string" }, "rst": { "type": "string" }, "log": { "type": "string" }, "src": { "type": "string" }, "remark": { "type": "string" }, "urg": { "type": "string" }, "name": { "items": { "type": "string" }, "type": "array" }, "ack": { "type": "string" }, "fin": { "type": "string" }, "action": { "type": "string" }, "dest_port1": { "type": "string" }, "dest_port2": { "type": "string" } } }, "avi_ipaddrgroup": { "required": [ "name" ], "type": "object", "description": "This module is used to configure IpAddrGroup object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "prefixes": { "type": "string" }, "uuid": { "type": "string" }, "url": { "type": "string" }, "description": { "type": "string" }, "tenant_ref": { "type": "string" }, "marathon_service_port": { "type": "string" }, "apic_epg_name": { "type": "string" }, "ranges": { "type": "string" }, "state": { "type": "string" }, "addrs": { "type": "string" }, "country_codes": { "type": "string" }, "marathon_app_name": { "type": "string" }, "ip_ports": { "type": "string" }, "name": { "type": "string" } } }, "ovirt_mac_pools": { "required": [ "name" ], "type": "object", "description": "This module manage MAC pools in oVirt/RHV.", "properties": { "allow_duplicates": { "type": "string" }, "ranges": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } } }, "exo_dns_domain": { "required": [ "name" ], "type": "object", "description": "Create and remove domain records.", "properties": { "state": { "type": "string" }, "name": { "type": "string" } } }, "panos_nat_policy": { "required": [ "rule_name", "password", "ip_address", "to_zone", "from_zone" ], "type": "object", "description": "Create a policy nat rule. Keep in mind that we can either end up configuring source NAT, destination NAT, or both. Instead of splitting it into two we will make a fair attempt to determine which one the user wants.", "properties": { "username": { "type": "string" }, "dnat_address": { "type": "string" }, "snat_bidirectional": { "type": "string" }, "to_zone": { "type": "string" }, "snat_type": { "type": "string" }, "service": { "type": "string" }, "source": { "items": { "type": "string" }, "type": "array" }, "from_zone": { "items": { "type": "string" }, "type": "array" }, "destination": { "items": { "type": "string" }, "type": "array" }, "dnat_port": { "type": "string" }, "snat_interface_address": { "type": "string" }, "rule_name": { "type": "string" }, "override": { "type": "string" }, "commit": { "type": "boolean" }, "password": { "type": "string" }, "ip_address": { "type": "string" }, "snat_address": { "type": "string" }, "snat_interface": { "type": "string" } } }, "pn_show": { "required": [ "pn_command" ], "type": "object", "description": "Execute show command in the nodes and returns the results read from the device.", "properties": { "pn_clipassword": { "type": "string" }, "pn_command": { "type": "string" }, "pn_cliusername": { "type": "string" }, "pn_parameters": { "items": { "type": "string" }, "type": "array" }, "pn_options": { "type": "string" }, "pn_cliswitch": { "type": "string" } } }, "sensu_handler": { "required": [ "name", "handlers", "type" ], "type": "object", "description": "Manages Sensu handler configuration\nFor more information, refer to the Sensu documentation: U(https://sensuapp.org/docs/latest/reference/handlers.html)", "properties": { "pipe": { "type": "string" }, "name": { "type": "string" }, "handlers": { "type": "string" }, "timeout": { "type": "integer" }, "severities": { "type": "string" }, "filter": { "type": "string" }, "mutator": { "type": "string" }, "state": { "type": "string" }, "command": { "type": "string" }, "filters": { "type": "string" }, "handle_flapping": { "type": "boolean" }, "handle_silenced": { "type": "boolean" }, "type": { "type": "string" }, "socket": { "type": "string" } } }, "a10_server": { "required": [ "server_name" ], "type": "object", "description": "Manage SLB (Server Load Balancer) server objects on A10 Networks devices via aXAPIv2.", "properties": { "server_name": { "type": "string" }, "server_ports": { "items": { "type": "string" }, "type": "array" }, "partition": { "type": "string" }, "server_status": { "type": "string" }, "state": { "type": "string" }, "server_ip": { "type": "string" }, "validate_certs": { "type": "string" } } }, "win_security_policy": { "required": [ "section", "key", "value" ], "type": "object", "description": "Allows you to set the local security policies that are configured by SecEdit.exe.", "properties": { "section": { "type": "string" }, "value": { "type": "string" }, "key": { "type": "string" } } }, "win_iis_webbinding": { "required": [ "name" ], "type": "object", "description": "Creates, Removes and configures a binding to an existing IIS Web site", "properties": { "protocol": { "type": "string" }, "name": { "type": "string" }, "certificate_hash": { "type": "string" }, "ip": { "type": "string" }, "host_header": { "type": "string" }, "state": { "type": "string" }, "port": { "type": "string" }, "certificate_store_name": { "type": "string" } } }, "rhn_channel": { "required": [ "sysname", "name", "url", "password", "user" ], "type": "object", "description": "Adds or removes Red Hat software channels.", "properties": { "sysname": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "state": { "type": "string" }, "user": { "type": "string" }, "password": { "type": "string" } } }, "netscaler_service": { "required": [], "type": "object", "description": "Manage service configuration in Netscaler.\nThis module allows the creation, deletion and modification of Netscaler services.\nThis module is intended to run either on the ansible control node or a bastion (jumpserver) with access to the actual netscaler instance.\nThis module supports check mode.", "properties": { "comment": { "type": "string" }, "tcpb": { "type": "string" }, "cachetype": { "type": "string" }, "maxbandwidth": { "type": "string" }, "ip": { "type": "string" }, "servername": { "type": "string" }, "disabled": { "type": "boolean" }, "maxreq": { "type": "string" }, "monitor_bindings": { "items": { "type": "string" }, "type": "array" }, "graceful": { "type": "boolean" }, "svrtimeout": { "type": "string" }, "port": { "type": "string" }, "clttimeout": { "type": "string" }, "servicetype": { "type": "string" }, "cacheable": { "type": "boolean" }, "pathmonitor": { "type": "string" }, "maxclient": { "type": "string" }, "ipaddress": { "type": "string" }, "usip": { "type": "string" }, "netprofile": { "type": "string" }, "customserverid": { "type": "string" }, "td": { "type": "string" }, "httpprofilename": { "type": "string" }, "pathmonitorindv": { "type": "string" }, "cleartextport": { "type": "string" }, "appflowlog": { "type": "string" }, "rtspsessionidremap": { "type": "boolean" }, "monthreshold": { "type": "string" }, "hashid": { "type": "string" }, "serverid": { "type": "string" }, "processlocal": { "type": "string" }, "accessdown": { "type": "boolean" }, "name": { "type": "string" }, "tcpprofilename": { "type": "string" }, "sp": { "type": "string" }, "downstateflush": { "type": "string" }, "cipheader": { "type": "string" }, "cip": { "type": "string" }, "healthmonitor": { "type": "boolean" }, "useproxyport": { "type": "string" }, "cka": { "type": "string" }, "dnsprofilename": { "type": "string" }, "cmp": { "type": "string" } } }, "aci_config_snapshot": { "required": [], "type": "object", "description": "Manage Config Snapshots on Cisco ACI fabrics.\nCreating new Snapshots is done using the configExportP class.\nRemoving Snapshots is done using the configSnapshot class.\nMore information from the internal APIC classes I(config:Snapshot) at U(https://developer.cisco.com/media/mim-ref/MO-configSnapshot.html) and I(config:ExportP) at U(https://developer.cisco.com/media/mim-ref/MO-configExportP.html).", "properties": { "export_policy": { "type": "string" }, "description": { "type": "string" }, "format": { "type": "string" }, "include_secure": { "type": "string" }, "max_count": { "type": "integer" }, "state": { "items": { "type": "string" }, "type": "array" }, "snapshot": { "type": "string" } } }, "sts_assume_role": { "required": [ "role_session_name", "role_arn" ], "type": "object", "description": "Assume a role using AWS Security Token Service and obtain temporary credentials", "properties": { "role_arn": { "type": "string" }, "duration_seconds": { "type": "string" }, "mfa_serial_number": { "type": "string" }, "role_session_name": { "type": "string" }, "mfa_token": { "type": "string" }, "policy": { "type": "string" }, "external_id": { "type": "string" } } }, "rax_cdb_user": { "required": [], "type": "object", "description": "create / delete a database in the Cloud Databases.", "properties": { "db_password": { "type": "string" }, "host": { "type": "string" }, "state": { "type": "string" }, "cdb_id": { "type": "string" }, "db_username": { "type": "string" }, "databases": { "type": "string" } } }, "proxmox": { "required": [ "api_host", "api_user" ], "type": "object", "description": "allows you to create/delete/stop instances in Proxmox VE cluster\nStarting in Ansible 2.1, it automatically detects containerization type (lxc for PVE 4, openvz for older)", "properties": { "force": { "type": "boolean" }, "cpus": { "type": "integer" }, "ostemplate": { "type": "string" }, "unprivileged": { "type": "boolean" }, "disk": { "type": "integer" }, "searchdomain": { "type": "string" }, "api_user": { "type": "string" }, "hostname": { "type": "string" }, "storage": { "type": "string" }, "state": { "type": "string" }, "swap": { "type": "integer" }, "memory": { "type": "integer" }, "pubkey": { "type": "string" }, "node": { "type": "string" }, "cpuunits": { "type": "integer" }, "api_password": { "type": "string" }, "password": { "type": "string" }, "ip_address": { "type": "string" }, "pool": { "type": "string" }, "netif": { "type": "string" }, "api_host": { "type": "string" }, "vmid": { "type": "string" }, "timeout": { "type": "integer" }, "mounts": { "type": "string" }, "cores": { "type": "integer" }, "nameserver": { "type": "string" }, "validate_certs": { "type": "boolean" }, "onboot": { "type": "boolean" } } }, "vmware_migrate_vmk": { "required": [ "current_switch_name", "migrate_portgroup_name", "esxi_hostname", "device", "migrate_switch_name", "current_portgroup_name" ], "type": "object", "description": "Migrate a VMK interface from VSS to VDS", "properties": { "current_switch_name": { "type": "string" }, "migrate_portgroup_name": { "type": "string" }, "esxi_hostname": { "type": "string" }, "device": { "type": "string" }, "migrate_switch_name": { "type": "string" }, "current_portgroup_name": { "type": "string" } } }, "win_scheduled_task": { "required": [ "name" ], "type": "object", "description": "Creates/modified or removes Windows scheduled tasks.", "properties": { "run_only_if_network_available": { "type": "string" }, "update_password": { "type": "string" }, "execution_time_limit": { "type": "string" }, "actions": { "items": { "type": "string" }, "type": "array" }, "frequency": { "items": { "type": "string" }, "type": "array" }, "path": { "type": "string" }, "wake_to_run": { "type": "string" }, "run_only_if_idle": { "type": "string" }, "executable": { "items": { "type": "string" }, "type": "array" }, "group": { "type": "string" }, "author": { "type": "string" }, "restart_count": { "type": "string" }, "compatibility": { "type": "string" }, "priority": { "type": "string" }, "source": { "type": "string" }, "state": { "type": "string" }, "version": { "type": "string" }, "allow_demand_start": { "type": "string" }, "arguments": { "items": { "type": "string" }, "type": "array" }, "logon_type": { "type": "string" }, "hidden": { "type": "string" }, "username": { "type": "string" }, "stop_if_going_on_batteries": { "type": "string" }, "disallow_start_if_on_batteries": { "type": "string" }, "description": { "type": "string" }, "delete_expired_task_after": { "type": "string" }, "days_of_week": { "items": { "type": "string" }, "type": "array" }, "restart_interval": { "type": "string" }, "start_when_available": { "type": "string" }, "date": { "type": "string" }, "display_name": { "type": "string" }, "password": { "type": "string" }, "run_level": { "type": "string" }, "multiple_instances": { "type": "string" }, "name": { "type": "string" }, "triggers": { "items": { "type": "string" }, "type": "array" }, "enabled": { "type": "string" }, "store_password": { "type": "string" }, "allow_hard_terminate": { "type": "string" }, "time": { "items": { "type": "string" }, "type": "array" } } }, "portinstall": { "required": [ "name" ], "type": "object", "description": "Manage packages for FreeBSD using 'portinstall'.", "properties": { "state": { "type": "string" }, "use_packages": { "type": "boolean" }, "name": { "type": "string" } } }, "ce_bgp_af": { "required": [ "af_type", "vrf_name" ], "type": "object", "description": "Manages BGP Address-family configurations on HUAWEI CloudEngine switches.", "properties": { "ingress_lsp_policy_name": { "type": "string" }, "vrf_rid_auto_sel": { "type": "string" }, "preference_internal": { "type": "string" }, "maximum_load_balance": { "type": "string" }, "preference_local": { "type": "string" }, "preference_external": { "type": "string" }, "router_id_neglect": { "type": "string" }, "default_local_pref": { "type": "string" }, "reflector_cluster_ipv4": { "type": "string" }, "prefrence_policy_name": { "type": "string" }, "nhp_relay_route_policy_name": { "type": "string" }, "reflector_cluster_id": { "type": "string" }, "as_path_neglect": { "type": "string" }, "auto_frr_enable": { "type": "string" }, "mask_len": { "type": "string" }, "ibgp_ecmp_nexthop_changed": { "type": "string" }, "af_type": { "type": "string" }, "nexthop_third_party": { "type": "string" }, "state": { "type": "string" }, "default_med": { "type": "string" }, "add_path_sel_num": { "type": "string" }, "med_none_as_maximum": { "type": "string" }, "ecmp_nexthop_changed": { "type": "string" }, "lowest_priority": { "type": "string" }, "rr_filter_number": { "type": "string" }, "import_process_id": { "type": "string" }, "router_id": { "type": "string" }, "determin_med": { "type": "string" }, "reflect_chg_path": { "type": "string" }, "load_balancing_as_path_ignore": { "type": "string" }, "ebgp_ecmp_nexthop_changed": { "type": "string" }, "always_compare_med": { "type": "string" }, "policy_ext_comm_enable": { "type": "string" }, "allow_invalid_as": { "type": "string" }, "relay_delay_enable": { "type": "string" }, "rib_only_policy_name": { "type": "string" }, "max_load_ebgp_num": { "type": "string" }, "import_protocol": { "type": "string" }, "ebgp_if_sensitive": { "type": "string" }, "network_address": { "type": "string" }, "supernet_uni_adv": { "type": "string" }, "next_hop_sel_depend_type": { "type": "string" }, "default_rt_import_enable": { "type": "string" }, "originator_prior": { "type": "string" }, "active_route_advertise": { "type": "string" }, "reflect_between_client": { "type": "string" }, "policy_vpn_target": { "type": "string" }, "summary_automatic": { "type": "string" }, "rib_only_enable": { "type": "string" }, "max_load_ibgp_num": { "type": "string" }, "route_sel_delay": { "type": "string" }, "supernet_label_adv": { "type": "string" }, "vrf_name": { "type": "string" }, "igp_metric_ignore": { "type": "string" } } }, "data_pipeline": { "required": [ "name" ], "type": "object", "description": "Create and manage AWS Datapipelines. Creation is not idempotent in AWS, so the uniqueId is created by hashing the options (minus objects) given to the datapipeline.\nThe pipeline definition must be in the format given here U(http://docs.aws.amazon.com/datapipeline/latest/APIReference/API_PutPipelineDefinition.html#API_PutPipelineDefinition_RequestSyntax).\nAlso operations will wait for a configurable amount of time to ensure the pipeline is in the requested state.", "properties": { "name": { "type": "string" }, "parameters": { "items": { "type": "string" }, "type": "array" }, "tags": { "type": "string" }, "state": { "type": "string" }, "objects": { "items": { "type": "string" }, "type": "array" }, "values": { "items": { "type": "string" }, "type": "array" }, "timeout": { "type": "integer" }, "description": { "type": "string" } } }, "bigip_wait": { "required": [], "type": "object", "description": "You can wait for BIG-IP to be \"ready\". By \"ready\", we mean that BIG-IP is ready to accept configuration.\nThis module can take into account situations where the device is in the middle of rebooting due to a configuration change.", "properties": { "delay": { "type": "integer" }, "msg": { "type": "string" }, "sleep": { "type": "integer" }, "timeout": { "type": "integer" } } }, "ovirt_nics": { "required": [ "name" ], "type": "object", "description": "Module to manage network interfaces of Virtual Machines in oVirt/RHV.", "properties": { "profile": { "type": "string" }, "network": { "type": "string" }, "vm": { "type": "string" }, "state": { "type": "string" }, "template": { "type": "string" }, "mac_address": { "type": "string" }, "interface": { "type": "string" }, "name": { "type": "string" } } }, "opkg": { "required": [ "name" ], "type": "object", "description": "Manages OpenWrt packages", "properties": { "update_cache": { "type": "string" }, "state": { "type": "string" }, "force": { "type": "string" }, "name": { "type": "string" } } }, "debug": { "required": [], "type": "object", "description": "This module prints statements during execution and can be useful for debugging variables or expressions without necessarily halting the playbook. Useful for debugging together with the 'when:' directive.\nThis module is also supported for Windows targets.", "properties": { "msg": { "type": "string" }, "var": { "type": "string" }, "verbosity": { "type": "integer" } } }, "win_dns_client": { "required": [ "adapter_names", "ipv4_addresses" ], "type": "object", "description": "The C(win_dns_client) module configures the DNS client on Windows network adapters.", "properties": { "adapter_names": { "items": { "type": "string" }, "type": "array" }, "ipv4_addresses": { "items": { "type": "string" }, "type": "array" } } }, "vdirect_commit": { "required": [ "vdirect_user", "vdirect_ip", "devices", "vdirect_password" ], "type": "object", "description": "Commits pending configuration changes on one or more Radware devices via vDirect server.\nFor Alteon ADC device, apply, sync and save actions will be performed by default. Skipping of an action is possible by explicit parameter specifying.\nFor Alteon VX Container device, no sync operation will be performed since sync action is only relevant for Alteon ADC devices.\nFor DefensePro and AppWall devices, a bulk commit action will be performed. Explicit apply, sync and save actions specifying is not relevant.", "properties": { "vdirect_user": { "type": "string" }, "vdirect_http_port": { "type": "integer" }, "vdirect_validate_certs": { "type": "string" }, "vdirect_timeout": { "type": "integer" }, "vdirect_wait": { "type": "string" }, "vdirect_https_port": { "type": "integer" }, "devices": { "items": { "type": "string" }, "type": "array" }, "vdirect_ip": { "type": "string" }, "sync": { "type": "string" }, "apply": { "type": "string" }, "vdirect_secondary_ip": { "type": "string" }, "save": { "type": "string" }, "vdirect_use_ssl": { "type": "string" }, "vdirect_password": { "type": "string" } } }, "cloudscale_server": { "required": [], "type": "object", "description": "Create, start, stop and delete servers on the cloudscale.ch IaaS service.\nAll operations are performed using the cloudscale.ch public API v1.\nFor details consult the full API documentation: U(https://www.cloudscale.ch/en/api/v1).\nA valid API token is required for all operations. You can create as many tokens as you like using the cloudscale.ch control panel at U(https://control.cloudscale.ch).", "properties": { "anti_affinity_with": { "type": "string" }, "uuid": { "type": "string" }, "use_public_network": { "type": "boolean" }, "image": { "type": "string" }, "api_timeout": { "type": "integer" }, "api_token": { "type": "string" }, "user_data": { "type": "string" }, "bulk_volume_size_gb": { "type": "string" }, "volume_size_gb": { "type": "integer" }, "use_private_network": { "type": "boolean" }, "state": { "type": "string" }, "use_ipv6": { "type": "boolean" }, "flavor": { "type": "string" }, "ssh_keys": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" } } }, "proxysql_scheduler": { "required": [ "filename" ], "type": "object", "description": "The M(proxysql_scheduler) module adds or removes schedules using the proxysql admin interface.", "properties": { "comment": { "type": "string" }, "login_port": { "type": "integer" }, "config_file": { "type": "string" }, "state": { "type": "string" }, "arg1": { "type": "string" }, "login_user": { "type": "string" }, "arg2": { "type": "string" }, "arg3": { "type": "string" }, "arg4": { "type": "string" }, "arg5": { "type": "string" }, "filename": { "type": "string" }, "force_delete": { "type": "boolean" }, "interval_ms": { "type": "integer" }, "load_to_runtime": { "type": "boolean" }, "login_password": { "type": "string" }, "active": { "type": "boolean" }, "save_to_disk": { "type": "boolean" }, "login_host": { "type": "string" } } }, "homebrew_cask": { "required": [ "name" ], "type": "object", "description": "Manages Homebrew casks.", "properties": { "update_homebrew": { "type": "boolean" }, "path": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "name": { "type": "string" }, "install_options": { "type": "string" } } }, "vmware_guest_powerstate": { "required": [], "type": "object", "description": "Power on / Power off / Restart a virtual machine.", "properties": { "name": { "type": "string" }, "state": { "type": "string" }, "folder": { "type": "string" }, "name_match": { "type": "string" }, "uuid": { "type": "string" } } }, "azure_rm_availabilityset_facts": { "required": [], "type": "object", "description": "Get facts for a specific availability set or all availability sets.", "properties": { "name": { "type": "string" }, "resource_group": { "type": "string" } } }, "import_playbook": { "required": [], "type": "object", "description": "Includes a file with a list of plays to be executed.\nFiles with a list of plays can only be included at the top level. You cannot use this action inside a play.", "properties": { "free-form": { "type": "string" } } }, "cs_instancegroup": { "required": [ "name" ], "type": "object", "description": "Create and remove instance groups.", "properties": { "project": { "type": "string" }, "account": { "type": "string" }, "state": { "type": "string" }, "domain": { "type": "string" }, "name": { "type": "string" } } }, "cs_vmsnapshot": { "required": [ "vm", "name" ], "type": "object", "description": "Create, remove and revert VM from snapshots.", "properties": { "snapshot_memory": { "type": "boolean" }, "domain": { "type": "string" }, "poll_async": { "type": "boolean" }, "description": { "type": "string" }, "zone": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "vm": { "type": "string" }, "project": { "type": "string" }, "state": { "type": "string" }, "account": { "type": "string" }, "name": { "type": "string" } } }, "pn_vrouterbgp": { "required": [ "pn_vrouter_name", "state" ], "type": "object", "description": "Execute vrouter-bgp-add, vrouter-bgp-remove, vrouter-bgp-modify command.\nEach fabric, cluster, standalone switch, or virtual network (VNET) can provide its tenants with a vRouter service that forwards traffic between networks and implements Layer 4 protocols.", "properties": { "pn_vrouter_name": { "type": "string" }, "pn_soft_reconfig": { "type": "string" }, "pn_ebgp": { "type": "string" }, "pn_route_reflector": { "type": "string" }, "pn_keepalive": { "type": "string" }, "pn_multiprotocol": { "type": "string" }, "pn_prefix_listout": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "pn_cliswitch": { "type": "string" }, "pn_max_prefix": { "type": "string" }, "pn_route_mapout": { "type": "string" }, "pn_bfd": { "type": "string" }, "pn_override_capability": { "type": "string" }, "pn_route_mapin": { "type": "string" }, "pn_prefix_listin": { "items": { "type": "string" }, "type": "array" }, "pn_password": { "type": "string" }, "pn_neighbor": { "type": "string" }, "pn_default_originate": { "type": "string" }, "pn_cliusername": { "type": "string" }, "pn_weight": { "type": "string" }, "pn_clipassword": { "type": "string" }, "pn_remote_as": { "type": "string" }, "pn_max_prefix_warn": { "type": "string" }, "pn_holdtime": { "type": "string" }, "pn_next_hop_self": { "type": "string" } } }, "iosxr_interface": { "required": [ "name" ], "type": "object", "description": "This module provides declarative management of Interfaces on Cisco IOS XR network devices.", "properties": { "delay": { "type": "integer" }, "name": { "type": "string" }, "duplex": { "type": "string" }, "enabled": { "type": "string" }, "mtu": { "type": "string" }, "rx_rate": { "type": "string" }, "state": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" }, "speed": { "type": "string" }, "tx_rate": { "type": "string" }, "description": { "type": "string" } } }, "panos_object": { "required": [ "password", "ip_address", "operation" ], "type": "object", "description": "- Policy objects form the match criteria for policy rules and many other functions in PAN-OS. These may include address object, address groups, service objects, service groups, and tag.\n", "properties": { "username": { "type": "string" }, "servicegroup": { "type": "string" }, "api_key": { "type": "string" }, "static_value": { "type": "string" }, "description": { "type": "string" }, "color": { "type": "string" }, "dynamic_value": { "type": "string" }, "protocol": { "type": "string" }, "addressgroup": { "type": "string" }, "addressobject": { "type": "string" }, "source_port": { "type": "string" }, "tag_name": { "type": "string" }, "address_type": { "type": "string" }, "serviceobject": { "type": "string" }, "address": { "type": "string" }, "services": { "type": "string" }, "devicegroup": { "type": "string" }, "destination_port": { "type": "string" }, "password": { "type": "string" }, "ip_address": { "type": "string" }, "operation": { "type": "string" } } }, "cnos_backup": { "required": [ "serverpassword", "configType", "protocol", "serverusername", "rcserverip", "rcpath" ], "type": "object", "description": "This module allows you to work with switch configurations. It provides a way to back up the running or startup configurations of a switch to a remote server. This is achieved by periodically saving a copy of the startup or running configuration of the network device to a remote server using FTP, SFTP, TFTP, or SCP. The first step is to create a directory from where the remote server can be reached. The next step is to provide the full file path of the location where the configuration will be backed up. Authentication details required by the remote server must be provided as well. This module uses SSH to manage network device configuration. The results of the operation will be placed in a directory named 'results' that must be created by the user in their local directory to where the playbook is run. For more information about this module from Lenovo and customizing it usage for your use cases, please visit U(http://systemx.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.switchmgt.ansible.doc%2Fcnos_backup.html)", "properties": { "serverpassword": { "type": "string" }, "protocol": { "type": "string" }, "configType": { "type": "string" }, "serverusername": { "type": "string" }, "rcserverip": { "type": "string" }, "rcpath": { "type": "string" } } }, "os_subnet": { "required": [ "name" ], "type": "object", "description": "Add or Remove a subnet to an OpenStack network", "properties": { "no_gateway_ip": { "type": "boolean" }, "use_default_subnetpool": { "type": "boolean" }, "enable_dhcp": { "type": "boolean" }, "availability_zone": { "type": "string" }, "dns_nameservers": { "items": { "type": "string" }, "type": "array" }, "gateway_ip": { "type": "string" }, "project": { "type": "string" }, "ipv6_ra_mode": { "type": "string" }, "state": { "type": "string" }, "allocation_pool_start": { "type": "string" }, "host_routes": { "items": { "type": "string" }, "type": "array" }, "ip_version": { "type": "integer" }, "ipv6_address_mode": { "type": "string" }, "cidr": { "type": "string" }, "network_name": { "type": "string" }, "allocation_pool_end": { "type": "string" }, "name": { "type": "string" } } }, "eos_user": { "required": [], "type": "object", "description": "This module provides declarative management of the local usernames configured on Arista EOS devices. It allows playbooks to manage either individual usernames or the collection of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined.", "properties": { "update_password": { "type": "string" }, "configured_password": { "type": "string" }, "name": { "type": "string" }, "nopassword": { "type": "string" }, "purge": { "type": "boolean" }, "privilege": { "type": "string" }, "state": { "type": "string" }, "role": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" }, "sshkey": { "type": "string" } } }, "azure_rm_deployment": { "required": [ "resource_group_name" ], "type": "object", "description": "Create or destroy Azure Resource Manager template deployments via the Azure SDK for Python. You can find some quick start templates in GitHub here https://github.com/azure/azure-quickstart-templates. For more information on Azue resource manager templates see https://azure.microsoft.com/en-us/documentation/articles/resource-group-template-deploy/.", "properties": { "resource_group_name": { "type": "string" }, "parameters": { "type": "string" }, "deployment_name": { "type": "string" }, "wait_for_deployment_polling_period": { "type": "integer" }, "template_link": { "type": "string" }, "state": { "type": "string" }, "location": { "type": "string" }, "wait_for_deployment_completion": { "type": "boolean" }, "parameters_link": { "type": "string" }, "deployment_mode": { "type": "string" }, "template": { "type": "string" } } }, "packet_sshkey": { "required": [], "type": "object", "description": "Create/delete an SSH key in Packet host.\nAPI is documented at U(https://www.packet.net/help/api/#page:ssh-keys,header:ssh-keys-ssh-keys-post).", "properties": { "auth_token": { "type": "string" }, "label": { "type": "string" }, "state": { "type": "string" }, "key": { "type": "string" }, "fingerprint": { "type": "string" }, "key_file": { "type": "string" }, "id": { "type": "string" } } }, "nmcli": { "required": [ "conn_name", "state" ], "type": "object", "description": "Manage the network devices. Create, modify, and manage, ethernet, teams, bonds, vlans etc.", "properties": { "conn_name": { "type": "string" }, "ingress": { "type": "string" }, "slavepriority": { "type": "integer" }, "path_cost": { "type": "integer" }, "vlandev": { "type": "string" }, "forwarddelay": { "type": "integer" }, "primary": { "type": "string" }, "hairpin": { "type": "boolean" }, "egress": { "type": "string" }, "ageingtime": { "type": "integer" }, "mtu": { "type": "integer" }, "arp_ip_target": { "type": "string" }, "maxage": { "type": "integer" }, "vlanid": { "type": "string" }, "priority": { "type": "integer" }, "gw4": { "type": "string" }, "state": { "type": "string" }, "gw6": { "type": "string" }, "master": { "type": "string" }, "flags": { "type": "string" }, "ifname": { "type": "string" }, "type": { "type": "string" }, "miimon": { "type": "integer" }, "hellotime": { "type": "integer" }, "downdelay": { "type": "string" }, "mac": { "type": "string" }, "ip6": { "type": "string" }, "ip4": { "type": "string" }, "autoconnect": { "type": "string" }, "dns6": { "items": { "type": "string" }, "type": "array" }, "dns4": { "items": { "type": "string" }, "type": "array" }, "arp_interval": { "type": "string" }, "stp": { "type": "string" }, "mode": { "type": "string" }, "updelay": { "type": "string" } } }, "avi_ipamdnsproviderprofile": { "required": [ "name", "type" ], "type": "object", "description": "This module is used to configure IpamDnsProviderProfile object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "openstack_profile": { "type": "string" }, "name": { "type": "string" }, "gcp_profile": { "type": "string" }, "proxy_configuration": { "type": "string" }, "infoblox_profile": { "type": "string" }, "tenant_ref": { "type": "string" }, "internal_profile": { "type": "string" }, "custom_profile": { "type": "string" }, "url": { "type": "string" }, "state": { "type": "string" }, "aws_profile": { "type": "string" }, "type": { "type": "string" }, "uuid": { "type": "string" } } }, "cnos_portchannel": { "required": [ "interfaceRange", "interfaceArg1" ], "type": "object", "description": "This module allows you to work with port aggregation related configurations. The operators used are overloaded to ensure control over switch port aggregation configurations. Apart from the regular device connection related attributes, there are five LAG arguments which are overloaded variables that will perform further configurations. They are interfaceArg1, interfaceArg2, interfaceArg3, interfaceArg4, and interfaceArg5. For more details on how to use these arguments, see [Overloaded Variables]. This module uses SSH to manage network device configuration. The results of the operation will be placed in a directory named 'results' that must be created by the user in their local directory to where the playbook is run. For more information about this module from Lenovo and customizing it usage for your use cases, please U(http://systemx.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.switchmgt.ansible.doc%2Fcnos_portchannel.html)", "properties": { "interfaceRange": { "type": "string" }, "interfaceArg4": { "type": "string" }, "interfaceArg5": { "type": "string" }, "interfaceArg6": { "type": "string" }, "interfaceArg7": { "type": "string" }, "interfaceArg1": { "type": "string" }, "interfaceArg2": { "type": "string" }, "interfaceArg3": { "type": "string" } } }, "sf_volume_manager": { "required": [ "name", "account_id", "state" ], "type": "object", "description": "Create, destroy, or update volumes on SolidFire", "properties": { "qos": { "type": "string" }, "name": { "type": "string" }, "size_unit": { "type": "string" }, "access": { "type": "string" }, "state": { "type": "string" }, "volume_id": { "type": "string" }, "512emulation": { "type": "string" }, "attributes": { "type": "string" }, "size": { "type": "string" }, "account_id": { "type": "string" } } }, "net_system": { "required": [], "type": "object", "description": "This module provides declarative management of node system attributes on network devices. It provides an option to configure host system parameters or remove those parameters from the device active configuration.", "properties": { "lookup_source": { "type": "string" }, "domain_search": { "items": { "type": "string" }, "type": "array" }, "hostname": { "type": "string" }, "domain_name": { "type": "string" }, "state": { "type": "string" }, "name_servers": { "items": { "type": "string" }, "type": "array" } } }, "ce_interface_ospf": { "required": [ "area", "process_id", "interface" ], "type": "object", "description": "Manages configuration of an OSPF interface instanceon HUAWEI CloudEngine switches.", "properties": { "process_id": { "type": "string" }, "cost": { "type": "string" }, "area": { "type": "string" }, "silent_interface": { "type": "boolean" }, "auth_mode": { "type": "string" }, "auth_key_id": { "type": "string" }, "auth_text_simple": { "type": "string" }, "state": { "type": "string" }, "dead_interval": { "type": "string" }, "hello_interval": { "type": "string" }, "auth_text_md5": { "type": "string" }, "interface": { "type": "string" } } }, "cloudwatchevent_rule": { "required": [ "name" ], "type": "object", "description": "This module creates and manages CloudWatch event rules and targets.", "properties": { "role_arn": { "type": "string" }, "description": { "type": "string" }, "event_pattern": { "type": "string" }, "schedule_expression": { "type": "string" }, "state": { "type": "string" }, "targets": { "type": "string" }, "name": { "type": "string" } } }, "gc_storage": { "required": [ "gs_access_key", "bucket", "mode", "gs_secret_key" ], "type": "object", "description": "This module allows users to manage their objects/buckets in Google Cloud Storage. It allows upload and download operations and can set some canned permissions. It also allows retrieval of URLs for objects for use in playbooks, and retrieval of string contents of objects. This module requires setting the default project in GCS prior to playbook usage. See U(https://developers.google.com/storage/docs/reference/v1/apiversion1) for information about setting the default project.", "properties": { "src": { "type": "string" }, "force": { "type": "boolean" }, "permission": { "type": "string" }, "dest": { "type": "string" }, "gs_access_key": { "type": "string" }, "object": { "type": "string" }, "bucket": { "type": "string" }, "headers": { "type": "string" }, "gs_secret_key": { "type": "string" }, "mode": { "type": "string" }, "region": { "type": "string" }, "versioning": { "type": "string" }, "expiration": { "type": "string" } } }, "rabbitmq_policy": { "required": [ "name", "tags", "pattern" ], "type": "object", "description": "Manage the state of a virtual host in RabbitMQ.", "properties": { "node": { "type": "string" }, "name": { "type": "string" }, "tags": { "type": "string" }, "pattern": { "type": "string" }, "priority": { "type": "integer" }, "vhost": { "type": "string" }, "state": { "type": "string" }, "apply_to": { "type": "string" } } }, "route53_facts": { "required": [ "query" ], "type": "object", "description": "Gets various details related to Route53 zone, record set or health check details", "properties": { "start_record_name": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" }, "resource_id": { "type": "string" }, "hosted_zone_method": { "items": { "type": "string" }, "type": "array" }, "dns_name": { "items": { "type": "string" }, "type": "array" }, "health_check_method": { "items": { "type": "string" }, "type": "array" }, "max_items": { "items": { "type": "string" }, "type": "array" }, "hosted_zone_id": { "type": "string" }, "health_check_id": { "type": "string" }, "change_id": { "type": "string" }, "query": { "type": "string" }, "next_marker": { "items": { "type": "string" }, "type": "array" }, "delegation_set_id": { "type": "string" } } }, "rax_mon_notification_plan": { "required": [ "label" ], "type": "object", "description": "Create or delete a Rackspace Cloud Monitoring notification plan by associating existing rax_mon_notifications with severity levels. Rackspace monitoring module flow | rax_mon_entity -> rax_mon_check -> rax_mon_notification -> *rax_mon_notification_plan* -> rax_mon_alarm", "properties": { "ok_state": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "warning_state": { "items": { "type": "string" }, "type": "array" }, "critical_state": { "items": { "type": "string" }, "type": "array" }, "label": { "type": "string" } } }, "bigip_provision": { "required": [ "name" ], "type": "object", "description": "Manage BIG-IP module provisioning. This module will only provision at the standard levels of Dedicated, Nominal, and Minimum.", "properties": { "state": { "type": "string" }, "name": { "type": "string" }, "level": { "type": "string" } } }, "elasticache": { "required": [ "name", "state" ], "type": "object", "description": "Manage cache clusters in Amazon Elasticache.\nReturns information about the specified cache cluster.", "properties": { "engine": { "type": "string" }, "cache_port": { "type": "string" }, "security_group_ids": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "cache_engine_version": { "type": "string" }, "node_type": { "type": "string" }, "num_nodes": { "type": "string" }, "state": { "type": "string" }, "cache_security_groups": { "items": { "type": "string" }, "type": "array" }, "zone": { "type": "string" }, "hard_modify": { "type": "boolean" }, "cache_subnet_group": { "type": "string" }, "cache_parameter_group": { "type": "string" }, "wait": { "type": "boolean" } } }, "aos_rack_type": { "required": [ "session" ], "type": "object", "description": "Apstra AOS Rack Type module let you manage your Rack Type easily. You can create create and delete Rack Type by Name, ID or by using a JSON File. This module is idempotent and support the I(check) mode. It's using the AOS REST API.", "properties": { "content": { "type": "string" }, "state": { "type": "string" }, "session": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "string" } } }, "apt_repository": { "required": [ "repo" ], "type": "object", "description": "Add or remove an APT repositories in Ubuntu and Debian.", "properties": { "filename": { "items": { "type": "string" }, "type": "array" }, "repo": { "type": "string" }, "state": { "type": "string" }, "update_cache": { "type": "string" }, "mode": { "items": { "type": "integer" }, "type": "array" }, "codename": { "type": "string" }, "validate_certs": { "type": "string" } } }, "ecs_attribute": { "required": [ "cluster", "ec2_instance_id", "attributes" ], "type": "object", "description": "Create, update or delete ECS container instance attributes.", "properties": { "cluster": { "type": "string" }, "state": { "type": "string" }, "ec2_instance_id": { "type": "string" }, "attributes": { "items": { "type": "string" }, "type": "array" } } }, "ipa_host": { "required": [ "fqdn" ], "type": "object", "description": "Add, modify and delete an IPA host using IPA API", "properties": { "force": { "type": "string" }, "description": { "type": "string" }, "user_certificate": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "fqdn": { "type": "string" }, "ip_address": { "type": "string" }, "ns_os_version": { "type": "string" }, "mac_address": { "items": { "type": "string" }, "type": "array" }, "ns_host_location": { "type": "string" }, "ns_hardware_platform": { "type": "string" }, "update_dns": { "type": "boolean" } } }, "oneview_logical_interconnect_group": { "required": [ "data" ], "type": "object", "description": "Provides an interface to manage Logical Interconnect Group resources. Can create, update, or delete.", "properties": { "state": { "type": "string" }, "data": { "items": { "type": "string" }, "type": "array" } } }, "win_domain_controller": { "required": [ "domain_admin_user", "domain_admin_password" ], "type": "object", "description": "Ensure that a Windows Server 2012+ host is configured as a domain controller or demoted to member server. This module may require subsequent use of the M(win_reboot) action if changes are made.", "properties": { "domain_admin_user": { "type": "string" }, "dns_domain_name": { "type": "string" }, "safe_mode_password": { "type": "string" }, "domain_admin_password": { "type": "string" }, "state": { "type": "string" }, "local_admin_password": { "type": "string" } } }, "vsphere_copy": { "required": [ "src", "datacenter", "host", "path", "login", "password", "datastore" ], "type": "object", "description": "Upload files to a vCenter datastore", "properties": { "src": { "type": "string" }, "datacenter": { "type": "string" }, "host": { "type": "string" }, "path": { "type": "string" }, "login": { "type": "string" }, "password": { "type": "string" }, "validate_certs": { "type": "string" }, "datastore": { "type": "string" } } }, "avi_prioritylabels": { "required": [ "name" ], "type": "object", "description": "This module is used to configure PriorityLabels object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "description": { "type": "string" }, "cloud_ref": { "type": "string" }, "tenant_ref": { "type": "string" }, "uuid": { "type": "string" }, "url": { "type": "string" }, "state": { "type": "string" }, "equivalent_labels": { "type": "string" }, "name": { "type": "string" } } }, "os_project_facts": { "required": [ "name" ], "type": "object", "description": "Retrieve facts about a one or more OpenStack projects", "properties": { "domain": { "type": "string" }, "name": { "type": "string" }, "filters": { "type": "string" }, "availability_zone": { "type": "string" } } }, "rax_network": { "required": [], "type": "object", "description": "creates / deletes a Rackspace Public Cloud isolated network.", "properties": { "state": { "type": "string" }, "cidr": { "type": "string" }, "label": { "type": "string" } } }, "ce_aaa_server_host": { "required": [], "type": "object", "description": "Manages AAA server host configuration on HUAWEI CloudEngine switches.", "properties": { "radius_server_port": { "type": "string" }, "hwtacacs_server_ipv6": { "type": "string" }, "local_service_type": { "type": "string" }, "hwtacacs_server_type": { "type": "string" }, "radius_server_ipv6": { "type": "string" }, "radius_server_type": { "type": "string" }, "hwtacacs_server_ip": { "type": "string" }, "local_user_group": { "type": "string" }, "local_user_level": { "type": "string" }, "radius_vpn_name": { "type": "string" }, "hwtacacs_vpn_name": { "type": "string" }, "hwtacacs_is_secondary_server": { "type": "boolean" }, "local_password": { "type": "string" }, "state": { "type": "string" }, "local_user_name": { "type": "string" }, "radius_server_name": { "type": "string" }, "radius_server_mode": { "type": "string" }, "radius_server_ip": { "type": "string" }, "local_ftp_dir": { "type": "string" }, "radius_group_name": { "type": "string" }, "hwtacacs_template": { "type": "string" }, "hwtacacs_server_host_name": { "type": "string" }, "hwtacacs_is_public_net": { "type": "boolean" } } }, "add_host": { "required": [ "name" ], "type": "object", "description": "Use variables to create new hosts and groups in inventory for use in later plays of the same playbook. Takes variables so you can define the new hosts more fully.\nThis module is also supported for Windows targets.", "properties": { "name": { "type": "string" }, "groups": { "type": "string" } } }, "cs_resourcelimit": { "required": [ "resource_type" ], "type": "object", "description": "Manage limits of resources for domains, accounts and projects.", "properties": { "project": { "type": "string" }, "domain": { "type": "string" }, "limit": { "type": "integer" }, "account": { "type": "string" }, "resource_type": { "type": "string" } } }, "nxos_vpc": { "required": [ "domain", "auto_recovery", "peer_gw", "state" ], "type": "object", "description": "Manages global VPC configuration", "properties": { "domain": { "type": "string" }, "system_priority": { "type": "string" }, "role_priority": { "type": "string" }, "auto_recovery": { "type": "string" }, "pkl_vrf": { "type": "string" }, "delay_restore": { "type": "string" }, "peer_gw": { "type": "string" }, "state": { "type": "string" }, "pkl_dest": { "type": "string" }, "pkl_src": { "type": "string" } } }, "solaris_zone": { "required": [ "name", "state" ], "type": "object", "description": "Create, start, stop and delete Solaris zones. This module doesn't currently allow changing of options for a zone that's already been created.", "properties": { "install_options": { "type": "string" }, "timeout": { "type": "integer" }, "name": { "type": "string" }, "create_options": { "type": "string" }, "state": { "type": "string" }, "root_password": { "type": "string" }, "sparse": { "type": "string" }, "path": { "type": "string" }, "config": { "items": { "type": "string" }, "type": "array" }, "attach_options": { "type": "string" } } }, "win_domain_group": { "required": [ "name" ], "type": "object", "description": "Creates, modifies or removes groups in Active Directory.\nFor local groups, use the M(win_group) module instead.", "properties": { "category": { "type": "string" }, "protect": { "type": "string" }, "display_name": { "type": "string" }, "description": { "type": "string" }, "domain_username": { "type": "string" }, "ignore_protection": { "type": "string" }, "state": { "type": "string" }, "domain_password": { "type": "string" }, "organizational_unit": { "type": "string" }, "scope": { "type": "string" }, "managed_by": { "type": "string" }, "attributes": { "type": "string" }, "name": { "type": "string" } } }, "vmware_vm_vss_dvs_migrate": { "required": [ "vm_name", "dvportgroup_name" ], "type": "object", "description": "Migrates a virtual machine from a standard vswitch to distributed", "properties": { "vm_name": { "type": "string" }, "dvportgroup_name": { "type": "string" } } }, "cnos_save": { "required": [], "type": "object", "description": "This module allows you to copy the running configuration of a switch over its startup configuration. It is recommended to use this module shortly after any major configuration changes so they persist after a switch restart. This module uses SSH to manage network device configuration. The results of the operation will be placed in a directory named 'results' that must be created by the user in their local directory to where the playbook is run. For more information about this module from Lenovo and customizing it usage for your use cases, please visit U(http://systemx.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.switchmgt.ansible.doc%2Fcnos_save.html)", "properties": {} }, "azure_rm_resourcegroup_facts": { "required": [], "type": "object", "description": "Get facts for a specific resource group or all resource groups.", "properties": { "name": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } } }, "bigip_remote_syslog": { "required": [ "remote_host" ], "type": "object", "description": "Manipulate remote syslog settings on a BIG-IP.", "properties": { "local_ip": { "type": "string" }, "remote_host": { "type": "string" }, "remote_port": { "type": "string" } } }, "netscaler": { "required": [ "name", "nsc_host", "user", "password" ], "type": "object", "description": "Manages Citrix NetScaler server and service entities.", "properties": { "name": { "type": "string" }, "validate_certs": { "type": "string" }, "nsc_protocol": { "type": "string" }, "nsc_host": { "type": "string" }, "user": { "type": "string" }, "action": { "type": "string" }, "password": { "type": "string" }, "type": { "type": "string" } } }, "azure_rm_dnszone": { "required": [ "name", "resource_group" ], "type": "object", "description": "Creates and deletes Azure DNS zones.", "properties": { "state": { "type": "string" }, "name": { "type": "string" }, "resource_group": { "type": "string" } } }, "junos_command": { "required": [], "type": "object", "description": "Sends an arbitrary set of commands to an JUNOS node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.", "properties": { "retries": { "type": "integer" }, "commands": { "type": "string" }, "rpcs": { "items": { "type": "string" }, "type": "array" }, "interval": { "type": "integer" }, "wait_for": { "type": "string" }, "display": { "type": "string" }, "match": { "type": "string" } } }, "apache2_module": { "required": [ "name" ], "type": "object", "description": "Enables or disables a specified module of the Apache2 webserver.", "properties": { "state": { "type": "string" }, "force": { "type": "boolean" }, "name": { "type": "string" }, "ignore_configcheck": { "type": "boolean" } } }, "lxc_container": { "required": [ "name" ], "type": "object", "description": "Management of LXC containers", "properties": { "zfs_root": { "type": "string" }, "clone_name": { "type": "boolean" }, "container_config": { "items": { "type": "string" }, "type": "array" }, "fs_type": { "type": "string" }, "archive": { "type": "boolean" }, "container_log": { "type": "boolean" }, "state": { "type": "string" }, "template": { "type": "string" }, "config": { "type": "string" }, "archive_path": { "type": "string" }, "container_log_level": { "type": "string" }, "template_options": { "type": "string" }, "container_command": { "type": "string" }, "lxc_path": { "type": "string" }, "archive_compression": { "type": "string" }, "thinpool": { "type": "string" }, "clone_snapshot": { "type": "boolean" }, "name": { "type": "string" }, "lv_name": { "type": "string" }, "fs_size": { "type": "string" }, "backing_store": { "type": "string" }, "vg_name": { "type": "string" }, "directory": { "type": "string" } } }, "eos_eapi": { "required": [], "type": "object", "description": "Use to enable or disable eAPI access, and set the port and state of http, https, local_http and unix-socket servers.\nWhen enabling eAPI access the default is to enable HTTP on port 80, enable HTTPS on port 443, disable local HTTP, and disable Unix socket server. Use the options listed below to override the default configuration.\nRequires EOS v4.12 or greater.", "properties": { "local_http_port": { "items": { "type": "integer" }, "type": "array" }, "http_port": { "items": { "type": "integer" }, "type": "array" }, "http": { "type": "boolean" }, "https_port": { "items": { "type": "integer" }, "type": "array" }, "state": { "type": "string" }, "vrf": { "items": { "type": "string" }, "type": "array" }, "https": { "type": "boolean" }, "config": { "type": "string" }, "local_http": { "type": "boolean" }, "socket": { "items": { "type": "boolean" }, "type": "array" } } }, "win_file": { "required": [ "path" ], "type": "object", "description": "Creates (empty) files, updates file modification stamps of existing files, and can create or remove directories.\nUnlike M(file), does not modify ownership, permissions or manipulate links.\nFor non-Windows targets, use the M(file) module instead.", "properties": { "path": { "type": "string" }, "state": { "type": "string" } } }, "rax": { "required": [], "type": "object", "description": "creates / deletes a Rackspace Public Cloud instance and optionally waits for it to be 'running'.", "properties": { "boot_volume_terminate": { "type": "boolean" }, "image": { "type": "string" }, "user_data": { "type": "string" }, "meta": { "type": "string" }, "flavor": { "type": "string" }, "networks": { "type": "string" }, "boot_from_volume": { "type": "string" }, "group": { "type": "string" }, "exact_count": { "type": "boolean" }, "disk_config": { "type": "string" }, "state": { "type": "string" }, "key_name": { "type": "string" }, "boot_volume_size": { "type": "integer" }, "config_drive": { "type": "boolean" }, "files": { "type": "string" }, "auto_increment": { "type": "boolean" }, "count_offset": { "type": "integer" }, "boot_volume": { "type": "string" }, "wait_timeout": { "type": "integer" }, "instance_ids": { "items": { "type": "string" }, "type": "array" }, "wait": { "type": "string" }, "count": { "type": "integer" }, "name": { "type": "string" }, "extra_client_args": { "type": "string" }, "extra_create_args": { "type": "string" } } }, "cs_ip_address": { "required": [], "type": "object", "description": "Acquires and associates a public IP to an account or project. Due to API limitations this is not an idempotent call, so be sure to only conditionally call this when C(state=present)", "properties": { "domain": { "type": "string" }, "poll_async": { "type": "boolean" }, "network": { "type": "string" }, "zone": { "type": "string" }, "account": { "type": "string" }, "project": { "type": "string" }, "vpc": { "type": "string" }, "ip_address": { "type": "string" } } }, "ce_vrf_interface": { "required": [ "vrf", "vpn_interface" ], "type": "object", "description": "Manages interface specific VPN configuration of HUAWEI CloudEngine switches.", "properties": { "state": { "type": "string" }, "vrf": { "type": "string" }, "vpn_interface": { "type": "string" } } }, "ec2_vpc_igw_facts": { "required": [], "type": "object", "description": "Gather facts about internet gateways in AWS.", "properties": { "filters": { "type": "string" }, "internet_gateway_ids": { "items": { "type": "string" }, "type": "array" } } }, "zypper_repository": { "required": [], "type": "object", "description": "Add or remove Zypper repositories on SUSE and openSUSE", "properties": { "priority": { "type": "string" }, "name": { "type": "string" }, "auto_import_keys": { "type": "string" }, "description": { "type": "string" }, "enabled": { "type": "string" }, "disable_gpg_check": { "type": "string" }, "repo": { "type": "string" }, "state": { "type": "string" }, "overwrite_multiple": { "type": "string" }, "runrefresh": { "items": { "type": "string" }, "type": "array" }, "autorefresh": { "type": "string" } } }, "aos_login": { "required": [ "server" ], "type": "object", "description": "Obtain the AOS server session token by providing the required username and password credentials. Upon successful authentication, this module will return the session-token that is required by all subsequent AOS module usage. On success the module will automatically populate ansible facts with the variable I(aos_session) This module is not idempotent and do not support check mode.", "properties": { "passwd": { "type": "string" }, "port": { "type": "integer" }, "user": { "type": "string" }, "server": { "type": "string" } } }, "aci_tenant_span_src_group": { "required": [], "type": "object", "description": "Manage SPAN source groups on Cisco ACI fabrics.\nMore information from the internal APIC class I(span:SrcGrp) at U(https://developer.cisco.com/media/mim-ref/MO-spanSrcGrp.html).", "properties": { "description": { "type": "string" }, "src_group": { "type": "string" }, "state": { "items": { "type": "string" }, "type": "array" }, "admin_state": { "type": "string" }, "dst_group": { "type": "string" }, "tenant": { "type": "string" } } }, "ce_info_center_log": { "required": [], "type": "object", "description": "Setting the Timestamp Format of Logs. Configuring the Device to Output Logs to the Log Buffer.", "properties": { "log_level": { "type": "string" }, "log_enable": { "type": "string" }, "log_buff_size": { "type": "string" }, "channel_id": { "type": "string" }, "state": { "type": "string" }, "log_buff_enable": { "type": "string" }, "log_time_stamp": { "type": "string" }, "module_name": { "type": "string" } } }, "netscaler_ssl_certkey": { "required": [], "type": "object", "description": "Manage ssl cerificate keys.", "properties": { "certkey": { "type": "string" }, "passplain": { "type": "string" }, "inform": { "type": "string" }, "cert": { "type": "string" }, "key": { "type": "string" }, "notificationperiod": { "type": "string" }, "expirymonitor": { "type": "string" }, "password": { "type": "string" } } }, "netapp_e_snapshot_images": { "required": [ "state", "api_url", "snapshot_group", "api_username", "api_password" ], "type": "object", "description": "Create and delete snapshots images on snapshot groups for NetApp E-series storage arrays.\nOnly the oldest snapshot image can be deleted so consistency is preserved.\nRelated: Snapshot volumes are created from snapshot images.", "properties": { "api_url": { "type": "string" }, "api_password": { "type": "string" }, "state": { "type": "string" }, "snapshot_group": { "type": "string" }, "api_username": { "type": "string" }, "validate_certs": { "type": "boolean" } } }, "nxos_pim": { "required": [ "ssm_range" ], "type": "object", "description": "Manages configuration of a Protocol Independent Multicast (PIM) instance.", "properties": { "ssm_range": { "type": "string" } } }, "ec2_lc": { "required": [ "name", "instance_type", "state" ], "type": "object", "description": "Can create or delete AWS Autoscaling Configurations\nWorks with the ec2_asg module to manage Autoscaling Groups", "properties": { "ebs_optimized": { "type": "boolean" }, "spot_price": { "type": "string" }, "name": { "type": "string" }, "instance_profile_name": { "type": "string" }, "user_data_path": { "type": "string" }, "kernel_id": { "type": "string" }, "key_name": { "type": "string" }, "ramdisk_id": { "type": "string" }, "user_data": { "type": "string" }, "vpc_id": { "type": "string" }, "instance_id": { "type": "string" }, "image_id": { "type": "string" }, "state": { "type": "string" }, "placement_tenancy": { "type": "string" }, "volumes": { "items": { "type": "string" }, "type": "array" }, "assign_public_ip": { "type": "string" }, "instance_monitoring": { "type": "boolean" }, "classic_link_vpc_id": { "type": "string" }, "instance_type": { "type": "string" }, "security_groups": { "items": { "type": "string" }, "type": "array" }, "classic_link_vpc_security_groups": { "items": { "type": "string" }, "type": "array" } } }, "vyos_system": { "required": [], "type": "object", "description": "Runs one or more commands on remote devices running VyOS. This module can also be introspected to validate key parameters before returning successfully.", "properties": { "domain_search": { "items": { "type": "string" }, "type": "array" }, "hostname": { "type": "string" }, "domain_name": { "type": "string" }, "name_server": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" } } }, "proxysql_replication_hostgroups": { "required": [ "reader_hostgroup", "writer_hostgroup" ], "type": "object", "description": "Each row in mysql_replication_hostgroups represent a pair of writer_hostgroup and reader_hostgroup. ProxySQL will monitor the value of read_only for all the servers in specified hostgroups, and based on the value of read_only will assign the server to the writer or reader hostgroups.", "properties": { "comment": { "type": "string" }, "login_port": { "type": "integer" }, "reader_hostgroup": { "type": "string" }, "config_file": { "type": "string" }, "login_user": { "type": "string" }, "login_host": { "type": "string" }, "login_password": { "type": "string" }, "writer_hostgroup": { "type": "string" }, "state": { "type": "string" }, "load_to_runtime": { "type": "boolean" }, "save_to_disk": { "type": "boolean" } } }, "ce_command": { "required": [ "commands" ], "type": "object", "description": "Sends an arbitrary command to an HUAWEI CloudEngine node and returns the results read from the device. The ce_command module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.", "properties": { "retries": { "type": "integer" }, "commands": { "type": "string" }, "wait_for": { "type": "string" }, "match": { "type": "string" }, "interval": { "type": "integer" } } }, "cs_user": { "required": [ "username" ], "type": "object", "description": "Create, update, disable, lock, enable and remove users.", "properties": { "username": { "type": "string" }, "keys_registered": { "type": "string" }, "account": { "type": "string" }, "last_name": { "type": "string" }, "poll_async": { "type": "boolean" }, "first_name": { "type": "string" }, "state": { "type": "string" }, "domain": { "type": "string" }, "timezone": { "type": "string" }, "password": { "type": "string" }, "email": { "type": "string" } } }, "grove": { "required": [ "message", "channel_token" ], "type": "object", "description": "The C(grove) module sends a message for a service to a Grove.io channel.", "properties": { "service": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "channel_token": { "type": "string" }, "message": { "type": "string" }, "validate_certs": { "type": "string" } } }, "avi_trafficcloneprofile": { "required": [ "name" ], "type": "object", "description": "This module is used to configure TrafficCloneProfile object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "name": { "type": "string" }, "cloud_ref": { "type": "string" }, "tenant_ref": { "type": "string" }, "uuid": { "type": "string" }, "url": { "type": "string" }, "state": { "type": "string" }, "preserve_client_ip": { "type": "string" }, "clone_servers": { "type": "string" } } }, "cs_serviceoffer": { "required": [ "name" ], "type": "object", "description": "Create and delete service offerings for guest and system VMs.\nUpdate display_text of existing service offering.", "properties": { "offer_ha": { "type": "boolean" }, "domain": { "type": "string" }, "host_tags": { "type": "string" }, "is_system": { "type": "boolean" }, "storage_type": { "type": "string" }, "is_volatile": { "type": "boolean" }, "network_rate": { "type": "string" }, "cpu_speed": { "type": "string" }, "service_offering_details": { "type": "string" }, "disk_iops_max": { "type": "string" }, "disk_iops_read_rate": { "type": "string" }, "bytes_read_rate": { "type": "string" }, "state": { "type": "string" }, "disk_iops_min": { "type": "string" }, "disk_iops_write_rate": { "type": "string" }, "provisioning_type": { "type": "string" }, "hypervisor_snapshot_reserve": { "type": "string" }, "display_text": { "type": "string" }, "system_vm_type": { "type": "string" }, "limit_cpu_usage": { "type": "string" }, "memory": { "type": "string" }, "storage_tags": { "type": "string" }, "deployment_planner": { "type": "string" }, "cpu_number": { "type": "string" }, "name": { "type": "string" }, "disk_iops_customized": { "type": "boolean" }, "bytes_write_rate": { "type": "string" } } }, "ovirt_tags_facts": { "required": [], "type": "object", "description": "Retrieve facts about one or more oVirt/RHV tags.", "properties": { "host": { "items": { "type": "string" }, "type": "array" }, "name": { "items": { "type": "string" }, "type": "array" }, "vm": { "items": { "type": "string" }, "type": "array" } } }, "azure_rm_virtualmachineimage_facts": { "required": [ "location" ], "type": "object", "description": "Get facts for virtual machine images.", "properties": { "sku": { "items": { "type": "string" }, "type": "array" }, "publisher": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "offer": { "items": { "type": "string" }, "type": "array" }, "version": { "type": "string" }, "location": { "items": { "type": "string" }, "type": "array" } } }, "manageiq_tags": { "required": [ "resource_name", "resource_type" ], "type": "object", "description": "The manageiq_tags module supports adding, updating and deleting tags in ManageIQ.", "properties": { "state": { "items": { "type": "string" }, "type": "array" }, "resource_name": { "type": "string" }, "resource_type": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } } }, "imc_rest": { "required": [ "hostname" ], "type": "object", "description": "Provides direct access to the Cisco IMC REST API.\nPerform any configuration changes and actions that the Cisco IMC supports.\nMore information about the IMC REST API is available from U(http://www.cisco.com/c/en/us/td/docs/unified_computing/ucs/c/sw/api/3_0/b_Cisco_IMC_api_301.html)", "properties": { "username": { "type": "string" }, "protocol": { "type": "string" }, "hostname": { "type": "string" }, "content": { "type": "string" }, "timeout": { "type": "integer" }, "path": { "type": "string" }, "password": { "type": "string" }, "validate_certs": { "type": "string" } } }, "runit": { "required": [ "name" ], "type": "object", "description": "Controls runit services on remote hosts using the sv utility.", "properties": { "state": { "type": "string" }, "enabled": { "type": "string" }, "name": { "type": "string" }, "service_src": { "type": "string" }, "service_dir": { "type": "string" } } }, "swupd": { "required": [], "type": "object", "description": "Manages updates and bundles with the swupd bundle manager, which is used by the Clear Linux Project for Intel Architecture.", "properties": { "contenturl": { "type": "string" }, "name": { "type": "string" }, "format": { "type": "string" }, "url": { "type": "string" }, "verify": { "type": "string" }, "update": { "type": "boolean" }, "manifest": { "type": "string" }, "state": { "type": "string" }, "versionurl": { "type": "string" } } }, "aci_epg_to_contract": { "required": [ "contract_type" ], "type": "object", "description": "Bind EPGs to Contracts on Cisco ACI fabrics.\nMore information from the internal APIC classes I(fv:RsCons) at U(https://developer.cisco.com/media/mim-ref/MO-fvRsCons.html) and I(fv:RsProv) at U(https://developer.cisco.com/media/mim-ref/MO-fvRsProv.html).", "properties": { "contract": { "type": "string" }, "priority": { "type": "string" }, "ap": { "type": "string" }, "state": { "items": { "type": "string" }, "type": "array" }, "contract_type": { "type": "string" }, "epg": { "type": "string" }, "provider_match": { "type": "string" }, "tenant": { "type": "string" } } }, "azure_rm_virtualmachine_scaleset": { "required": [ "resource_group", "image", "vm_size", "capacity", "name" ], "type": "object", "description": "Create and update a virtual machine scale set.", "properties": { "remove_on_absent": { "items": { "type": "string" }, "type": "array" }, "capacity": { "type": "string" }, "name": { "type": "string" }, "resource_group": { "type": "string" }, "virtual_network_name": { "type": "string" }, "image": { "type": "string" }, "state": { "type": "string" }, "admin_username": { "type": "string" }, "upgrade_policy": { "type": "string" }, "managed_disk_type": { "type": "string" }, "ssh_public_keys": { "items": { "type": "string" }, "type": "array" }, "subnet_name": { "type": "string" }, "admin_password": { "type": "string" }, "os_disk_caching": { "type": "string" }, "tier": { "type": "string" }, "vm_size": { "items": { "type": "string" }, "type": "array" }, "data_disks": { "items": { "type": "string" }, "type": "array" }, "ssh_password_enabled": { "type": "boolean" }, "os_type": { "type": "string" }, "location": { "type": "string" } } }, "ec2_vpc": { "required": [ "state", "resource_tags" ], "type": "object", "description": "Create or terminates AWS virtual private clouds. This module has a dependency on python-boto.", "properties": { "subnets": { "items": { "type": "string" }, "type": "array" }, "route_tables": { "items": { "type": "string" }, "type": "array" }, "dns_support": { "type": "string" }, "internet_gateway": { "type": "string" }, "instance_tenancy": { "type": "string" }, "state": { "type": "string" }, "wait_timeout": { "type": "integer" }, "dns_hostnames": { "type": "string" }, "resource_tags": { "items": { "type": "string" }, "type": "array" }, "vpc_id": { "type": "string" }, "cidr_block": { "type": "string" }, "wait": { "type": "string" } } }, "bigip_configsync_action": { "required": [ "device_group" ], "type": "object", "description": "Allows one to run different config-sync actions. These actions allow you to manually sync your configuration across multiple BIG-IPs when those devices are in an HA pair.", "properties": { "overwrite_config": { "type": "boolean" }, "sync_device_to_group": { "type": "string" }, "sync_most_recent_to_device": { "type": "string" }, "device_group": { "type": "string" } } }, "layman": { "required": [ "name" ], "type": "object", "description": "Uses Layman to manage an additional repositories for the Portage package manager on Gentoo Linux. Please note that Layman must be installed on a managed node prior using this module.", "properties": { "list_url": { "items": { "type": "string" }, "type": "array" }, "validate_certs": { "type": "string" }, "name": { "type": "string" }, "state": { "type": "string" } } }, "ce_vlan": { "required": [], "type": "object", "description": "Manages VLAN configurations on Huawei CloudEngine switches.", "properties": { "state": { "type": "string" }, "vlan_range": { "type": "string" }, "name": { "type": "string" }, "vlan_id": { "type": "string" }, "description": { "type": "string" } } }, "iptables": { "required": [], "type": "object", "description": "Iptables is used to set up, maintain, and inspect the tables of IP packet filter rules in the Linux kernel.\nThis module does not handle the saving and/or loading of rules, but rather only manipulates the current rules that are present in memory. This is the same as the behaviour of the C(iptables) and C(ip6tables) command which this module uses internally.", "properties": { "tcp_flags": { "items": { "type": "string" }, "type": "array" }, "comment": { "type": "string" }, "log_prefix": { "type": "string" }, "protocol": { "type": "string" }, "chain": { "type": "string" }, "ip_version": { "type": "string" }, "out_interface": { "type": "string" }, "limit_burst": { "type": "string" }, "ctstate": { "items": { "type": "string" }, "type": "array" }, "jump": { "type": "string" }, "to_ports": { "type": "string" }, "flush": { "type": "string" }, "table": { "type": "string" }, "icmp_type": { "type": "string" }, "to_destination": { "type": "string" }, "uid_owner": { "type": "string" }, "set_dscp_mark_class": { "type": "string" }, "destination": { "type": "string" }, "set_dscp_mark": { "type": "string" }, "source": { "type": "string" }, "state": { "type": "string" }, "policy": { "type": "string" }, "set_counters": { "type": "string" }, "match": { "type": "string" }, "goto": { "type": "string" }, "fragment": { "type": "string" }, "to_source": { "type": "string" }, "syn": { "type": "string" }, "action": { "type": "string" }, "destination_port": { "type": "string" }, "reject_with": { "type": "string" }, "limit": { "type": "string" }, "source_port": { "type": "string" }, "in_interface": { "type": "string" } } }, "rax_mon_entity": { "required": [ "label" ], "type": "object", "description": "Create or delete a Rackspace Cloud Monitoring entity, which represents a device to monitor. Entities associate checks and alarms with a target system and provide a convenient, centralized place to store IP addresses. Rackspace monitoring module flow | *rax_mon_entity* -> rax_mon_check -> rax_mon_notification -> rax_mon_notification_plan -> rax_mon_alarm", "properties": { "state": { "type": "string" }, "metadata": { "type": "string" }, "agent_id": { "type": "string" }, "named_ip_addresses": { "type": "string" }, "label": { "type": "string" } } }, "vyos_command": { "required": [ "commands" ], "type": "object", "description": "The command module allows running one or more commands on remote devices running VyOS. This module can also be introspected to validate key parameters before returning successfully. If the conditional statements are not met in the wait period, the task fails.\nCertain C(show) commands in VyOS produce many lines of output and use a custom pager that can cause this module to hang. If the value of the environment variable C(ANSIBLE_VYOS_TERMINAL_LENGTH) is not set, the default number of 10000 is used.", "properties": { "retries": { "type": "integer" }, "commands": { "type": "string" }, "wait_for": { "type": "string" }, "match": { "type": "string" }, "interval": { "type": "integer" } } }, "webfaction_db": { "required": [ "name", "login_password", "type", "login_name" ], "type": "object", "description": "Add or remove a database on a Webfaction host. Further documentation at http://github.com/quentinsf/ansible-webfaction.", "properties": { "name": { "type": "string" }, "machine": { "type": "string" }, "state": { "type": "string" }, "login_password": { "type": "string" }, "password": { "type": "string" }, "type": { "type": "string" }, "login_name": { "type": "string" } } }, "netapp_e_snapshot_volume": { "required": [ "snapshot_image_id", "ssid", "api_password", "view_mode", "state", "storage_pool_name", "api_username", "api_url", "name" ], "type": "object", "description": "Create, update, remove snapshot volumes for NetApp E/EF-Series storage arrays.", "properties": { "snapshot_image_id": { "type": "string" }, "ssid": { "type": "string" }, "state": { "type": "string" }, "api_password": { "type": "string" }, "repo_percentage": { "type": "integer" }, "full_threshold": { "type": "integer" }, "name": { "type": "string" }, "view_mode": { "type": "string" }, "storage_pool_name": { "type": "string" }, "api_username": { "type": "string" }, "validate_certs": { "type": "boolean" }, "api_url": { "type": "string" } } }, "openssl_csr": { "required": [ "privatekey_path", "path" ], "type": "object", "description": "This module allows one to (re)generate OpenSSL certificate signing requests. It uses the pyOpenSSL python library to interact with openssl. This module supports the subjectAltName as well as the keyUsage and extendedKeyUsage extensions. Note: At least one of common_name or subject_alt_name must be specified.", "properties": { "privatekey_passphrase": { "type": "string" }, "state_or_province_name": { "type": "string" }, "extended_key_usage_critical": { "type": "string" }, "force": { "type": "boolean" }, "extended_key_usage": { "items": { "type": "string" }, "type": "array" }, "subject_alt_name": { "items": { "type": "string" }, "type": "array" }, "key_usage_critical": { "type": "string" }, "locality_name": { "type": "string" }, "subject_alt_name_critical": { "type": "string" }, "privatekey_path": { "type": "string" }, "organization_name": { "type": "string" }, "country_name": { "type": "string" }, "state": { "type": "string" }, "version": { "type": "integer" }, "key_usage": { "items": { "type": "string" }, "type": "array" }, "common_name": { "type": "string" }, "path": { "type": "string" }, "email_address": { "type": "string" }, "organizational_unit_name": { "type": "string" }, "digest": { "type": "string" } } }, "bigip_virtual_server": { "required": [ "destination", "name" ], "type": "object", "description": "Manages F5 BIG-IP LTM virtual servers via iControl SOAP API.", "properties": { "route_advertisement_state": { "type": "string" }, "partition": { "type": "string" }, "name": { "type": "string" }, "fallback_persistence_profile": { "type": "string" }, "default_persistence_profile": { "type": "string" }, "destination": { "type": "string" }, "all_profiles": { "items": { "type": "string" }, "type": "array" }, "all_rules": { "items": { "type": "string" }, "type": "array" }, "enabled_vlans": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "pool": { "type": "string" }, "snat": { "type": "string" }, "port": { "type": "string" }, "all_policies": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" } } }, "vyos_interface": { "required": [ "name" ], "type": "object", "description": "This module provides declarative management of Interfaces on VyOS network devices.", "properties": { "neighbors": { "type": "string" }, "name": { "type": "string" }, "duplex": { "type": "string" }, "enabled": { "type": "string" }, "mtu": { "type": "string" }, "delay": { "type": "integer" }, "state": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" }, "speed": { "type": "string" }, "description": { "type": "string" } } }, "patch": { "required": [ "src" ], "type": "object", "description": "Apply patch files using the GNU patch tool.", "properties": { "src": { "type": "string" }, "remote_src": { "type": "string" }, "dest": { "type": "string" }, "basedir": { "type": "string" }, "binary": { "type": "string" }, "strip": { "type": "integer" }, "backup": { "type": "string" } } }, "os_networks_facts": { "required": [], "type": "object", "description": "Retrieve facts about one or more networks from OpenStack.", "properties": { "name": { "type": "string" }, "filters": { "type": "string" }, "availability_zone": { "type": "string" } } }, "manageiq_user": { "required": [ "userid" ], "type": "object", "description": "The manageiq_user module supports adding, updating and deleting users in ManageIQ.", "properties": { "update_password": { "type": "string" }, "group": { "type": "string" }, "name": { "type": "string" }, "userid": { "type": "string" }, "state": { "type": "string" }, "password": { "type": "string" }, "email": { "type": "string" } } }, "win_group_membership": { "required": [ "name", "members" ], "type": "object", "description": "Allows the addition and removal of local, service and domain users, and domain groups from a local group.", "properties": { "state": { "type": "string" }, "name": { "type": "string" }, "members": { "items": { "type": "string" }, "type": "array" } } }, "beadm": { "required": [ "name" ], "type": "object", "description": "Create, delete or activate ZFS boot environments.\nMount and unmount ZFS boot environments.", "properties": { "force": { "type": "boolean" }, "name": { "type": "string" }, "state": { "type": "string" }, "snapshot": { "type": "boolean" }, "mountpoint": { "type": "boolean" }, "options": { "type": "boolean" }, "description": { "type": "boolean" } } }, "ce_vrf": { "required": [ "vrf" ], "type": "object", "description": "Manages VPN instance of HUAWEI CloudEngine switches.", "properties": { "state": { "type": "string" }, "vrf": { "type": "string" }, "description": { "type": "string" } } }, "open_iscsi": { "required": [], "type": "object", "description": "Discover targets on given portal, (dis)connect targets, mark targets to manually or auto start, return device nodes of connected targets.", "properties": { "auto_node_startup": { "type": "string" }, "target": { "type": "string" }, "show_nodes": { "items": { "type": "string" }, "type": "array" }, "node_auth": { "type": "string" }, "node_pass": { "type": "string" }, "discover": { "items": { "type": "string" }, "type": "array" }, "portal": { "type": "string" }, "login": { "type": "string" }, "node_user": { "type": "string" }, "port": { "items": { "type": "integer" }, "type": "array" } } }, "ce_startup": { "required": [], "type": "object", "description": "Manages a system startup information on HUAWEI CloudEngine switches.", "properties": { "slot": { "type": "string" }, "action": { "type": "string" }, "software_file": { "type": "string" }, "patch_file": { "type": "string" }, "cfg_file": { "type": "string" } } }, "ce_reboot": { "required": [], "type": "object", "description": "Reboot a HUAWEI CloudEngine switches.", "properties": { "save_config": { "type": "boolean" }, "confirm": { "type": "boolean" } } }, "fail": { "required": [], "type": "object", "description": "This module fails the progress with a custom message. It can be useful for bailing out when a certain condition is met using C(when).\nThis module is also supported for Windows targets.", "properties": { "msg": { "type": "string" } } }, "ec2_asg_facts": { "required": [], "type": "object", "description": "Gather facts about ec2 Auto Scaling Groups (ASGs) in AWS", "properties": { "name": { "type": "string" }, "tags": { "type": "string" } } }, "azure_rm_virtualmachine": { "required": [ "resource_group", "image", "name" ], "type": "object", "description": "Create, update, stop and start a virtual machine. Provide an existing storage account and network interface or allow the module to create these for you. If you choose not to provide a network interface, the resource group must contain a virtual network with at least one subnet.\nCurrently requires an image found in the Azure Marketplace. Use azure_rm_virtualmachineimage_facts module to discover the publisher, offer, sku and version of a particular image.", "properties": { "virtual_network_resource_group": { "type": "string" }, "resource_group": { "type": "string" }, "public_ip_allocation_method": { "type": "string" }, "image": { "type": "string" }, "managed_disk_type": { "type": "string" }, "ssh_public_keys": { "items": { "type": "string" }, "type": "array" }, "storage_container_name": { "type": "string" }, "allocated": { "type": "boolean" }, "ssh_password_enabled": { "type": "boolean" }, "storage_blob_name": { "type": "string" }, "remove_on_absent": { "items": { "type": "string" }, "type": "array" }, "availability_set": { "type": "string" }, "short_hostname": { "type": "string" }, "started": { "type": "boolean" }, "state": { "type": "string" }, "subnet_name": { "type": "string" }, "location": { "type": "string" }, "network_interface_names": { "items": { "type": "string" }, "type": "array" }, "admin_password": { "type": "string" }, "virtual_network_name": { "type": "string" }, "open_ports": { "items": { "type": "string" }, "type": "array" }, "plan": { "type": "string" }, "vm_size": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "restarted": { "type": "boolean" }, "admin_username": { "type": "string" }, "os_type": { "type": "string" }, "storage_account_name": { "type": "string" }, "data_disks": { "items": { "type": "string" }, "type": "array" }, "os_disk_caching": { "type": "string" } } }, "irc": { "required": [ "msg", "channel" ], "type": "object", "description": "Send a message to an IRC channel. This is a very simplistic implementation.", "properties": { "style": { "type": "string" }, "timeout": { "type": "integer" }, "nick": { "type": "string" }, "passwd": { "type": "string" }, "server": { "type": "string" }, "topic": { "type": "string" }, "color": { "type": "string" }, "part": { "type": "boolean" }, "nick_to": { "items": { "type": "string" }, "type": "array" }, "key": { "type": "string" }, "msg": { "type": "string" }, "use_ssl": { "type": "boolean" }, "port": { "type": "integer" }, "channel": { "type": "string" } } }, "import_role": { "required": [ "name" ], "type": "object", "description": "Much like the `roles:` keyword, this task loads a role, but it allows you to control it when the role tasks run in between other tasks of the play.\nMost keywords, loops and conditionals will only be applied to the imported tasks, not to this statement itself. If you want the opposite behaviour, use M(include_role) instead.", "properties": { "name": { "type": "string" }, "private": { "type": "string" }, "allow_duplicates": { "type": "boolean" }, "tasks_from": { "type": "string" }, "vars_from": { "type": "string" }, "defaults_from": { "type": "string" } } }, "rabbitmq_queue": { "required": [ "name" ], "type": "object", "description": "This module uses rabbitMQ Rest API to create/delete queues", "properties": { "login_port": { "type": "integer" }, "dead_letter_exchange": { "type": "string" }, "max_priority": { "type": "string" }, "login_user": { "type": "string" }, "login_host": { "type": "string" }, "message_ttl": { "type": "string" }, "vhost": { "type": "string" }, "state": { "type": "string" }, "max_length": { "type": "string" }, "arguments": { "type": "string" }, "auto_delete": { "type": "boolean" }, "login_password": { "type": "boolean" }, "auto_expires": { "type": "string" }, "dead_letter_routing_key": { "type": "string" }, "durable": { "type": "boolean" }, "name": { "type": "string" } } }, "elb_classic_lb_facts": { "required": [], "type": "object", "description": "Gather facts about EC2 Elastic Load Balancers in AWS", "properties": { "names": { "items": { "type": "string" }, "type": "array" } } }, "azure_rm_publicipaddress": { "required": [ "name", "resource_group" ], "type": "object", "description": "Create, update and delete a Public IP address. Allows setting and updating the address allocation method and domain name label. Use the azure_rm_networkinterface module to associate a Public IP with a network interface.", "properties": { "name": { "type": "string" }, "resource_group": { "type": "string" }, "state": { "type": "string" }, "domain_name_label": { "type": "string" }, "location": { "type": "string" }, "allocation_method": { "type": "string" } } }, "bigip_ssl_key": { "required": [ "name" ], "type": "object", "description": "This module will import/delete SSL keys on a BIG-IP. Keys can be imported from key files on the local disk, in PEM format.", "properties": { "content": { "type": "string" }, "state": { "type": "string" }, "name": { "type": "string" }, "passphrase": { "type": "string" } } }, "bigip_pool": { "required": [ "name" ], "type": "object", "description": "Manages F5 BIG-IP LTM pools via iControl REST API.", "properties": { "lb_method": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "partition": { "type": "string" }, "slow_ramp_time": { "type": "string" }, "service_down_action": { "type": "string" }, "port": { "type": "string" }, "monitor_type": { "items": { "type": "string" }, "type": "array" }, "host": { "type": "string" }, "reselect_tries": { "type": "string" }, "monitors": { "items": { "type": "string" }, "type": "array" }, "quorum": { "type": "string" } } }, "panos_restart": { "required": [ "password", "ip_address" ], "type": "object", "description": "Restart a device", "properties": { "username": { "type": "string" }, "password": { "type": "string" }, "ip_address": { "type": "string" } } }, "nxos_vpc_interface": { "required": [ "state", "portchannel" ], "type": "object", "description": "Manages interface VPC configuration", "properties": { "peer_link": { "type": "string" }, "state": { "type": "string" }, "portchannel": { "type": "string" }, "vpc": { "type": "string" } } }, "os_ironic_node": { "required": [], "type": "object", "description": "Deploy to nodes controlled by Ironic.", "properties": { "timeout": { "type": "string" }, "uuid": { "type": "string" }, "power": { "type": "string" }, "availability_zone": { "type": "string" }, "deploy": { "type": "boolean" }, "ironic_url": { "type": "string" }, "maintenance_reason": { "type": "string" }, "state": { "type": "string" }, "maintenance": { "type": "boolean" }, "wait": { "type": "boolean" }, "instance_info": { "type": "string" }, "config_drive": { "type": "string" } } }, "ios_command": { "required": [ "commands" ], "type": "object", "description": "Sends arbitrary commands to an ios node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.\nThis module does not support running commands in configuration mode. Please use M(ios_config) to configure IOS devices.", "properties": { "retries": { "type": "integer" }, "commands": { "items": { "type": "string" }, "type": "array" }, "wait_for": { "items": { "type": "string" }, "type": "array" }, "match": { "type": "string" }, "interval": { "type": "integer" } } }, "aws_s3": { "required": [ "bucket", "mode" ], "type": "object", "description": "This module allows the user to manage S3 buckets and the objects within them. Includes support for creating and deleting both objects and buckets, retrieving objects as files or strings and generating download links. This module has a dependency on boto3 and botocore.", "properties": { "prefix": { "items": { "type": "string" }, "type": "array" }, "marker": { "items": { "type": "string" }, "type": "array" }, "ignore_nonexistent_bucket": { "type": "string" }, "overwrite": { "type": "string" }, "aws_secret_key": { "type": "string" }, "encrypt": { "type": "boolean" }, "rgw": { "type": "boolean" }, "retries": { "type": "integer" }, "max_keys": { "items": { "type": "integer" }, "type": "array" }, "version": { "type": "string" }, "s3_url": { "type": "string" }, "mode": { "items": { "type": "string" }, "type": "array" }, "permission": { "items": { "type": "string" }, "type": "array" }, "dest": { "type": "string" }, "object": { "type": "string" }, "src": { "type": "string" }, "aws_access_key": { "type": "string" }, "region": { "type": "string" }, "bucket": { "type": "string" }, "headers": { "type": "string" }, "expiration": { "type": "integer" }, "metadata": { "type": "string" } } }, "ovirt_vms": { "required": [], "type": "object", "description": "This module manages whole lifecycle of the Virtual Machine(VM) in oVirt/RHV.\nSince VM can hold many states in oVirt/RHV, this see notes to see how the states of the VM are handled.", "properties": { "comment": { "type": "string" }, "disks": { "items": { "type": "string" }, "type": "array" }, "force": { "type": "string" }, "cloud_init_nics": { "items": { "type": "string" }, "type": "array" }, "xen": { "type": "string" }, "template_version": { "type": "string" }, "cluster": { "type": "string" }, "timezone": { "type": "string" }, "id": { "type": "string" }, "vmware": { "type": "string" }, "high_availability": { "type": "string" }, "storage_domain": { "type": "string" }, "instance_type": { "type": "string" }, "nics": { "items": { "type": "string" }, "type": "array" }, "disk_format": { "type": "string" }, "sysprep": { "type": "string" }, "cpu_cores": { "type": "string" }, "state": { "type": "string" }, "cpu_sockets": { "type": "string" }, "delete_protected": { "type": "string" }, "memory": { "type": "string" }, "cd_iso": { "type": "string" }, "clone_permissions": { "type": "string" }, "type": { "type": "string" }, "initrd_path": { "type": "string" }, "lease": { "type": "string" }, "description": { "type": "string" }, "clone": { "type": "string" }, "kvm": { "type": "string" }, "boot_devices": { "items": { "type": "string" }, "type": "array" }, "template": { "type": "string" }, "host": { "type": "string" }, "serial_policy": { "type": "string" }, "use_latest_template_version": { "type": "string" }, "stateless": { "type": "string" }, "operating_system": { "type": "string" }, "serial_policy_value": { "type": "string" }, "name": { "type": "string" }, "kernel_path": { "type": "string" }, "cloud_init": { "type": "string" }, "memory_guaranteed": { "type": "string" }, "kernel_params": { "type": "string" }, "allow_partial_import": { "type": "string" }, "cpu_shares": { "type": "string" } } }, "pkgutil": { "required": [ "state", "name" ], "type": "object", "description": "Manages CSW packages (SVR4 format) on Solaris 10 and 11.\nThese were the native packages on Solaris <= 10 and are available as a legacy feature in Solaris 11.\nPkgutil is an advanced packaging system, which resolves dependency on installation. It is designed for CSW packages.", "properties": { "state": { "items": { "type": "string" }, "type": "array" }, "site": { "type": "string" }, "name": { "type": "string" }, "update_catalog": { "type": "boolean" } } }, "win_copy": { "required": [ "src", "dest" ], "type": "object", "description": "The C(win_copy) module copies a file on the local box to remote windows locations.\nFor non-Windows targets, use the M(copy) module instead.", "properties": { "src": { "type": "string" }, "force": { "type": "string" }, "remote_src": { "type": "string" }, "dest": { "type": "string" }, "decrypt": { "type": "string" }, "content": { "type": "string" }, "local_follow": { "type": "string" } } }, "ce_bfd_session": { "required": [ "session_name" ], "type": "object", "description": "Manages BFD session configuration, creates a BFD session or deletes a specified BFD session on HUAWEI CloudEngine devices.", "properties": { "src_addr": { "type": "string" }, "out_if_name": { "type": "string" }, "state": { "type": "string" }, "dest_addr": { "type": "string" }, "vrf_name": { "type": "string" }, "create_type": { "type": "string" }, "session_name": { "type": "string" }, "use_default_ip": { "type": "boolean" }, "addr_type": { "type": "string" } } }, "nuage_vspk": { "required": [ "auth", "type" ], "type": "object", "description": "Manage or find Nuage VSP entities, this includes create, update, delete, assign, unassign and find, with all supported properties.", "properties": { "children": { "type": "string" }, "parent_type": { "type": "string" }, "auth": { "type": "string" }, "id": { "type": "string" }, "match_filter": { "type": "string" }, "parent_id": { "type": "string" }, "state": { "type": "string" }, "command": { "type": "string" }, "type": { "type": "string" }, "properties": { "type": "string" } } }, "bigip_gtm_pool": { "required": [ "name" ], "type": "object", "description": "Manages F5 BIG-IP GTM pools.", "properties": { "alternate_lb_method": { "type": "string" }, "name": { "type": "string" }, "partition": { "type": "string" }, "fallback_ip": { "type": "string" }, "state": { "type": "string" }, "fallback_lb_method": { "type": "string" }, "preferred_lb_method": { "type": "string" }, "type": { "type": "string" } } }, "apt_key": { "required": [], "type": "object", "description": "Add or remove an I(apt) key, optionally downloading it.", "properties": { "keyserver": { "type": "string" }, "url": { "type": "string" }, "validate_certs": { "type": "string" }, "keyring": { "type": "string" }, "state": { "type": "string" }, "file": { "type": "string" }, "data": { "type": "string" }, "id": { "type": "string" } } }, "ovirt_group_facts": { "required": [], "type": "object", "description": "Retrieve facts about one or more oVirt/RHV groups.", "properties": { "pattern": { "type": "string" } } }, "sf_check_connections": { "required": [], "type": "object", "description": "Used to test the management connection to the cluster.\nThe test pings the MVIP and SVIP, and executes a simple API method to verify connectivity.", "properties": { "svip": { "type": "string" }, "skip": { "type": "string" }, "mvip": { "type": "string" } } }, "zypper": { "required": [ "name" ], "type": "object", "description": "Manage packages on SUSE and openSUSE using the zypper and rpm tools.", "properties": { "force": { "type": "string" }, "name": { "items": { "type": "string" }, "type": "array" }, "disable_gpg_check": { "type": "string" }, "extra_args": { "type": "string" }, "state": { "type": "string" }, "oldpackage": { "type": "string" }, "update_cache": { "type": "string" }, "disable_recommends": { "type": "string" }, "type": { "type": "string" } } }, "telnet": { "required": [ "command" ], "type": "object", "description": "Executes a low-down and dirty telnet command, not going through the module subsystem.\nThis is mostly to be used for enabling ssh on devices that only have telnet enabled by default.", "properties": { "pause": { "type": "integer" }, "prompts": { "items": { "type": "string" }, "type": "array" }, "host": { "type": "string" }, "command": { "items": { "type": "string" }, "type": "array" }, "user": { "type": "string" }, "timeout": { "type": "integer" }, "password": { "type": "string" }, "port": { "type": "integer" } } }, "netscaler_gslb_vserver": { "required": [], "type": "object", "description": "Configure gslb vserver entities in Netscaler.", "properties": { "comment": { "type": "string" }, "disabled": { "type": "boolean" }, "domain_bindings": { "items": { "type": "string" }, "type": "array" }, "service_bindings": { "items": { "type": "string" }, "type": "array" }, "mir": { "type": "string" }, "tolerance": { "type": "string" }, "lbmethod": { "type": "string" }, "sothreshold": { "type": "string" }, "sopersistence": { "type": "string" }, "appflowlog": { "type": "string" }, "persistenceid": { "type": "string" }, "sobackupaction": { "type": "string" }, "servicetype": { "type": "string" }, "dnsrecordtype": { "type": "string" }, "considereffectivestate": { "type": "string" }, "netmask": { "type": "string" }, "v6netmasklen": { "type": "string" }, "persistencetype": { "type": "string" }, "name": { "type": "string" }, "disableprimaryondown": { "type": "string" }, "backuplbmethod": { "type": "string" }, "dynamicweight": { "type": "string" }, "somethod": { "type": "string" }, "sopersistencetimeout": { "type": "string" }, "persistmask": { "type": "string" }, "timeout": { "type": "string" }, "v6persistmasklen": { "type": "string" } } }, "junos_user": { "required": [], "type": "object", "description": "This module manages locally configured user accounts on remote network devices running the JUNOS operating system. It provides a set of arguments for creating, removing and updating locally defined accounts", "properties": { "name": { "type": "string" }, "purge": { "type": "boolean" }, "active": { "type": "boolean" }, "state": { "type": "string" }, "role": { "type": "string" }, "full_name": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" }, "sshkey": { "type": "string" } } }, "avi_gslb": { "required": [ "name" ], "type": "object", "description": "This module is used to configure Gslb object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "uuid": { "type": "string" }, "url": { "type": "string" }, "third_party_sites": { "type": "string" }, "description": { "type": "string" }, "tenant_ref": { "type": "string" }, "is_federated": { "type": "string" }, "sites": { "type": "string" }, "state": { "type": "string" }, "send_interval": { "type": "string" }, "view_id": { "type": "string" }, "dns_configs": { "type": "string" }, "leader_cluster_uuid": { "type": "string" }, "client_ip_addr_group": { "type": "string" }, "clear_on_max_retries": { "type": "string" }, "name": { "type": "string" } } }, "vmware_cfg_backup": { "required": [], "type": "object", "description": "Backup / Restore / Reset ESXi host configuration", "properties": { "dest": { "type": "string" }, "src": { "type": "string" }, "state": { "type": "string" } } }, "pacemaker_cluster": { "required": [ "state" ], "type": "object", "description": "This module can manage a pacemaker cluster and nodes from Ansible using the pacemaker cli.", "properties": { "node": { "type": "string" }, "state": { "type": "string" }, "force": { "type": "string" }, "timeout": { "type": "integer" } } }, "locale_gen": { "required": [ "name" ], "type": "object", "description": "Manages locales by editing /etc/locale.gen and invoking locale-gen.", "properties": { "state": { "type": "string" }, "name": { "type": "string" } } }, "cs_domain": { "required": [ "path" ], "type": "object", "description": "Create, update and remove domains.", "properties": { "path": { "type": "string" }, "state": { "type": "string" }, "network_domain": { "type": "string" }, "poll_async": { "type": "boolean" }, "clean_up": { "type": "boolean" } } }, "pagerduty_alert": { "required": [ "name", "state", "service_key", "api_key" ], "type": "object", "description": "This module will let you trigger, acknowledge or resolve a PagerDuty incident by sending events", "properties": { "client_url": { "type": "string" }, "name": { "type": "string" }, "state": { "type": "string" }, "incident_key": { "type": "string" }, "client": { "type": "string" }, "service_key": { "items": { "type": "string" }, "type": "array" }, "api_key": { "type": "string" }, "desc": { "type": "string" } } }, "github_key": { "required": [ "token", "name" ], "type": "object", "description": "Creates, removes, or updates GitHub access keys.", "properties": { "force": { "type": "string" }, "token": { "items": { "type": "string" }, "type": "array" }, "pubkey": { "type": "string" }, "name": { "type": "string" }, "state": { "type": "string" } } }, "cs_template": { "required": [ "name" ], "type": "object", "description": "Register a template from URL, create a template from a ROOT volume of a stopped VM or its snapshot, extract and delete templates.", "properties": { "is_featured": { "type": "boolean" }, "vm": { "type": "string" }, "domain": { "type": "string" }, "is_extractable": { "type": "boolean" }, "poll_async": { "type": "boolean" }, "password_enabled": { "type": "boolean" }, "zone": { "type": "string" }, "sshkey_enabled": { "type": "boolean" }, "is_dynamically_scalable": { "type": "boolean" }, "state": { "type": "string" }, "template_filter": { "type": "string" }, "is_ready": { "items": { "type": "boolean" }, "type": "array" }, "requires_hvm": { "type": "boolean" }, "is_routing": { "type": "string" }, "template_tag": { "type": "string" }, "bits": { "type": "integer" }, "details": { "type": "string" }, "format": { "type": "string" }, "is_public": { "type": "boolean" }, "tags": { "items": { "type": "string" }, "type": "array" }, "display_text": { "type": "string" }, "account": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "checksum": { "type": "boolean" }, "cross_zones": { "type": "boolean" }, "project": { "type": "string" }, "snapshot": { "type": "string" }, "mode": { "type": "string" }, "hypervisor": { "type": "string" }, "os_type": { "type": "string" } } }, "purefa_pg": { "required": [ "pgroup" ], "type": "object", "description": "Create, delete or modify protection groups on Pure Storage FlashArrays.", "properties": { "enabled": { "type": "string" }, "state": { "type": "string" }, "hostgroup": { "items": { "type": "string" }, "type": "array" }, "volume": { "items": { "type": "string" }, "type": "array" }, "host": { "items": { "type": "string" }, "type": "array" }, "pgroup": { "type": "string" }, "eradicate": { "type": "string" } } }, "os_auth": { "required": [], "type": "object", "description": "Retrieve an auth token from an OpenStack Cloud", "properties": { "availability_zone": { "type": "string" } } }, "ce_snmp_target_host": { "required": [], "type": "object", "description": "Manages SNMP target host configurations on HUAWEI CloudEngine switches.", "properties": { "security_name_v3": { "type": "string" }, "interface_name": { "type": "string" }, "security_model": { "type": "string" }, "vpn_name": { "type": "string" }, "security_level": { "type": "string" }, "security_name": { "type": "string" }, "is_public_net": { "type": "string" }, "connect_port": { "type": "string" }, "version": { "type": "string" }, "host_name": { "type": "string" }, "address": { "type": "string" }, "recv_port": { "type": "string" }, "notify_type": { "type": "string" } } }, "avi_sslkeyandcertificate": { "required": [ "name", "certificate" ], "type": "object", "description": "This module is used to configure SSLKeyAndCertificate object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "status": { "type": "string" }, "enckey_base64": { "type": "string" }, "certificate_management_profile_ref": { "type": "string" }, "name": { "type": "string" }, "dynamic_params": { "type": "string" }, "url": { "type": "string" }, "enckey_name": { "type": "string" }, "tenant_ref": { "type": "string" }, "state": { "type": "string" }, "created_by": { "type": "string" }, "ca_certs": { "type": "string" }, "hardwaresecuritymodulegroup_ref": { "type": "string" }, "key": { "type": "string" }, "key_params": { "type": "string" }, "certificate": { "type": "string" }, "type": { "type": "string" }, "uuid": { "type": "string" } } }, "make": { "required": [ "chdir" ], "type": "object", "description": "Run targets in a Makefile.", "properties": { "chdir": { "type": "string" }, "params": { "type": "string" }, "target": { "type": "string" }, "file": { "type": "string" } } }, "panos_dag": { "required": [ "dag_name", "password", "ip_address", "dag_filter" ], "type": "object", "description": "Create a dynamic address group object in the firewall used for policy rules", "properties": { "username": { "type": "string" }, "dag_name": { "type": "string" }, "commit": { "type": "boolean" }, "password": { "type": "string" }, "ip_address": { "type": "string" }, "dag_filter": { "type": "string" } } }, "vmware_portgroup": { "required": [ "portgroup_name", "switch_name", "vlan_id" ], "type": "object", "description": "Create a VMware portgroup", "properties": { "network_policy": { "items": { "type": "string" }, "type": "array" }, "portgroup_name": { "type": "string" }, "switch_name": { "type": "string" }, "vlan_id": { "type": "string" } } }, "digital_ocean_certificate": { "required": [ "oauth_token", "name" ], "type": "object", "description": "Create, Retrieve and remove certificates DigitalOcean.", "properties": { "private_key": { "type": "string" }, "name": { "type": "string" }, "certificate_chain": { "type": "string" }, "state": { "type": "string" }, "oauth_token": { "type": "string" }, "leaf_certificate": { "type": "string" } } }, "avi_gslbservice": { "required": [ "name" ], "type": "object", "description": "This module is used to configure GslbService object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "uuid": { "type": "string" }, "controller_health_status_enabled": { "type": "string" }, "description": { "type": "string" }, "wildcard_match": { "type": "string" }, "url": { "type": "string" }, "enabled": { "type": "string" }, "down_response": { "type": "string" }, "tenant_ref": { "type": "string" }, "state": { "type": "string" }, "created_by": { "type": "string" }, "domain_names": { "type": "string" }, "health_monitor_refs": { "type": "string" }, "use_edns_client_subnet": { "type": "string" }, "is_federated": { "type": "string" }, "groups": { "items": { "type": "string" }, "type": "array" }, "ttl": { "type": "string" }, "health_monitor_scope": { "type": "string" }, "num_dns_ip": { "type": "string" }, "name": { "type": "string" } } }, "cs_network_acl_rule": { "required": [ "vpc", "network_acl", "rule_position" ], "type": "object", "description": "Add, update and remove network ACL rules.", "properties": { "icmp_code": { "type": "string" }, "project": { "type": "string" }, "domain": { "type": "string" }, "protocol_number": { "type": "string" }, "start_port": { "type": "string" }, "action_policy": { "type": "string" }, "zone": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "end_port": { "type": "string" }, "account": { "type": "string" }, "rule_position": { "type": "string" }, "network_acl": { "type": "string" }, "state": { "type": "string" }, "vpc": { "type": "string" }, "poll_async": { "type": "boolean" }, "protocol": { "type": "string" }, "cidr": { "type": "string" }, "icmp_type": { "type": "string" }, "traffic_type": { "type": "string" } } }, "aci_vrf": { "required": [], "type": "object", "description": "Manage VRF (private networks aka. contexts) on Cisco ACI fabrics.\nEach context is a private network associated to a tenant, i.e. VRF.\nMore information from the internal APIC class I(fv:Ctx) at U(https://developer.cisco.com/media/mim-ref/MO-fvCtx.html).", "properties": { "policy_control_preference": { "type": "string" }, "policy_control_direction": { "type": "string" }, "state": { "items": { "type": "string" }, "type": "array" }, "vrf": { "type": "string" }, "tenant": { "type": "string" }, "description": { "type": "string" } } }, "ovirt_hosts_facts": { "required": [], "type": "object", "description": "Retrieve facts about one or more oVirt/RHV hosts.", "properties": { "pattern": { "type": "string" } } }, "ce_sflow": { "required": [], "type": "object", "description": "Configure Sampled Flow (sFlow) to monitor traffic on an interface in real time, detect abnormal traffic, and locate the source of attack traffic, ensuring stable running of the network.", "properties": { "sample_direction": { "type": "string" }, "agent_ip": { "type": "string" }, "collector_ip_vpn": { "type": "string" }, "counter_interval": { "type": "string" }, "export_route": { "type": "string" }, "counter_collector": { "items": { "type": "string" }, "type": "array" }, "rate_limit_slot": { "type": "string" }, "collector_ip": { "type": "string" }, "rate_limit": { "type": "string" }, "collector_udp_port": { "type": "string" }, "source_ip": { "type": "string" }, "sample_length": { "type": "string" }, "collector_datagram_size": { "type": "string" }, "state": { "type": "string" }, "collector_id": { "type": "string" }, "sample_rate": { "type": "string" }, "sample_collector": { "items": { "type": "string" }, "type": "array" }, "sflow_interface": { "type": "string" }, "forward_enp_slot": { "type": "string" }, "collector_meth": { "type": "string" }, "collector_description": { "type": "string" } } }, "nxos_udld_interface": { "required": [ "interface", "mode" ], "type": "object", "description": "Manages UDLD interface configuration params.", "properties": { "interface": { "type": "string" }, "state": { "type": "string" }, "mode": { "type": "string" } } }, "panos_commit": { "required": [ "password", "ip_address" ], "type": "object", "description": "PanOS module that will commit firewall's candidate configuration on\nthe device. The new configuration will become active immediately.", "properties": { "username": { "type": "string" }, "interval": { "type": "number" }, "sync": { "type": "boolean" }, "timeout": { "type": "string" }, "password": { "type": "string" }, "ip_address": { "type": "string" } } }, "webfaction_site": { "required": [ "name", "host", "login_password", "login_name" ], "type": "object", "description": "Add or remove a website on a Webfaction host. Further documentation at http://github.com/quentinsf/ansible-webfaction.", "properties": { "name": { "type": "string" }, "state": { "type": "string" }, "subdomains": { "items": { "type": "string" }, "type": "array" }, "host": { "type": "string" }, "https": { "type": "string" }, "login_password": { "type": "string" }, "login_name": { "type": "string" }, "site_apps": { "type": "string" } } }, "ipa_dnsrecord": { "required": [ "zone_name", "record_name", "record_value" ], "type": "object", "description": "Add, modify and delete an IPA DNS Record using IPA API", "properties": { "record_type": { "type": "string" }, "state": { "type": "string" }, "record_value": { "type": "string" }, "record_name": { "type": "string" }, "zone_name": { "type": "string" } } }, "panos_admin": { "required": [ "admin_password", "password", "ip_address" ], "type": "object", "description": "PanOS module that allows changes to the user account passwords by doing API calls to the Firewall using pan-api as the protocol.", "properties": { "username": { "type": "string" }, "admin_username": { "type": "string" }, "role": { "type": "string" }, "admin_password": { "type": "string" }, "commit": { "type": "boolean" }, "password": { "type": "string" }, "ip_address": { "type": "string" } } }, "avi_certificatemanagementprofile": { "required": [ "name", "script_path" ], "type": "object", "description": "This module is used to configure CertificateManagementProfile object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "tenant_ref": { "type": "string" }, "state": { "type": "string" }, "script_path": { "type": "string" }, "script_params": { "items": { "type": "string" }, "type": "array" }, "uuid": { "type": "string" } } }, "win_wakeonlan": { "required": [ "mac" ], "type": "object", "description": "The C(win_wakeonlan) module sends magic Wake-on-LAN (WoL) broadcast packets.", "properties": { "broadcast": { "type": "string" }, "mac": { "type": "string" }, "port": { "type": "integer" } } }, "statusio_maintenance": { "required": [ "api_id", "statuspage", "api_key" ], "type": "object", "description": "Creates a maintenance window for status.io\nDeletes a maintenance window for status.io", "properties": { "maintenance_notify_72_hr": { "type": "boolean" }, "maintenance_notify_1_hr": { "type": "boolean" }, "title": { "type": "string" }, "maintenance_notify_now": { "type": "boolean" }, "start_time": { "type": "string" }, "api_id": { "type": "string" }, "automation": { "type": "boolean" }, "maintenance_notify_24_hr": { "type": "boolean" }, "state": { "type": "string" }, "all_infrastructure_affected": { "type": "boolean" }, "url": { "type": "string" }, "components": { "type": "string" }, "statuspage": { "type": "string" }, "maintenance_id": { "type": "string" }, "api_key": { "type": "string" }, "minutes": { "type": "integer" }, "start_date": { "type": "string" }, "containers": { "type": "string" }, "desc": { "type": "string" } } }, "ipmi_boot": { "required": [ "bootdev", "name", "user", "password" ], "type": "object", "description": "Use this module to manage order of boot devices", "properties": { "bootdev": { "type": "string" }, "name": { "type": "string" }, "uefiboot": { "type": "boolean" }, "persistent": { "type": "boolean" }, "state": { "type": "string" }, "user": { "type": "string" }, "password": { "type": "string" }, "port": { "type": "integer" } } }, "proxmox_kvm": { "required": [ "api_host", "api_user" ], "type": "object", "description": "Allows you to create/delete/stop Qemu(KVM) Virtual Machines in Proxmox VE cluster.", "properties": { "storage": { "type": "string" }, "force": { "type": "string" }, "revert": { "type": "string" }, "numa": { "type": "string" }, "scsihw": { "type": "string" }, "startup": { "type": "string" }, "migrate_speed": { "type": "string" }, "freeze": { "type": "string" }, "full": { "type": "boolean" }, "keyboard": { "type": "string" }, "watchdog": { "type": "string" }, "serial": { "type": "string" }, "sockets": { "type": "integer" }, "digest": { "type": "string" }, "description": { "type": "string" }, "startdate": { "type": "string" }, "tablet": { "type": "string" }, "bios": { "type": "string" }, "cpu": { "type": "string" }, "balloon": { "type": "integer" }, "cpuunits": { "type": "integer" }, "boot": { "type": "string" }, "vga": { "type": "string" }, "shares": { "type": "string" }, "machine": { "type": "string" }, "hostpci": { "type": "string" }, "state": { "type": "string" }, "autostart": { "type": "string" }, "memory": { "type": "integer" }, "net": { "type": "string" }, "api_host": { "type": "string" }, "migrate_downtime": { "type": "string" }, "localtime": { "type": "string" }, "node": { "type": "string" }, "agent": { "type": "string" }, "virtio": { "type": "string" }, "template": { "type": "string" }, "format": { "type": "string" }, "clone": { "type": "string" }, "args": { "type": "string" }, "api_password": { "type": "string" }, "snapname": { "type": "string" }, "tdf": { "type": "string" }, "kvm": { "type": "string" }, "sata": { "type": "string" }, "protection": { "type": "string" }, "reboot": { "type": "string" }, "hotplug": { "items": { "type": "string" }, "type": "array" }, "api_user": { "type": "string" }, "parallel": { "type": "string" }, "pool": { "type": "string" }, "target": { "type": "string" }, "lock": { "type": "string" }, "ide": { "type": "string" }, "name": { "type": "string" }, "update": { "type": "string" }, "vmid": { "type": "string" }, "hugepages": { "type": "string" }, "bootdisk": { "type": "string" }, "ostype": { "type": "string" }, "acpi": { "type": "string" }, "vcpus": { "type": "string" }, "newid": { "type": "string" }, "timeout": { "type": "integer" }, "smbios": { "type": "string" }, "skiplock": { "type": "string" }, "cores": { "type": "integer" }, "scsi": { "type": "string" }, "cpulimit": { "type": "string" }, "validate_certs": { "type": "string" }, "onboot": { "type": "string" }, "delete": { "items": { "type": "string" }, "type": "array" } } }, "dynamodb_table": { "required": [ "name" ], "type": "object", "description": "Create or delete AWS Dynamo DB tables.\nCan update the provisioned throughput on existing tables.\nReturns the status of the specified table.", "properties": { "write_capacity": { "type": "integer" }, "hash_key_name": { "type": "string" }, "range_key_type": { "type": "string" }, "name": { "type": "string" }, "tags": { "type": "string" }, "read_capacity": { "type": "integer" }, "indexes": { "items": { "type": "string" }, "type": "array" }, "range_key_name": { "type": "string" }, "state": { "type": "string" }, "wait_for_active_timeout": { "type": "integer" }, "hash_key_type": { "type": "string" } } }, "group_by": { "required": [ "key" ], "type": "object", "description": "Use facts to create ad-hoc groups that can be used later in a playbook.\nThis module is also supported for Windows targets.", "properties": { "parents": { "items": { "type": "string" }, "type": "array" }, "key": { "type": "string" } } }, "rax_mon_notification": { "required": [ "notification_type", "details", "label" ], "type": "object", "description": "Create or delete a Rackspace Cloud Monitoring notification that specifies a channel that can be used to communicate alarms, such as email, webhooks, or PagerDuty. Rackspace monitoring module flow | rax_mon_entity -> rax_mon_check -> *rax_mon_notification* -> rax_mon_notification_plan -> rax_mon_alarm", "properties": { "notification_type": { "type": "string" }, "state": { "type": "string" }, "details": { "type": "string" }, "label": { "type": "string" } } }, "uptimerobot": { "required": [ "monitorid", "state", "apikey" ], "type": "object", "description": "This module will let you start and pause Uptime Robot Monitoring", "properties": { "monitorid": { "type": "string" }, "state": { "type": "string" }, "apikey": { "type": "string" } } }, "lxd_profile": { "required": [ "name" ], "type": "object", "description": "Management of LXD profiles", "properties": { "new_name": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "trust_password": { "type": "string" }, "cert_file": { "type": "string" }, "devices": { "type": "string" }, "state": { "type": "string" }, "key_file": { "type": "string" }, "config": { "type": "string" }, "description": { "type": "string" } } }, "avi_sslprofile": { "required": [ "name" ], "type": "object", "description": "This module is used to configure SSLProfile object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "ssl_session_timeout": { "type": "string" }, "accepted_ciphers": { "type": "string" }, "prefer_client_cipher_ordering": { "type": "string" }, "description": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "url": { "type": "string" }, "tenant_ref": { "type": "string" }, "accepted_versions": { "type": "string" }, "uuid": { "type": "string" }, "enable_ssl_session_reuse": { "type": "string" }, "state": { "type": "string" }, "cipher_enums": { "type": "string" }, "send_close_notify": { "type": "string" }, "dhparam": { "type": "string" }, "ssl_rating": { "type": "string" }, "name": { "type": "string" } } }, "rax_mon_check": { "required": [ "entity_id", "check_type", "label" ], "type": "object", "description": "Create or delete a Rackspace Cloud Monitoring check associated with an existing rax_mon_entity. A check is a specific test or measurement that is performed, possibly from different monitoring zones, on the systems you monitor. Rackspace monitoring module flow | rax_mon_entity -> *rax_mon_check* -> rax_mon_notification -> rax_mon_notification_plan -> rax_mon_alarm", "properties": { "entity_id": { "type": "string" }, "check_type": { "type": "string" }, "target_alias": { "type": "string" }, "target_hostname": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "string" }, "state": { "type": "string" }, "period": { "type": "string" }, "details": { "type": "string" }, "timeout": { "type": "string" }, "monitoring_zones_poll": { "items": { "type": "string" }, "type": "array" }, "metadata": { "type": "string" } } }, "rabbitmq_binding": { "required": [ "name", "destination", "destination_type" ], "type": "object", "description": "This module uses rabbitMQ Rest API to create/delete bindings", "properties": { "login_port": { "type": "integer" }, "name": { "type": "string" }, "login_user": { "type": "string" }, "login_host": { "type": "string" }, "destination": { "type": "string" }, "routing_key": { "type": "string" }, "vhost": { "type": "string" }, "state": { "type": "string" }, "arguments": { "type": "string" }, "login_password": { "type": "boolean" }, "destination_type": { "type": "string" } } }, "vyos_linkagg": { "required": [ "name" ], "type": "object", "description": "This module provides declarative management of link aggregation groups on VyOS network devices.", "properties": { "aggregate": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "name": { "type": "string" }, "members": { "items": { "type": "string" }, "type": "array" }, "mode": { "type": "string" } } }, "nxos_vlan": { "required": [], "type": "object", "description": "Manages VLAN configurations on NX-OS switches.", "properties": { "vlan_state": { "type": "string" }, "name": { "type": "string" }, "mapped_vni": { "type": "string" }, "state": { "type": "string" }, "admin_state": { "type": "string" }, "mode": { "type": "string" }, "vlan_range": { "type": "string" }, "vlan_id": { "type": "string" } } }, "nxos_vrf_interface": { "required": [ "interface", "vrf" ], "type": "object", "description": "Manages interface specific VRF configuration.", "properties": { "interface": { "type": "string" }, "state": { "type": "string" }, "vrf": { "type": "string" } } }, "nxos_ospf": { "required": [ "ospf" ], "type": "object", "description": "Manages configuration of an ospf instance.", "properties": { "state": { "type": "string" }, "ospf": { "type": "string" } } }, "bigpanda": { "required": [ "component", "token", "state", "version" ], "type": "object", "description": "Notify BigPanda when deployments start and end (successfully or not). Returns a deployment object containing all the parameters for future module calls.", "properties": { "description": { "type": "string" }, "url": { "type": "string" }, "component": { "type": "string" }, "state": { "type": "string" }, "token": { "type": "string" }, "version": { "type": "string" }, "hosts": { "items": { "type": "string" }, "type": "array" }, "env": { "type": "string" }, "owner": { "type": "string" }, "validate_certs": { "type": "string" } } }, "sensu_check": { "required": [ "name", "command" ], "type": "object", "description": "Manage the checks that should be run on a machine by I(Sensu).\nMost options do not have a default and will not be added to the check definition unless specified.\nAll defaults except I(path), I(state), I(backup) and I(metric) are not managed by this module,\nthey are simply specified for your convenience.", "properties": { "interval": { "type": "string" }, "metric": { "type": "boolean" }, "subdue_begin": { "type": "string" }, "occurrences": { "type": "integer" }, "low_flap_threshold": { "type": "string" }, "ttl": { "type": "string" }, "publish": { "type": "boolean" }, "custom": { "type": "string" }, "source": { "type": "string" }, "state": { "type": "string" }, "subdue_end": { "type": "string" }, "handle": { "type": "boolean" }, "dependencies": { "type": "string" }, "subscribers": { "items": { "type": "string" }, "type": "array" }, "aggregate": { "type": "boolean" }, "path": { "type": "string" }, "name": { "type": "string" }, "standalone": { "type": "boolean" }, "handlers": { "items": { "type": "string" }, "type": "array" }, "refresh": { "type": "string" }, "command": { "type": "string" }, "high_flap_threshold": { "type": "string" }, "timeout": { "type": "integer" }, "backup": { "type": "boolean" } } }, "selinux_permissive": { "required": [ "domain", "permissive" ], "type": "object", "description": "Add and remove domain from the list of permissive domain.", "properties": { "domain": { "items": { "type": "string" }, "type": "array" }, "store": { "type": "string" }, "no_reload": { "type": "boolean" }, "permissive": { "type": "string" } } }, "os_user": { "required": [ "name" ], "type": "object", "description": "Manage OpenStack Identity users. Users can be created, updated or deleted using this module. A user will be updated if I(name) matches an existing user and I(state) is present. The value for I(name) cannot be updated without deleting and re-creating the user.", "properties": { "update_password": { "type": "string" }, "description": { "type": "string" }, "availability_zone": { "type": "string" }, "enabled": { "type": "boolean" }, "default_project": { "type": "string" }, "state": { "type": "string" }, "domain": { "type": "string" }, "password": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" } } }, "ipify_facts": { "required": [], "type": "object", "description": "If behind NAT and need to know the public IP of your internet gateway.", "properties": { "validate_certs": { "type": "string" }, "api_url": { "type": "string" }, "timeout": { "type": "integer" } } }, "flowadm": { "required": [ "name" ], "type": "object", "description": "Create/modify/remove networking bandwidth and associated resources for a type of traffic on a particular link.", "properties": { "dsfield": { "type": "string" }, "temporary": { "type": "boolean" }, "name": { "type": "string" }, "maxbw": { "type": "string" }, "local_ip": { "type": "string" }, "local_port": { "type": "string" }, "remove_ip": { "type": "string" }, "priority": { "type": "string" }, "state": { "type": "string" }, "link": { "type": "string" }, "transport": { "type": "string" } } }, "ce_netstream_template": { "required": [ "type" ], "type": "object", "description": "Manages NetStream template configuration on HUAWEI CloudEngine switches.", "properties": { "record_name": { "type": "string" }, "description": { "type": "string" }, "collect_counter": { "type": "string" }, "state": { "type": "string" }, "collect_interface": { "type": "string" }, "type": { "type": "string" }, "match": { "type": "string" } } }, "vdirect_runnable": { "required": [ "vdirect_user", "runnable_name", "vdirect_ip", "runnable_type", "vdirect_password" ], "type": "object", "description": "Runs configuration templates, creates workflows and runs workflow actions in Radware vDirect server.", "properties": { "vdirect_user": { "type": "string" }, "vdirect_password": { "type": "string" }, "runnable_name": { "type": "string" }, "parameters": { "type": "string" }, "vdirect_https_port": { "type": "integer" }, "vdirect_validate_certs": { "type": "string" }, "vdirect_timeout": { "type": "integer" }, "vdirect_wait": { "type": "string" }, "vdirect_ip": { "type": "string" }, "action_name": { "type": "string" }, "runnable_type": { "type": "string" }, "vdirect_secondary_ip": { "type": "string" }, "vdirect_use_ssl": { "type": "string" }, "vdirect_http_port": { "type": "integer" } } }, "os_stack": { "required": [ "name" ], "type": "object", "description": "Add or Remove a Stack to an OpenStack Heat", "properties": { "rollback": { "type": "boolean" }, "name": { "type": "string" }, "parameters": { "type": "string" }, "availability_zone": { "type": "string" }, "environment": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "timeout": { "type": "integer" }, "template": { "type": "string" } } }, "os_server_facts": { "required": [], "type": "object", "description": "Retrieve facts about server instances from OpenStack.", "properties": { "detailed": { "type": "boolean" }, "availability_zone": { "type": "string" }, "server": { "type": "string" } } }, "aci_bd_to_l3out": { "required": [], "type": "object", "description": "Bind Bridge Domain to L3 Out on Cisco ACI fabrics.\nMore information from the internal APIC class I(fv:RsBDToOut) at U(https://developer.cisco.com/media/mim-ref/MO-fvRsBDToOut.html).", "properties": { "bd": { "type": "string" }, "l3out": { "type": "string" }, "state": { "items": { "type": "string" }, "type": "array" }, "tenant": { "type": "string" } } }, "panos_security_policy": { "required": [ "password", "ip_address", "rule_name" ], "type": "object", "description": "Security policies allow you to enforce rules and take action, and can be as general or specific as needed. The policy rules are compared against the incoming traffic in sequence, and because the first rule that matches the traffic is applied, the more specific rules must precede the more general ones.", "properties": { "username": { "type": "string" }, "spyware": { "type": "string" }, "hip_profiles": { "type": "string" }, "file_blocking": { "type": "string" }, "tag": { "type": "string" }, "log_start": { "type": "boolean" }, "description": { "type": "string" }, "to_zone": { "items": { "type": "string" }, "type": "array" }, "service": { "items": { "type": "string" }, "type": "array" }, "source": { "items": { "type": "string" }, "type": "array" }, "destination": { "items": { "type": "string" }, "type": "array" }, "from_zone": { "items": { "type": "string" }, "type": "array" }, "source_user": { "type": "string" }, "url_filtering": { "type": "string" }, "group_profile": { "type": "string" }, "api_key": { "type": "string" }, "wildfire_analysis": { "type": "string" }, "devicegroup": { "type": "string" }, "data_filtering": { "type": "string" }, "antivirus": { "type": "string" }, "rule_name": { "type": "string" }, "application": { "items": { "type": "string" }, "type": "array" }, "password": { "type": "string" }, "ip_address": { "type": "string" }, "rule_type": { "type": "string" }, "vulnerability": { "type": "string" }, "action": { "type": "string" }, "commit": { "type": "boolean" }, "log_end": { "type": "boolean" } } }, "vertica_user": { "required": [ "name" ], "type": "object", "description": "Adds or removes Vertica database user and, optionally, assigns roles.\nA user will not be removed until all the dependencies have been dropped.\nIn such a situation, if the module tries to remove the user it will fail and only remove roles granted to the user.", "properties": { "profile": { "type": "string" }, "resource_pool": { "type": "string" }, "name": { "type": "string" }, "roles": { "items": { "type": "string" }, "type": "array" }, "login_user": { "type": "string" }, "login_password": { "type": "string" }, "db": { "type": "string" }, "cluster": { "type": "string" }, "state": { "type": "string" }, "ldap": { "type": "string" }, "password": { "type": "string" }, "expired": { "type": "string" }, "port": { "type": "integer" } } }, "tower_credential": { "required": [ "kind", "name" ], "type": "object", "description": "Create, update, or destroy Ansible Tower credentials. See U(https://www.ansible.com/tower) for an overview.", "properties": { "authorize": { "type": "boolean" }, "domain": { "type": "string" }, "vault_password": { "type": "string" }, "become_username": { "type": "string" }, "become_method": { "type": "string" }, "secret": { "type": "string" }, "state": { "type": "string" }, "ssh_key_unlock": { "type": "string" }, "authorize_password": { "type": "string" }, "username": { "type": "string" }, "description": { "type": "string" }, "host": { "type": "string" }, "user": { "type": "string" }, "become_password": { "type": "string" }, "password": { "type": "string" }, "tenant": { "type": "string" }, "subscription": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" }, "project": { "type": "string" }, "client": { "type": "string" }, "ssh_key_data": { "type": "string" }, "team": { "type": "string" }, "organization": { "type": "string" } } }, "ovirt_group": { "required": [ "authz_name", "name" ], "type": "object", "description": "Module to manage groups in oVirt/RHV", "properties": { "namespace": { "type": "string" }, "state": { "type": "string" }, "authz_name": { "type": "string" }, "name": { "type": "string" } } }, "zabbix_template": { "required": [ "template_name", "template_groups" ], "type": "object", "description": "create/delete zabbix template", "properties": { "clear_templates": { "items": { "type": "string" }, "type": "array" }, "template_name": { "type": "string" }, "macros": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "template_groups": { "items": { "type": "string" }, "type": "array" }, "link_templates": { "items": { "type": "string" }, "type": "array" } } }, "ovirt_scheduling_policies_facts": { "required": [ "id" ], "type": "object", "description": "Retrieve facts about one or more oVirt scheduling policies.", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "win_region": { "required": [], "type": "object", "description": "Set the location settings of a Windows Server.\nSet the format settings of a Windows Server.\nSet the unicode language settings of a Windows Server.\nCopy across these settings to the default profile.", "properties": { "unicode_language": { "items": { "type": "string" }, "type": "array" }, "copy_settings": { "type": "boolean" }, "location": { "items": { "type": "string" }, "type": "array" }, "format": { "items": { "type": "string" }, "type": "array" } } }, "azure": { "required": [ "image", "storage_account", "name", "location" ], "type": "object", "description": "Creates or terminates azure instances. When created optionally waits for it to be 'running'.", "properties": { "endpoints": { "items": { "type": "integer" }, "type": "array" }, "role_size": { "type": "string" }, "name": { "type": "string" }, "location": { "type": "string" }, "virtual_network_name": { "type": "string" }, "image": { "type": "string" }, "hostname": { "type": "string" }, "enable_winrm": { "type": "string" }, "state": { "type": "string" }, "wait_timeout_redirects": { "type": "integer" }, "management_cert_path": { "type": "string" }, "ssh_cert_path": { "type": "string" }, "wait_timeout": { "type": "integer" }, "user": { "type": "string" }, "auto_updates": { "type": "string" }, "storage_account": { "type": "string" }, "os_type": { "type": "string" }, "password": { "type": "string" }, "subscription_id": { "type": "string" }, "wait": { "type": "string" } } }, "ecs_task": { "required": [ "operation" ], "type": "object", "description": "Creates or deletes instances of task definitions.", "properties": { "count": { "type": "string" }, "task": { "type": "string" }, "overrides": { "type": "string" }, "started_by": { "type": "string" }, "cluster": { "type": "string" }, "task_definition": { "type": "string" }, "container_instances": { "items": { "type": "string" }, "type": "array" }, "operation": { "type": "string" } } }, "swdepot": { "required": [ "state", "name" ], "type": "object", "description": "Will install, upgrade and remove packages with swdepot package manager (HP-UX)", "properties": { "state": { "type": "string" }, "depot": { "type": "string" }, "name": { "type": "string" } } }, "iam_managed_policy": { "required": [ "state", "policy_name" ], "type": "object", "description": "Allows creating and removing managed IAM policies", "properties": { "policy_description": { "type": "string" }, "policy_name": { "type": "string" }, "state": { "type": "string" }, "make_default": { "type": "boolean" }, "policy": { "type": "string" }, "only_version": { "type": "boolean" } } }, "rax_dns_record": { "required": [ "name", "data", "type" ], "type": "object", "description": "Manage DNS records on Rackspace Cloud DNS", "properties": { "comment": { "type": "string" }, "domain": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "server": { "type": "string" }, "priority": { "type": "string" }, "state": { "type": "string" }, "overwrite": { "type": "boolean" }, "ttl": { "type": "integer" }, "data": { "type": "string" }, "loadbalancer": { "type": "string" } } }, "azure_rm_functionapp_facts": { "required": [], "type": "object", "description": "Get facts for one Azure Function App or all Function Apps within a resource group", "properties": { "name": { "type": "string" }, "resource_group": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } } }, "bigip_monitor_tcp_half_open": { "required": [ "name" ], "type": "object", "description": "Manages F5 BIG-IP LTM tcp monitors via iControl SOAP API.", "properties": { "name": { "type": "string" }, "parent": { "type": "string" }, "ip": { "type": "string" }, "interval": { "type": "string" }, "time_until_up": { "type": "string" }, "timeout": { "type": "string" } } }, "gce_pd": { "required": [ "name" ], "type": "object", "description": "This module can create and destroy unformatted GCE persistent disks U(https://developers.google.com/compute/docs/disks#persistentdisks). It also supports attaching and detaching disks from running instances. Full install/configuration instructions for the gce* modules can be found in the comments of ansible/test/gce_tests.py.", "properties": { "size_gb": { "type": "integer" }, "disk_type": { "type": "string" }, "name": { "type": "string" }, "zone": { "type": "string" }, "service_account_email": { "type": "string" }, "image": { "type": "string" }, "pem_file": { "type": "string" }, "instance_name": { "type": "string" }, "state": { "type": "string" }, "snapshot": { "type": "string" }, "detach_only": { "type": "string" }, "credentials_file": { "type": "string" }, "project_id": { "type": "string" }, "delete_on_termination": { "type": "boolean" }, "mode": { "type": "string" } } }, "tower_user": { "required": [ "username", "email" ], "type": "object", "description": "Create, update, or destroy Ansible Tower users. See U(https://www.ansible.com/tower) for an overview.", "properties": { "username": { "type": "string" }, "superuser": { "type": "boolean" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "state": { "type": "string" }, "auditor": { "type": "boolean" }, "password": { "type": "string" }, "email": { "type": "string" } } }, "ec2_ami_copy": { "required": [ "source_image_id", "source_region" ], "type": "object", "description": "Copies AMI from a source region to a destination region. B(Since version 2.3 this module depends on boto3.)", "properties": { "description": { "type": "string" }, "tags": { "type": "string" }, "encrypted": { "type": "string" }, "kms_key_id": { "type": "string" }, "source_image_id": { "type": "string" }, "wait_timeout": { "type": "integer" }, "source_region": { "type": "string" }, "wait": { "type": "string" }, "name": { "type": "string" } } }, "vmware_guest": { "required": [ "name", "state" ], "type": "object", "description": "Create new virtual machines (from templates or not).\nPower on/power off/restart a virtual machine.\nModify, rename or remove a virtual machine.", "properties": { "force": { "type": "string" }, "hardware": { "type": "string" }, "cluster": { "type": "string" }, "customization": { "items": { "type": "string" }, "type": "array" }, "disk": { "items": { "type": "string" }, "type": "array" }, "networks": { "items": { "type": "string" }, "type": "array" }, "wait_for_ip_address": { "type": "string" }, "uuid": { "type": "string" }, "customvalues": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "template": { "type": "string" }, "linked_clone": { "type": "string" }, "folder": { "type": "string" }, "resource_pool": { "type": "string" }, "snapshot_src": { "type": "string" }, "guest_id": { "type": "string" }, "name_match": { "type": "string" }, "cdrom": { "type": "string" }, "annotation": { "type": "string" }, "datacenter": { "type": "string" }, "name": { "type": "string" }, "is_template": { "type": "string" }, "esxi_hostname": { "type": "string" } } }, "slurp": { "required": [ "src" ], "type": "object", "description": "This module works like M(fetch). It is used for fetching a base64- encoded blob containing the data in a remote file.\nThis module is also supported for Windows targets.", "properties": { "src": { "type": "string" } } }, "seboolean": { "required": [ "state", "name" ], "type": "object", "description": "Toggles SELinux booleans.", "properties": { "state": { "type": "string" }, "name": { "type": "string" }, "persistent": { "type": "string" } } }, "nxos_reboot": { "required": [], "type": "object", "description": "Reboot a network device.", "properties": { "confirm": { "type": "boolean" } } }, "docker_volume": { "required": [ "name" ], "type": "object", "description": "Create/remove Docker volumes.\nPerforms largely the same function as the \"docker volume\" CLI subcommand.", "properties": { "force": { "type": "string" }, "name": { "type": "string" }, "labels": { "items": { "type": "string" }, "type": "array" }, "driver": { "type": "string" }, "state": { "type": "string" }, "driver_options": { "type": "string" } } }, "oc": { "required": [ "kind", "token", "state" ], "type": "object", "description": "This module allows management of resources in an OpenShift cluster. The inventory host can be any host with network connectivity to the OpenShift cluster; the default port being 8443/TCP.\nThis module relies on a token to authenticate to OpenShift. This can either be a user or a service account.", "properties": { "kind": { "type": "string" }, "name": { "type": "string" }, "state": { "type": "string" }, "namespace": { "type": "string" }, "token": { "type": "string" }, "host": { "type": "string" }, "inline": { "type": "string" }, "port": { "type": "integer" } } }, "vmware_vswitch": { "required": [ "switch" ], "type": "object", "description": "Add or remove a VMware Standard Switch to an ESXi host.", "properties": { "nics": { "items": { "type": "string" }, "type": "array" }, "switch": { "type": "string" }, "number_of_ports": { "type": "integer" }, "state": { "type": "string" }, "mtu": { "type": "string" } } }, "ec2_vpc_nacl_facts": { "required": [], "type": "object", "description": "Gather facts about Network ACLs in an AWS VPC", "properties": { "nacl_ids": { "items": { "type": "string" }, "type": "array" }, "filters": { "type": "string" } } }, "cyberark_user": { "required": [ "username", "cyberark_session" ], "type": "object", "description": "CyberArk User Management using PAS Web Services SDK. It currently supports the following actions Get User Details, Add User, Update User, Delete User.", "properties": { "username": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "initial_password": { "type": "string" }, "user_type_name": { "type": "string" }, "new_password": { "type": "string" }, "cyberark_session": { "type": "string" }, "group_name": { "type": "string" }, "disabled": { "type": "string" }, "change_password_on_the_next_logon": { "type": "string" }, "state": { "type": "string" }, "expiry_date": { "type": "string" }, "location": { "type": "string" }, "email": { "type": "string" } } }, "tower_group": { "required": [ "inventory", "name" ], "type": "object", "description": "Create, update, or destroy Ansible Tower groups. See U(https://www.ansible.com/tower) for an overview.", "properties": { "credential": { "type": "string" }, "source_vars": { "type": "string" }, "update_on_launch": { "type": "boolean" }, "overwrite_vars": { "type": "string" }, "source_regions": { "type": "string" }, "name": { "type": "string" }, "variables": { "type": "string" }, "instance_filters": { "items": { "type": "string" }, "type": "array" }, "group_by": { "type": "string" }, "source": { "type": "string" }, "source_script": { "type": "string" }, "state": { "type": "string" }, "inventory": { "type": "string" }, "overwrite": { "type": "boolean" }, "description": { "type": "string" } } }, "win_defrag": { "required": [], "type": "object", "description": "Locates and consolidates fragmented files on local volumes to improve system performance.\nMore information regarding C(win_defrag) is available from: U(https://technet.microsoft.com/en-us/library/cc731650(v=ws.11).aspx)", "properties": { "priority": { "type": "string" }, "freespace_consolidation": { "type": "string" }, "exclude_volumes": { "items": { "type": "string" }, "type": "array" }, "parallel": { "type": "string" }, "include_volumes": { "items": { "type": "string" }, "type": "array" } } }, "win_group": { "required": [ "name" ], "type": "object", "description": "Add and remove local groups.\nFor non-Windows targets, please use the M(group) module instead.", "properties": { "state": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } } }, "infini_host": { "required": [ "name" ], "type": "object", "description": "This module creates, deletes or modifies hosts on Infinibox.", "properties": { "volume": { "type": "string" }, "state": { "type": "string" }, "name": { "type": "string" }, "wwns": { "items": { "type": "string" }, "type": "array" } } }, "lambda_event": { "required": [ "source_params", "state", "alias", "lambda_function_arn" ], "type": "object", "description": "This module allows the management of AWS Lambda function event source mappings such as DynamoDB and Kinesis stream events via the Ansible framework. These event source mappings are relevant only in the AWS Lambda pull model, where AWS Lambda invokes the function. It is idempotent and supports \"Check\" mode. Use module M(lambda) to manage the lambda function itself and M(lambda_alias) to manage function aliases.", "properties": { "source_params": { "type": "string" }, "event_source": { "type": "string" }, "lambda_function_arn": { "type": "string" }, "alias": { "type": "string" }, "state": { "type": "string" }, "version": { "type": "string" } } }, "bigip_virtual_address": { "required": [ "address" ], "type": "object", "description": "Manage LTM virtual addresses on a BIG-IP.", "properties": { "icmp_echo": { "type": "string" }, "auto_delete": { "type": "string" }, "partition": { "type": "string" }, "connection_limit": { "type": "string" }, "state": { "type": "string" }, "netmask": { "type": "string" }, "arp_state": { "type": "string" }, "address": { "type": "string" }, "use_route_advertisement": { "type": "string" }, "advertise_route": { "type": "string" } } }, "cs_firewall": { "required": [], "type": "object", "description": "Creates and removes firewall rules.", "properties": { "icmp_code": { "type": "string" }, "domain": { "type": "string" }, "start_port": { "type": "string" }, "network": { "type": "string" }, "zone": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" }, "end_port": { "type": "string" }, "cidrs": { "items": { "type": "string" }, "type": "array" }, "account": { "type": "string" }, "project": { "type": "string" }, "state": { "type": "string" }, "poll_async": { "type": "boolean" }, "protocol": { "type": "string" }, "icmp_type": { "type": "string" }, "ip_address": { "type": "string" } } }, "ldap_attr": { "required": [ "dn", "name", "values" ], "type": "object", "description": "Add or remove LDAP attribute values.", "properties": { "dn": { "type": "string" }, "name": { "type": "string" }, "server_uri": { "type": "string" }, "start_tls": { "type": "string" }, "bind_dn": { "type": "string" }, "state": { "type": "string" }, "values": { "items": { "type": "string" }, "type": "array" }, "bind_pw": { "type": "string" }, "validate_certs": { "type": "string" } } }, "aireos_command": { "required": [ "commands" ], "type": "object", "description": "Sends arbitrary commands to an aireos node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.\nThis module does not support running commands in configuration mode. Please use M(aireos_config) to configure WLC devices.", "properties": { "retries": { "type": "integer" }, "commands": { "items": { "type": "string" }, "type": "array" }, "wait_for": { "items": { "type": "string" }, "type": "array" }, "match": { "type": "string" }, "interval": { "type": "integer" } } }, "vmware_host_facts": { "required": [], "type": "object", "description": "Gathers facts about remote vmware host.", "properties": {} }, "firewalld": { "required": [ "state" ], "type": "object", "description": "This module allows for addition or deletion of services and ports either tcp or udp in either running or permanent firewalld rules.", "properties": { "zone": { "items": { "type": "string" }, "type": "array" }, "service": { "items": { "type": "string" }, "type": "array" }, "masquerade": { "type": "string" }, "immediate": { "type": "boolean" }, "source": { "type": "string" }, "state": { "type": "string" }, "permanent": { "type": "string" }, "timeout": { "type": "integer" }, "interface": { "type": "string" }, "port": { "type": "string" }, "rich_rule": { "type": "string" } } }, "ipa_user": { "required": [ "uid" ], "type": "object", "description": "Add, modify and delete user within IPA server", "properties": { "telephonenumber": { "items": { "type": "string" }, "type": "array" }, "sshpubkey": { "items": { "type": "string" }, "type": "array" }, "givenname": { "type": "string" }, "displayname": { "type": "string" }, "uid": { "type": "string" }, "krbpasswordexpiration": { "type": "string" }, "title": { "type": "string" }, "loginshell": { "type": "string" }, "uidnumber": { "type": "string" }, "gidnumber": { "type": "string" }, "state": { "type": "string" }, "sn": { "type": "string" }, "mail": { "items": { "type": "string" }, "type": "array" }, "password": { "type": "string" } } }, "mongodb_user": { "required": [ "name", "database" ], "type": "object", "description": "Adds or removes a user from a MongoDB database.", "properties": { "login_port": { "type": "integer" }, "update_password": { "type": "string" }, "name": { "type": "string" }, "roles": { "type": "string" }, "database": { "type": "string" }, "login_user": { "type": "string" }, "login_host": { "type": "string" }, "login_password": { "type": "string" }, "ssl_cert_reqs": { "type": "string" }, "ssl": { "type": "boolean" }, "state": { "type": "string" }, "login_database": { "type": "string" }, "password": { "type": "string" }, "replica_set": { "type": "string" } } }, "vmware_target_canonical_facts": { "required": [ "target_id" ], "type": "object", "description": "Return canonical (NAA) from an ESXi host based on SCSI target ID", "properties": { "target_id": { "type": "string" } } }, "openvswitch_port": { "required": [ "bridge", "port" ], "type": "object", "description": "Manage Open vSwitch ports", "properties": { "bridge": { "type": "string" }, "set": { "type": "string" }, "state": { "type": "string" }, "tag": { "type": "string" }, "timeout": { "type": "integer" }, "external_ids": { "type": "string" }, "port": { "type": "string" } } }, "panos_interface": { "required": [ "zone_name", "password", "ip_address", "if_name" ], "type": "object", "description": "Configure data-port (DP) network interface for DHCP. By default DP interfaces are static.", "properties": { "username": { "type": "string" }, "if_name": { "type": "string" }, "create_default_route": { "type": "string" }, "zone_name": { "type": "string" }, "commit": { "type": "boolean" }, "password": { "type": "string" }, "ip_address": { "type": "string" } } }, "timezone": { "required": [], "type": "object", "description": "This module configures the timezone setting, both of the system clock and of the hardware clock. If you want to set up the NTP, use M(service) module.\nIt is recommended to restart C(crond) after changing the timezone, otherwise the jobs may run at the wrong time.\nSeveral different tools are used depending on the OS/Distribution involved. For Linux it can use C(timedatectl) or edit C(/etc/sysconfig/clock) or C(/etc/timezone) andC(hwclock). On SmartOS, C(sm-set-timezone), for macOS, C(systemsetup), for BSD, C(/etc/localtime) is modified.\nAs of version 2.3 support was added for SmartOS and BSDs.\nAs of version 2.4 support was added for macOS.\nWindows, AIX and HPUX are not supported, please let us know if you find any other OS/distro in which this fails.", "properties": { "hwclock": { "type": "string" }, "name": { "type": "string" } } }, "ios_config": { "required": [], "type": "object", "description": "Cisco IOS configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with IOS configuration sections in a deterministic way.", "properties": { "multiline_delimiter": { "type": "string" }, "src": { "type": "string" }, "save_when": { "type": "string" }, "force": { "type": "boolean" }, "intended_config": { "type": "string" }, "after": { "type": "string" }, "lines": { "type": "string" }, "diff_against": { "type": "string" }, "replace": { "type": "string" }, "running_config": { "type": "string" }, "defaults": { "type": "boolean" }, "before": { "type": "string" }, "parents": { "type": "string" }, "save": { "type": "boolean" }, "backup": { "type": "boolean" }, "match": { "type": "string" }, "diff_ignore_lines": { "items": { "type": "string" }, "type": "array" } } }, "archive": { "required": [ "path" ], "type": "object", "description": "Packs an archive. It is the opposite of M(unarchive). By default, it assumes the compression source exists on the target. It will not copy the source file from the local system to the target before archiving. Source files can be deleted after archival by specifying I(remove=True).", "properties": { "dest": { "items": { "type": "string" }, "type": "array" }, "path": { "items": { "type": "string" }, "type": "array" }, "exclude_path": { "items": { "type": "string" }, "type": "array" }, "remove": { "type": "string" }, "format": { "type": "string" } } }, "cs_iso": { "required": [ "name" ], "type": "object", "description": "Register and remove ISO images.", "properties": { "display_text": { "type": "string" }, "is_featured": { "type": "string" }, "poll_async": { "type": "boolean" }, "name": { "type": "string" }, "zone": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "url": { "type": "string" }, "checksum": { "type": "string" }, "iso_filter": { "type": "string" }, "is_dynamically_scalable": { "type": "string" }, "project": { "type": "string" }, "bootable": { "type": "string" }, "state": { "type": "string" }, "is_ready": { "items": { "type": "boolean" }, "type": "array" }, "domain": { "type": "string" }, "account": { "type": "string" }, "is_public": { "type": "string" }, "os_type": { "type": "string" }, "cross_zones": { "type": "boolean" } } }, "ce_facts": { "required": [], "type": "object", "description": "Collects facts from CloudEngine devices running the CloudEngine operating system. Fact collection is supported over Cli transport. This module prepends all of the base network fact keys with C(ansible_net_). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.", "properties": { "gather_subset": { "items": { "type": "string" }, "type": "array" } } }, "avi_applicationprofile": { "required": [ "name", "type" ], "type": "object", "description": "This module is used to configure ApplicationProfile object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "tcp_app_profile": { "type": "string" }, "name": { "type": "string" }, "dns_service_profile": { "type": "string" }, "type": { "type": "string" }, "tenant_ref": { "type": "string" }, "uuid": { "type": "string" }, "http_profile": { "type": "string" }, "url": { "type": "string" }, "state": { "type": "string" }, "dos_rl_profile": { "type": "string" }, "preserve_client_ip": { "type": "string" }, "description": { "type": "string" } } }, "win_lineinfile": { "required": [ "path" ], "type": "object", "description": "This module will search a file for a line, and ensure that it is present or absent.\nThis is primarily useful when you want to change a single line in a file only.", "properties": { "insertbefore": { "type": "string" }, "encoding": { "type": "string" }, "create": { "type": "string" }, "newline": { "type": "string" }, "backrefs": { "type": "string" }, "state": { "type": "string" }, "regexp": { "type": "string" }, "insertafter": { "type": "string" }, "path": { "type": "string" }, "line": { "type": "string" }, "backup": { "type": "string" }, "validate": { "type": "string" } } }, "bcf_switch": { "required": [ "name", "mac", "controller", "fabric_role" ], "type": "object", "description": "Create and remove a Big Cloud Fabric switch.", "properties": { "name": { "type": "string" }, "access_token": { "type": "string" }, "controller": { "type": "string" }, "mac": { "type": "string" }, "state": { "type": "string" }, "leaf_group": { "type": "string" }, "validate_certs": { "type": "boolean" }, "fabric_role": { "type": "string" } } }, "nxos_vrf": { "required": [ "vrf" ], "type": "object", "description": "Manages global VRF configuration.", "properties": { "description": { "type": "string" }, "vni": { "type": "string" }, "state": { "type": "string" }, "route_distinguisher": { "type": "string" }, "admin_state": { "type": "string" }, "vrf": { "type": "string" } } }, "nxos_vrf_af": { "required": [ "afi", "vrf", "safi" ], "type": "object", "description": "Manages VRF AF", "properties": { "state": { "type": "string" }, "safi": { "type": "string" }, "route_target_both_auto_evpn": { "type": "string" }, "afi": { "type": "string" }, "vrf": { "type": "string" } } }, "ovirt_vms_facts": { "required": [], "type": "object", "description": "Retrieve facts about one or more oVirt/RHV virtual machines.", "properties": { "all_content": { "type": "string" }, "pattern": { "type": "string" }, "max": { "type": "string" }, "case_sensitive": { "type": "string" } } }, "win_domain_membership": { "required": [ "domain_admin_user" ], "type": "object", "description": "Manages domain membership or workgroup membership for a Windows host. Also supports hostname changes. This module may require subsequent use of the M(win_reboot) action if changes are made.", "properties": { "workgroup_name": { "type": "string" }, "domain_admin_user": { "type": "string" }, "domain_ou_path": { "type": "string" }, "hostname": { "type": "string" }, "domain_admin_password": { "type": "string" }, "state": { "type": "string" }, "dns_domain_name": { "type": "string" } } }, "win_domain": { "required": [ "dns_domain_name", "safe_mode_password" ], "type": "object", "description": "Ensure that the domain named by C(dns_domain_name) exists and is reachable. If the domain is not reachable, the domain is created in a new forest on the target Windows Server 2012R2+ host. This module may require subsequent use of the M(win_reboot) action if changes are made.", "properties": { "dns_domain_name": { "type": "string" }, "safe_mode_password": { "type": "string" } } }, "serverless": { "required": [ "service_path" ], "type": "object", "description": "Provides support for managing Serverless Framework (https://serverless.com/) project deployments and stacks.", "properties": { "functions": { "items": { "type": "string" }, "type": "array" }, "deploy": { "type": "boolean" }, "region": { "type": "string" }, "state": { "type": "string" }, "serverless_bin_path": { "type": "string" }, "service_path": { "type": "string" }, "stage": { "type": "string" } } }, "os_keystone_role": { "required": [ "name" ], "type": "object", "description": "Manage OpenStack Identity Roles.", "properties": { "state": { "type": "string" }, "name": { "type": "string" }, "availability_zone": { "type": "string" } } }, "win_regedit": { "required": [ "path" ], "type": "object", "description": "Add, modify or remove registry keys and values.\nMore information about the windows registry from Wikipedia U(https://en.wikipedia.org/wiki/Windows_Registry).", "properties": { "name": { "type": "string" }, "data": { "items": { "type": "string" }, "type": "array" }, "hive": { "type": "string" }, "state": { "type": "string" }, "delete_key": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string" } } }, "ios_logging": { "required": [], "type": "object", "description": "This module provides declarative management of logging on Cisco Ios devices.", "properties": { "name": { "type": "string" }, "facility": { "type": "string" }, "dest": { "type": "string" }, "level": { "type": "string" }, "state": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" }, "size": { "type": "integer" } } }, "net_ping": { "required": [ "dest" ], "type": "object", "description": "Tests reachability using ping from network device to a remote destination.", "properties": { "count": { "type": "integer" }, "dest": { "type": "string" }, "state": { "type": "string" }, "vrf": { "type": "string" }, "source": { "type": "string" } } }, "ios_system": { "required": [], "type": "object", "description": "This module provides declarative management of node system attributes on Cisco IOS devices. It provides an option to configure host system parameters or remove those parameters from the device active configuration.", "properties": { "lookup_source": { "type": "string" }, "domain_search": { "items": { "type": "string" }, "type": "array" }, "hostname": { "type": "string" }, "domain_name": { "type": "string" }, "state": { "type": "string" }, "name_servers": { "items": { "type": "string" }, "type": "array" }, "lookup_enabled": { "type": "string" } } }, "win_rabbitmq_plugin": { "required": [ "names" ], "type": "object", "description": "Manage RabbitMQ plugins.", "properties": { "state": { "type": "string" }, "names": { "items": { "type": "string" }, "type": "array" }, "prefix": { "type": "string" }, "new_only": { "items": { "type": "string" }, "type": "array" } } }, "ce_info_center_global": { "required": [], "type": "object", "description": "This module offers the ability to be output to the log buffer, log file, console, terminal, or log host on HUAWEI CloudEngine switches.", "properties": { "facility": { "type": "string" }, "transport_mode": { "type": "string" }, "channel_cfg_name": { "type": "string" }, "suppress_enable": { "type": "string" }, "channel_name": { "type": "string" }, "packet_priority": { "type": "string" }, "state": { "type": "string" }, "logfile_max_size": { "type": "integer" }, "server_port": { "type": "string" }, "info_center_enable": { "type": "string" }, "ip_type": { "type": "string" }, "logfile_max_num": { "type": "string" }, "server_ip": { "type": "string" }, "filter_log_name": { "type": "string" }, "ssl_policy_name": { "type": "string" }, "timestamp": { "type": "string" }, "channel_out_direct": { "type": "string" }, "filter_feature_name": { "type": "string" }, "is_default_vpn": { "type": "boolean" }, "server_domain": { "type": "string" }, "level": { "type": "string" }, "source_ip": { "type": "string" }, "channel_id": { "type": "string" }, "vrf_name": { "type": "string" } } }, "macports": { "required": [ "name" ], "type": "object", "description": "Manages MacPorts packages", "properties": { "state": { "type": "string" }, "update_cache": { "type": "string" }, "name": { "type": "string" } } }, "ovirt_affinity_group": { "required": [ "name" ], "type": "object", "description": "This module manage affinity groups in oVirt/RHV. It can also manage assignments of those groups to VMs.", "properties": { "vm_enforcing": { "type": "string" }, "name": { "type": "string" }, "host_rule": { "type": "string" }, "cluster": { "type": "string" }, "state": { "type": "string" }, "hosts": { "items": { "type": "string" }, "type": "array" }, "vm_rule": { "type": "string" }, "host_enforcing": { "type": "string" }, "vms": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" } } }, "net_banner": { "required": [ "banner" ], "type": "object", "description": "This will configure both login and motd banners on network devices. It allows playbooks to add or remote banner text from the active running configuration.", "properties": { "text": { "type": "string" }, "state": { "type": "string" }, "banner": { "type": "string" } } }, "os_user_group": { "required": [ "group", "user" ], "type": "object", "description": "Add and remove users from groups", "properties": { "state": { "type": "string" }, "group": { "type": "string" }, "user": { "type": "string" }, "availability_zone": { "type": "string" } } }, "avi_controllerproperties": { "required": [], "type": "object", "description": "This module is used to configure ControllerProperties object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "vs_se_ping_fail": { "type": "string" }, "vs_se_create_fail": { "type": "string" }, "portal_token": { "type": "string" }, "warmstart_se_reconnect_wait_time": { "type": "string" }, "persistence_key_rotate_period": { "type": "string" }, "unresponsive_se_reboot": { "type": "string" }, "attach_ip_retry_interval": { "type": "string" }, "vs_se_vnic_fail": { "type": "string" }, "attach_ip_retry_limit": { "type": "string" }, "se_vnic_cooldown": { "type": "string" }, "vnic_op_fail_time": { "type": "string" }, "vs_key_rotate_period": { "type": "string" }, "vs_se_bootup_fail": { "type": "string" }, "seupgrade_fabric_pool_size": { "type": "string" }, "max_pcap_per_tenant": { "type": "string" }, "seupgrade_segroup_min_dead_timeout": { "type": "string" }, "dns_refresh_period": { "type": "string" }, "upgrade_lease_time": { "type": "string" }, "se_create_timeout": { "type": "string" }, "query_host_fail": { "type": "string" }, "vs_apic_scaleout_timeout": { "type": "string" }, "state": { "type": "string" }, "se_offline_del": { "type": "string" }, "max_dead_se_in_grp": { "type": "string" }, "upgrade_dns_ttl": { "type": "string" }, "fatal_error_lease_time": { "type": "string" }, "allow_ip_forwarding": { "type": "string" }, "max_seq_vnic_failures": { "type": "string" }, "allow_unauthenticated_nodes": { "type": "string" }, "allow_unauthenticated_apis": { "type": "string" }, "vs_awaiting_se_timeout": { "type": "string" }, "cluster_ip_gratuitous_arp_period": { "type": "string" }, "uuid": { "type": "string" }, "dummy": { "type": "string" }, "secure_channel_cleanup_timeout": { "type": "string" }, "vs_se_vnic_ip_fail": { "type": "string" }, "ssl_certificate_expiry_warning_days": { "type": "string" }, "secure_channel_se_token_timeout": { "type": "string" }, "url": { "type": "string" }, "secure_channel_controller_token_timeout": { "type": "string" }, "api_idle_timeout": { "type": "string" }, "crashed_se_reboot": { "type": "string" }, "appviewx_compat_mode": { "type": "string" }, "se_failover_attempt_interval": { "type": "string" }, "dead_se_detection_timer": { "type": "string" } } }, "ce_vxlan_vap": { "required": [], "type": "object", "description": "Manages VXLAN Virtual access point on HUAWEI CloudEngine Devices.", "properties": { "pe_vid": { "type": "string" }, "l2_sub_interface": { "type": "string" }, "bind_vlan_id": { "type": "string" }, "bridge_domain_id": { "type": "string" }, "state": { "type": "string" }, "ce_vid": { "type": "string" }, "encapsulation": { "type": "string" } } }, "clc_server_snapshot": { "required": [ "server_ids" ], "type": "object", "description": "An Ansible module to Create, Delete and Restore server snapshots in CenturyLink Cloud.", "properties": { "server_ids": { "items": { "type": "string" }, "type": "array" }, "expiration_days": { "type": "integer" }, "state": { "type": "string" }, "wait": { "type": "boolean" } } }, "openvswitch_db": { "required": [ "record", "key", "column", "table", "value" ], "type": "object", "description": "Set column values in record in database table.", "properties": { "key": { "type": "string" }, "column": { "type": "string" }, "value": { "type": "string" }, "record": { "type": "string" }, "state": { "type": "string" }, "timeout": { "type": "integer" }, "table": { "type": "string" } } }, "net_l2_interface": { "required": [], "type": "object", "description": "This module provides declarative management of Layer-2 interface on network devices.", "properties": { "native_vlan": { "type": "string" }, "access_vlan": { "type": "string" }, "name": { "type": "string" }, "state": { "type": "string" }, "trunk_vlans": { "items": { "type": "string" }, "type": "array" }, "trunk_allowed_vlans": { "items": { "type": "string" }, "type": "array" }, "mode": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" } } }, "mlnxos_command": { "required": [ "commands" ], "type": "object", "description": "Sends arbitrary commands to an mlnxos node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.\nThis module does not support running commands in configuration mode. Please use M(mlnxos_config) to configure Mellanox MLNX-OS devices.", "properties": { "retries": { "type": "integer" }, "commands": { "items": { "type": "string" }, "type": "array" }, "wait_for": { "items": { "type": "string" }, "type": "array" }, "match": { "type": "string" }, "interval": { "type": "integer" } } }, "consul": { "required": [ "state" ], "type": "object", "description": "Registers services and checks for an agent with a consul cluster. A service is some process running on the agent node that should be advertised by consul's discovery mechanism. It may optionally supply a check definition, a periodic service test to notify the consul cluster of service's health.\nChecks may also be registered per node e.g. disk usage, or cpu usage and notify the health of the entire node to the cluster. Service level checks do not require a check name or id as these are derived by Consul from the Service name and id respectively by appending 'service:' Node level checks require a check_name and optionally a check_id.\nCurrently, there is no complete way to retrieve the script, interval or ttl metadata for a registered check. Without this metadata it is not possible to tell if the data supplied with ansible represents a change to a check. As a result this does not attempt to determine changes and will always report a changed occurred. An api method is planned to supply this metadata so at that stage change management will be added.\nSee http://consul.io for more details.", "properties": { "service_address": { "items": { "type": "string" }, "type": "array" }, "http": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "check_name": { "type": "string" }, "service_name": { "type": "string" }, "notes": { "type": "string" }, "script": { "type": "string" }, "token": { "type": "string" }, "interval": { "type": "string" }, "check_id": { "type": "string" }, "host": { "type": "string" }, "state": { "type": "string" }, "service_port": { "items": { "type": "string" }, "type": "array" }, "timeout": { "type": "string" }, "ttl": { "type": "string" }, "service_id": { "type": "string" }, "scheme": { "type": "string" }, "validate_certs": { "type": "boolean" }, "port": { "type": "integer" } } }, "alternatives": { "required": [ "path", "name" ], "type": "object", "description": "Manages symbolic links using the 'update-alternatives' tool\nUseful when multiple programs are installed but provide similar functionality (e.g. different editors).", "properties": { "priority": { "type": "integer" }, "path": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" } } }, "gce_tag": { "required": [ "tags" ], "type": "object", "description": "This module can add or remove tags U(https://cloud.google.com/compute/docs/label-or-tag-resources#tags) to/from GCE instances. Use 'instance_pattern' to update multiple instances in a specify zone.", "properties": { "zone": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "service_account_email": { "type": "string" }, "pem_file": { "type": "string" }, "instance_name": { "type": "string" }, "state": { "type": "string" }, "instance_pattern": { "type": "string" }, "project_id": { "type": "string" } } }, "infini_pool": { "required": [ "name" ], "type": "object", "description": "This module to creates, deletes or modifies pools on Infinibox.", "properties": { "ssd_cache": { "type": "boolean" }, "state": { "type": "string" }, "vsize": { "type": "string" }, "name": { "type": "string" }, "size": { "type": "string" } } }, "nxos_ntp": { "required": [], "type": "object", "description": "Manages core NTP configuration.", "properties": { "source_addr": { "type": "string" }, "prefer": { "type": "string" }, "server": { "type": "string" }, "state": { "type": "string" }, "vrf_name": { "type": "string" }, "peer": { "type": "string" }, "key_id": { "type": "string" }, "source_int": { "type": "string" } } }, "netapp_e_amg_sync": { "required": [ "api_password", "state", "api_username", "api_url", "name" ], "type": "object", "description": "Allows for the initialization, suspension and resumption of an asynchronous mirror group's synchronization for NetApp E-series storage arrays.", "properties": { "api_url": { "type": "string" }, "api_password": { "type": "string" }, "name": { "type": "string" }, "state": { "type": "string" }, "api_username": { "type": "string" }, "delete_recovery_point": { "type": "boolean" }, "validate_certs": { "type": "boolean" }, "ssid": { "type": "string" } } }, "ovirt_storage_vms_facts": { "required": [], "type": "object", "description": "Retrieve facts about one or more oVirt/RHV virtual machines relate to a storage domain.", "properties": { "unregistered": { "type": "string" } } }, "elb_application_lb_facts": { "required": [], "type": "object", "description": "Gather facts about application ELBs in AWS", "properties": { "names": { "type": "string" }, "load_balancer_arns": { "type": "string" } } }, "eos_vrf": { "required": [ "name" ], "type": "object", "description": "This module provides declarative management of VRFs on Arista EOS network devices.", "properties": { "rd": { "type": "string" }, "name": { "type": "string" }, "interfaces": { "items": { "type": "string" }, "type": "array" }, "delay": { "type": "integer" }, "purge": { "type": "boolean" }, "state": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" } } }, "cs_network_acl": { "required": [ "name", "vpc" ], "type": "object", "description": "Create and remove network ACLs.", "properties": { "domain": { "type": "string" }, "poll_async": { "type": "boolean" }, "name": { "type": "string" }, "zone": { "type": "string" }, "account": { "type": "string" }, "project": { "type": "string" }, "state": { "type": "string" }, "vpc": { "type": "string" }, "description": { "type": "string" } } }, "ec2_vpc_dhcp_option_facts": { "required": [], "type": "object", "description": "Gather facts about dhcp options sets in AWS", "properties": { "dhcp_options_ids": { "items": { "type": "string" }, "type": "array" }, "filters": { "type": "string" } } }, "avi_gslbhealthmonitor": { "required": [ "name", "type" ], "type": "object", "description": "This module is used to configure GslbHealthMonitor object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "monitor_port": { "type": "string" }, "https_monitor": { "type": "string" }, "receive_timeout": { "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "dns_monitor": { "type": "string" }, "tenant_ref": { "type": "string" }, "uuid": { "type": "string" }, "name": { "type": "string" }, "failed_checks": { "type": "string" }, "tcp_monitor": { "type": "string" }, "state": { "type": "string" }, "send_interval": { "type": "string" }, "udp_monitor": { "type": "string" }, "http_monitor": { "type": "string" }, "external_monitor": { "type": "string" }, "type": { "type": "string" }, "successful_checks": { "type": "string" } } }, "cs_portforward": { "required": [ "private_port", "ip_address", "public_port" ], "type": "object", "description": "Create, update and remove port forwarding rules.", "properties": { "vm_guest_ip": { "type": "boolean" }, "domain": { "type": "string" }, "protocol": { "type": "string" }, "network": { "type": "string" }, "open_firewall": { "type": "boolean" }, "tags": { "items": { "type": "string" }, "type": "array" }, "public_port": { "type": "string" }, "vm": { "type": "string" }, "public_end_port": { "type": "string" }, "project": { "type": "string" }, "private_port": { "type": "string" }, "state": { "type": "string" }, "vpc": { "type": "string" }, "private_end_port": { "type": "string" }, "account": { "type": "string" }, "poll_async": { "type": "boolean" }, "zone": { "type": "string" }, "ip_address": { "type": "string" } } }, "bigip_config": { "required": [], "type": "object", "description": "Manages a BIG-IP configuration by allowing TMSH commands that modify running configuration, or merge SCF formatted files into the running configuration. Additionally, this module is of significant importance because it allows you to save your running configuration to disk. Since the F5 module only manipulate running configuration, it is important that you utilize this module to save that running config.", "properties": { "reset": { "type": "boolean" }, "verify": { "type": "boolean" }, "save": { "type": "boolean" }, "merge_content": { "type": "string" } } }, "rax_files_objects": { "required": [ "container" ], "type": "object", "description": "Upload, download, and delete objects in Rackspace Cloud Files", "properties": { "src": { "items": { "type": "string" }, "type": "array" }, "container": { "type": "string" }, "dest": { "items": { "type": "string" }, "type": "array" }, "expires": { "type": "string" }, "state": { "type": "string" }, "clear_meta": { "type": "string" }, "meta": { "type": "string" }, "type": { "type": "string" }, "method": { "type": "string" }, "structure": { "type": "string" } } }, "win_acl": { "required": [ "user", "rights", "path", "type" ], "type": "object", "description": "Add or remove rights/permissions for a given user or group for the specified file, folder, registry key or AppPool identifies.\nIf adding ACL's for AppPool identities (available since 2.3), the Windows Feature \"Web-Scripting-Tools\" must be enabled.", "properties": { "rights": { "type": "string" }, "inherit": { "items": { "type": "string" }, "type": "array" }, "propagation": { "type": "string" }, "state": { "type": "string" }, "user": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string" } } }, "infini_vol": { "required": [ "name", "pool" ], "type": "object", "description": "This module creates, deletes or modifies volume on Infinibox.", "properties": { "state": { "type": "string" }, "name": { "type": "string" }, "pool": { "type": "string" }, "size": { "type": "string" } } }, "ce_static_route": { "required": [ "prefix", "aftype", "mask" ], "type": "object", "description": "Manages the static routes on HUAWEI CloudEngine switches.", "properties": { "description": { "type": "string" }, "state": { "type": "string" }, "pref": { "type": "string" }, "mask": { "type": "string" }, "destvrf": { "type": "string" }, "nhp_interface": { "type": "string" }, "prefix": { "type": "string" }, "next_hop": { "type": "string" }, "vrf": { "type": "string" }, "tag": { "type": "string" }, "aftype": { "type": "string" } } }, "cnos_rollback": { "required": [ "serverpassword", "configType", "protocol", "serverusername", "rcserverip", "rcpath" ], "type": "object", "description": "This module allows you to work with switch configurations. It provides a way to roll back configurations of a switch from a remote server. This is achieved by using startup or running configurations of the target device that were previously backed up to a remote server using FTP, SFTP, TFTP, or SCP. The first step is to create a directory from where the remote server can be reached. The next step is to provide the full file path of the backup configuration's location. Authentication details required by the remote server must be provided as well. By default, this method overwrites the switch's configuration file with the newly downloaded file. This module uses SSH to manage network device configuration. The results of the operation will be placed in a directory named 'results' that must be created by the user in their local directory to where the playbook is run. For more information about this module from Lenovo and customizing it usage for your use cases, please visit U(http://systemx.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.switchmgt.ansible.doc%2Fcnos_rollback.html)", "properties": { "serverpassword": { "type": "string" }, "protocol": { "type": "string" }, "configType": { "type": "string" }, "serverusername": { "type": "string" }, "rcserverip": { "type": "string" }, "rcpath": { "type": "string" } } }, "ec2_elb_lb": { "required": [ "name", "state" ], "type": "object", "description": "Returns information about the load balancer.\nWill be marked changed when called only if state is changed.", "properties": { "purge_subnets": { "type": "boolean" }, "purge_instance_ids": { "type": "boolean" }, "connection_draining_timeout": { "type": "string" }, "access_logs": { "type": "string" }, "state": { "type": "string" }, "purge_listeners": { "items": { "type": "boolean" }, "type": "array" }, "scheme": { "type": "string" }, "subnets": { "items": { "type": "string" }, "type": "array" }, "health_check": { "type": "string" }, "tags": { "type": "string" }, "instance_ids": { "items": { "type": "boolean" }, "type": "array" }, "idle_timeout": { "type": "string" }, "wait_timeout": { "type": "integer" }, "cross_az_load_balancing": { "type": "string" }, "security_group_ids": { "items": { "type": "string" }, "type": "array" }, "purge_zones": { "type": "boolean" }, "wait": { "type": "boolean" }, "zones": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "listeners": { "items": { "type": "string" }, "type": "array" }, "security_group_names": { "items": { "type": "string" }, "type": "array" }, "validate_certs": { "type": "string" }, "stickiness": { "items": { "type": "string" }, "type": "array" } } }, "eos_vlan": { "required": [ "vlan_id" ], "type": "object", "description": "This module provides declarative management of VLANs on Arista EOS network devices.", "properties": { "delay": { "type": "integer" }, "name": { "type": "string" }, "interfaces": { "items": { "type": "string" }, "type": "array" }, "purge": { "type": "boolean" }, "state": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" }, "vlan_id": { "type": "string" } } }, "avi_networksecuritypolicy": { "required": [], "type": "object", "description": "This module is used to configure NetworkSecurityPolicy object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "description": { "type": "string" }, "rules": { "items": { "type": "string" }, "type": "array" }, "tenant_ref": { "type": "string" }, "uuid": { "type": "string" }, "created_by": { "type": "string" }, "url": { "type": "string" }, "state": { "type": "string" }, "cloud_config_cksum": { "type": "string" }, "name": { "type": "string" } } }, "lightsail": { "required": [ "name" ], "type": "object", "description": "Creates or instances in AWS Lightsail and optionally wait for it to be 'running'.", "properties": { "name": { "type": "string" }, "zone": { "type": "string" }, "blueprint_id": { "type": "string" }, "wait_timeout": { "type": "integer" }, "user_data": { "type": "string" }, "state": { "type": "string" }, "key_pair_name": { "type": "string" }, "bundle_id": { "type": "string" }, "wait": { "type": "string" } } }, "netapp_e_storage_system": { "required": [ "ssid", "api_password", "api_username", "state", "api_url", "controller_addresses" ], "type": "object", "description": "Manage the arrays accessible via a NetApp Web Services Proxy for NetApp E-series storage arrays.", "properties": { "meta_tags": { "type": "string" }, "ssid": { "type": "string" }, "validate_certs": { "type": "boolean" }, "array_wwn": { "type": "string" }, "api_password": { "type": "string" }, "state": { "type": "string" }, "api_username": { "type": "string" }, "controller_addresses": { "items": { "type": "string" }, "type": "array" }, "enable_trace": { "type": "boolean" }, "array_password": { "type": "string" }, "api_url": { "type": "string" } } }, "aci_tenant_span_dst_group": { "required": [ "dst_group", "tenant" ], "type": "object", "description": "Manage SPAN destination groups on Cisco ACI fabrics.\nMore information from the internal APIC class I(span:DestGrp) at U(https://developer.cisco.com/media/mim-ref/MO-spanDestGrp.html).", "properties": { "state": { "items": { "type": "string" }, "type": "array" }, "dst_group": { "type": "string" }, "description": { "type": "string" }, "tenant": { "type": "string" } } }, "ce_dldp": { "required": [], "type": "object", "description": "Manages global DLDP configuration on HUAWEI CloudEngine switches.", "properties": { "reset": { "type": "string" }, "enable": { "type": "string" }, "auth_pwd": { "type": "string" }, "time_internal": { "type": "string" }, "auth_mode": { "type": "string" }, "work_mode": { "type": "string" } } }, "iso_extract": { "required": [ "dest", "files", "image" ], "type": "object", "description": "This module has two possible ways of operation.\nIf 7zip is installed on the system, this module extracts files from an ISO into a temporary directory and copies files to a given destination, if needed.\nIf the user has mount-capabilities (CAP_SYS_ADMIN on Linux) this module mounts the ISO image to a temporary location, and copies files to a given destination, if needed.", "properties": { "dest": { "type": "string" }, "files": { "items": { "type": "string" }, "type": "array" }, "image": { "type": "string" }, "force": { "type": "string" }, "executable": { "type": "string" } } }, "ovirt_host_pm": { "required": [ "name" ], "type": "object", "description": "Module to manage power management of hosts in oVirt/RHV.", "properties": { "username": { "type": "string" }, "slot": { "type": "string" }, "encrypt_options": { "type": "string" }, "name": { "type": "string" }, "order": { "type": "string" }, "state": { "type": "string" }, "options": { "type": "string" }, "address": { "type": "string" }, "password": { "type": "string" }, "type": { "type": "string" }, "port": { "type": "string" } } }, "template": { "required": [ "src", "dest" ], "type": "object", "description": "Templates are processed by the Jinja2 templating language (U(http://jinja.pocoo.org/docs/)) - documentation on the template formatting can be found in the Template Designer Documentation (U(http://jinja.pocoo.org/docs/templates/)).\nSix additional variables can be used in templates: C(ansible_managed) (configurable via the C(defaults) section of C(ansible.cfg)) contains a string which can be used to describe the template name, host, modification time of the template file and the owner uid. C(template_host) contains the node name of the template's machine. C(template_uid) the numeric user id of the owner. C(template_path) the path of the template. C(template_fullpath) is the absolute path of the template. C(template_run_date) is the date that the template was rendered.", "properties": { "src": { "type": "string" }, "force": { "type": "string" }, "trim_blocks": { "type": "string" }, "dest": { "type": "string" }, "block_end_string": { "type": "string" }, "variable_start_string": { "type": "string" }, "newline_sequence": { "type": "string" }, "variable_end_string": { "type": "string" }, "follow": { "type": "string" }, "block_start_string": { "type": "string" }, "backup": { "type": "string" } } }, "tower_inventory": { "required": [ "organization", "name" ], "type": "object", "description": "Create, update, or destroy Ansible Tower inventories. See U(https://www.ansible.com/tower) for an overview.", "properties": { "organization": { "type": "string" }, "variables": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "state": { "type": "string" } } }, "tower_job_wait": { "required": [ "job_id" ], "type": "object", "description": "Wait for Ansible Tower job to finish and report success or failure. See U(https://www.ansible.com/tower) for an overview.", "properties": { "min_interval": { "type": "integer" }, "max_interval": { "type": "integer" }, "job_id": { "type": "string" }, "timeout": { "type": "string" } } }, "ovirt_tags": { "required": [ "name" ], "type": "object", "description": "This module manage tags in oVirt/RHV. It can also manage assignments of those tags to entities.", "properties": { "description": { "type": "string" }, "parent": { "type": "string" }, "state": { "type": "string" }, "hosts": { "items": { "type": "string" }, "type": "array" }, "vms": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" } } }, "ovirt_cluster_facts": { "required": [], "type": "object", "description": "Retrieve facts about one or more oVirt/RHV clusters.", "properties": { "pattern": { "type": "string" } } }, "vyos_lldp_interface": { "required": [], "type": "object", "description": "This module provides declarative management of LLDP interfaces configuration on VyOS network devices.", "properties": { "aggregate": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "name": { "type": "string" } } }, "elasticache_subnet_group": { "required": [ "state", "name" ], "type": "object", "description": "Creates, modifies, and deletes Elasticache subnet groups. This module has a dependency on python-boto >= 2.5.", "properties": { "subnets": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } } }, "vmware_host": { "required": [ "cluster_name", "datacenter_name", "esxi_hostname", "esxi_password", "esxi_username" ], "type": "object", "description": "This module can be used to add/remove an ESXi host to/from vCenter.", "properties": { "datacenter_name": { "type": "string" }, "esxi_hostname": { "type": "string" }, "esxi_username": { "type": "string" }, "cluster_name": { "type": "string" }, "state": { "type": "string" }, "esxi_password": { "type": "string" } } }, "ce_snmp_location": { "required": [ "location" ], "type": "object", "description": "Manages SNMP location configurations on HUAWEI CloudEngine switches.", "properties": { "state": { "type": "string" }, "location": { "type": "string" } } }, "webfaction_domain": { "required": [ "login_name", "name", "login_password" ], "type": "object", "description": "Add or remove domains or subdomains on a Webfaction host. Further documentation at http://github.com/quentinsf/ansible-webfaction.", "properties": { "state": { "type": "string" }, "login_password": { "type": "string" }, "login_name": { "type": "string" }, "name": { "type": "string" }, "subdomains": { "type": "string" } } }, "webfaction_mailbox": { "required": [ "mailbox_password", "login_name", "mailbox_name", "login_password" ], "type": "object", "description": "Add or remove mailboxes on a Webfaction account. Further documentation at http://github.com/quentinsf/ansible-webfaction.", "properties": { "mailbox_password": { "type": "string" }, "state": { "type": "string" }, "login_name": { "type": "string" }, "mailbox_name": { "type": "string" }, "login_password": { "type": "string" } } }, "avi_vsdatascriptset": { "required": [ "name" ], "type": "object", "description": "This module is used to configure VSDataScriptSet object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "datascript": { "type": "string" }, "uuid": { "type": "string" }, "pool_refs": { "type": "string" }, "url": { "type": "string" }, "pool_group_refs": { "type": "string" }, "description": { "type": "string" }, "tenant_ref": { "type": "string" }, "ipgroup_refs": { "type": "string" }, "string_group_refs": { "type": "string" }, "state": { "type": "string" }, "name": { "type": "string" } } }, "sns_topic": { "required": [ "name" ], "type": "object", "description": "The C(sns_topic) module allows you to create, delete, and manage subscriptions for AWS SNS topics.", "properties": { "display_name": { "type": "string" }, "name": { "type": "string" }, "subscriptions": { "items": { "type": "string" }, "type": "array" }, "delivery_policy": { "type": "string" }, "state": { "type": "string" }, "policy": { "type": "string" }, "purge_subscriptions": { "items": { "type": "boolean" }, "type": "array" } } }, "sensu_silence": { "required": [ "state", "subscription" ], "type": "object", "description": "Create and clear (delete) a silence entries via the Sensu API for subscriptions and checks.", "properties": { "creator": { "type": "string" }, "url": { "type": "string" }, "expire_on_resolve": { "type": "string" }, "reason": { "type": "string" }, "state": { "type": "string" }, "expire": { "type": "string" }, "check": { "type": "string" }, "subscription": { "type": "string" } } }, "win_dotnet_ngen": { "required": [], "type": "object", "description": "After .NET framework is installed/updated, Windows will probably want to recompile things to optimise for the host.\nThis happens via scheduled task, usually at some inopportune time.\nThis module allows you to run this task on your own schedule, so you incur the CPU hit at some more convenient and controlled time.\nhttp://blogs.msdn.com/b/dotnet/archive/2013/08/06/wondering-why-mscorsvw-exe-has-high-cpu-usage-you-can-speed-it-up.aspx", "properties": {} }, "ipadm_if": { "required": [ "name" ], "type": "object", "description": "Create, delete, enable or disable IP interfaces on Solaris/illumos systems.", "properties": { "state": { "type": "string" }, "temporary": { "type": "boolean" }, "name": { "type": "string" } } }, "rpm_key": { "required": [ "key" ], "type": "object", "description": "Adds or removes (rpm --import) a gpg key to your rpm database.", "properties": { "state": { "type": "string" }, "validate_certs": { "type": "string" }, "key": { "type": "string" } } }, "win_robocopy": { "required": [ "dest", "src" ], "type": "object", "description": "Synchronizes the contents of two directories on the remote machine.\nUnder the hood this just calls out to RoboCopy, since that should be available on most modern Windows Systems.", "properties": { "dest": { "type": "string" }, "src": { "type": "string" }, "recurse": { "type": "string" }, "purge": { "type": "string" }, "flags": { "type": "string" } } }, "github_issue": { "required": [ "repo", "organization", "issue" ], "type": "object", "description": "View GitHub issue for a given repository.", "properties": { "repo": { "type": "string" }, "organization": { "type": "string" }, "issue": { "type": "string" }, "action": { "type": "string" } } }, "ovirt_hosts": { "required": [ "name" ], "type": "object", "description": "Module to manage hosts in oVirt/RHV", "properties": { "comment": { "type": "string" }, "check_upgrade": { "type": "boolean" }, "password": { "type": "string" }, "activate": { "type": "boolean" }, "force": { "type": "boolean" }, "name": { "type": "string" }, "public_key": { "type": "boolean" }, "spm_priority": { "type": "string" }, "iscsi": { "type": "string" }, "hosted_engine": { "type": "string" }, "power_management_enabled": { "type": "string" }, "cluster": { "type": "string" }, "state": { "type": "string" }, "kernel_params": { "items": { "type": "string" }, "type": "array" }, "address": { "type": "string" }, "override_iptables": { "type": "string" }, "kdump_integration": { "type": "string" }, "override_display": { "type": "string" } } }, "docker_login": { "required": [ "username", "password" ], "type": "object", "description": "Provides functionality similar to the \"docker login\" command.\nAuthenticate with a docker registry and add the credentials to your local Docker config file. Adding the credentials to the config files allows future connections to the registry using tools such as Ansible's Docker modules, the Docker CLI and docker-py without needing to provide credentials.\nRunning in check mode will perform the authentication without updating the config file.", "properties": { "username": { "type": "string" }, "config_path": { "type": "string" }, "registry_url": { "type": "string" }, "state": { "type": "string" }, "password": { "type": "string" }, "email": { "type": "string" }, "reauthorize": { "type": "boolean" } } }, "nxos_bgp_af": { "required": [ "afi", "safi", "vrf", "asn" ], "type": "object", "description": "Manages BGP Address-family configurations on NX-OS switches.", "properties": { "dampening_max_suppress_time": { "type": "string" }, "additional_paths_send": { "type": "string" }, "additional_paths_install": { "type": "string" }, "dampening_state": { "type": "string" }, "additional_paths_receive": { "type": "string" }, "suppress_inactive": { "type": "string" }, "dampening_routemap": { "type": "string" }, "networks": { "items": { "type": "string" }, "type": "array" }, "distance_local": { "type": "string" }, "advertise_l2vpn_evpn": { "type": "string" }, "afi": { "type": "string" }, "default_information_originate": { "type": "string" }, "distance_ibgp": { "type": "string" }, "state": { "type": "string" }, "next_hop_route_map": { "type": "string" }, "table_map_filter": { "type": "string" }, "safi": { "type": "string" }, "default_metric": { "type": "string" }, "client_to_client": { "type": "string" }, "dampen_igp_metric": { "type": "string" }, "additional_paths_selection": { "type": "string" }, "maximum_paths_ibgp": { "type": "string" }, "vrf": { "type": "string" }, "distance_ebgp": { "type": "string" }, "asn": { "type": "string" }, "redistribute": { "items": { "type": "string" }, "type": "array" }, "dampening_reuse_time": { "type": "string" }, "maximum_paths": { "type": "string" }, "inject_map": { "type": "string" }, "dampening_suppress_time": { "type": "string" }, "table_map": { "type": "string" }, "dampening_half_time": { "type": "string" } } }, "gitlab_user": { "required": [ "username", "name", "server_url", "password", "email" ], "type": "object", "description": "When the user does not exists in Gitlab, it will be created.\nWhen the user does exists and state=absent, the user will be deleted.\nWhen changes are made to user, the user will be updated.", "properties": { "username": { "type": "string" }, "group": { "type": "string" }, "name": { "type": "string" }, "sshkey_file": { "type": "string" }, "sshkey_name": { "type": "string" }, "login_user": { "type": "string" }, "login_token": { "type": "string" }, "confirm": { "type": "boolean" }, "server_url": { "type": "string" }, "access_level": { "type": "string" }, "state": { "type": "string" }, "login_password": { "type": "string" }, "password": { "type": "string" }, "validate_certs": { "type": "boolean" }, "email": { "type": "string" } } }, "bigip_policy": { "required": [ "name" ], "type": "object", "description": "Manages general policy configuration on a BIG-IP. This module is best used in conjunction with the C(bigip_policy_rule) module. This module can handle general configuration like setting the draft state of the policy, the description, and things unrelated to the policy rules themselves. It is also the first module that should be used when creating rules as the C(bigip_policy_rule) module requires a policy parameter.", "properties": { "description": { "type": "string" }, "rules": { "items": { "type": "string" }, "type": "array" }, "partition": { "type": "string" }, "strategy": { "type": "string" }, "state": { "type": "string" }, "name": { "type": "string" } } }, "azure_rm_dnsrecordset_facts": { "required": [], "type": "object", "description": "Get facts for a specific DNS Record Set in a Zone, or a specific type in all Zones or in one Zone etc.", "properties": { "zone_name": { "type": "string" }, "top": { "type": "integer" }, "record_type": { "type": "string" }, "resource_group": { "type": "string" }, "relative_name": { "type": "string" } } }, "cs_instance": { "required": [], "type": "object", "description": "Deploy, start, update, scale, restart, restore, stop and destroy instances.", "properties": { "domain": { "type": "string" }, "force": { "type": "boolean" }, "disk_offering": { "type": "string" }, "keyboard": { "type": "string" }, "user_data": { "type": "string" }, "root_disk_size": { "type": "string" }, "cpu_speed": { "type": "string" }, "ip6_address": { "type": "string" }, "networks": { "items": { "type": "string" }, "type": "array" }, "security_groups": { "items": { "type": "string" }, "type": "array" }, "group": { "type": "string" }, "zone": { "type": "string" }, "state": { "type": "string" }, "template": { "type": "string" }, "memory": { "type": "string" }, "iso": { "type": "string" }, "template_filter": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "ssh_key": { "type": "string" }, "display_name": { "type": "string" }, "service_offering": { "type": "string" }, "ip_address": { "type": "string" }, "account": { "type": "string" }, "disk_size": { "type": "string" }, "name": { "type": "string" }, "hypervisor": { "type": "string" }, "ip_to_networks": { "items": { "type": "string" }, "type": "array" }, "project": { "type": "string" }, "affinity_groups": { "type": "string" }, "poll_async": { "type": "boolean" }, "cpu": { "type": "string" } } }, "bigip_iapp_service": { "required": [ "name" ], "type": "object", "description": "Manages TCL iApp services on a BIG-IP.", "properties": { "force": { "type": "boolean" }, "name": { "type": "string" }, "parameters": { "items": { "type": "string" }, "type": "array" }, "strict_updates": { "type": "boolean" }, "partition": { "type": "string" }, "state": { "type": "string" }, "template": { "type": "string" }, "traffic_group": { "type": "string" } } }, "pushbullet": { "required": [ "title", "api_key" ], "type": "object", "description": "This module sends push notifications via Pushbullet to channels or devices.", "properties": { "body": { "type": "string" }, "title": { "type": "string" }, "push_type": { "type": "string" }, "device": { "type": "string" }, "api_key": { "type": "string" }, "channel": { "type": "string" } } }, "ec2_ami": { "required": [], "type": "object", "description": "Registers or deregisters ec2 images.", "properties": { "enhanced_networking": { "type": "string" }, "purge_tags": { "type": "string" }, "launch_permissions": { "items": { "type": "string" }, "type": "array" }, "ramdisk_id": { "type": "string" }, "no_reboot": { "type": "boolean" }, "billing_products": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "virtualization_type": { "type": "string" }, "sriov_net_support": { "type": "string" }, "root_device_name": { "type": "string" }, "image_location": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "string" }, "kernel_id": { "type": "string" }, "image_id": { "type": "string" }, "wait_timeout": { "type": "integer" }, "wait": { "type": "string" }, "name": { "type": "string" }, "delete_snapshot": { "type": "string" }, "instance_id": { "type": "string" }, "architecture": { "type": "string" }, "device_mapping": { "items": { "type": "string" }, "type": "array" } } }, "panos_check": { "required": [ "password", "ip_address" ], "type": "object", "description": "Check if PAN-OS device is ready for being configured (no pending jobs).\nThe check could be done once or multiple times until the device is ready.", "properties": { "username": { "type": "string" }, "password": { "type": "string" }, "ip_address": { "type": "string" }, "timeout": { "type": "string" }, "interval": { "type": "string" } } }, "os_ironic": { "required": [ "nics", "driver" ], "type": "object", "description": "Create or Remove Ironic nodes from OpenStack.", "properties": { "uuid": { "type": "string" }, "driver_info": { "type": "string" }, "availability_zone": { "type": "string" }, "nics": { "items": { "type": "string" }, "type": "array" }, "driver": { "type": "string" }, "ironic_url": { "type": "string" }, "state": { "type": "string" }, "chassis_uuid": { "type": "string" }, "skip_update_of_driver_password": { "type": "boolean" }, "properties": { "type": "string" }, "name": { "type": "string" } } }, "apt_rpm": { "required": [ "pkg" ], "type": "object", "description": "Manages packages with I(apt-rpm). Both low-level (I(rpm)) and high-level (I(apt-get)) package manager binaries required.", "properties": { "state": { "type": "string" }, "update_cache": { "type": "boolean" }, "pkg": { "type": "string" } } }, "nxos_vrrp": { "required": [ "group", "interface" ], "type": "object", "description": "Manages VRRP configuration on NX-OS switches.", "properties": { "group": { "type": "string" }, "vip": { "type": "string" }, "authentication": { "type": "string" }, "priority": { "type": "string" }, "state": { "type": "string" }, "admin_state": { "type": "string" }, "interface": { "type": "string" } } }, "dellos10_command": { "required": [ "commands" ], "type": "object", "description": "Sends arbitrary commands to a Dell OS10 node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.\nThis module does not support running commands in configuration mode. Please use M(dellos10_config) to configure Dell OS10 devices.", "properties": { "retries": { "type": "integer" }, "commands": { "items": { "type": "string" }, "type": "array" }, "wait_for": { "items": { "type": "string" }, "type": "array" }, "interval": { "type": "integer" } } }, "ping": { "required": [], "type": "object", "description": "A trivial test module, this module always returns C(pong) on successful contact. It does not make sense in playbooks, but it is useful from C(/usr/bin/ansible) to verify the ability to login and that a usable python is configured.\nThis is NOT ICMP ping, this is just a trivial test module.", "properties": {} }, "avi_cloud": { "required": [ "name", "vtype" ], "type": "object", "description": "This module is used to configure Cloud object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "vca_configuration": { "type": "string" }, "proxy_configuration": { "type": "string" }, "docker_configuration": { "type": "string" }, "oshiftk8s_configuration": { "type": "string" }, "mtu": { "type": "string" }, "rancher_configuration": { "type": "string" }, "vtype": { "type": "string" }, "uuid": { "type": "string" }, "linuxserver_configuration": { "type": "string" }, "nsx_configuration": { "type": "string" }, "state": { "type": "string" }, "apic_mode": { "type": "string" }, "dns_provider_ref": { "type": "string" }, "mesos_configuration": { "type": "string" }, "openstack_configuration": { "type": "string" }, "enable_vip_static_routes": { "type": "string" }, "aws_configuration": { "type": "string" }, "cloudstack_configuration": { "type": "string" }, "ipam_provider_ref": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "tenant_ref": { "type": "string" }, "dhcp_enabled": { "type": "string" }, "east_west_ipam_provider_ref": { "type": "string" }, "obj_name_prefix": { "type": "string" }, "apic_configuration": { "type": "string" }, "prefer_static_routes": { "type": "string" }, "license_type": { "type": "string" }, "vcenter_configuration": { "type": "string" }, "east_west_dns_provider_ref": { "type": "string" } } }, "bigip_facts": { "required": [ "include" ], "type": "object", "description": "Collect facts from F5 BIG-IP devices via iControl SOAP API", "properties": { "filter": { "type": "string" }, "include": { "items": { "type": "string" }, "type": "array" }, "session": { "type": "boolean" } } }, "os_volume": { "required": [ "display_name" ], "type": "object", "description": "Create or Remove cinder block storage volumes", "properties": { "display_name": { "type": "string" }, "availability_zone": { "type": "string" }, "image": { "type": "string" }, "volume_type": { "type": "string" }, "volume": { "type": "string" }, "state": { "type": "string" }, "display_description": { "type": "string" }, "snapshot_id": { "type": "string" }, "scheduler_hints": { "type": "string" }, "size": { "type": "string" } } }, "ce_eth_trunk": { "required": [ "trunk_id" ], "type": "object", "description": "Manages Eth-Trunk specific configuration parameters on HUAWEI CloudEngine switches.", "properties": { "force": { "type": "boolean" }, "hash_type": { "type": "string" }, "state": { "type": "string" }, "mode": { "type": "string" }, "members": { "items": { "type": "string" }, "type": "array" }, "min_links": { "type": "string" }, "trunk_id": { "type": "string" } } }, "a10_server_axapi3": { "required": [ "server_ip", "server_name" ], "type": "object", "description": "Manage SLB (Server Load Balancer) server objects on A10 Networks devices via aXAPIv3.", "properties": { "server_name": { "type": "string" }, "server_ports": { "items": { "type": "string" }, "type": "array" }, "server_status": { "type": "string" }, "server_ip": { "type": "string" }, "operation": { "type": "string" }, "validate_certs": { "type": "string" } } }, "set_fact": { "required": [ "key_value" ], "type": "object", "description": "This module allows setting new variables. Variables are set on a host-by-host basis just like facts discovered by the setup module.\nThese variables will be available to subsequent plays during an ansible-playbook run, but will not be saved across executions even if you use a fact cache.\nPer the standard Ansible variable precedence rules, many other types of variables have a higher priority, so this value may be overridden. See U(http://docs.ansible.com/ansible/playbooks_variables.html#variable-precedence-where-should-i-put-a-variable) for more information.\nThis module is also supported for Windows targets.", "properties": { "key_value": { "type": "string" }, "cacheable": { "type": "boolean" } } }, "ec2_eni_facts": { "required": [], "type": "object", "description": "Gather facts about ec2 ENI interfaces in AWS", "properties": { "filters": { "type": "string" } } }, "net_user": { "required": [], "type": "object", "description": "This module provides declarative management of the local usernames configured on network devices. It allows playbooks to manage either individual usernames or the aggregate of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined.", "properties": { "update_password": { "type": "string" }, "configured_password": { "type": "string" }, "name": { "type": "string" }, "nopassword": { "type": "string" }, "purge": { "type": "boolean" }, "privilege": { "type": "string" }, "state": { "type": "string" }, "role": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" }, "sshkey": { "type": "string" } } }, "vyos_logging": { "required": [], "type": "object", "description": "This module provides declarative management of logging on Vyatta Vyos devices.", "properties": { "name": { "type": "string" }, "facility": { "type": "string" }, "dest": { "type": "string" }, "level": { "type": "string" }, "state": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" } } }, "sns": { "required": [ "topic", "msg", "message_structure" ], "type": "object", "description": "The C(sns) module sends notifications to a topic on your Amazon SNS account", "properties": { "aws_secret_key": { "type": "string" }, "aws_access_key": { "type": "string" }, "http": { "type": "string" }, "sqs": { "type": "string" }, "region": { "type": "string" }, "sms": { "type": "string" }, "topic": { "type": "string" }, "https": { "type": "string" }, "msg": { "type": "string" }, "message_attributes": { "type": "string" }, "email": { "type": "string" }, "message_structure": { "type": "string" }, "subject": { "type": "string" } } }, "bigip_ssl_certificate": { "required": [ "name" ], "type": "object", "description": "This module will import/delete SSL certificates on BIG-IP LTM. Certificates can be imported from certificate and key files on the local disk, in PEM format.", "properties": { "key_src": { "type": "string" }, "key_content": { "type": "string" }, "cert_src": { "type": "string" }, "state": { "type": "string" }, "passphrase": { "type": "string" }, "cert_content": { "type": "string" }, "name": { "type": "string" } } }, "junos_vrf": { "required": [], "type": "object", "description": "This module provides declarative management of VRF definitions on Juniper JUNOS devices. It allows playbooks to manage individual or the entire VRF collection.", "properties": { "target": { "type": "string" }, "interfaces": { "type": "string" }, "description": { "type": "string" }, "rd": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "table_label": { "type": "string" }, "active": { "type": "boolean" }, "name": { "type": "string" } } }, "purefa_volume": { "required": [ "name" ], "type": "object", "description": "Create, delete or extend the capacity of a volume on Pure Storage FlashArray.", "properties": { "target": { "type": "string" }, "name": { "type": "string" }, "state": { "type": "string" }, "size": { "type": "string" }, "overwrite": { "type": "string" }, "eradicate": { "type": "string" } } }, "ecs_taskdefinition_facts": { "required": [ "task_definition" ], "type": "object", "description": "Describes a task definition in ecs.", "properties": { "task_definition": { "type": "string" } } }, "aci_tenant_ep_retention_policy": { "required": [], "type": "object", "description": "Manage End Point (EP) retention protocol policies on Cisco ACI fabrics.\nMore information from the internal APIC class I(fv:EpRetPol) at U(https://developer.cisco.com/media/mim-ref/MO-fvEpRetPol.html).", "properties": { "description": { "type": "string" }, "hold_interval": { "type": "integer" }, "state": { "items": { "type": "string" }, "type": "array" }, "bounce_trigger": { "type": "string" }, "epr_policy": { "type": "string" }, "local_ep_interval": { "type": "integer" }, "tenant": { "type": "string" }, "move_frequency": { "type": "integer" }, "remote_ep_interval": { "type": "integer" }, "bounce_age": { "type": "integer" } } }, "nxos_bgp_neighbor_af": { "required": [ "afi", "safi", "asn", "neighbor" ], "type": "object", "description": "Manages BGP address-family's neighbors configurations on NX-OS switches.", "properties": { "default_originate": { "type": "string" }, "next_hop_self": { "type": "string" }, "suppress_inactive": { "type": "string" }, "weight": { "type": "string" }, "soo": { "type": "string" }, "additional_paths_receive": { "type": "string" }, "route_reflector_client": { "type": "string" }, "max_prefix_limit": { "type": "string" }, "prefix_list_out": { "items": { "type": "string" }, "type": "array" }, "as_override": { "type": "string" }, "filter_list_out": { "items": { "type": "string" }, "type": "array" }, "additional_paths_send": { "type": "string" }, "allowas_in": { "type": "string" }, "max_prefix_warning": { "type": "string" }, "asn": { "type": "string" }, "state": { "type": "string" }, "advertise_map_non_exist": { "type": "string" }, "default_originate_route_map": { "type": "string" }, "neighbor": { "type": "string" }, "safi": { "type": "string" }, "filter_list_in": { "items": { "type": "string" }, "type": "array" }, "vrf": { "type": "string" }, "unsuppress_map": { "type": "string" }, "max_prefix_threshold": { "type": "string" }, "route_map_in": { "type": "string" }, "afi": { "type": "string" }, "soft_reconfiguration_in": { "type": "string" }, "max_prefix_interval": { "type": "string" }, "route_map_out": { "type": "string" }, "send_community": { "type": "string" }, "prefix_list_in": { "items": { "type": "string" }, "type": "array" }, "disable_peer_as_check": { "type": "string" }, "next_hop_third_party": { "type": "string" }, "advertise_map_exist": { "type": "string" }, "allowas_in_max": { "type": "string" } } }, "ce_netstream_export": { "required": [ "type" ], "type": "object", "description": "Configure NetStream flow statistics exporting and versions for exported packets on HUAWEI CloudEngine switches.", "properties": { "bgp_nexthop": { "type": "string" }, "host_port": { "type": "string" }, "source_ip": { "type": "string" }, "as_option": { "type": "string" }, "host_ip": { "type": "string" }, "state": { "type": "string" }, "version": { "type": "string" }, "type": { "type": "string" }, "host_vpn": { "type": "string" } } }, "avi_alertconfig": { "required": [ "name", "category", "source", "alert_rule" ], "type": "object", "description": "This module is used to configure AlertConfig object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "category": { "type": "string" }, "uuid": { "type": "string" }, "throttle": { "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "tenant_ref": { "type": "string" }, "object_type": { "type": "string" }, "enabled": { "type": "string" }, "autoscale_alert": { "type": "string" }, "summary": { "type": "string" }, "rolling_window": { "type": "string" }, "source": { "type": "string" }, "state": { "type": "string" }, "obj_uuid": { "type": "string" }, "alert_rule": { "items": { "type": "string" }, "type": "array" }, "recommendation": { "type": "string" }, "threshold": { "type": "string" }, "expiry_time": { "type": "string" }, "action_group_ref": { "type": "string" }, "name": { "type": "string" } } }, "netscaler_cs_vserver": { "required": [], "type": "object", "description": "Manage content switching vserver\nThis module is intended to run either on the ansible control node or a bastion (jumpserver) with access to the actual netscaler instance", "properties": { "comment": { "type": "string" }, "oracleserverversion": { "type": "string" }, "precedence": { "type": "string" }, "domainname": { "type": "string" }, "mysqlcharacterset": { "type": "string" }, "rtspnat": { "type": "string" }, "authn401": { "type": "string" }, "disabled": { "type": "string" }, "mysqlprotocolversion": { "type": "string" }, "listenpolicy": { "items": { "type": "string" }, "type": "array" }, "icmpvsrresponse": { "type": "string" }, "ttl": { "type": "string" }, "redirecturl": { "type": "string" }, "ipmask": { "type": "string" }, "insertvserveripport": { "type": "string" }, "redirectportrewrite": { "type": "string" }, "port": { "type": "string" }, "clttimeout": { "type": "string" }, "downstateflush": { "type": "string" }, "authenticationhost": { "type": "string" }, "servicetype": { "type": "string" }, "authnprofile": { "type": "string" }, "cookietimeout": { "type": "string" }, "mysqlservercapabilities": { "type": "string" }, "mysqlserverversion": { "type": "string" }, "backupvserver": { "type": "string" }, "backupip": { "type": "string" }, "vipheader": { "type": "string" }, "pushvserver": { "type": "string" }, "authentication": { "type": "string" }, "authnvsname": { "type": "string" }, "netprofile": { "type": "string" }, "pushmulticlients": { "type": "string" }, "td": { "type": "string" }, "httpprofilename": { "type": "string" }, "rhistate": { "type": "string" }, "targettype": { "type": "string" }, "sothreshold": { "type": "string" }, "sopersistence": { "type": "string" }, "appflowlog": { "type": "string" }, "sobackupaction": { "type": "string" }, "dbprofilename": { "type": "string" }, "cookiedomain": { "type": "string" }, "cacheable": { "type": "string" }, "l2conn": { "type": "string" }, "ipv46": { "type": "string" }, "name": { "type": "string" }, "ippattern": { "type": "string" }, "disableprimaryondown": { "type": "string" }, "tcpprofilename": { "type": "string" }, "mssqlserverversion": { "type": "string" }, "sitedomainttl": { "type": "string" }, "pushlabel": { "type": "string" }, "sopersistencetimeout": { "type": "string" }, "casesensitive": { "type": "string" }, "range": { "type": "string" }, "somethod": { "type": "string" }, "push": { "type": "string" }, "stateupdate": { "type": "string" }, "dnsprofilename": { "type": "string" } } }, "netapp_e_amg_role": { "required": [ "ssid", "api_password", "role", "api_username", "api_url" ], "type": "object", "description": "Update a storage array to become the primary or secondary instance in an asynchronous mirror group", "properties": { "force": { "type": "boolean" }, "ssid": { "type": "string" }, "api_password": { "type": "string" }, "role": { "type": "string" }, "api_username": { "type": "string" }, "validate_certs": { "type": "boolean" }, "noSync": { "type": "boolean" }, "api_url": { "type": "string" } } }, "svr4pkg": { "required": [ "state", "name" ], "type": "object", "description": "Manages SVR4 packages on Solaris 10 and 11.\nThese were the native packages on Solaris <= 10 and are available as a legacy feature in Solaris 11.\nNote that this is a very basic packaging system. It will not enforce dependencies on install or remove.", "properties": { "category": { "type": "string" }, "src": { "type": "string" }, "name": { "type": "string" }, "zone": { "type": "string" }, "state": { "type": "string" }, "proxy": { "type": "string" }, "response_file": { "type": "string" } } }, "group": { "required": [ "name" ], "type": "object", "description": "Manage presence of groups on a host.\nFor Windows targets, use the M(win_group) module instead.", "properties": { "state": { "type": "string" }, "gid": { "type": "string" }, "name": { "type": "string" }, "system": { "type": "string" } } }, "oneview_fcoe_network": { "required": [ "data" ], "type": "object", "description": "Provides an interface to manage FCoE Network resources. Can create, update, or delete.", "properties": { "state": { "type": "string" }, "data": { "items": { "type": "string" }, "type": "array" } } }, "avi_serverautoscalepolicy": { "required": [ "name" ], "type": "object", "description": "This module is used to configure ServerAutoScalePolicy object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "use_predicted_load": { "type": "string" }, "intelligent_autoscale": { "type": "string" }, "max_scalein_adjustment_step": { "type": "string" }, "intelligent_scalein_margin": { "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "intelligent_scaleout_margin": { "type": "string" }, "tenant_ref": { "type": "string" }, "scaleout_alertconfig_refs": { "type": "string" }, "min_size": { "type": "string" }, "state": { "type": "string" }, "scalein_alertconfig_refs": { "type": "string" }, "scalein_cooldown": { "type": "string" }, "max_scaleout_adjustment_step": { "type": "string" }, "uuid": { "type": "string" }, "scaleout_cooldown": { "type": "string" }, "max_size": { "type": "string" }, "name": { "type": "string" } } }, "mail": { "required": [ "subject" ], "type": "object", "description": "This module is useful for sending emails from playbooks.\nOne may wonder why automate sending emails? In complex environments there are from time to time processes that cannot be automated, either because you lack the authority to make it so, or because not everyone agrees to a common approach.\nIf you cannot automate a specific step, but the step is non-blocking, sending out an email to the responsible party to make them perform their part of the bargain is an elegant way to put the responsibility in someone else's lap.\nOf course sending out a mail can be equally useful as a way to notify one or more people in a team that a specific action has been (successfully) taken.", "properties": { "body": { "type": "string" }, "username": { "type": "string" }, "from": { "type": "string" }, "secure": { "type": "string" }, "headers": { "items": { "type": "string" }, "type": "array" }, "cc": { "items": { "type": "string" }, "type": "array" }, "charset": { "type": "string" }, "bcc": { "items": { "type": "string" }, "type": "array" }, "to": { "items": { "type": "string" }, "type": "array" }, "host": { "type": "string" }, "timeout": { "type": "integer" }, "subtype": { "type": "string" }, "attach": { "items": { "type": "string" }, "type": "array" }, "password": { "type": "string" }, "port": { "type": "integer" }, "subject": { "type": "string" } } }, "ovirt_datacenter_facts": { "required": [], "type": "object", "description": "Retrieve facts about one or more oVirt/RHV datacenters.", "properties": { "pattern": { "type": "string" } } }, "pushover": { "required": [ "msg", "user_key", "app_token" ], "type": "object", "description": "Send notifications via pushover, to subscriber list of devices, and email addresses. Requires pushover app on devices.", "properties": { "msg": { "type": "string" }, "user_key": { "type": "string" }, "app_token": { "type": "string" }, "pri": { "type": "string" } } }, "dladm_linkprop": { "required": [ "link", "property" ], "type": "object", "description": "Set / reset link properties on Solaris/illumos systems.", "properties": { "temporary": { "type": "boolean" }, "state": { "type": "string" }, "property": { "type": "string" }, "link": { "type": "string" }, "value": { "type": "string" } } }, "azure_rm_dnszone_facts": { "required": [], "type": "object", "description": "Get facts for a specific DNS zone or all DNS zones within a resource group.", "properties": { "name": { "type": "string" }, "resource_group": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } } }, "cs_instance_nic_secondaryip": { "required": [ "vm" ], "type": "object", "description": "Add and remove secondary IPs to and from a NIC of an instance.", "properties": { "vm_guest_ip": { "type": "string" }, "account": { "type": "string" }, "poll_async": { "type": "boolean" }, "network": { "type": "string" }, "zone": { "type": "string" }, "domain": { "type": "string" }, "vm": { "type": "string" }, "project": { "type": "string" }, "state": { "type": "string" }, "vpc": { "type": "string" } } }, "pn_vlan": { "required": [ "pn_vlanid", "state" ], "type": "object", "description": "Execute vlan-create or vlan-delete command.\nVLANs are used to isolate network traffic at Layer 2.The VLAN identifiers 0 and 4095 are reserved and cannot be used per the IEEE 802.1Q standard. The range of configurable VLAN identifiers is 2 through 4092.", "properties": { "pn_scope": { "type": "string" }, "pn_clipassword": { "type": "string" }, "pn_cliusername": { "type": "string" }, "pn_vlanid": { "type": "string" }, "state": { "type": "string" }, "pn_ports": { "items": { "type": "string" }, "type": "array" }, "pn_untagged_ports": { "type": "string" }, "pn_cliswitch": { "type": "string" }, "pn_stats": { "type": "string" }, "pn_description": { "type": "string" } } }, "azure_rm_subnet": { "required": [ "name", "resource_group", "address_prefix_cidr", "virtual_network_name" ], "type": "object", "description": "Create, update or delete a subnet within a given virtual network. Allows setting and updating the address prefix CIDR, which must be valid within the context of the virtual network. Use the azure_rm_networkinterface module to associate interfaces with the subnet and assign specific IP addresses.", "properties": { "name": { "type": "string" }, "resource_group": { "type": "string" }, "virtual_network_name": { "type": "string" }, "security_group_name": { "type": "string" }, "state": { "type": "string" }, "address_prefix_cidr": { "type": "string" } } }, "pn_vlag": { "required": [ "pn_name", "state" ], "type": "object", "description": "Execute vlag-create/vlag-delete/vlag-modify command.\nA virtual link aggregation group (VLAG) allows links that are physically connected to two different Pluribus Networks devices to appear as a single trunk to a third device. The third device can be a switch, server, or any Ethernet device. A VLAG can provide Layer 2 multipathing, which allows you to create redundancy by increasing bandwidth, enabling multiple parallel paths between nodes and loadbalancing traffic where alternative paths exist.", "properties": { "pn_name": { "type": "string" }, "pn_lacp_fallback": { "type": "string" }, "pn_lacp_fallback_timeout": { "type": "string" }, "pn_clipassword": { "type": "string" }, "pn_lacp_timeout": { "type": "string" }, "pn_failover_action": { "type": "string" }, "pn_cliusername": { "type": "string" }, "pn_lacp_mode": { "type": "string" }, "state": { "type": "string" }, "pn_peer_port": { "type": "string" }, "pn_peer_switch": { "type": "string" }, "pn_mode": { "type": "string" }, "pn_cliswitch": { "type": "string" }, "pn_port": { "type": "string" } } }, "nxos_ip_interface": { "required": [ "interface" ], "type": "object", "description": "Manages Layer 3 attributes for IPv4 and IPv6 interfaces.", "properties": { "addr": { "type": "string" }, "dot1q": { "type": "string" }, "mask": { "type": "string" }, "state": { "type": "string" }, "tag": { "type": "integer" }, "interface": { "type": "string" }, "allow_secondary": { "type": "boolean" } } }, "name": { "type": "string" }, "clc_server": { "required": [], "type": "object", "description": "An Ansible module to Create, Delete, Start and Stop servers in CenturyLink Cloud.", "properties": { "anti_affinity_policy_name": { "type": "string" }, "storage_type": { "type": "string" }, "anti_affinity_policy_id": { "type": "string" }, "ttl": { "type": "string" }, "count_group": { "type": "string" }, "secondary_dns": { "type": "string" }, "custom_fields": { "items": { "type": "string" }, "type": "array" }, "password": { "type": "string" }, "group": { "type": "string" }, "exact_count": { "type": "string" }, "state": { "type": "string" }, "cpu_autoscale_policy_id": { "type": "string" }, "template": { "type": "string" }, "memory": { "type": "integer" }, "server_ids": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" }, "managed_os": { "type": "boolean" }, "location": { "type": "string" }, "additional_disks": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" }, "add_public_ip": { "type": "boolean" }, "alert_policy_id": { "type": "string" }, "alert_policy_name": { "type": "string" }, "packages": { "items": { "type": "string" }, "type": "array" }, "ip_address": { "type": "string" }, "os_type": { "type": "string" }, "wait": { "type": "boolean" }, "count": { "type": "integer" }, "name": { "type": "string" }, "network_id": { "type": "string" }, "primary_dns": { "type": "string" }, "alias": { "type": "string" }, "public_ip_ports": { "items": { "type": "string" }, "type": "array" }, "source_server_password": { "type": "string" }, "public_ip_protocol": { "type": "string" }, "configuration_id": { "type": "string" }, "cpu": { "type": "integer" } } }, "aci_aep": { "required": [ "aep" ], "type": "object", "description": "Connect to external virtual and physical domains by using attachable Access Entity Profiles (AEP) on Cisco ACI fabrics.\nMore information from the internal APIC class I(infra:AttEntityP) at U(https://developer.cisco.com/media/mim-ref/MO-infraAttEntityP.html).", "properties": { "aep": { "type": "string" }, "state": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" } } }, "ec2_vpc_route_table": { "required": [ "vpc_id" ], "type": "object", "description": "Manage route tables for AWS virtual private clouds", "properties": { "subnets": { "type": "string" }, "tags": { "type": "string" }, "purge_subnets": { "type": "string" }, "state": { "type": "string" }, "routes": { "items": { "type": "string" }, "type": "array" }, "purge_routes": { "type": "string" }, "lookup": { "type": "string" }, "route_table_id": { "type": "string" }, "vpc_id": { "type": "string" }, "propagating_vgw_ids": { "type": "string" } } }, "avi_tenant": { "required": [ "name" ], "type": "object", "description": "This module is used to configure Tenant object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "config_settings": { "type": "string" }, "url": { "type": "string" }, "description": { "type": "string" }, "uuid": { "type": "string" }, "created_by": { "type": "string" }, "state": { "type": "string" }, "local": { "type": "string" }, "name": { "type": "string" } } }, "facter": { "required": [], "type": "object", "description": "Runs the I(facter) discovery program (U(https://github.com/puppetlabs/facter)) on the remote system, returning JSON data that can be useful for inventory purposes.", "properties": {} }, "vdirect_file": { "required": [ "vdirect_user", "file_name", "vdirect_ip", "vdirect_password" ], "type": "object", "description": "Uploads a new or updates an existing configuration template or workflow template into the Radware vDirect server. All parameters may be set as environment variables.", "properties": { "vdirect_user": { "type": "string" }, "vdirect_https_port": { "type": "integer" }, "vdirect_validate_certs": { "type": "string" }, "file_name": { "type": "string" }, "vdirect_timeout": { "type": "integer" }, "vdirect_wait": { "type": "string" }, "vdirect_ip": { "type": "string" }, "vdirect_password": { "type": "string" }, "vdirect_secondary_ip": { "type": "string" }, "vdirect_use_ssl": { "type": "string" }, "vdirect_http_port": { "type": "integer" } } }, "cs_loadbalancer_rule_member": { "required": [ "name", "vms" ], "type": "object", "description": "Add and remove load balancer rule members.", "properties": { "account": { "type": "string" }, "name": { "type": "string" }, "zone": { "type": "string" }, "domain": { "type": "string" }, "project": { "type": "string" }, "state": { "type": "string" }, "ip_address": { "type": "string" }, "vms": { "items": { "type": "string" }, "type": "array" } } }, "gcp_forwarding_rule": { "required": [ "forwarding_rule_name", "state" ], "type": "object", "description": "Create, Update or Destroy a Forwarding_Rule. See U(https://cloud.google.com/compute/docs/load-balancing/http/target-proxies) for an overview. More details on the Global Forwarding_Rule API can be found at U(https://cloud.google.com/compute/docs/reference/latest/globalForwardingRules) More details on the Forwarding Rules API can be found at U(https://cloud.google.com/compute/docs/reference/latest/forwardingRules)", "properties": { "protocol": { "type": "string" }, "target": { "type": "string" }, "region": { "type": "string" }, "forwarding_rule_name": { "type": "string" }, "port_range": { "type": "string" }, "state": { "type": "string" }, "address": { "type": "string" } } }, "eos_system": { "required": [], "type": "object", "description": "This module provides declarative management of node system attributes on Arista EOS devices. It provides an option to configure host system parameters or remove those parameters from the device active configuration.", "properties": { "lookup_source": { "items": { "type": "string" }, "type": "array" }, "domain_search": { "items": { "type": "string" }, "type": "array" }, "hostname": { "type": "string" }, "domain_name": { "type": "string" }, "state": { "type": "string" }, "name_servers": { "items": { "type": "string" }, "type": "array" } } }, "a10_virtual_server": { "required": [ "virtual_server" ], "type": "object", "description": "Manage SLB (Server Load Balancing) virtual server objects on A10 Networks devices via aXAPIv2.", "properties": { "partition": { "type": "string" }, "virtual_server_ports": { "items": { "type": "string" }, "type": "array" }, "virtual_server_status": { "type": "string" }, "virtual_server_ip": { "type": "string" }, "virtual_server": { "type": "string" }, "validate_certs": { "type": "string" } } }, "avi_role": { "required": [ "name" ], "type": "object", "description": "This module is used to configure Role object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "uuid": { "type": "string" }, "url": { "type": "string" }, "privileges": { "items": { "type": "string" }, "type": "array" }, "tenant_ref": { "type": "string" }, "state": { "type": "string" }, "name": { "type": "string" } } }, "ec2_vpc_igw": { "required": [ "vpc_id" ], "type": "object", "description": "Manage an AWS VPC Internet gateway", "properties": { "vpc_id": { "type": "string" }, "state": { "type": "string" }, "tags": { "type": "string" } } }, "ovh_ip_loadbalancing_backend": { "required": [ "endpoint", "name", "application_key", "application_secret", "consumer_key", "backend" ], "type": "object", "description": "Manage OVH (French European hosting provider) LoadBalancing IP backends", "properties": { "endpoint": { "type": "string" }, "name": { "type": "string" }, "weight": { "type": "integer" }, "probe": { "type": "string" }, "application_key": { "type": "string" }, "state": { "type": "string" }, "application_secret": { "type": "string" }, "timeout": { "type": "integer" }, "consumer_key": { "type": "string" }, "backend": { "type": "string" } } }, "win_path": { "required": [ "elements" ], "type": "object", "description": "Allows element-based ordering, addition, and removal of Windows path environment variables.", "properties": { "scope": { "type": "string" }, "state": { "type": "string" }, "elements": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" } } }, "ios_static_route": { "required": [], "type": "object", "description": "This module provides declarative management of static IP routes on Cisco IOS network devices.", "properties": { "mask": { "type": "string" }, "prefix": { "type": "string" }, "admin_distance": { "type": "integer" }, "state": { "type": "string" }, "next_hop": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" } } }, "dellos9_facts": { "required": [], "type": "object", "description": "Collects a base set of device facts from a remote device that is running OS9. This module prepends all of the base network fact keys with C(ansible_net_). The facts module always collects a base set of facts from the device and can enable or disable collection of additional facts.", "properties": { "gather_subset": { "items": { "type": "string" }, "type": "array" } } }, "ce_snmp_user": { "required": [], "type": "object", "description": "Manages SNMP user configurations on CloudEngine switches.", "properties": { "priv_key": { "type": "string" }, "aaa_local_user": { "type": "string" }, "auth_key": { "type": "string" }, "usm_user_name": { "type": "string" }, "acl_number": { "items": { "type": "string" }, "type": "array" }, "auth_protocol": { "type": "string" }, "remote_engine_id": { "type": "string" }, "priv_protocol": { "type": "string" }, "user_group": { "type": "string" } } }, "ipadm_addr": { "required": [ "addrobj" ], "type": "object", "description": "Create/delete static/dynamic IP addresses on network interfaces on Solaris/illumos systems.\nUp/down static/dynamic IP addresses on network interfaces on Solaris/illumos systems.\nManage IPv6 link-local addresses on network interfaces on Solaris/illumos systems.", "properties": { "addrtype": { "type": "string" }, "temporary": { "type": "boolean" }, "state": { "type": "string" }, "address": { "type": "string" }, "wait": { "type": "integer" }, "addrobj": { "type": "string" } } }, "nxos_vtp_domain": { "required": [ "domain" ], "type": "object", "description": "Manages VTP domain configuration.", "properties": { "domain": { "type": "string" } } }, "git": { "required": [ "dest", "repo" ], "type": "object", "description": "Manage I(git) checkouts of repositories to deploy files or software.", "properties": { "depth": { "type": "string" }, "executable": { "type": "string" }, "refspec": { "type": "string" }, "force": { "type": "string" }, "track_submodules": { "type": "string" }, "reference": { "type": "string" }, "dest": { "type": "string" }, "verify_commit": { "type": "string" }, "clone": { "type": "string" }, "accept_hostkey": { "type": "string" }, "update": { "type": "string" }, "ssh_opts": { "type": "string" }, "repo": { "type": "string" }, "umask": { "type": "string" }, "version": { "type": "string" }, "bare": { "type": "string" }, "remote": { "type": "string" }, "key_file": { "type": "string" }, "archive": { "type": "string" }, "recursive": { "type": "string" } } }, "dellos10_config": { "required": [], "type": "object", "description": "OS10 configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with OS10 configuration sections in a deterministic way.", "properties": { "src": { "type": "string" }, "backup": { "type": "boolean" }, "after": { "type": "string" }, "lines": { "type": "string" }, "update": { "type": "string" }, "replace": { "type": "string" }, "parents": { "type": "string" }, "save": { "type": "boolean" }, "config": { "type": "string" }, "match": { "type": "string" }, "before": { "type": "string" } } }, "deploy_helper": { "required": [ "path" ], "type": "object", "description": "The Deploy Helper manages some of the steps common in deploying software. It creates a folder structure, manages a symlink for the current release and cleans up old releases.\nRunning it with the C(state=query) or C(state=present) will return the C(deploy_helper) fact. C(project_path), whatever you set in the path parameter, C(current_path), the path to the symlink that points to the active release, C(releases_path), the path to the folder to keep releases in, C(shared_path), the path to the folder to keep shared resources in, C(unfinished_filename), the file to check for to recognize unfinished builds, C(previous_release), the release the 'current' symlink is pointing to, C(previous_release_path), the full path to the 'current' symlink target, C(new_release), either the 'release' parameter or a generated timestamp, C(new_release_path), the path to the new release folder (not created by the module).", "properties": { "unfinished_filename": { "type": "string" }, "keep_releases": { "type": "integer" }, "current_path": { "type": "string" }, "state": { "type": "string" }, "shared_path": { "type": "string" }, "releases_path": { "type": "string" }, "clean": { "type": "boolean" }, "release": { "type": "string" }, "path": { "type": "string" } } }, "rax_scaling_policy": { "required": [ "name", "scaling_group", "policy_type" ], "type": "object", "description": "Manipulate Rackspace Cloud Autoscale Scaling Policy", "properties": { "is_percent": { "type": "boolean" }, "name": { "type": "string" }, "scaling_group": { "type": "string" }, "cron": { "type": "string" }, "desired_capacity": { "type": "string" }, "state": { "type": "string" }, "cooldown": { "type": "string" }, "at": { "type": "string" }, "policy_type": { "type": "string" }, "change": { "type": "string" } } }, "cs_instance_facts": { "required": [ "name" ], "type": "object", "description": "Gathering facts from the API of an instance.", "properties": { "project": { "type": "string" }, "account": { "type": "string" }, "domain": { "type": "string" }, "name": { "type": "string" } } }, "bigmon_chain": { "required": [ "controller", "name" ], "type": "object", "description": "Create and remove a bigmon inline service chain.", "properties": { "access_token": { "type": "string" }, "state": { "type": "string" }, "validate_certs": { "type": "boolean" }, "controller": { "type": "string" }, "name": { "type": "string" } } }, "homebrew_tap": { "required": [ "name" ], "type": "object", "description": "Tap external Homebrew repositories.", "properties": { "url": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "name": { "type": "string" } } }, "na_cdot_license": { "required": [], "type": "object", "description": "Add or remove licenses on NetApp ONTAP.", "properties": { "remove_expired": { "type": "string" }, "serial_number": { "type": "string" }, "licenses": { "items": { "type": "string" }, "type": "array" }, "remove_unused": { "type": "string" } } }, "easy_install": { "required": [ "name" ], "type": "object", "description": "Installs Python libraries, optionally in a I(virtualenv)", "properties": { "virtualenv": { "type": "string" }, "virtualenv_command": { "type": "string" }, "name": { "type": "string" }, "executable": { "type": "string" }, "virtualenv_site_packages": { "type": "string" }, "state": { "type": "string" } } }, "yum": { "required": [ "name" ], "type": "object", "description": "Installs, upgrade, downgrades, removes, and lists packages and groups with the I(yum) package manager.", "properties": { "allow_downgrade": { "items": { "type": "string" }, "type": "array" }, "name": { "items": { "type": "string" }, "type": "array" }, "list": { "items": { "type": "string" }, "type": "array" }, "disable_gpg_check": { "type": "string" }, "conf_file": { "type": "string" }, "update_only": { "type": "string" }, "state": { "type": "string" }, "disablerepo": { "type": "string" }, "update_cache": { "type": "string" }, "enablerepo": { "type": "string" }, "exclude": { "type": "string" }, "security": { "type": "string" }, "validate_certs": { "type": "string" }, "installroot": { "type": "string" }, "skip_broken": { "type": "string" } } }, "win_owner": { "required": [ "path", "user" ], "type": "object", "description": "Set owner of files or directories", "properties": { "path": { "type": "string" }, "recurse": { "type": "string" }, "user": { "type": "string" } } }, "lambda": { "required": [ "name" ], "type": "object", "description": "Allows for the management of Lambda functions.", "properties": { "vpc_security_group_ids": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" }, "s3_key": { "type": "string" }, "zip_file": { "type": "string" }, "s3_object_version": { "type": "string" }, "state": { "type": "string" }, "handler": { "type": "string" }, "memory_size": { "type": "integer" }, "timeout": { "type": "integer" }, "environment_variables": { "type": "string" }, "role": { "type": "string" }, "dead_letter_arn": { "type": "string" }, "runtime": { "type": "string" }, "s3_bucket": { "type": "string" }, "vpc_subnet_ids": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" } } }, "route53_health_check": { "required": [ "request_interval", "type", "state", "failure_threshold" ], "type": "object", "description": "Creates and deletes DNS Health checks in Amazons Route53 service\nOnly the port, resource_path, string_match and request_interval are considered when updating existing health-checks.", "properties": { "request_interval": { "type": "integer" }, "ip_address": { "type": "string" }, "fqdn": { "type": "string" }, "string_match": { "type": "string" }, "state": { "type": "string" }, "resource_path": { "type": "string" }, "failure_threshold": { "type": "integer" }, "type": { "type": "string" }, "port": { "type": "string" } } }, "ios_interface": { "required": [ "name" ], "type": "object", "description": "This module provides declarative management of Interfaces on Cisco IOS network devices.", "properties": { "neighbors": { "type": "string" }, "delay": { "type": "integer" }, "name": { "type": "string" }, "duplex": { "type": "string" }, "enabled": { "type": "string" }, "mtu": { "type": "string" }, "rx_rate": { "type": "string" }, "state": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" }, "speed": { "type": "string" }, "tx_rate": { "type": "string" }, "description": { "type": "string" } } }, "aci_l3out_route_tag_policy": { "required": [ "rtp", "tenant" ], "type": "object", "description": "Manage route tag policies on Cisco ACI fabrics.\nMore information from the internal APIC class I(l3ext:RouteTagPol) at U(https://developer.cisco.com/media/mim-ref/MO-l3extRouteTagPol.html).", "properties": { "state": { "items": { "type": "string" }, "type": "array" }, "tag": { "type": "string" }, "rtp": { "type": "string" }, "tenant": { "type": "string" }, "description": { "type": "string" } } }, "vyos_facts": { "required": [], "type": "object", "description": "Collects a base set of device facts from a remote device that is running VyOS. This module prepends all of the base network fact keys with U(ansible_net_). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.", "properties": { "gather_subset": { "items": { "type": "string" }, "type": "array" } } }, "oneview_fcoe_network_facts": { "required": [], "type": "object", "description": "Retrieve the facts about one or more of the FCoE Networks from OneView.", "properties": { "name": { "type": "string" } } }, "iam": { "required": [ "name", "iam_type", "state" ], "type": "object", "description": "Allows for the management of IAM users, user API keys, groups, roles.", "properties": { "new_name": { "type": "string" }, "update_password": { "type": "string" }, "new_path": { "type": "string" }, "name": { "type": "string" }, "key_count": { "type": "string" }, "access_key_state": { "type": "string" }, "iam_type": { "type": "string" }, "state": { "type": "string" }, "access_key_ids": { "items": { "type": "string" }, "type": "array" }, "groups": { "items": { "type": "string" }, "type": "array" }, "trust_policy": { "type": "string" }, "path": { "type": "string" }, "password": { "type": "string" }, "trust_policy_filepath": { "type": "string" } } }, "os_client_config": { "required": [], "type": "object", "description": "Get I(openstack) client config data from clouds.yaml or environment", "properties": { "clouds": { "items": { "type": "string" }, "type": "array" } } }, "ios_banner": { "required": [ "banner" ], "type": "object", "description": "This will configure both login and motd banners on remote devices running Cisco IOS. It allows playbooks to add or remote banner text from the active running configuration.", "properties": { "text": { "type": "string" }, "state": { "type": "string" }, "banner": { "type": "string" } } }, "azure_rm_availabilityset": { "required": [ "name", "resource_group" ], "type": "object", "description": "Create, update and delete Azure availability set. An availability set cannot be updated, you will have to recreate one instead. The only update operation will be for the tags.", "properties": { "sku": { "type": "string" }, "name": { "type": "string" }, "resource_group": { "type": "string" }, "platform_update_domain_count": { "type": "integer" }, "platform_fault_domain_count": { "type": "integer" }, "state": { "type": "string" }, "location": { "type": "string" } } }, "oneview_network_set_facts": { "required": [], "type": "object", "description": "Retrieve facts about the Network Sets from OneView.", "properties": { "name": { "type": "string" }, "options": { "items": { "type": "string" }, "type": "array" } } }, "ec2_ami_facts": { "required": [], "type": "object", "description": "Gather facts about ec2 AMIs", "properties": { "image_ids": { "type": "string" }, "owners": { "type": "string" }, "filters": { "type": "string" }, "executable_users": { "type": "string" } } }, "ce_mlag_config": { "required": [], "type": "object", "description": "Manages MLAG configuration on HUAWEI CloudEngine switches.", "properties": { "eth_trunk_id": { "type": "string" }, "pseudo_priority": { "type": "string" }, "nickname": { "type": "string" }, "priority_id": { "type": "string" }, "vpn_instance_name": { "type": "string" }, "peer_link_id": { "type": "string" }, "state": { "type": "string" }, "dfs_group_id": { "type": "string" }, "ip_address": { "type": "string" }, "pseudo_nickname": { "type": "string" } } }, "netapp_e_volume": { "required": [ "name", "state", "storage_pool_name", "thin_volume_repo_size", "size" ], "type": "object", "description": "Create or remove volumes (standard and thin) for NetApp E/EF-series storage arrays.", "properties": { "segment_size_kb": { "type": "integer" }, "ssd_cache_enabled": { "type": "string" }, "name": { "type": "string" }, "data_assurance_enabled": { "type": "boolean" }, "thin_provision": { "type": "boolean" }, "size_unit": { "type": "string" }, "state": { "type": "string" }, "storage_pool_name": { "type": "string" }, "thin_volume_max_repo_size": { "type": "string" }, "thin_volume_repo_size": { "type": "string" }, "size": { "type": "string" } } }, "nxos_ntp_options": { "required": [], "type": "object", "description": "Manages NTP options, e.g. authoritative server and logging.", "properties": { "logging": { "type": "string" }, "state": { "type": "string" }, "master": { "type": "string" }, "stratum": { "type": "string" } } }, "netconf_config": { "required": [ "username", "host", "password" ], "type": "object", "description": "Netconf is a network management protocol developed and standardized by the IETF. It is documented in RFC 6241.\nThis module allows the user to send a configuration XML file to a netconf device, and detects if there was a configuration change.", "properties": { "username": { "type": "string" }, "xml": { "type": "string" }, "password": { "type": "string" }, "allow_agent": { "type": "boolean" }, "src": { "type": "string" }, "host": { "type": "string" }, "look_for_keys": { "type": "boolean" }, "hostkey_verify": { "type": "boolean" }, "datastore": { "type": "string" }, "save": { "type": "boolean" }, "port": { "type": "integer" } } }, "copy": { "required": [ "dest" ], "type": "object", "description": "The C(copy) module copies a file from the local or remote machine to a location on the remote machine. Use the M(fetch) module to copy files from remote locations to the local box. If you need variable interpolation in copied files, use the M(template) module.\nFor Windows targets, use the M(win_copy) module instead.", "properties": { "src": { "type": "string" }, "directory_mode": { "type": "string" }, "force": { "type": "string" }, "remote_src": { "type": "string" }, "dest": { "type": "string" }, "content": { "type": "string" }, "follow": { "type": "string" }, "backup": { "type": "string" }, "local_follow": { "type": "string" } } }, "pam_limits": { "required": [ "domain", "value", "limit_item", "limit_type" ], "type": "object", "description": "The C(pam_limits) module modify PAM limits, default in /etc/security/limits.conf. For the full documentation, see man limits.conf(5).", "properties": { "comment": { "type": "string" }, "use_max": { "type": "string" }, "domain": { "type": "string" }, "dest": { "type": "string" }, "value": { "type": "string" }, "use_min": { "type": "string" }, "limit_item": { "type": "string" }, "limit_type": { "type": "string" }, "backup": { "type": "string" } } }, "win_template": { "required": [ "src", "dest" ], "type": "object", "description": "Templates are processed by the Jinja2 templating language (U(http://jinja.pocoo.org/docs/)) - documentation on the template formatting can be found in the Template Designer Documentation (U(http://jinja.pocoo.org/docs/templates/)).\nSix additional variables can be used in templates: C(ansible_managed) (configurable via the C(defaults) section of C(ansible.cfg)) contains a string which can be used to describe the template name, host, modification time of the template file and the owner uid, C(template_host) contains the node name of the template's machine, C(template_uid) the owner, C(template_path) the absolute path of the template, C(template_fullpath) is the absolute path of the template, and C(template_run_date) is the date that the template was rendered. Note that including a string that uses a date in the template will result in the template being marked 'changed' each time.", "properties": { "src": { "type": "string" }, "force": { "type": "string" }, "trim_blocks": { "type": "string" }, "dest": { "type": "string" }, "block_end_string": { "type": "string" }, "variable_start_string": { "type": "string" }, "newline_sequence": { "type": "string" }, "variable_end_string": { "type": "string" }, "block_start_string": { "type": "string" } } }, "cs_configuration": { "required": [ "name", "value" ], "type": "object", "description": "Manages global, zone, account, storage and cluster configurations.", "properties": { "account": { "type": "string" }, "name": { "type": "string" }, "zone": { "type": "string" }, "storage": { "type": "string" }, "domain": { "type": "string" }, "value": { "type": "string" }, "cluster": { "type": "string" } } }, "ec2_scaling_policy": { "required": [ "state", "name", "asg_name" ], "type": "object", "description": "Can create or delete scaling policies for autoscaling groups\nReferenced autoscaling groups must already exist", "properties": { "name": { "type": "string" }, "asg_name": { "type": "string" }, "adjustment_type": { "type": "string" }, "min_adjustment_step": { "type": "string" }, "scaling_adjustment": { "type": "string" }, "state": { "type": "string" }, "cooldown": { "type": "string" } } }, "aos_logical_device_map": { "required": [ "session" ], "type": "object", "description": "Apstra AOS Logical Device Map module let you manage your Logical Device Map easily. You can create create and delete Logical Device Map by Name, ID or by using a JSON File. This module is idempotent and support the I(check) mode. It's using the AOS REST API.", "properties": { "content": { "type": "string" }, "state": { "type": "string" }, "session": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "string" } } }, "rax_clb": { "required": [], "type": "object", "description": "creates / deletes a Rackspace Public Cloud load balancer.", "properties": { "protocol": { "type": "string" }, "name": { "type": "string" }, "algorithm": { "type": "string" }, "state": { "type": "string" }, "wait_timeout": { "type": "integer" }, "meta": { "type": "string" }, "timeout": { "type": "integer" }, "wait": { "type": "string" }, "type": { "type": "string" }, "port": { "type": "integer" }, "vip_id": { "type": "string" } } }, "influxdb_database": { "required": [ "database_name", "hostname" ], "type": "object", "description": "Manage InfluxDB databases", "properties": { "username": { "type": "string" }, "database_name": { "type": "string" }, "hostname": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "password": { "type": "string" }, "port": { "items": { "type": "integer" }, "type": "array" } } }, "bigip_monitor_tcp": { "required": [ "name" ], "type": "object", "description": "Manages F5 BIG-IP LTM tcp monitors via iControl SOAP API.", "properties": { "name": { "type": "string" }, "parent": { "type": "string" }, "receive": { "type": "string" }, "ip": { "type": "string" }, "interval": { "type": "string" }, "send": { "type": "string" }, "time_until_up": { "type": "string" }, "timeout": { "type": "string" }, "type": { "type": "string" }, "port": { "type": "string" } } }, "cs_staticnat": { "required": [ "ip_address" ], "type": "object", "description": "Create, update and remove static NATs.", "properties": { "vm_guest_ip": { "type": "boolean" }, "domain": { "type": "string" }, "poll_async": { "type": "boolean" }, "network": { "type": "string" }, "zone": { "type": "string" }, "vm": { "type": "string" }, "project": { "type": "string" }, "state": { "type": "string" }, "vpc": { "type": "string" }, "account": { "type": "string" }, "ip_address": { "type": "string" } } }, "dellos6_facts": { "required": [], "type": "object", "description": "Collects a base set of device facts from a remote device that is running OS6. This module prepends all of the base network fact keys with C(ansible_net_). The facts module always collects a base set of facts from the device and can enable or disable collection of additional facts.", "properties": { "gather_subset": { "items": { "type": "string" }, "type": "array" } } }, "dconf": { "required": [ "key" ], "type": "object", "description": "This module allows modifications and reading of dconf database. The module is implemented as a wrapper around dconf tool. Please see the dconf(1) man page for more details.\nSince C(dconf) requires a running D-Bus session to change values, the module will try to detect an existing session and reuse it, or run the tool via C(dbus-run-session).", "properties": { "state": { "type": "string" }, "value": { "type": "string" }, "key": { "type": "string" } } }, "docker_image": { "required": [ "name" ], "type": "object", "description": "Build, load or pull an image, making the image available for creating containers. Also supports tagging an image into a repository and archiving an image to a .tar file.", "properties": { "archive_path": { "type": "string" }, "pull": { "type": "boolean" }, "force": { "type": "boolean" }, "name": { "type": "string" }, "repository": { "type": "string" }, "container_limits": { "type": "string" }, "dockerfile": { "type": "string" }, "nocache": { "type": "boolean" }, "load_path": { "type": "string" }, "use_tls": { "type": "boolean" }, "state": { "type": "string" }, "tag": { "type": "string" }, "buildargs": { "type": "string" }, "rm": { "type": "boolean" }, "push": { "type": "boolean" }, "path": { "type": "string" }, "http_timeout": { "type": "string" } } }, "aci_epg": { "required": [ "bd", "ap", "epg" ], "type": "object", "description": "Manage End Point Groups (EPG) on Cisco ACI fabrics.\nMore information from the internal APIC class I(fv:AEPg) at U(https://developer.cisco.com/media/mim-ref/MO-fvAEPg.html).", "properties": { "bd": { "type": "string" }, "description": { "type": "string" }, "fwd_control": { "type": "string" }, "priority": { "type": "string" }, "ap": { "type": "string" }, "state": { "items": { "type": "string" }, "type": "array" }, "epg": { "type": "string" }, "intra_epg_isolation": { "type": "string" }, "tenant": { "type": "string" } } }, "vmadm": { "required": [ "state", "brand" ], "type": "object", "description": "Manage SmartOS virtual machines through vmadm(1M).", "properties": { "customer_metadata": { "type": "string" }, "disk_driver": { "type": "string" }, "force": { "type": "string" }, "zfs_root_compression": { "type": "string" }, "virtio_txtimer": { "type": "string" }, "spice_password": { "type": "string" }, "zfs_io_priority": { "type": "string" }, "ram": { "type": "string" }, "dns_domain": { "type": "string" }, "max_physical_memory": { "type": "string" }, "nic_driver": { "type": "string" }, "zfs_data_compression": { "type": "string" }, "image_uuid": { "type": "string" }, "fs_allowed": { "items": { "type": "string" }, "type": "array" }, "qemu_opts": { "type": "string" }, "virtio_txburst": { "type": "string" }, "firewall_enabled": { "type": "string" }, "mdata_exec_timeout": { "type": "string" }, "spice_opts": { "type": "string" }, "nics": { "items": { "type": "string" }, "type": "array" }, "hostname": { "type": "string" }, "boot": { "type": "string" }, "vga": { "type": "string" }, "name": { "type": "string" }, "zfs_snapshot_limit": { "type": "string" }, "state": { "type": "string" }, "limit_priv": { "items": { "type": "string" }, "type": "array" }, "cpu_cap": { "type": "string" }, "maintain_resolvers": { "type": "string" }, "zfs_data_recsize": { "type": "string" }, "qemu_extra_opts": { "type": "string" }, "vnc_password": { "type": "string" }, "max_swap": { "type": "string" }, "zfs_root_recsize": { "type": "string" }, "brand": { "type": "string" }, "zfs_filesystem_limit": { "type": "string" }, "quota": { "type": "string" }, "filesystems": { "type": "string" }, "autoboot": { "type": "string" }, "tmpfs": { "type": "string" }, "indestructible_zoneroot": { "type": "string" }, "resolvers": { "items": { "type": "string" }, "type": "array" }, "max_lwps": { "type": "string" }, "nowait": { "type": "string" }, "indestructible_delegated": { "type": "string" }, "kernel_version": { "type": "string" }, "max_locked_memory": { "type": "string" }, "disks": { "items": { "type": "string" }, "type": "array" }, "uuid": { "type": "string" }, "internal_metadata_namespace": { "items": { "type": "string" }, "type": "array" }, "delegate_dataset": { "type": "string" }, "archive_on_delete": { "type": "string" }, "vcpus": { "type": "string" }, "internal_metadata": { "type": "string" }, "cpu_type": { "type": "string" }, "routes": { "type": "string" }, "zpool": { "type": "string" }, "cpu_shares": { "type": "string" }, "vnc_port": { "items": { "type": "string" }, "type": "array" } } }, "ec2_vpc_net": { "required": [ "name", "cidr_block" ], "type": "object", "description": "Create or terminate AWS virtual private clouds. This module has a dependency on python-boto.", "properties": { "name": { "type": "string" }, "dns_support": { "type": "boolean" }, "tags": { "type": "string" }, "multi_ok": { "type": "boolean" }, "state": { "type": "string" }, "tenancy": { "type": "string" }, "dns_hostnames": { "type": "boolean" }, "cidr_block": { "type": "string" }, "dhcp_opts_id": { "type": "string" } } }, "rax_keypair": { "required": [ "name" ], "type": "object", "description": "Create a keypair for use with Rackspace Cloud Servers", "properties": { "public_key": { "type": "string" }, "state": { "type": "string" }, "name": { "type": "string" } } }, "aci_epg_to_domain": { "required": [], "type": "object", "description": "Bind EPGs to Physical and Virtual Domains on Cisco ACI fabrics.\nMore information from the internal APIC class I(fv:RsDomAtt) at U(https://developer.cisco.com/media/mim-ref/MO-fvRsDomAtt.html).", "properties": { "domain": { "type": "string" }, "primary_encap": { "type": "string" }, "allow_useg": { "type": "string" }, "deploy_immediacy": { "type": "string" }, "domain_type": { "type": "string" }, "ap": { "type": "string" }, "state": { "items": { "type": "string" }, "type": "array" }, "netflow": { "type": "string" }, "encap": { "type": "string" }, "epg": { "type": "string" }, "encap_mode": { "type": "string" }, "vm_provider": { "type": "string" }, "resolution_immediacy": { "type": "string" }, "tenant": { "type": "string" } } }, "aws_kms": { "required": [ "mode" ], "type": "object", "description": "Manage role/user access to a KMS key. Not designed for encrypting/decrypting.", "properties": { "role_arn": { "type": "string" }, "grant_types": { "items": { "type": "string" }, "type": "array" }, "role_name": { "type": "string" }, "mode": { "type": "string" }, "key_arn": { "type": "string" }, "clean_invalid_entries": { "type": "boolean" }, "key_alias": { "type": "string" } } }, "nxos_snmp_traps": { "required": [ "group" ], "type": "object", "description": "Manages SNMP traps configurations.", "properties": { "state": { "type": "string" }, "group": { "type": "string" } } }, "win_timezone": { "required": [ "timezone" ], "type": "object", "description": "Sets machine time to the specified timezone.", "properties": { "timezone": { "type": "string" } } }, "bigip_device_ntp": { "required": [], "type": "object", "description": "Manage NTP servers on a BIG-IP", "properties": { "ntp_servers": { "items": { "type": "string" }, "type": "array" }, "timezone": { "type": "string" }, "state": { "type": "string" } } }, "ec2_eni": { "required": [], "type": "object", "description": "Create and optionally attach an Elastic Network Interface (ENI) to an instance. If an ENI ID or private_ip is provided, the existing ENI (if any) will be modified. The 'attached' parameter controls the attachment status of the network interface.", "properties": { "secondary_private_ip_addresses": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" }, "subnet_id": { "type": "string" }, "device_index": { "type": "integer" }, "attached": { "type": "boolean" }, "force_detach": { "type": "boolean" }, "instance_id": { "type": "string" }, "state": { "type": "string" }, "source_dest_check": { "type": "string" }, "private_ip_address": { "type": "string" }, "secondary_private_ip_address_count": { "type": "string" }, "eni_id": { "type": "string" }, "delete_on_termination": { "type": "string" }, "security_groups": { "items": { "type": "string" }, "type": "array" } } }, "cisco_spark": { "required": [ "personal_token", "message", "recipient_id", "recipient_type" ], "type": "object", "description": "Send a message to a Cisco Spark Room or Individual with options to control the formatting.", "properties": { "personal_token": { "type": "string" }, "message": { "type": "string" }, "recipient_id": { "type": "string" }, "message_type": { "type": "string" }, "recipient_type": { "type": "string" } } }, "ce_info_center_debug": { "required": [], "type": "object", "description": "Manages information center debug configurations on HUAWEI CloudEngine switches.", "properties": { "debug_enable": { "type": "string" }, "debug_level": { "type": "string" }, "debug_time_stamp": { "type": "string" }, "channel_id": { "type": "string" }, "state": { "type": "string" }, "module_name": { "type": "string" } } }, "ec2_snapshot_facts": { "required": [], "type": "object", "description": "Gather facts about ec2 volume snapshots in AWS", "properties": { "restorable_by_user_ids": { "items": { "type": "string" }, "type": "array" }, "snapshot_ids": { "type": "string" }, "filters": { "type": "string" }, "owner_ids": { "type": "string" } } }, "aws_acm_facts": { "required": [], "type": "object", "description": "Retrieve facts for ACM certificates", "properties": { "status": { "type": "string" }, "name": { "type": "string" } } }, "ipmi_power": { "required": [ "state", "name", "password", "user" ], "type": "object", "description": "Use this module for power management", "properties": { "name": { "type": "string" }, "state": { "type": "string" }, "user": { "type": "string" }, "timeout": { "type": "integer" }, "password": { "type": "string" }, "port": { "type": "integer" } } }, "cs_loadbalancer_rule": { "required": [ "name", "public_port", "state", "ip_address" ], "type": "object", "description": "Add, update and remove load balancer rules.", "properties": { "domain": { "type": "string" }, "protocol": { "type": "string" }, "name": { "type": "string" }, "open_firewall": { "type": "boolean" }, "public_port": { "type": "string" }, "account": { "type": "string" }, "project": { "type": "string" }, "private_port": { "type": "string" }, "state": { "type": "string" }, "algorithm": { "type": "string" }, "cidr": { "type": "string" }, "zone": { "type": "string" }, "ip_address": { "type": "string" }, "description": { "type": "string" } } }, "vmware_dvswitch": { "required": [ "datacenter_name", "discovery_proto", "mtu", "switch_name", "uplink_quantity" ], "type": "object", "description": "Create or remove a distributed vSwitch", "properties": { "datacenter_name": { "type": "string" }, "discovery_proto": { "type": "string" }, "discovery_operation": { "type": "string" }, "state": { "type": "string" }, "mtu": { "type": "string" }, "switch_name": { "type": "string" }, "uplink_quantity": { "type": "string" }, "switch_version": { "type": "string" } } }, "ec2_vpc_subnet": { "required": [ "vpc_id" ], "type": "object", "description": "Manage subnets in AWS virtual private clouds", "properties": { "assign_instances_ipv6": { "type": "boolean" }, "ipv6_cidr": { "type": "string" }, "tags": { "type": "string" }, "purge_tags": { "items": { "type": "boolean" }, "type": "array" }, "state": { "type": "string" }, "wait_timeout": { "type": "integer" }, "map_public": { "type": "boolean" }, "vpc_id": { "type": "string" }, "cidr": { "type": "string" }, "az": { "type": "string" }, "wait": { "type": "boolean" } } }, "rax_clb_nodes": { "required": [ "load_balancer_id" ], "type": "object", "description": "Adds, modifies and removes nodes from a Rackspace Cloud Load Balancer", "properties": { "node_id": { "type": "string" }, "weight": { "type": "string" }, "load_balancer_id": { "type": "string" }, "state": { "type": "string" }, "wait_timeout": { "type": "integer" }, "address": { "type": "string" }, "type": { "type": "string" }, "port": { "type": "string" }, "condition": { "type": "string" }, "wait": { "type": "string" } } }, "avi_httppolicyset": { "required": [ "name" ], "type": "object", "description": "This module is used to configure HTTPPolicySet object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "http_response_policy": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "tenant_ref": { "type": "string" }, "uuid": { "type": "string" }, "created_by": { "type": "string" }, "state": { "type": "string" }, "cloud_config_cksum": { "type": "string" }, "http_security_policy": { "type": "string" }, "http_request_policy": { "type": "string" }, "is_internal_policy": { "type": "string" }, "description": { "type": "string" } } }, "mysql_db": { "required": [ "name" ], "type": "object", "description": "Add or remove MySQL databases from a remote host.", "properties": { "target": { "type": "string" }, "encoding": { "type": "string" }, "name": { "type": "string" }, "quick": { "type": "boolean" }, "state": { "type": "string" }, "collation": { "type": "string" }, "single_transaction": { "type": "boolean" } } }, "ovirt_snapshots_facts": { "required": [ "vm" ], "type": "object", "description": "Retrieve facts about one or more oVirt/RHV virtual machine snapshots.", "properties": { "snapshot_id": { "type": "string" }, "description": { "type": "string" }, "vm": { "type": "string" } } }, "bigip_monitor_http": { "required": [ "name" ], "type": "object", "description": "Manages F5 BIG-IP LTM http monitors.", "properties": { "partition": { "type": "string" }, "name": { "type": "string" }, "parent": { "type": "string" }, "receive": { "type": "string" }, "ip": { "type": "string" }, "interval": { "type": "string" }, "send": { "type": "string" }, "target_username": { "type": "string" }, "time_until_up": { "type": "string" }, "timeout": { "type": "string" }, "target_password": { "type": "string" }, "port": { "type": "string" }, "receive_disable": { "type": "string" } } }, "gce_mig": { "required": [ "name", "zone" ], "type": "object", "description": "Create, Update or Destroy a Managed Instance Group (MIG). See U(https://cloud.google.com/compute/docs/instance-groups) for an overview. Full install/configuration instructions for the gce* modules can be found in the comments of ansible/test/gce_tests.py.", "properties": { "name": { "type": "string" }, "zone": { "type": "string" }, "service_account_email": { "type": "string" }, "autoscaling": { "type": "string" }, "named_ports": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "template": { "type": "string" }, "credentials_file": { "type": "string" }, "project_id": { "type": "string" }, "size": { "type": "string" } } }, "avi_serviceenginegroup": { "required": [ "name" ], "type": "object", "description": "This module is used to configure ServiceEngineGroup object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "host_attribute_value": { "type": "string" }, "async_ssl": { "type": "string" }, "instance_flavor": { "type": "string" }, "auto_redistribute_active_standby_load": { "type": "string" }, "uuid": { "type": "string" }, "vs_scalein_timeout": { "type": "string" }, "se_udp_encap_ipc": { "type": "string" }, "min_cpu_usage": { "type": "string" }, "custom_securitygroups_data": { "type": "string" }, "vcenter_clusters": { "type": "string" }, "iptables": { "type": "string" }, "connection_memory_percentage": { "type": "string" }, "service_ip_subnets": { "type": "string" }, "placement_mode": { "type": "string" }, "max_scaleout_per_vs": { "type": "string" }, "enable_routing": { "type": "string" }, "per_app": { "type": "string" }, "vcenter_datastores_include": { "type": "string" }, "se_name_prefix": { "type": "string" }, "name": { "type": "string" }, "tenant_ref": { "type": "string" }, "max_se": { "type": "string" }, "se_dos_profile": { "type": "string" }, "udf_log_throttle": { "type": "string" }, "vcenter_hosts": { "type": "string" }, "vcpus_per_se": { "type": "string" }, "cpu_socket_affinity": { "type": "string" }, "realtime_se_metrics": { "type": "string" }, "custom_tag": { "type": "string" }, "non_significant_log_throttle": { "type": "string" }, "extra_shared_config_memory": { "type": "string" }, "vcenter_datastores": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "active_standby": { "type": "string" }, "extra_config_multiplier": { "type": "string" }, "async_ssl_threads": { "type": "string" }, "vcenter_folder": { "type": "string" }, "floating_intf_ip": { "type": "string" }, "advertise_backend_networks": { "type": "string" }, "max_cpu_usage": { "type": "string" }, "min_scaleout_per_vs": { "type": "string" }, "buffer_se": { "type": "string" }, "mem_reserve": { "type": "string" }, "vcenter_datastore_mode": { "type": "string" }, "least_load_core_selection": { "type": "string" }, "aggressive_failure_detection": { "type": "string" }, "significant_log_throttle": { "type": "string" }, "enable_vip_on_all_interfaces": { "type": "string" }, "auto_rebalance": { "type": "string" }, "se_tunnel_mode": { "type": "string" }, "memory_per_se": { "type": "string" }, "se_tunnel_udp_port": { "type": "string" }, "vs_scaleout_timeout": { "type": "string" }, "mgmt_subnet": { "type": "string" }, "cloud_ref": { "type": "string" }, "se_remote_punt_udp_port": { "type": "string" }, "openstack_mgmt_network_name": { "type": "string" }, "max_vs_per_se": { "type": "string" }, "os_reserved_memory": { "type": "string" }, "openstack_mgmt_network_uuid": { "type": "string" }, "se_vs_hb_max_pkts_in_batch": { "type": "string" }, "host_attribute_key": { "type": "string" }, "se_ipc_udp_port": { "type": "string" }, "hypervisor": { "type": "string" }, "cpu_reserve": { "type": "string" }, "enable_vmac": { "type": "string" }, "archive_shm_limit": { "type": "string" }, "hm_on_standby": { "type": "string" }, "disk_per_se": { "type": "string" }, "hardwaresecuritymodulegroup_ref": { "type": "string" }, "custom_securitygroups_mgmt": { "type": "string" }, "floating_intf_ip_se_2": { "type": "string" }, "log_disksz": { "type": "string" }, "openstack_availability_zone": { "type": "string" }, "auto_rebalance_interval": { "type": "string" }, "openstack_availability_zones": { "type": "string" }, "num_flow_cores_sum_changes_to_ignore": { "type": "string" }, "se_thread_multiplier": { "type": "string" }, "description": { "type": "string" }, "vs_scalein_timeout_for_upgrade": { "type": "string" }, "se_deprovision_delay": { "type": "string" }, "se_vs_hb_max_vs_in_pkt": { "type": "string" }, "mgmt_network_ref": { "type": "string" }, "url": { "type": "string" }, "ha_mode": { "type": "string" }, "distribute_load_active_standby": { "type": "string" }, "algo": { "type": "string" }, "dedicated_dispatcher_core": { "type": "string" }, "vs_host_redundancy": { "type": "string" } } }, "rocketchat": { "required": [ "domain", "token" ], "type": "object", "description": "The C(rocketchat) module sends notifications to Rocket Chat via the Incoming WebHook integration", "properties": { "username": { "type": "string" }, "domain": { "type": "string" }, "protocol": { "type": "string" }, "attachments": { "items": { "type": "string" }, "type": "array" }, "color": { "type": "string" }, "icon_url": { "type": "string" }, "token": { "type": "string" }, "icon_emoji": { "type": "string" }, "link_names": { "type": "integer" }, "msg": { "type": "string" }, "validate_certs": { "type": "string" }, "channel": { "type": "string" } } }, "vyos_banner": { "required": [ "banner" ], "type": "object", "description": "This will configure both pre-login and post-login banners on remote devices running VyOS. It allows playbooks to add or remote banner text from the active running configuration.", "properties": { "text": { "type": "string" }, "state": { "type": "string" }, "banner": { "type": "string" } } }, "xml": { "required": [ "xmlstring", "path" ], "type": "object", "description": "A CRUD-like interface to managing bits of XML files.\nYou might also be interested in a brief tutorial from U(http://www.w3schools.com/xpath/) and U(https://developer.mozilla.org/en-US/docs/Web/XPath).", "properties": { "xpath": { "type": "string" }, "count": { "type": "string" }, "set_children": { "type": "string" }, "xmlstring": { "type": "string" }, "attribute": { "type": "string" }, "pretty_print": { "type": "string" }, "add_children": { "items": { "type": "string" }, "type": "array" }, "value": { "type": "string" }, "content": { "type": "string" }, "state": { "type": "string" }, "namespaces": { "items": { "type": "string" }, "type": "array" }, "input_type": { "type": "string" }, "print_match": { "type": "string" }, "path": { "type": "string" }, "backup": { "type": "string" } } }, "tower_team": { "required": [ "organization", "name" ], "type": "object", "description": "Create, update, or destroy Ansible Tower teams. See U(https://www.ansible.com/tower) for an overview.", "properties": { "organization": { "type": "string" }, "state": { "type": "string" }, "name": { "type": "string" } } }, "win_iis_webapppool": { "required": [ "name" ], "type": "object", "description": "Creates, removes and configures an IIS Web Application Pool.", "properties": { "attributes": { "type": "string" }, "state": { "type": "string" }, "name": { "type": "string" } } }, "nxos_vxlan_vtep_vni": { "required": [ "vni", "interface" ], "type": "object", "description": "Creates a Virtual Network Identifier member (VNI) for an NVE overlay interface.", "properties": { "assoc_vrf": { "type": "string" }, "vni": { "type": "string" }, "multicast_group": { "type": "string" }, "state": { "type": "string" }, "peer_list": { "items": { "type": "string" }, "type": "array" }, "interface": { "type": "string" }, "ingress_replication": { "type": "string" }, "suppress_arp": { "type": "string" } } }, "nxos_snmp_location": { "required": [ "location" ], "type": "object", "description": "Manages SNMP location configuration.", "properties": { "state": { "type": "string" }, "location": { "type": "string" } } }, "rax_scaling_group": { "required": [ "image", "min_entities", "flavor", "max_entities", "name", "server_name" ], "type": "object", "description": "Manipulate Rackspace Cloud Autoscale Groups", "properties": { "files": { "type": "string" }, "max_entities": { "type": "string" }, "name": { "type": "string" }, "server_name": { "type": "string" }, "loadbalancers": { "items": { "type": "string" }, "type": "array" }, "key_name": { "type": "string" }, "image": { "type": "string" }, "disk_config": { "type": "string" }, "user_data": { "type": "string" }, "min_entities": { "type": "string" }, "state": { "type": "string" }, "cooldown": { "type": "string" }, "meta": { "type": "string" }, "flavor": { "type": "string" }, "config_drive": { "type": "boolean" }, "networks": { "type": "string" }, "wait_timeout": { "type": "integer" }, "wait": { "type": "string" } } }, "aci_intf_policy_port_security": { "required": [ "port_security" ], "type": "object", "description": "Manage port security on Cisco ACI fabrics.\nMore information from the internal APIC class I(l2:PortSecurityPol) at U(https://developer.cisco.com/media/mim-ref/MO-l2PortSecurityPol.html).", "properties": { "state": { "items": { "type": "string" }, "type": "array" }, "port_security": { "type": "string" }, "max_end_points": { "type": "string" }, "description": { "type": "string" } } }, "newrelic_deployment": { "required": [ "token" ], "type": "object", "description": "Notify newrelic about app deployments (see https://docs.newrelic.com/docs/apm/new-relic-apm/maintenance/deployment-notifications#api)", "properties": { "application_id": { "type": "string" }, "description": { "type": "string" }, "appname": { "type": "string" }, "changelog": { "items": { "type": "string" }, "type": "array" }, "environment": { "type": "string" }, "token": { "type": "string" }, "user": { "type": "string" }, "app_name": { "type": "string" }, "validate_certs": { "type": "string" }, "revision": { "type": "string" } } }, "ce_ntp": { "required": [], "type": "object", "description": "Manages core NTP configuration on HUAWEI CloudEngine switches.", "properties": { "is_preferred": { "type": "string" }, "vpn_name": { "type": "string" }, "server": { "type": "string" }, "state": { "type": "string" }, "peer": { "type": "string" }, "key_id": { "type": "string" }, "source_int": { "type": "string" } } }, "azure_rm_virtualmachine_extension": { "required": [ "name", "resource_group" ], "type": "object", "description": "Create, update and delete Azure Virtual Machine Extension", "properties": { "publisher": { "type": "string" }, "virtual_machine_extension_type": { "type": "string" }, "name": { "type": "string" }, "resource_group": { "type": "string" }, "settings": { "type": "string" }, "state": { "type": "string" }, "location": { "type": "string" }, "protected_settings": { "type": "string" }, "type_handler_version": { "type": "string" }, "auto_upgrade_minor_version": { "type": "string" }, "virtual_machine_name": { "type": "string" } } }, "nxos_overlay_global": { "required": [ "anycast_gateway_mac" ], "type": "object", "description": "Configures anycast gateway MAC of the switch.", "properties": { "anycast_gateway_mac": { "type": "string" } } }, "gem": { "required": [ "name" ], "type": "object", "description": "Manage installation and uninstallation of Ruby gems.", "properties": { "include_dependencies": { "type": "string" }, "executable": { "type": "string" }, "name": { "type": "string" }, "repository": { "type": "string" }, "build_flags": { "type": "string" }, "include_doc": { "type": "string" }, "user_install": { "type": "string" }, "pre_release": { "type": "string" }, "env_shebang": { "type": "string" }, "state": { "type": "string" }, "version": { "type": "string" }, "gem_source": { "type": "string" } } }, "gce_eip": { "required": [ "region", "name" ], "type": "object", "description": "Create (reserve) or Destroy (release) Regional or Global IP Addresses. See U(https://cloud.google.com/compute/docs/configure-instance-ip-addresses#reserve_new_static) for more on reserving static addresses.", "properties": { "region": { "type": "string" }, "name": { "type": "string" }, "state": { "type": "string" } } }, "ec2_vpc_endpoint": { "required": [], "type": "object", "description": "Creates AWS VPC endpoints.\nDeletes AWS VPC endpoints.\nThis module support check mode.", "properties": { "policy_file": { "type": "string" }, "service": { "type": "string" }, "vpc_endpoint_id": { "type": "string" }, "state": { "type": "string" }, "wait_timeout": { "type": "integer" }, "policy": { "type": "string" }, "vpc_id": { "type": "string" }, "client_token": { "type": "string" }, "route_table_ids": { "items": { "type": "string" }, "type": "array" }, "wait": { "type": "boolean" } } }, "dellos9_config": { "required": [], "type": "object", "description": "OS9 configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with OS9 configuration sections in a deterministic way.", "properties": { "src": { "type": "string" }, "backup": { "type": "boolean" }, "after": { "type": "string" }, "lines": { "type": "string" }, "update": { "type": "string" }, "replace": { "type": "string" }, "parents": { "type": "string" }, "save": { "type": "boolean" }, "config": { "type": "string" }, "match": { "type": "string" }, "before": { "type": "string" } } }, "iam_group": { "required": [ "state", "name" ], "type": "object", "description": "Manage AWS IAM groups", "properties": { "name": { "type": "string" }, "purge_users": { "items": { "type": "boolean" }, "type": "array" }, "state": { "type": "string" }, "purge_policy": { "items": { "type": "boolean" }, "type": "array" }, "managed_policy": { "items": { "type": "string" }, "type": "array" }, "users": { "items": { "type": "string" }, "type": "array" } } }, "aci_ap": { "required": [ "ap", "tenant" ], "type": "object", "description": "Manage top level Application Profile (AP) objects on Cisco ACI fabrics\nMore information from the internal APIC class I(fv:Ap) at U(https://developer.cisco.com/media/mim-ref/MO-fvAp.html).", "properties": { "ap": { "type": "string" }, "state": { "items": { "type": "string" }, "type": "array" }, "descr": { "type": "string" }, "tenant": { "type": "string" } } }, "gce_img": { "required": [ "name" ], "type": "object", "description": "This module can create and delete GCE private images from gzipped compressed tarball containing raw disk data or from existing detached disks in any zone. U(https://cloud.google.com/compute/docs/images)", "properties": { "name": { "type": "string" }, "family": { "type": "string" }, "service_account_email": { "type": "string" }, "pem_file": { "type": "string" }, "source": { "type": "string" }, "state": { "type": "string" }, "zone": { "type": "string" }, "timeout": { "type": "integer" }, "project_id": { "type": "string" }, "description": { "type": "string" } } }, "rax_clb_ssl": { "required": [ "loadbalancer" ], "type": "object", "description": "Set up, reconfigure, or remove SSL termination for an existing load balancer.", "properties": { "private_key": { "type": "string" }, "certificate": { "type": "string" }, "enabled": { "type": "boolean" }, "https_redirect": { "type": "string" }, "state": { "type": "string" }, "wait_timeout": { "type": "integer" }, "intermediate_certificate": { "type": "string" }, "secure_traffic_only": { "type": "boolean" }, "secure_port": { "items": { "type": "integer" }, "type": "array" }, "loadbalancer": { "type": "string" }, "wait": { "type": "boolean" } } }, "pingdom": { "required": [ "checkid", "passwd", "state", "uid", "key" ], "type": "object", "description": "This module will let you pause/unpause Pingdom alerts", "properties": { "checkid": { "type": "string" }, "passwd": { "type": "string" }, "state": { "type": "string" }, "uid": { "type": "string" }, "key": { "type": "string" } } }, "vyos_l3_interface": { "required": [], "type": "object", "description": "This module provides declarative management of L3 interfaces on VyOS network devices.", "properties": { "aggregate": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "ipv6": { "type": "string" }, "ipv4": { "type": "string" }, "name": { "type": "string" } } }, "udm_share": { "required": [ "name", "ou" ], "type": "object", "description": "This module allows to manage samba shares on a univention corporate server (UCS). It uses the python API of the UCS to create a new object or edit it.", "properties": { "samba_name": { "type": "string" }, "samba_hide_files": { "type": "string" }, "samba_directory_mode": { "type": "string" }, "samba_dos_filemode": { "type": "string" }, "path": { "type": "string" }, "owner": { "type": "integer" }, "samba_fake_oplocks": { "type": "string" }, "samba_strict_locking": { "type": "string" }, "nfs_custom_settings": { "type": "string" }, "samba_force_directory_security_mode": { "type": "string" }, "samba_writeable": { "type": "string" }, "samba_block_size": { "type": "string" }, "samba_nt_acl_support": { "type": "string" }, "samba_write_list": { "type": "string" }, "samba_preexec": { "type": "string" }, "samba_browseable": { "type": "string" }, "samba_inherit_acls": { "type": "string" }, "samba_msdfs_root": { "type": "string" }, "state": { "type": "string" }, "samba_valid_users": { "type": "string" }, "samba_force_create_mode": { "type": "string" }, "root_squash": { "type": "string" }, "samba_directory_security_mode": { "type": "string" }, "samba_force_group": { "type": "string" }, "samba_vfs_objects": { "type": "string" }, "samba_force_directory_mode": { "type": "string" }, "writeable": { "type": "string" }, "samba_locking": { "type": "string" }, "samba_security_mode": { "type": "string" }, "samba_inherit_owner": { "type": "string" }, "samba_csc_policy": { "type": "string" }, "sync": { "type": "string" }, "nfs_hosts": { "type": "string" }, "group": { "type": "string" }, "samba_public": { "type": "string" }, "samba_force_user": { "type": "string" }, "samba_level_2_oplocks": { "type": "string" }, "samba_invalid_users": { "type": "string" }, "samba_create_mode": { "type": "string" }, "samba_force_security_mode": { "type": "string" }, "name": { "type": "string" }, "samba_custom_settings": { "type": "string" }, "samba_hide_unreadable": { "type": "string" }, "samba_blocking_locks": { "type": "string" }, "samba_postexec": { "type": "string" }, "host": { "type": "string" }, "samba_oplocks": { "type": "string" }, "samba_hosts_allow": { "type": "string" }, "samba_inherit_permissions": { "type": "string" }, "subtree_checking": { "type": "string" }, "directorymode": { "type": "string" }, "ou": { "type": "string" }, "samba_hosts_deny": { "type": "string" } } }, "dnsimple": { "required": [], "type": "object", "description": "Manages domains and records via the DNSimple API, see the docs: U(http://developer.dnsimple.com/)", "properties": { "solo": { "type": "string" }, "domain": { "items": { "type": "string" }, "type": "array" }, "account_email": { "type": "string" }, "record_ids": { "items": { "type": "string" }, "type": "array" }, "value": { "type": "string" }, "priority": { "type": "string" }, "record": { "type": "string" }, "state": { "type": "string" }, "ttl": { "type": "string" }, "type": { "type": "string" }, "account_api_token": { "type": "string" } } }, "win_user_right": { "required": [ "name", "users" ], "type": "object", "description": "Add, remove or set User Rights for a group or users or groups.\nYou can set user rights for both local and domain accounts.", "properties": { "action": { "type": "string" }, "name": { "type": "string" }, "users": { "items": { "type": "string" }, "type": "array" } } }, "bigip_selfip": { "required": [ "name" ], "type": "object", "description": "Manage Self-IPs on a BIG-IP system.", "properties": { "partition": { "type": "string" }, "name": { "type": "string" }, "vlan": { "type": "string" }, "netmask": { "type": "string" }, "allow_service": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "route_domain": { "type": "string" }, "address": { "type": "string" }, "traffic_group": { "type": "string" } } }, "nxos_bgp_neighbor": { "required": [ "asn", "neighbor" ], "type": "object", "description": "Manages BGP neighbors configurations on NX-OS switches.", "properties": { "pwd_type": { "type": "string" }, "dynamic_capability": { "type": "string" }, "shutdown": { "type": "string" }, "low_memory_exempt": { "type": "string" }, "remove_private_as": { "type": "string" }, "suppress_4_byte_as": { "type": "string" }, "connected_check": { "type": "string" }, "remote_as": { "type": "string" }, "ebgp_multihop": { "type": "string" }, "maximum_peers": { "type": "string" }, "state": { "type": "string" }, "timers_holdtime": { "type": "string" }, "update_source": { "type": "string" }, "description": { "type": "string" }, "local_as": { "type": "string" }, "timers_keepalive": { "type": "string" }, "pwd": { "type": "string" }, "vrf": { "type": "string" }, "log_neighbor_changes": { "type": "string" }, "asn": { "type": "string" }, "transport_passive_only": { "type": "string" }, "capability_negotiation": { "type": "string" }, "neighbor": { "type": "string" } } }, "azure_rm_loadbalancer_facts": { "required": [], "type": "object", "description": "Get facts for a specific load balancer or all load balancers.", "properties": { "name": { "type": "string" }, "resource_group": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } } }, "win_hotfix": { "required": [], "type": "object", "description": "Install, uninstall a Windows hotfix.", "properties": { "hotfix_identifier": { "type": "string" }, "state": { "type": "string" }, "hotfix_kb": { "type": "string" }, "source": { "type": "string" } } }, "gluster_volume": { "required": [ "name", "state" ], "type": "object", "description": "Create, remove, start, stop and tune GlusterFS volumes", "properties": { "force": { "type": "string" }, "name": { "type": "string" }, "replicas": { "type": "string" }, "bricks": { "type": "string" }, "disperses": { "type": "string" }, "quota": { "items": { "type": "string" }, "type": "array" }, "stripes": { "type": "string" }, "cluster": { "items": { "type": "string" }, "type": "array" }, "host": { "type": "string" }, "state": { "type": "string" }, "arbiter": { "type": "string" }, "redundancies": { "type": "string" }, "directory": { "type": "string" }, "start_on_create": { "type": "string" }, "rebalance": { "type": "string" }, "options": { "type": "string" }, "transport": { "type": "string" } } }, "eos_static_route": { "required": [ "next_hop", "address" ], "type": "object", "description": "This module provides declarative management of static IP routes on Arista EOS network devices.", "properties": { "aggregate": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "next_hop": { "type": "string" }, "admin_distance": { "type": "integer" }, "address": { "type": "string" } } }, "profitbricks": { "required": [ "image", "name" ], "type": "object", "description": "Create, destroy, update, start, stop, and reboot a ProfitBricks virtual machine. When the virtual machine is created it can optionally wait for it to be 'running' before returning. This module has a dependency on profitbricks >= 1.0.0", "properties": { "image": { "type": "string" }, "ram": { "type": "integer" }, "subscription_password": { "type": "string" }, "ssh_keys": { "type": "string" }, "subscription_user": { "type": "string" }, "volume_size": { "type": "integer" }, "state": { "type": "string" }, "location": { "type": "string" }, "assign_public_ip": { "type": "boolean" }, "auto_increment": { "type": "boolean" }, "lan": { "type": "integer" }, "image_password": { "type": "string" }, "bus": { "type": "string" }, "instance_ids": { "items": { "type": "string" }, "type": "array" }, "wait_timeout": { "type": "integer" }, "cpu_family": { "type": "string" }, "wait": { "type": "string" }, "count": { "type": "integer" }, "datacenter": { "type": "string" }, "remove_boot_volume": { "type": "string" }, "name": { "type": "string" }, "cores": { "type": "integer" } } }, "netapp_e_host": { "required": [ "host_type_index", "name" ], "type": "object", "description": "Create, update, remove hosts on NetApp E-series storage arrays", "properties": { "host_type_index": { "type": "string" }, "group": { "type": "string" }, "name": { "type": "string" }, "ports": { "items": { "type": "string" }, "type": "array" } } }, "os_server_group": { "required": [ "name" ], "type": "object", "description": "Add or remove server groups from OpenStack.", "properties": { "state": { "type": "string" }, "name": { "type": "string" }, "policies": { "items": { "type": "string" }, "type": "array" }, "availability_zone": { "type": "string" } } }, "ovirt_storage_connections": { "required": [], "type": "object", "description": "Module to manage storage connections in oVirt", "properties": { "username": { "type": "string" }, "force": { "type": "string" }, "target": { "type": "string" }, "storage": { "type": "string" }, "nfs_retrans": { "type": "string" }, "id": { "type": "string" }, "port": { "type": "string" }, "state": { "type": "string" }, "mount_options": { "type": "string" }, "address": { "type": "string" }, "nfs_timeout": { "type": "string" }, "path": { "type": "string" }, "vfs_type": { "type": "string" }, "password": { "type": "string" }, "type": { "type": "string" }, "nfs_version": { "type": "string" } } }, "junos_package": { "required": [ "src", "force", "reboot" ], "type": "object", "description": "This module can install new and updated packages on remote devices running Junos. The module will compare the specified package with the one running on the remote device and install the specified version if there is a mismatch", "properties": { "src": { "type": "string" }, "force": { "type": "boolean" }, "no_copy": { "type": "boolean" }, "reboot": { "type": "boolean" }, "version": { "type": "string" }, "validate": { "type": "boolean" } } }, "cs_affinitygroup": { "required": [ "name" ], "type": "object", "description": "Create and remove affinity groups.", "properties": { "account": { "type": "string" }, "poll_async": { "type": "boolean" }, "name": { "type": "string" }, "domain": { "type": "string" }, "affinity_type": { "type": "string" }, "project": { "type": "string" }, "state": { "type": "string" }, "description": { "type": "string" } } }, "ec2_vpc_nat_gateway": { "required": [], "type": "object", "description": "Ensure the state of AWS VPC NAT Gateways based on their id, allocation and subnet ids.", "properties": { "client_token": { "type": "string" }, "nat_gateway_id": { "type": "string" }, "allocation_id": { "type": "string" }, "subnet_id": { "type": "string" }, "if_exist_do_not_create": { "type": "boolean" }, "eip_address": { "type": "string" }, "state": { "type": "string" }, "wait_timeout": { "type": "integer" }, "release_eip": { "type": "boolean" }, "wait": { "type": "boolean" } } }, "gcdns_zone": { "required": [ "zone" ], "type": "object", "description": "Creates or removes managed zones in Google Cloud DNS.", "properties": { "description": { "type": "string" }, "zone": { "type": "string" }, "service_account_email": { "type": "string" }, "pem_file": { "type": "string" }, "state": { "type": "string" }, "credentials_file": { "type": "string" }, "project_id": { "type": "string" } } }, "rabbitmq_vhost": { "required": [ "name" ], "type": "object", "description": "Manage the state of a virtual host in RabbitMQ", "properties": { "node": { "type": "string" }, "tracing": { "type": "string" }, "state": { "type": "string" }, "name": { "type": "string" } } }, "elasticache_snapshot": { "required": [ "name" ], "type": "object", "description": "Manage cache snapshots in Amazon Elasticache.\nReturns information about the specified snapshot.", "properties": { "replication_id": { "type": "string" }, "name": { "type": "string" }, "bucket": { "type": "string" }, "state": { "type": "string" }, "cluster_id": { "type": "string" }, "target": { "type": "string" } } }, "win_share": { "required": [ "name", "path" ], "type": "object", "description": "Add, modify or remove Windows share and set share permissions.", "properties": { "deny": { "items": { "type": "string" }, "type": "array" }, "full": { "items": { "type": "string" }, "type": "array" }, "encrypt": { "type": "string" }, "name": { "type": "string" }, "read": { "items": { "type": "string" }, "type": "array" }, "list": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "caching_mode": { "type": "string" }, "path": { "type": "string" }, "change": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" } } }, "virt_net": { "required": [ "name" ], "type": "object", "description": "Manage I(libvirt) networks.", "properties": { "xml": { "type": "string" }, "name": { "type": "string" }, "uri": { "type": "string" }, "state": { "type": "string" }, "command": { "type": "string" }, "autostart": { "type": "string" } } }, "avi_cloudproperties": { "required": [], "type": "object", "description": "This module is used to configure CloudProperties object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "info": { "type": "string" }, "hyp_props": { "type": "string" }, "uuid": { "type": "string" }, "url": { "type": "string" }, "state": { "type": "string" }, "cc_props": { "type": "string" }, "cc_vtypes": { "type": "string" } } }, "postgresql_user": { "required": [ "name" ], "type": "object", "description": "Add or remove PostgreSQL users (roles) from a remote host and, optionally, grant the users access to an existing database or tables.\nThe fundamental function of the module is to create, or delete, roles from a PostgreSQL cluster. Privilege assignment, or removal, is an optional step, which works on one database at a time. This allows for the module to be called several times in the same module to modify the permissions on different databases, or to grant permissions to already existing users.\nA user cannot be removed until all the privileges have been stripped from the user. In such situation, if the module tries to remove the user it will fail. To avoid this from happening the fail_on_user option signals the module to try to remove the user, but if not possible keep going; the module will report if changes happened and separately if the user was removed or not.", "properties": { "ssl_rootcert": { "type": "string" }, "ssl_mode": { "type": "string" }, "name": { "type": "string" }, "no_password_changes": { "type": "string" }, "login_user": { "type": "string" }, "login_host": { "type": "string" }, "expires": { "type": "string" }, "db": { "type": "string" }, "role_attr_flags": { "type": "string" }, "conn_limit": { "type": "string" }, "login_unix_socket": { "type": "string" }, "state": { "type": "string" }, "encrypted": { "type": "boolean" }, "login_password": { "type": "string" }, "password": { "type": "string" }, "port": { "type": "integer" }, "fail_on_user": { "type": "string" }, "priv": { "type": "string" } } }, "ce_vxlan_arp": { "required": [], "type": "object", "description": "Manages ARP attributes of VXLAN on HUAWEI CloudEngine devices.", "properties": { "evn_bgp": { "type": "string" }, "vbdif_name": { "type": "string" }, "bridge_domain_id": { "type": "string" }, "state": { "type": "string" }, "evn_server": { "type": "string" }, "evn_peer_ip": { "type": "string" }, "evn_source_ip": { "type": "string" }, "arp_collect_host": { "type": "string" }, "arp_suppress": { "type": "string" }, "evn_reflect_client": { "type": "string" }, "host_collect_protocol": { "type": "string" } } }, "gcp_healthcheck": { "required": [ "healthcheck_name", "healthcheck_type", "host_header", "state" ], "type": "object", "description": "Create, Update or Destroy a Healthcheck. Currently only HTTP and HTTPS Healthchecks are supported. Healthchecks are used to monitor individual instances, managed instance groups and/or backend services. Healtchecks are reusable.\nVisit U(https://cloud.google.com/compute/docs/load-balancing/health-checks) for an overview of Healthchecks on GCP.\nSee U(https://cloud.google.com/compute/docs/reference/latest/httpHealthChecks) for API details on HTTP Healthchecks.\nSee U(https://cloud.google.com/compute/docs/reference/latest/httpsHealthChecks) for more details on the HTTPS Healtcheck API.", "properties": { "healthcheck_name": { "type": "string" }, "healthcheck_type": { "type": "string" }, "timeout": { "type": "integer" }, "service_account_email": { "type": "string" }, "healthy_threshold": { "type": "integer" }, "service_account_permissions": { "type": "string" }, "unhealthy_threshold": { "type": "integer" }, "host_header": { "type": "string" }, "state": { "type": "string" }, "check_interval": { "type": "integer" }, "credentials_file": { "type": "string" }, "project_id": { "type": "string" }, "port": { "type": "string" }, "request_path": { "type": "string" } } }, "interfaces_file": { "required": [], "type": "object", "description": "Manage (add, remove, change) individual interface options in an interfaces-style file without having to manage the file as a whole with, say, M(template) or M(assemble). Interface has to be presented in a file.\nRead information about interfaces from interfaces-styled files", "properties": { "iface": { "type": "string" }, "option": { "type": "string" }, "dest": { "type": "string" }, "value": { "type": "string" }, "state": { "type": "string" }, "backup": { "type": "string" } } }, "docker_container": { "required": [ "name" ], "type": "object", "description": "Manage the life cycle of docker containers.\nSupports check mode. Run with --check and --diff to view config difference and list of actions to be taken.", "properties": { "tty": { "type": "boolean" }, "dns_servers": { "items": { "type": "string" }, "type": "array" }, "links": { "items": { "type": "string" }, "type": "array" }, "oom_score_adj": { "type": "integer" }, "auto_remove": { "type": "boolean" }, "image": { "type": "string" }, "recreate": { "type": "boolean" }, "command": { "items": { "type": "string" }, "type": "array" }, "memory_reservation": { "type": "integer" }, "paused": { "type": "boolean" }, "trust_image_content": { "type": "boolean" }, "cpuset_cpus": { "type": "string" }, "stop_timeout": { "type": "string" }, "security_opts": { "items": { "type": "string" }, "type": "array" }, "force_kill": { "type": "boolean" }, "pid_mode": { "type": "string" }, "env_file": { "type": "string" }, "networks": { "items": { "type": "string" }, "type": "array" }, "cpu_quota": { "type": "integer" }, "log_driver": { "type": "string" }, "cpu_period": { "type": "integer" }, "detach": { "type": "boolean" }, "cpuset_mems": { "type": "string" }, "hostname": { "type": "string" }, "restart_retries": { "type": "integer" }, "working_dir": { "type": "string" }, "capabilities": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "cleanup": { "type": "boolean" }, "entrypoint": { "type": "string" }, "restart": { "type": "boolean" }, "env": { "type": "string" }, "memory": { "type": "integer" }, "volumes_from": { "items": { "type": "string" }, "type": "array" }, "blkio_weight": { "type": "string" }, "log_options": { "type": "string" }, "privileged": { "type": "boolean" }, "exposed_ports": { "items": { "type": "string" }, "type": "array" }, "read_only": { "type": "boolean" }, "labels": { "type": "string" }, "ipc_mode": { "type": "string" }, "oom_killer": { "type": "boolean" }, "shm_size": { "type": "string" }, "mac_address": { "type": "string" }, "memory_swappiness": { "type": "integer" }, "kill_signal": { "type": "string" }, "network_mode": { "type": "string" }, "volume_driver": { "type": "string" }, "kernel_memory": { "type": "integer" }, "user": { "type": "string" }, "groups": { "items": { "type": "string" }, "type": "array" }, "tmpfs": { "type": "string" }, "restart_policy": { "type": "string" }, "memory_swap": { "type": "integer" }, "pull": { "type": "boolean" }, "name": { "type": "string" }, "stop_signal": { "type": "string" }, "keep_volumes": { "type": "boolean" }, "ignore_image": { "type": "boolean" }, "devices": { "items": { "type": "string" }, "type": "array" }, "etc_hosts": { "type": "string" }, "uts": { "type": "string" }, "sysctls": { "type": "string" }, "published_ports": { "items": { "type": "string" }, "type": "array" }, "volumes": { "items": { "type": "string" }, "type": "array" }, "dns_search_domains": { "items": { "type": "string" }, "type": "array" }, "purge_networks": { "type": "boolean" }, "cpu_shares": { "type": "string" }, "ulimits": { "items": { "type": "string" }, "type": "array" }, "interactive": { "type": "boolean" } } }, "lambda_policy": { "required": [ "statement_id", "state", "action", "function_name", "principal" ], "type": "object", "description": "This module allows the management of AWS Lambda policy statements. It is idempotent and supports \"Check\" mode. Use module M(lambda) to manage the lambda function itself, M(lambda_alias) to manage function aliases, M(lambda_event) to manage event source mappings such as Kinesis streams, M(lambda_invoke) to execute a lambda function and M(lambda_facts) to gather facts relating to one or more lambda functions.", "properties": { "event_source_token": { "type": "string" }, "statement_id": { "type": "string" }, "alias": { "type": "string" }, "state": { "type": "string" }, "version": { "type": "string" }, "action": { "type": "string" }, "source_arn": { "type": "string" }, "principal": { "type": "string" }, "source_account": { "type": "string" }, "function_name": { "type": "string" } } }, "junos_banner": { "required": [ "banner" ], "type": "object", "description": "This will configure both login and motd banners on network devices. It allows playbooks to add or remote banner text from the active running configuration.", "properties": { "active": { "type": "boolean" }, "text": { "type": "string" }, "state": { "type": "string" }, "banner": { "type": "string" } } }, "ec2_lc_facts": { "required": [], "type": "object", "description": "Gather facts about AWS Autoscaling Launch Configurations", "properties": { "sort": { "type": "string" }, "sort_end": { "type": "string" }, "sort_order": { "type": "string" }, "name": { "items": { "type": "string" }, "type": "array" }, "sort_start": { "type": "string" } } }, "azure_rm_storageaccount": { "required": [ "resource_group" ], "type": "object", "description": "Create, update or delete a storage account.", "properties": { "kind": { "type": "string" }, "account_type": { "type": "string" }, "custom_domain": { "type": "string" }, "resource_group": { "type": "string" }, "state": { "type": "string" }, "location": { "type": "string" }, "access_tier": { "type": "string" }, "name": { "type": "string" } } }, "ovirt_quotas_facts": { "required": [ "data_center" ], "type": "object", "description": "Retrieve facts about one or more oVirt/RHV quotas.", "properties": { "name": { "type": "string" }, "data_center": { "type": "string" } } }, "mount": { "required": [ "state", "path" ], "type": "object", "description": "This module controls active and configured mount points in C(/etc/fstab).", "properties": { "src": { "type": "string" }, "dump": { "type": "integer" }, "boot": { "type": "string" }, "fstab": { "type": "string" }, "passno": { "type": "integer" }, "fstype": { "type": "string" }, "state": { "type": "string" }, "path": { "type": "string" }, "opts": { "type": "string" } } }, "oneview_fc_network": { "required": [ "data" ], "type": "object", "description": "Provides an interface to manage Fibre Channel Network resources. Can create, update, and delete.", "properties": { "state": { "type": "string" }, "data": { "items": { "type": "string" }, "type": "array" } } }, "openssl_publickey": { "required": [ "path", "privatekey_path" ], "type": "object", "description": "This module allows one to (re)generate OpenSSL public keys from their private keys. It uses the pyOpenSSL python library to interact with openssl. Keys are generated in PEM format. This module works only if the version of PyOpenSSL is recent enough (> 16.0.0).", "properties": { "privatekey_passphrase": { "type": "string" }, "force": { "type": "boolean" }, "format": { "type": "string" }, "privatekey_path": { "type": "string" }, "state": { "type": "string" }, "path": { "type": "string" } } }, "packet_device": { "required": [ "project_id" ], "type": "object", "description": "Manage a bare metal server in the Packet Host (a \"device\" in the API terms).\nWhen the machine is created it can optionally wait for public IP address, or for active state.\nThis module has a dependency on packet >= 1.0.\nAPI is documented at U(https://www.packet.net/developers/api/devices).", "properties": { "count": { "type": "integer" }, "project_id": { "type": "string" }, "operating_system": { "items": { "type": "string" }, "type": "array" }, "locked": { "type": "boolean" }, "features": { "type": "string" }, "facility": { "items": { "type": "string" }, "type": "array" }, "wait_for_public_IPv": { "type": "string" }, "auth_token": { "type": "string" }, "count_offset": { "type": "integer" }, "wait": { "type": "boolean" }, "user_data": { "type": "string" }, "always_pxe": { "type": "boolean" }, "state": { "type": "string" }, "hostnames": { "items": { "type": "string" }, "type": "array" }, "plan": { "items": { "type": "string" }, "type": "array" }, "device_ids": { "items": { "type": "string" }, "type": "array" }, "wait_timeout": { "type": "integer" }, "ipxe_script_url": { "type": "string" } } }, "cronvar": { "required": [ "name" ], "type": "object", "description": "Use this module to manage crontab variables. This module allows you to create, update, or delete cron variable definitions.", "properties": { "name": { "type": "string" }, "insertbefore": { "type": "string" }, "cron_file": { "type": "string" }, "value": { "type": "string" }, "state": { "type": "string" }, "user": { "type": "string" }, "insertafter": { "type": "string" }, "backup": { "type": "string" } } }, "tower_role": { "required": [ "role" ], "type": "object", "description": "Create, update, or destroy Ansible Tower roles. See U(https://www.ansible.com/tower) for an overview.", "properties": { "credential": { "type": "string" }, "job_template": { "type": "string" }, "project": { "type": "string" }, "state": { "type": "string" }, "role": { "type": "string" }, "inventory": { "type": "string" }, "team": { "type": "string" }, "organization": { "type": "string" }, "target_team": { "type": "string" }, "user": { "type": "string" } } }, "aos_external_router": { "required": [ "session" ], "type": "object", "description": "Apstra AOS External Router module let you manage your External Router easily. You can create create and delete External Router by Name, ID or by using a JSON File. This module is idempotent and support the I(check) mode. It's using the AOS REST API.", "properties": { "name": { "type": "string" }, "loopback": { "type": "string" }, "id": { "type": "string" }, "content": { "type": "string" }, "state": { "type": "string" }, "session": { "type": "string" }, "asn": { "type": "string" } } }, "ce_bfd_global": { "required": [], "type": "object", "description": "Manages BFD global configuration on HUAWEI CloudEngine devices.", "properties": { "tos_exp_dynamic": { "type": "string" }, "default_ip": { "type": "string" }, "damp_init_wait_time": { "type": "string" }, "bfd_enable": { "type": "string" }, "delay_up_time": { "type": "string" }, "state": { "type": "string" }, "damp_max_wait_time": { "type": "string" }, "damp_second_wait_time": { "type": "string" }, "tos_exp_static": { "type": "string" } } }, "hostname": { "required": [ "name" ], "type": "object", "description": "Set system's hostname, supports most OSs/Distributions, including those using systemd.\nNote, this module does *NOT* modify C(/etc/hosts). You need to modify it yourself using other modules like template or replace.\nWindows, HP-UX and AIX are not currently supported.", "properties": { "name": { "type": "string" } } }, "avi_dnspolicy": { "required": [], "type": "object", "description": "This module is used to configure DnsPolicy object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "description": { "type": "string" }, "url": { "type": "string" }, "tenant_ref": { "type": "string" }, "uuid": { "type": "string" }, "rule": { "type": "string" }, "state": { "type": "string" }, "created_by": { "type": "string" }, "name": { "type": "string" } } }, "azure_rm_networkinterface_facts": { "required": [], "type": "object", "description": "Get facts for a specific network interface or all network interfaces within a resource group.", "properties": { "name": { "type": "string" }, "resource_group": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } } }, "aruba_config": { "required": [], "type": "object", "description": "Aruba configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with Aruba configuration sections in a deterministic way.", "properties": { "src": { "type": "string" }, "diff_ignore_lines": { "items": { "type": "string" }, "type": "array" }, "encrypt": { "type": "boolean" }, "after": { "type": "string" }, "lines": { "type": "string" }, "intended_config": { "type": "string" }, "diff_against": { "type": "string" }, "replace": { "type": "string" }, "parents": { "type": "string" }, "running_config": { "type": "string" }, "save_when": { "type": "string" }, "backup": { "type": "boolean" }, "match": { "type": "string" }, "before": { "type": "string" } } }, "ce_netstream_aging": { "required": [], "type": "object", "description": "Manages timeout mode of NetStream on HUAWEI CloudEngine switches.", "properties": { "timeout_type": { "type": "string" }, "state": { "type": "string" }, "type": { "type": "string" }, "manual_slot": { "type": "string" }, "timeout_interval": { "type": "integer" } } }, "panos_loadcfg": { "required": [ "password", "ip_address" ], "type": "object", "description": "Load configuration on PAN-OS device", "properties": { "username": { "type": "string" }, "commit": { "type": "boolean" }, "password": { "type": "string" }, "ip_address": { "type": "string" }, "file": { "type": "string" } } }, "bigip_node": { "required": [ "state", "host" ], "type": "object", "description": "Manages F5 BIG-IP LTM nodes via iControl SOAP API", "properties": { "session_state": { "type": "string" }, "name": { "type": "string" }, "monitor_state": { "type": "string" }, "description": { "type": "string" }, "partition": { "type": "string" }, "host": { "type": "string" }, "monitors": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "monitor_type": { "type": "string" }, "quorum": { "type": "string" } } }, "manageiq_provider": { "required": [ "name", "type" ], "type": "object", "description": "The manageiq_provider module supports adding, updating, and deleting provider in ManageIQ.", "properties": { "name": { "type": "string" }, "zone": { "type": "string" }, "alerts": { "type": "string" }, "metrics": { "type": "string" }, "state": { "type": "string" }, "provider": { "type": "string" }, "provider_region": { "type": "string" }, "type": { "type": "string" } } }, "ovirt_external_provider": { "required": [], "type": "object", "description": "Module to manage external providers in oVirt/RHV", "properties": { "username": { "type": "string" }, "read_only": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "tenant_name": { "type": "string" }, "state": { "type": "string" }, "authentication_url": { "type": "string" }, "data_center": { "type": "string" }, "password": { "type": "string" }, "type": { "type": "string" }, "network_type": { "type": "string" }, "description": { "type": "string" } } }, "aci_intf_policy_l2": { "required": [ "l2_policy" ], "type": "object", "description": "Manage Layer 2 interface policies on Cisco ACI fabrics.\nMore information from the internal APIC class I(l2:IfPol) at U(https://developer.cisco.com/media/mim-ref/MO-l2IfPol.html).", "properties": { "description": { "type": "string" }, "vepa": { "type": "string" }, "state": { "items": { "type": "string" }, "type": "array" }, "qinq": { "type": "string" }, "l2_policy": { "type": "string" }, "vlan_scope": { "type": "string" } } }, "ec2_asg": { "required": [ "launch_config_name", "name" ], "type": "object", "description": "Can create or delete AWS Autoscaling Groups\nWorks with the ec2_lc module to manage Launch Configurations", "properties": { "suspend_processes": { "items": { "type": "string" }, "type": "array" }, "default_cooldown": { "type": "string" }, "health_check_period": { "type": "string" }, "lc_check": { "type": "boolean" }, "availability_zones": { "items": { "type": "string" }, "type": "array" }, "replace_batch_size": { "type": "integer" }, "target_group_arns": { "items": { "type": "string" }, "type": "array" }, "replace_instances": { "items": { "type": "string" }, "type": "array" }, "desired_capacity": { "type": "string" }, "state": { "type": "string" }, "health_check_type": { "type": "string" }, "launch_config_name": { "type": "string" }, "placement_group": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "min_size": { "type": "string" }, "vpc_zone_identifier": { "items": { "type": "string" }, "type": "array" }, "load_balancers": { "items": { "type": "string" }, "type": "array" }, "max_size": { "type": "string" }, "name": { "type": "string" }, "replace_all_instances": { "type": "boolean" }, "termination_policies": { "items": { "type": "string" }, "type": "array" }, "wait_timeout": { "type": "integer" }, "notification_topic": { "type": "string" }, "notification_types": { "items": { "type": "string" }, "type": "array" }, "wait_for_instances": { "type": "boolean" } } }, "panos_admpwd": { "required": [ "newpassword", "key_filename", "ip_address" ], "type": "object", "description": "Change the admin password of PAN-OS via SSH using a SSH key for authentication.\nUseful for AWS instances where the first login should be done via SSH.", "properties": { "username": { "type": "string" }, "newpassword": { "type": "string" }, "key_filename": { "type": "string" }, "ip_address": { "type": "string" } } }, "avi_poolgroup": { "required": [ "name" ], "type": "object", "description": "This module is used to configure PoolGroup object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "priority_labels_ref": { "type": "string" }, "description": { "type": "string" }, "cloud_ref": { "type": "string" }, "min_servers": { "type": "string" }, "tenant_ref": { "type": "string" }, "uuid": { "type": "string" }, "created_by": { "type": "string" }, "url": { "type": "string" }, "state": { "type": "string" }, "cloud_config_cksum": { "type": "string" }, "members": { "items": { "type": "string" }, "type": "array" }, "fail_action": { "type": "string" }, "deployment_policy_ref": { "type": "string" }, "name": { "type": "string" } } }, "azure_rm_dnsrecordset": { "required": [ "resource_group", "record_type", "relative_name", "zone_name" ], "type": "object", "description": "Creates, deletes, and updates DNS records sets and records within an existing Azure DNS Zone.", "properties": { "resource_group": { "type": "string" }, "records": { "items": { "type": "string" }, "type": "array" }, "record_mode": { "type": "string" }, "time_to_live": { "type": "integer" }, "relative_name": { "type": "string" }, "record_type": { "type": "string" }, "state": { "type": "string" }, "zone_name": { "type": "string" } } }, "subversion": { "required": [ "dest", "repo" ], "type": "object", "description": "Deploy given repository URL / revision to dest. If dest exists, update to the specified revision, otherwise perform a checkout.", "properties": { "username": { "type": "string" }, "executable": { "type": "string" }, "force": { "type": "string" }, "dest": { "type": "string" }, "update": { "type": "string" }, "repo": { "type": "string" }, "switch": { "type": "string" }, "export": { "type": "string" }, "password": { "type": "string" }, "checkout": { "type": "string" }, "revision": { "type": "string" } } }, "panos_nat_rule": { "required": [ "rule_name", "password", "ip_address", "source_zone", "destination_zone" ], "type": "object", "description": "- Create a policy nat rule. Keep in mind that we can either end up configuring source NAT, destination NAT, or both. Instead of splitting it into two we will make a fair attempt to determine which one the user wants.\n", "properties": { "username": { "type": "string" }, "dnat_address": { "type": "string" }, "destination_ip": { "items": { "type": "string" }, "type": "array" }, "api_key": { "type": "string" }, "snat_type": { "type": "string" }, "service": { "type": "string" }, "snat_static_address": { "type": "string" }, "source_ip": { "items": { "type": "string" }, "type": "array" }, "source_zone": { "items": { "type": "string" }, "type": "array" }, "dnat_port": { "type": "string" }, "snat_bidirectional": { "type": "string" }, "snat_interface_address": { "type": "string" }, "rule_name": { "type": "string" }, "snat_dynamic_address": { "type": "string" }, "snat_address_type": { "type": "string" }, "commit": { "type": "boolean" }, "operation": { "type": "string" }, "password": { "type": "string" }, "ip_address": { "type": "string" }, "snat_interface": { "type": "string" }, "destination_zone": { "type": "string" } } }, "junos_config": { "required": [], "type": "object", "description": "This module provides an implementation for working with the active configuration running on Juniper JUNOS devices. It provides a set of arguments for loading configuration, performing rollback operations and zeroing the active configuration on the device.", "properties": { "comment": { "type": "string" }, "src": { "type": "string" }, "rollback": { "type": "string" }, "confirm": { "type": "integer" }, "lines": { "items": { "type": "string" }, "type": "array" }, "update": { "type": "string" }, "replace": { "type": "boolean" }, "confirm_commit": { "type": "boolean" }, "zeroize": { "type": "string" }, "src_format": { "type": "string" }, "backup": { "type": "boolean" } } }, "mattermost": { "required": [ "url", "text", "api_key" ], "type": "object", "description": "Sends notifications to U(http://your.mattermost.url) via the Incoming WebHook integration.", "properties": { "username": { "type": "string" }, "url": { "type": "string" }, "icon_url": { "type": "string" }, "text": { "type": "string" }, "api_key": { "type": "string" }, "validate_certs": { "type": "boolean" }, "channel": { "type": "string" } } }, "os_server": { "required": [ "name", "image" ], "type": "object", "description": "Create or Remove compute instances from OpenStack.", "properties": { "availability_zone": { "type": "string" }, "image": { "type": "string" }, "image_exclude": { "type": "string" }, "flavor_include": { "type": "string" }, "meta": { "items": { "type": "string" }, "type": "array" }, "flavor": { "type": "integer" }, "security_groups": { "items": { "type": "string" }, "type": "array" }, "scheduler_hints": { "type": "string" }, "boot_from_volume": { "type": "boolean" }, "userdata": { "type": "string" }, "network": { "type": "string" }, "nics": { "items": { "type": "string" }, "type": "array" }, "floating_ips": { "items": { "type": "string" }, "type": "array" }, "flavor_ram": { "type": "integer" }, "volume_size": { "type": "string" }, "state": { "type": "string" }, "auto_ip": { "type": "string" }, "config_drive": { "type": "string" }, "terminate_volume": { "type": "boolean" }, "key_name": { "type": "string" }, "boot_volume": { "type": "string" }, "wait": { "type": "string" }, "name": { "type": "string" }, "timeout": { "type": "integer" }, "delete_fip": { "type": "boolean" }, "volumes": { "items": { "type": "string" }, "type": "array" }, "floating_ip_pools": { "type": "string" }, "reuse_ips": { "type": "boolean" } } }, "aci_filter": { "required": [ "filter", "tenant" ], "type": "object", "description": "Manages top level filter objects on Cisco ACI fabrics.\nMore information from the internal APIC class I(vz:Filter) at U(https://developer.cisco.com/media/mim-ref/MO-vzFilter.html).\nThis modules does not manage filter entries, see M(aci_filter_entry) for this functionality.", "properties": { "filter": { "type": "string" }, "state": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" }, "tenant": { "type": "string" } } }, "ohai": { "required": [], "type": "object", "description": "Similar to the M(facter) module, this runs the I(Ohai) discovery program (U(http://wiki.opscode.com/display/chef/Ohai)) on the remote host and returns JSON inventory data. I(Ohai) data is a bit more verbose and nested than I(facter).", "properties": {} }, "tower_host": { "required": [ "name", "inventory" ], "type": "object", "description": "Create, update, or destroy Ansible Tower hosts. See U(https://www.ansible.com/tower) for an overview.", "properties": { "name": { "type": "string" }, "variables": { "type": "string" }, "enabled": { "type": "boolean" }, "state": { "type": "string" }, "inventory": { "type": "string" }, "description": { "type": "string" } } }, "nxos_smu": { "required": [ "pkg" ], "type": "object", "description": "Perform software maintenance upgrades (SMUs) on Cisco NX-OS devices.", "properties": { "pkg": { "type": "string" }, "file_system": { "type": "string" } } }, "os_ironic_inspect": { "required": [], "type": "object", "description": "Requests Ironic to set a node into inspect state in order to collect metadata regarding the node. This command may be out of band or in-band depending on the ironic driver configuration. This is only possible on nodes in 'manageable' and 'available' state.", "properties": { "name": { "type": "string" }, "availability_zone": { "type": "string" }, "ironic_url": { "type": "string" }, "mac": { "type": "string" }, "timeout": { "type": "integer" }, "uuid": { "type": "string" } } }, "ovirt_datacenter": { "required": [ "name" ], "type": "object", "description": "Module to manage data centers in oVirt/RHV", "properties": { "comment": { "type": "string" }, "compatibility_version": { "type": "string" }, "force": { "type": "boolean" }, "name": { "type": "string" }, "mac_pool": { "type": "string" }, "quota_mode": { "type": "string" }, "state": { "type": "string" }, "local": { "type": "string" }, "description": { "type": "string" } } }, "aci_tenant": { "required": [ "tenant" ], "type": "object", "description": "Manage tenants on Cisco ACI fabrics.\nMore information from the internal APIC class I(fv:Tenant) at U(https://developer.cisco.com/media/mim-ref/MO-fvTenant.html).", "properties": { "state": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" }, "tenant": { "type": "string" } } }, "dellos6_config": { "required": [], "type": "object", "description": "OS6 configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with OS6 configuration sections in a deterministic way.", "properties": { "src": { "type": "string" }, "backup": { "type": "boolean" }, "after": { "type": "string" }, "lines": { "type": "string" }, "update": { "type": "string" }, "replace": { "type": "string" }, "parents": { "type": "string" }, "save": { "type": "boolean" }, "config": { "type": "string" }, "match": { "type": "string" }, "before": { "type": "string" } } }, "os_security_group": { "required": [ "name" ], "type": "object", "description": "Add or Remove security groups from an OpenStack cloud.", "properties": { "state": { "type": "string" }, "availability_zone": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" } } }, "iosxr_config": { "required": [], "type": "object", "description": "Cisco IOS XR configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with IOS XR configuration sections in a deterministic way.", "properties": { "comment": { "type": "string" }, "src": { "type": "string" }, "force": { "type": "boolean" }, "admin": { "type": "boolean" }, "backup": { "type": "boolean" }, "after": { "type": "string" }, "lines": { "type": "string" }, "replace": { "type": "string" }, "parents": { "type": "string" }, "config": { "type": "string" }, "match": { "type": "string" }, "before": { "type": "string" } } }, "vmware_guest_tools_wait": { "required": [], "type": "object", "description": "Wait for VMware tools to become available on the VM and return facts.", "properties": { "folder": { "type": "string" }, "uuid": { "type": "string" }, "name": { "type": "string" }, "name_match": { "type": "string" } } }, "nosh": { "required": [ "name" ], "type": "object", "description": "Control running and enabled state for system-wide or user services.\nBSD and Linux systems are supported.", "properties": { "state": { "type": "string" }, "preset": { "type": "string" }, "enabled": { "type": "string" }, "name": { "type": "string" }, "user": { "type": "string" } } }, "aos_blueprint_virtnet": { "required": [ "blueprint", "session" ], "type": "object", "description": "Apstra AOS Blueprint Virtual Network module let you manage your Virtual Network easily. You can create access, define and delete Virtual Network by name or by using a JSON / Yaml file. This module is idempotent and support the I(check) mode. It's using the AOS REST API.", "properties": { "blueprint": { "type": "string" }, "content": { "type": "string" }, "state": { "type": "string" }, "session": { "type": "string" }, "name": { "type": "string" } } }, "ce_snmp_traps": { "required": [], "type": "object", "description": "Manages SNMP traps configurations on HUAWEI CloudEngine switches.", "properties": { "trap_name": { "type": "string" }, "interface_type": { "type": "string" }, "feature_name": { "type": "string" }, "port_number": { "type": "string" }, "interface_number": { "type": "string" } } }, "nxos_bgp": { "required": [ "asn" ], "type": "object", "description": "Manages BGP configurations on NX-OS switches.", "properties": { "neighbor_down_fib_accelerate": { "type": "string" }, "confederation_peers": { "type": "string" }, "confederation_id": { "type": "string" }, "graceful_restart_helper": { "type": "string" }, "bestpath_always_compare_med": { "type": "string" }, "cluster_id": { "type": "string" }, "shutdown": { "type": "string" }, "timer_bgp_hold": { "type": "string" }, "bestpath_aspath_multipath_relax": { "type": "string" }, "graceful_restart_timers_stalepath_time": { "type": "string" }, "maxas_limit": { "type": "string" }, "bestpath_med_confed": { "type": "string" }, "isolate": { "type": "string" }, "timer_bgp_keepalive": { "type": "string" }, "bestpath_cost_community_ignore": { "type": "string" }, "fast_external_fallover": { "type": "string" }, "state": { "type": "string" }, "disable_policy_batching": { "type": "string" }, "suppress_fib_pending": { "type": "string" }, "bestpath_med_missing_as_worst": { "type": "string" }, "router_id": { "type": "string" }, "timer_bestpath_limit": { "type": "string" }, "local_as": { "type": "string" }, "event_history_periodic": { "type": "string" }, "timer_bestpath_limit_always": { "type": "string" }, "disable_policy_batching_ipv4_prefix_list": { "items": { "type": "string" }, "type": "array" }, "vrf": { "type": "string" }, "event_history_cli": { "type": "string" }, "log_neighbor_changes": { "type": "string" }, "event_history_events": { "type": "string" }, "asn": { "type": "string" }, "disable_policy_batching_ipv6_prefix_list": { "items": { "type": "string" }, "type": "array" }, "event_history_detail": { "type": "string" }, "graceful_restart": { "type": "string" }, "flush_routes": { "type": "string" }, "enforce_first_as": { "items": { "type": "string" }, "type": "array" }, "bestpath_med_non_deterministic": { "type": "string" }, "reconnect_interval": { "type": "string" }, "graceful_restart_timers_restart": { "type": "string" }, "bestpath_compare_routerid": { "type": "string" } } }, "avi_snmptrapprofile": { "required": [ "name" ], "type": "object", "description": "This module is used to configure SnmpTrapProfile object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "tenant_ref": { "type": "string" }, "trap_servers": { "type": "string" }, "state": { "type": "string" }, "uuid": { "type": "string" } } }, "os_router": { "required": [ "name" ], "type": "object", "description": "Create or Delete routers from OpenStack. Although Neutron allows routers to share the same name, this module enforces name uniqueness to be more user friendly.", "properties": { "enable_snat": { "type": "boolean" }, "network": { "type": "string" }, "availability_zone": { "type": "string" }, "interfaces": { "items": { "type": "string" }, "type": "array" }, "admin_state_up": { "type": "boolean" }, "project": { "type": "string" }, "state": { "type": "string" }, "external_fixed_ips": { "type": "string" }, "name": { "type": "string" } } }, "bearychat": { "required": [ "url" ], "type": "object", "description": "The M(bearychat) module sends notifications to U(https://bearychat.com) via the Incoming Robot integration.", "properties": { "url": { "type": "string" }, "text": { "type": "string" }, "markdown": { "type": "string" }, "attachments": { "items": { "type": "string" }, "type": "array" }, "channel": { "type": "string" } } }, "elb_instance": { "required": [ "instance_id", "state" ], "type": "object", "description": "This module de-registers or registers an AWS EC2 instance from the ELBs that it belongs to.\nReturns fact \"ec2_elbs\" which is a list of elbs attached to the instance if state=absent is passed as an argument.\nWill be marked changed when called only if there are ELBs found to operate on.", "properties": { "instance_id": { "type": "string" }, "state": { "type": "string" }, "wait_timeout": { "type": "integer" }, "ec2_elbs": { "items": { "type": "string" }, "type": "array" }, "validate_certs": { "type": "string" }, "enable_availability_zone": { "type": "boolean" }, "wait": { "type": "boolean" } } }, "redis": { "required": [ "command" ], "type": "object", "description": "Unified utility to interact with redis instances.", "properties": { "login_port": { "type": "integer" }, "name": { "type": "string" }, "flush_mode": { "type": "string" }, "db": { "type": "string" }, "login_host": { "type": "string" }, "login_password": { "type": "string" }, "master_host": { "type": "string" }, "value": { "type": "string" }, "command": { "type": "string" }, "master_port": { "type": "string" }, "slave_mode": { "type": "string" } } }, "cnos_conditional_command": { "required": [ "flag", "clicommand", "condition" ], "type": "object", "description": "This module allows you to modify the running configuration of a switch. It provides a way to execute a single CNOS command on a network device by evaluating the current running configuration and executing the command only if the specific settings have not been already configured. The CNOS command is passed as an argument of the method. This module functions the same as the cnos_command module. The only exception is that the following inventory variable can be specified [\"condition = \"] When this inventory variable is specified as the variable of a task, the command is executed for the network element that matches the flag string. Usually, commands are executed across a group of network devices. When there is a requirement to skip the execution of the command on one or more devices, it is recommended to use this module. This module uses SSH to manage network device configuration. For more information about this module from Lenovo and customizing it usage for your use cases, please visit U(http://systemx.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.switchmgt.ansible.doc%2Fcnos_conditional_command.html)", "properties": { "flag": { "type": "string" }, "clicommand": { "type": "string" }, "condition": { "type": "string" } } }, "ce_info_center_trap": { "required": [], "type": "object", "description": "Manages information center trap configurations on HUAWEI CloudEngine switches.", "properties": { "trap_time_stamp": { "type": "string" }, "trap_buff_size": { "type": "string" }, "channel_id": { "type": "string" }, "state": { "type": "string" }, "trap_level": { "type": "string" }, "trap_buff_enable": { "type": "string" }, "module_name": { "type": "string" }, "trap_enable": { "type": "string" } } }, "hponcfg": { "required": [ "path" ], "type": "object", "description": "This modules configures the HP iLO interface using hponcfg.", "properties": { "path": { "type": "string" }, "executable": { "type": "string" }, "minfw": { "type": "string" }, "verbose": { "type": "boolean" } } }, "lvol": { "required": [ "vg", "lv" ], "type": "object", "description": "This module creates, removes or resizes logical volumes.", "properties": { "pvs": { "items": { "type": "string" }, "type": "array" }, "force": { "type": "string" }, "vg": { "type": "string" }, "lv": { "type": "string" }, "resizefs": { "type": "string" }, "state": { "type": "string" }, "snapshot": { "type": "string" }, "active": { "type": "string" }, "shrink": { "type": "string" }, "opts": { "type": "string" }, "size": { "type": "string" } } }, "cl_interface": { "required": [ "name" ], "type": "object", "description": "Configures a front panel, sub-interface, SVI, management or loopback port on a Cumulus Linux switch. For bridge ports use the cl_bridge module. For bond ports use the cl_bond module. When configuring bridge related features like the \"vid\" option, please follow the guidelines for configuring \"vlan aware\" bridging. For more details review the Layer2 Interface Guide at U(http://docs.cumulusnetworks.com)", "properties": { "clagd_sys_mac": { "type": "string" }, "name": { "type": "string" }, "clagd_enable": { "type": "string" }, "mstpctl_portnetwork": { "type": "string" }, "speed": { "type": "string" }, "clagd_peer_ip": { "type": "string" }, "clagd_priority": { "type": "string" }, "location": { "type": "string" }, "mstpctl_portadminedge": { "type": "string" }, "mtu": { "type": "string" }, "pvid": { "type": "string" }, "virtual_mac": { "type": "string" }, "ipv6": { "items": { "type": "string" }, "type": "array" }, "vids": { "items": { "type": "string" }, "type": "array" }, "addr_method": { "type": "string" }, "mstpctl_bpduguard": { "type": "string" }, "alias_name": { "type": "string" }, "ipv4": { "items": { "type": "string" }, "type": "array" }, "virtual_ip": { "type": "string" } } }, "assemble": { "required": [ "src", "dest" ], "type": "object", "description": "Assembles a configuration file from fragments. Often a particular program will take a single configuration file and does not support a C(conf.d) style structure where it is easy to build up the configuration from multiple sources. C(assemble) will take a directory of files that can be local or have already been transferred to the system, and concatenate them together to produce a destination file. Files are assembled in string sorting order. Puppet calls this idea I(fragments).", "properties": { "ignore_hidden": { "type": "string" }, "src": { "type": "string" }, "remote_src": { "type": "string" }, "dest": { "type": "string" }, "delimiter": { "type": "string" }, "regexp": { "type": "string" }, "validate": { "type": "string" }, "backup": { "type": "string" } } }, "iosxr_user": { "required": [], "type": "object", "description": "This module provides declarative management of the local usernames configured on network devices. It allows playbooks to manage either individual usernames or the aggregate of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined.", "properties": { "public_key": { "type": "string" }, "update_password": { "type": "string" }, "configured_password": { "type": "string" }, "group": { "type": "string" }, "name": { "type": "string" }, "purge": { "type": "boolean" }, "state": { "type": "string" }, "public_key_contents": { "type": "string" }, "groups": { "items": { "type": "string" }, "type": "array" }, "aggregate": { "items": { "type": "string" }, "type": "array" } } }, "package": { "required": [ "state", "name" ], "type": "object", "description": "Installs, upgrade and removes packages using the underlying OS package manager.\nFor Windows targets, use the M(win_package) module instead.", "properties": { "state": { "type": "string" }, "use": { "type": "string" }, "name": { "type": "string" } } }, "get_url": { "required": [ "dest", "url" ], "type": "object", "description": "Downloads files from HTTP, HTTPS, or FTP to the remote server. The remote server I(must) have direct access to the remote resource.\nBy default, if an environment variable C(_proxy) is set on the target host, requests will be sent through that proxy. This behaviour can be overridden by setting a variable for this task (see `setting the environment `_), or by using the use_proxy option.\nHTTP redirects can redirect from HTTP to HTTPS so you should be sure that your proxy environment for both protocols is correct.\nFrom Ansible 2.4 when run with C(--check), it will do a HEAD request to validate the URL but will not download the entire file or verify it against hashes.\nFor Windows targets, use the M(win_get_url) module instead.", "properties": { "url_password": { "type": "string" }, "force": { "type": "string" }, "use_proxy": { "type": "string" }, "headers": { "type": "string" }, "dest": { "type": "string" }, "checksum": { "type": "string" }, "force_basic_auth": { "type": "string" }, "timeout": { "type": "integer" }, "sha256sum": { "type": "string" }, "url": { "type": "string" }, "url_username": { "type": "string" }, "others": { "type": "string" }, "validate_certs": { "type": "string" }, "backup": { "type": "string" }, "client_cert": { "type": "string" }, "tmp_dest": { "type": "string" }, "client_key": { "type": "string" } } }, "oneview_fc_network_facts": { "required": [], "type": "object", "description": "Retrieve the facts about one or more of the Fibre Channel Networks from OneView.", "properties": { "name": { "type": "string" } } }, "ovirt_templates": { "required": [], "type": "object", "description": "Module to manage virtual machine templates in oVirt/RHV.", "properties": { "exclusive": { "type": "string" }, "cpu_profile": { "type": "string" }, "storage_domain": { "type": "string" }, "description": { "type": "string" }, "allow_partial_import": { "type": "string" }, "export_domain": { "type": "string" }, "template_image_disk_name": { "type": "string" }, "image_disk": { "type": "string" }, "vm": { "type": "string" }, "name": { "type": "string" }, "cluster": { "type": "string" }, "state": { "type": "string" }, "seal": { "type": "boolean" }, "clone_permissions": { "type": "boolean" }, "id": { "type": "string" }, "image_provider": { "type": "string" } } }, "acl": { "required": [ "path" ], "type": "object", "description": "Sets and retrieves file ACL information.", "properties": { "recursive": { "type": "string" }, "default": { "type": "string" }, "entity": { "type": "string" }, "state": { "type": "string" }, "entry": { "type": "string" }, "etype": { "type": "string" }, "follow": { "type": "string" }, "path": { "type": "string" }, "permissions": { "type": "string" } } }, "gitlab_project": { "required": [ "server_url", "name" ], "type": "object", "description": "When the project does not exists in Gitlab, it will be created.\nWhen the project does exists and state=absent, the project will be deleted.\nWhen changes are made to the project, the project will be updated.", "properties": { "group": { "type": "string" }, "merge_requests_enabled": { "type": "boolean" }, "import_url": { "type": "boolean" }, "login_user": { "type": "string" }, "login_token": { "type": "string" }, "server_url": { "type": "string" }, "name": { "type": "string" }, "path": { "type": "string" }, "state": { "type": "string" }, "issues_enabled": { "type": "boolean" }, "login_password": { "type": "string" }, "snippets_enabled": { "type": "boolean" }, "wiki_enabled": { "type": "boolean" }, "visibility_level": { "type": "integer" }, "validate_certs": { "type": "boolean" }, "public": { "type": "boolean" }, "description": { "type": "string" } } }, "oneview_san_manager_facts": { "required": [], "type": "object", "description": "Retrieve facts about one or more of the SAN Managers from OneView", "properties": { "provider_display_name": { "type": "string" }, "params": { "items": { "type": "string" }, "type": "array" } } }, "cnos_reload": { "required": [], "type": "object", "description": "This module allows you to restart the switch using the current startup configuration. The module is usually invoked after the running configuration has been saved over the startup configuration. This module uses SSH to manage network device configuration. The results of the operation can be viewed in results directory. For more information about this module from Lenovo and customizing it usage for your use cases, please visit U(http://systemx.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.switchmgt.ansible.doc%2Fcnos_reload.html)", "properties": {} }, "oneview_ethernet_network": { "required": [ "data" ], "type": "object", "description": "Provides an interface to manage Ethernet Network resources. Can create, update, or delete.", "properties": { "state": { "type": "string" }, "data": { "items": { "type": "string" }, "type": "array" } } }, "redshift": { "required": [ "command", "identifier" ], "type": "object", "description": "Creates, deletes, or modifies amazon Redshift cluster instances.", "properties": { "cluster_parameter_group_name": { "type": "string" }, "availability_zone": { "type": "string" }, "encrypted": { "type": "boolean" }, "node_type": { "type": "string" }, "publicly_accessible": { "type": "boolean" }, "port": { "items": { "type": "string" }, "type": "array" }, "allow_version_upgrade": { "type": "boolean" }, "cluster_type": { "type": "string" }, "final_cluster_snapshot_identifier": { "type": "string" }, "vpc_security_group_ids": { "type": "string" }, "username": { "type": "string" }, "new_cluster_identifier": { "type": "string" }, "number_of_nodes": { "type": "string" }, "wait_timeout": { "type": "integer" }, "password": { "type": "string" }, "cluster_subnet_group_name": { "type": "string" }, "wait": { "type": "string" }, "cluster_security_groups": { "type": "string" }, "elastic_ip": { "type": "string" }, "db_name": { "type": "string" }, "command": { "type": "string" }, "automated_snapshot_retention_period": { "type": "string" }, "identifier": { "type": "string" }, "cluster_version": { "type": "string" }, "skip_final_cluster_snapshot": { "type": "boolean" }, "preferred_maintenance_window": { "type": "string" } } }, "cnos_image": { "required": [ "protocol", "serverusername", "imgtype", "serverip", "imgpath" ], "type": "object", "description": "This module allows you to work with switch firmware images. It provides a way to download a firmware image to a network device from a remote server using FTP, SFTP, TFTP, or SCP. The first step is to create a directory from where the remote server can be reached. The next step is to provide the full file path of the image's location. Authentication details required by the remote server must be provided as well. By default, this method makes the newly downloaded firmware image the active image, which will be used by the switch during the next restart. This module uses SSH to manage network device configuration. The results of the operation will be placed in a directory named 'results' that must be created by the user in their local directory to where the playbook is run. For more information about this module from Lenovo and customizing it usage for your use cases, please visit U(http://systemx.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.switchmgt.ansible.doc%2Fcnos_image.html)", "properties": { "serverpassword": { "type": "string" }, "protocol": { "type": "string" }, "serverip": { "type": "string" }, "imgpath": { "type": "string" }, "serverusername": { "type": "string" }, "imgtype": { "type": "string" } } }, "vmware_vmotion": { "required": [ "vm_name", "destination_host" ], "type": "object", "description": "Using VMware vCenter, move a virtual machine using vMotion to a different host.", "properties": { "vm_name": { "type": "string" }, "destination_host": { "type": "string" } } }, "zabbix_hostmacro": { "required": [ "macro_value", "macro_name", "host_name" ], "type": "object", "description": "manages Zabbix host macros, it can create, update or delete them.", "properties": { "macro_value": { "type": "string" }, "state": { "type": "string" }, "macro_name": { "type": "string" }, "host_name": { "type": "string" } } }, "consul_acl": { "required": [], "type": "object", "description": "Allows the addition, modification and deletion of ACL keys and associated rules in a consul cluster via the agent. For more details on using and configuring ACLs, see https://www.consul.io/docs/guides/acl.html.", "properties": { "name": { "type": "string" }, "rules": { "items": { "type": "string" }, "type": "array" }, "token": { "type": "string" }, "token_type": { "type": "string" }, "state": { "type": "string" }, "mgmt_token": { "items": { "type": "string" }, "type": "array" }, "host": { "type": "string" }, "scheme": { "type": "string" }, "validate_certs": { "type": "boolean" }, "port": { "type": "integer" } } }, "cs_region": { "required": [ "id" ], "type": "object", "description": "Add, update and remove regions.", "properties": { "state": { "type": "string" }, "endpoint": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } } }, "nxos_snmp_user": { "required": [ "user", "group" ], "type": "object", "description": "Manages SNMP user configuration.", "properties": { "group": { "type": "string" }, "privacy": { "type": "string" }, "state": { "type": "string" }, "authentication": { "type": "string" }, "user": { "type": "string" }, "encrypt": { "type": "string" }, "pwd": { "type": "string" } } }, "azure_rm_virtualnetwork_facts": { "required": [], "type": "object", "description": "Get facts for a specific virtual network or all virtual networks within a resource group.", "properties": { "name": { "type": "string" }, "resource_group": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } } }, "cnos_command": { "required": [ "clicommand" ], "type": "object", "description": "This module allows you to modify the switch running configuration. It provides a way to execute a single CNOS command on a switch by evaluating the current running configuration and executing the command only if the specific setting has not been already configured. The CNOS command is passed as an argument of the method. This module uses SSH to manage network device configuration. The results of the operation will be placed in a directory named 'results' that must be created by the user in their local directory to where the playbook is run. For more information about this module from Lenovo and customizing it usage for your use cases, please visit U(http://systemx.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.switchmgt.ansible.doc%2Fcnos_command.html)", "properties": { "clicommand": { "type": "string" } } }, "vyos_static_route": { "required": [], "type": "object", "description": "This module provides declarative management of static IP routes on Vyatta VyOS network devices.", "properties": { "mask": { "type": "string" }, "prefix": { "type": "string" }, "admin_distance": { "type": "string" }, "state": { "type": "string" }, "next_hop": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" } } }, "aci_bd": { "required": [], "type": "object", "description": "Manages Bridge Domains (BD) on Cisco ACI Fabrics.\nMore information from the internal APIC class I(fv:BD) at U(https://developer.cisco.com/media/mim-ref/MO-fvBD.html).", "properties": { "bd": { "type": "string" }, "arp_flooding": { "type": "boolean" }, "endpoint_retention_action": { "type": "string" }, "description": { "type": "string" }, "limit_ip_learn": { "type": "boolean" }, "multi_dest": { "type": "string" }, "l3_unknown_multicast": { "type": "string" }, "enable_routing": { "type": "boolean" }, "ip_learning": { "type": "string" }, "endpoint_move_detect": { "type": "string" }, "state": { "items": { "type": "string" }, "type": "array" }, "ipv6_nd_policy": { "type": "string" }, "vrf": { "type": "string" }, "bd_type": { "type": "string" }, "igmp_snoop_policy": { "type": "string" }, "endpoint_retention_policy": { "type": "string" }, "enable_multicast": { "type": "boolean" }, "endpoint_clear": { "type": "boolean" }, "tenant": { "type": "string" }, "l2_unknown_unicast": { "type": "string" } } }, "htpasswd": { "required": [ "name", "path" ], "type": "object", "description": "Add and remove username/password entries in a password file using htpasswd.\nThis is used by web servers such as Apache and Nginx for basic authentication.", "properties": { "name": { "type": "string" }, "create": { "type": "string" }, "state": { "type": "string" }, "path": { "type": "string" }, "password": { "type": "string" }, "crypt_scheme": { "items": { "type": "string" }, "type": "array" } } }, "cyberark_authentication": { "required": [], "type": "object", "description": "Authenticates to CyberArk Vault using Privileged Account Security Web Services SDK and creates a session fact that can be used by other modules. It returns an Ansible fact called I(cyberark_session). Every module can use this fact as C(cyberark_session) parameter.", "properties": { "username": { "type": "string" }, "use_radius_authentication": { "type": "string" }, "new_password": { "type": "string" }, "cyberark_session": { "type": "string" }, "state": { "type": "string" }, "password": { "type": "string" }, "validate_certs": { "type": "string" }, "use_shared_logon_authentication": { "type": "string" }, "api_base_url": { "type": "string" } } }, "bigip_gtm_virtual_server": { "required": [ "virtual_server_server", "virtual_server_name" ], "type": "object", "description": "Manages F5 BIG-IP GTM virtual servers", "properties": { "host": { "type": "string" }, "virtual_server_name": { "type": "string" }, "virtual_server_server": { "type": "string" }, "port": { "type": "string" }, "state": { "type": "string" } } }, "nxos_interface_ospf": { "required": [ "area", "interface", "ospf" ], "type": "object", "description": "Manages configuration of an OSPF interface instance.", "properties": { "cost": { "type": "string" }, "passive_interface": { "type": "string" }, "area": { "type": "string" }, "message_digest_algorithm_type": { "type": "string" }, "message_digest_key_id": { "type": "string" }, "message_digest_encryption_type": { "type": "string" }, "state": { "type": "string" }, "dead_interval": { "type": "string" }, "hello_interval": { "type": "string" }, "message_digest_password": { "type": "string" }, "interface": { "type": "string" }, "ospf": { "type": "string" }, "message_digest": { "type": "string" } } }, "netscaler_servicegroup": { "required": [], "type": "object", "description": "Manage service group configuration in Netscaler.\nThis module is intended to run either on the ansible control node or a bastion (jumpserver) with access to the actual netscaler instance.", "properties": { "comment": { "type": "string" }, "tcpb": { "type": "string" }, "cachetype": { "type": "string" }, "disabled": { "type": "boolean" }, "maxreq": { "type": "string" }, "maxbandwidth": { "type": "string" }, "graceful": { "type": "string" }, "svrtimeout": { "type": "string" }, "clttimeout": { "type": "string" }, "servicetype": { "type": "string" }, "cacheable": { "type": "string" }, "autoscale": { "type": "string" }, "maxclient": { "type": "string" }, "monitorbindings": { "items": { "type": "string" }, "type": "array" }, "servicegroupname": { "type": "string" }, "usip": { "type": "string" }, "netprofile": { "type": "string" }, "rtspsessionidremap": { "type": "string" }, "httpprofilename": { "type": "string" }, "pathmonitorindv": { "type": "string" }, "pathmonitor": { "type": "string" }, "appflowlog": { "type": "string" }, "servicemembers": { "items": { "type": "string" }, "type": "array" }, "monthreshold": { "type": "string" }, "memberport": { "type": "string" }, "cka": { "type": "string" }, "tcpprofilename": { "type": "string" }, "sp": { "type": "string" }, "downstateflush": { "type": "string" }, "cipheader": { "type": "string" }, "cip": { "type": "string" }, "healthmonitor": { "type": "string" }, "useproxyport": { "type": "string" }, "cmp": { "type": "string" } } }, "aix_lvol": { "required": [ "vg", "lv" ], "type": "object", "description": "This module creates, removes or resizes AIX logical volumes. Inspired by lvol module.", "properties": { "pvs": { "items": { "type": "string" }, "type": "array" }, "lv_type": { "type": "string" }, "vg": { "type": "string" }, "copies": { "type": "string" }, "lv": { "type": "string" }, "state": { "type": "string" }, "policy": { "type": "string" }, "opts": { "type": "string" }, "size": { "type": "string" } } }, "zabbix_screen": { "required": [ "screens" ], "type": "object", "description": "This module allows you to create, modify and delete Zabbix screens and associated graph data.", "properties": { "screens": { "items": { "type": "string" }, "type": "array" } } }, "ce_dldp_interface": { "required": [ "interface" ], "type": "object", "description": "Manages interface DLDP configuration on HUAWEI CloudEngine switches.", "properties": { "reset": { "type": "string" }, "enable": { "type": "string" }, "state": { "type": "string" }, "interface": { "type": "string" }, "mode_enable": { "type": "string" }, "local_mac": { "type": "string" } } }, "pacman": { "required": [], "type": "object", "description": "Manage packages with the I(pacman) package manager, which is used by Arch Linux and its variants.", "properties": { "upgrade": { "type": "boolean" }, "force": { "type": "boolean" }, "name": { "items": { "type": "string" }, "type": "array" }, "recurse": { "type": "boolean" }, "state": { "type": "string" }, "update_cache": { "items": { "type": "boolean" }, "type": "array" } } }, "nxos_snmp_host": { "required": [ "snmp_host", "state" ], "type": "object", "description": "Manages SNMP host configuration parameters.", "properties": { "vrf_filter": { "type": "string" }, "udp": { "type": "string" }, "src_intf": { "type": "string" }, "snmp_host": { "type": "string" }, "community": { "type": "string" }, "state": { "type": "string" }, "version": { "type": "string" }, "vrf": { "type": "string" }, "type": { "type": "string" } } }, "set_stats": { "required": [ "data" ], "type": "object", "description": "This module allows setting/accumulating stats on the current ansible run, either per host of for all hosts in the run.\nThis module is also supported for Windows targets.", "properties": { "aggregate": { "type": "boolean" }, "data": { "type": "string" }, "per_host": { "type": "boolean" } } }, "mysql_variables": { "required": [ "variable" ], "type": "object", "description": "Query / Set MySQL variables", "properties": { "variable": { "type": "string" }, "value": { "type": "string" } } }, "nagios": { "required": [ "action", "command", "services" ], "type": "object", "description": "The C(nagios) module has two basic functions: scheduling downtime and toggling alerts for services or hosts.\nAll actions require the I(host) parameter to be given explicitly. In playbooks you can use the C({{inventory_hostname}}) variable to refer to the host the playbook is currently running on.\nYou can specify multiple services at once by separating them with commas, .e.g., C(services=httpd,nfs,puppet).\nWhen specifying what service to handle there is a special service value, I(host), which will handle alerts/downtime for the I(host itself), e.g., C(service=host). This keyword may not be given with other services at the same time. I(Setting alerts/downtime for a host does not affect alerts/downtime for any of the services running on it.) To schedule downtime for all services on particular host use keyword \"all\", e.g., C(service=all).\nWhen using the C(nagios) module you will need to specify your Nagios server using the C(delegate_to) parameter.", "properties": { "comment": { "type": "string" }, "servicegroup": { "type": "string" }, "author": { "type": "string" }, "services": { "type": "string" }, "host": { "type": "string" }, "command": { "type": "string" }, "action": { "type": "string" }, "minutes": { "type": "integer" }, "cmdfile": { "type": "string" } } }, "flowdock": { "required": [ "type", "token", "msg" ], "type": "object", "description": "Send a message to a flowdock team inbox or chat using the push API (see https://www.flowdock.com/api/team-inbox and https://www.flowdock.com/api/chat)", "properties": { "from_name": { "type": "string" }, "from_address": { "type": "string" }, "tags": { "type": "string" }, "validate_certs": { "type": "string" }, "external_user_name": { "type": "string" }, "project": { "type": "string" }, "source": { "type": "string" }, "token": { "type": "string" }, "link": { "type": "string" }, "msg": { "type": "string" }, "reply_to": { "type": "string" }, "type": { "type": "string" }, "subject": { "type": "string" } } }, "file": { "required": [ "path" ], "type": "object", "description": "Sets attributes of files, symlinks, and directories, or removes files/symlinks/directories. Many other modules support the same options as the C(file) module - including M(copy), M(template), and M(assemble).\nFor Windows targets, use the M(win_file) module instead.", "properties": { "src": { "type": "string" }, "force": { "type": "string" }, "recurse": { "type": "string" }, "state": { "type": "string" }, "path": { "type": "string" }, "follow": { "type": "string" } } }, "win_stat": { "required": [ "path" ], "type": "object", "description": "Returns information about a Windows file.\nFor non-Windows targets, use the M(stat) module instead.", "properties": { "path": { "type": "string" }, "get_md5": { "type": "string" }, "get_checksum": { "type": "string" }, "checksum_algorithm": { "type": "string" } } }, "wakeonlan": { "required": [ "mac" ], "type": "object", "description": "The C(wakeonlan) module sends magic Wake-on-LAN (WoL) broadcast packets.", "properties": { "broadcast": { "type": "string" }, "mac": { "type": "string" }, "port": { "type": "integer" } } }, "cs_nic": { "required": [ "vm" ], "type": "object", "description": "Add and remove secondary IPs to and from a NIC.", "properties": { "vm_guest_ip": { "type": "string" }, "account": { "type": "string" }, "poll_async": { "type": "string" }, "network": { "type": "string" }, "zone": { "type": "string" }, "domain": { "type": "string" }, "vm": { "type": "string" }, "project": { "type": "string" }, "state": { "type": "string" }, "vpc": { "type": "string" } } }, "lambda_alias": { "required": [ "function_name", "state", "name" ], "type": "object", "description": "This module allows the management of AWS Lambda functions aliases via the Ansible framework. It is idempotent and supports \"Check\" mode. Use module M(lambda) to manage the lambda function itself and M(lambda_event) to manage event source mappings.", "properties": { "state": { "type": "string" }, "version": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "function_name": { "type": "string" } } }, "aos_blueprint_param": { "required": [ "blueprint", "session" ], "type": "object", "description": "Apstra AOS Blueprint Parameter module let you manage your Blueprint Parameter easily. You can create access, define and delete Blueprint Parameter. The list of Parameters supported is different per Blueprint. The option I(get_param_list) can help you to access the list of supported Parameters for your blueprint. This module is idempotent and support the I(check) mode. It's using the AOS REST API.", "properties": { "blueprint": { "type": "string" }, "name": { "items": { "type": "string" }, "type": "array" }, "value": { "type": "string" }, "state": { "type": "string" }, "session": { "type": "string" }, "param_map": { "type": "string" }, "get_param_list": { "items": { "type": "string" }, "type": "array" } } }, "nxos_acl_interface": { "required": [ "interface", "direction", "name" ], "type": "object", "description": "Manages applying ACLs to interfaces.", "properties": { "interface": { "type": "string" }, "direction": { "type": "string" }, "name": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" } } }, "win_iis_virtualdirectory": { "required": [ "name", "site" ], "type": "object", "description": "Creates, Removes and configures a virtual directory in IIS.", "properties": { "application": { "type": "string" }, "state": { "type": "string" }, "name": { "type": "string" }, "physical_path": { "type": "string" }, "site": { "type": "string" } } }, "pear": { "required": [ "name" ], "type": "object", "description": "Manage PHP packages with the pear package manager.", "properties": { "state": { "type": "string" }, "executable": { "type": "string" }, "name": { "type": "string" } } }, "bigip_hostname": { "required": [ "hostname" ], "type": "object", "description": "Manage the hostname of a BIG-IP.", "properties": { "hostname": { "type": "string" } } }, "infini_export": { "required": [ "name", "filesystem" ], "type": "object", "description": "This module creates, deletes or modifies NFS exports on Infinibox.", "properties": { "inner_path": { "type": "string" }, "state": { "type": "string" }, "client_list": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "filesystem": { "type": "string" } } }, "oneview_logical_interconnect_group_facts": { "required": [], "type": "object", "description": "Retrieve facts about one or more of the Logical Interconnect Groups from OneView", "properties": { "name": { "type": "string" } } }, "aws_api_gateway": { "required": [], "type": "object", "description": "Allows for the management of API Gateway APIs\nNormally you should give the api_id since there is no other stable guaranteed unique identifier for the API. If you do not give api_id then a new API will be create each time this is run.\nBeware that there are very hard limits on the rate that you can call API Gateway's REST API. You may need to patch your boto. See https://github.com/boto/boto3/issues/876 and discuss with your AWS rep.\nswagger_file and swagger_text are passed directly on to AWS transparently whilst swagger_dict is an ansible dict which is converted to JSON before the API definitions are uploaded.", "properties": { "swagger_file": { "type": "string" }, "swagger_dict": { "type": "string" }, "deploy_desc": { "type": "string" }, "api_id": { "type": "string" }, "state": { "type": "string" }, "swagger_text": { "type": "string" }, "stage": { "type": "string" } } }, "nxos_aaa_server": { "required": [ "state", "server_type" ], "type": "object", "description": "Manages AAA server global configuration", "properties": { "server_timeout": { "type": "string" }, "server_type": { "type": "string" }, "encrypt_type": { "type": "string" }, "state": { "type": "string" }, "deadtime": { "type": "string" }, "directed_request": { "type": "string" }, "global_key": { "type": "string" } } }, "azure_rm_virtualnetwork": { "required": [ "name", "resource_group" ], "type": "object", "description": "Create, update or delete a virtual networks. Allows setting and updating the available IPv4 address ranges and setting custom DNS servers. Use the azure_rm_subnet module to associate subnets with a virtual network.", "properties": { "dns_servers": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "resource_group": { "type": "string" }, "state": { "type": "string" }, "address_prefixes_cidr": { "items": { "type": "string" }, "type": "array" }, "purge_dns_servers": { "type": "boolean" }, "purge_address_prefixes": { "type": "boolean" }, "location": { "type": "string" } } }, "nxos_igmp": { "required": [], "type": "object", "description": "Manages IGMP global configuration configuration settings.", "properties": { "state": { "type": "string" }, "enforce_rtr_alert": { "type": "string" }, "restart": { "type": "string" }, "flush_routes": { "type": "string" } } }, "selinux": { "required": [ "state" ], "type": "object", "description": "Configures the SELinux mode and policy. A reboot may be required after usage. Ansible will not issue this reboot but will let you know when it is required.", "properties": { "policy": { "type": "string" }, "state": { "type": "string" }, "conf": { "type": "string" } } }, "gce_lb": { "required": [], "type": "object", "description": "This module can create and destroy Google Compute Engine C(loadbalancer) and C(httphealthcheck) resources. The primary LB resource is the C(load_balancer) resource and the health check parameters are all prefixed with I(httphealthcheck). The full documentation for Google Compute Engine load balancing is at U(https://developers.google.com/compute/docs/load-balancing/). However, the ansible module simplifies the configuration by following the libcloud model. Full install/configuration instructions for the gce* modules can be found in the comments of ansible/test/gce_tests.py.", "properties": { "httphealthcheck_host": { "type": "string" }, "httphealthcheck_name": { "type": "string" }, "name": { "type": "string" }, "external_ip": { "type": "string" }, "service_account_email": { "type": "string" }, "region": { "type": "string" }, "httphealthcheck_unhealthy_count": { "type": "integer" }, "httphealthcheck_healthy_count": { "type": "integer" }, "pem_file": { "type": "string" }, "httphealthcheck_path": { "type": "string" }, "port_range": { "type": "string" }, "state": { "type": "string" }, "httphealthcheck_timeout": { "type": "integer" }, "members": { "items": { "type": "string" }, "type": "array" }, "credentials_file": { "type": "string" }, "httphealthcheck_port": { "type": "integer" }, "protocol": { "type": "string" }, "project_id": { "type": "string" }, "httphealthcheck_interval": { "type": "integer" } } }, "os_keystone_domain_facts": { "required": [ "name" ], "type": "object", "description": "Retrieve facts about a one or more OpenStack domains", "properties": { "name": { "type": "string" }, "filters": { "type": "string" }, "availability_zone": { "type": "string" } } }, "os_recordset": { "required": [ "name", "zone", "records", "recordset_type" ], "type": "object", "description": "Manage OpenStack DNS recordsets. Recordsets can be created, deleted or updated. Only the I(records), I(description), and I(ttl) values can be updated.", "properties": { "name": { "type": "string" }, "zone": { "type": "string" }, "availability_zone": { "type": "string" }, "records": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "ttl": { "type": "string" }, "recordset_type": { "type": "string" }, "description": { "type": "string" } } }, "zabbix_maintenance": { "required": [ "name", "desc" ], "type": "object", "description": "This module will let you create Zabbix maintenance windows.", "properties": { "name": { "type": "string" }, "host_names": { "type": "string" }, "state": { "type": "string" }, "host_groups": { "type": "string" }, "collect_data": { "type": "string" }, "minutes": { "type": "integer" }, "desc": { "type": "string" } } }, "cl_img_install": { "required": [ "src" ], "type": "object", "description": "install a different version of Cumulus Linux in the inactive slot. For more details go the Image Management User Guide at U(http://docs.cumulusnetworks.com/).", "properties": { "src": { "type": "string" }, "version": { "type": "string" }, "switch_slot": { "type": "string" } } }, "nxos_gir_profile_management": { "required": [ "mode" ], "type": "object", "description": "Manage a maintenance-mode or normal-mode profile with configuration commands that can be applied during graceful removal or graceful insertion.", "properties": { "include_defaults": { "type": "boolean" }, "commands": { "items": { "type": "string" }, "type": "array" }, "config": { "type": "string" }, "mode": { "type": "string" }, "state": { "type": "string" } } }, "kernel_blacklist": { "required": [ "name" ], "type": "object", "description": "Add or remove kernel modules from blacklist.", "properties": { "blacklist_file": { "items": { "type": "string" }, "type": "array" }, "state": { "items": { "type": "string" }, "type": "array" }, "name": { "items": { "type": "string" }, "type": "array" } } }, "nxos_command": { "required": [ "commands" ], "type": "object", "description": "Sends an arbitrary command to an NXOS node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.", "properties": { "retries": { "type": "integer" }, "commands": { "type": "string" }, "wait_for": { "type": "string" }, "match": { "type": "string" }, "interval": { "type": "integer" } } }, "bigip_ucs": { "required": [], "type": "object", "description": "Manage upload, installation and removal of UCS files.", "properties": { "force": { "type": "string" }, "reset_trust": { "type": "string" }, "no_platform_check": { "type": "string" }, "state": { "type": "string" }, "include_chassis_level_config": { "type": "string" }, "passphrase": { "type": "string" }, "ucs": { "type": "string" }, "no_license": { "type": "string" } } }, "net_l3_interface": { "required": [], "type": "object", "description": "This module provides declarative management of L3 interfaces on network devices.", "properties": { "name": { "type": "string" }, "purge": { "type": "boolean" }, "state": { "type": "string" }, "ipv4": { "type": "string" }, "ipv6": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" } } }, "logentries": { "required": [ "path" ], "type": "object", "description": "Sends logs to LogEntries in realtime", "properties": { "path": { "type": "string" }, "state": { "type": "string" }, "name": { "type": "string" }, "logtype": { "type": "string" } } }, "bigip_pool_member": { "required": [ "state", "host", "port", "pool" ], "type": "object", "description": "Manages F5 BIG-IP LTM pool members via iControl SOAP API", "properties": { "session_state": { "type": "string" }, "ratio": { "type": "string" }, "description": { "type": "string" }, "monitor_state": { "type": "string" }, "partition": { "type": "string" }, "connection_limit": { "type": "string" }, "host": { "type": "string" }, "state": { "type": "string" }, "preserve_node": { "type": "string" }, "rate_limit": { "type": "string" }, "priority_group": { "type": "string" }, "port": { "type": "string" }, "pool": { "type": "string" } } }, "os_floating_ip": { "required": [ "server" ], "type": "object", "description": "Add or Remove a floating IP to an instance", "properties": { "fixed_address": { "type": "string" }, "network": { "type": "string" }, "availability_zone": { "type": "string" }, "wait": { "type": "boolean" }, "nat_destination": { "type": "string" }, "purge": { "type": "boolean" }, "state": { "type": "string" }, "floating_ip_address": { "type": "string" }, "timeout": { "type": "integer" }, "server": { "type": "string" }, "reuse": { "type": "boolean" } } }, "win_feature": { "required": [ "name" ], "type": "object", "description": "Installs or uninstalls Windows Roles or Features on Windows Server. This module uses the Add/Remove-WindowsFeature Cmdlets on Windows 2008 and Install/Uninstall-WindowsFeature Cmdlets on Windows 2012, which are not available on client os machines.", "properties": { "name": { "items": { "type": "string" }, "type": "array" }, "include_management_tools": { "type": "string" }, "include_sub_features": { "type": "string" }, "source": { "type": "string" }, "state": { "type": "string" }, "restart": { "type": "string" } } }, "win_service": { "required": [ "name" ], "type": "object", "description": "Manage and query Windows services.\nFor non-Windows targets, use the M(service) module instead.", "properties": { "username": { "type": "string" }, "display_name": { "type": "string" }, "description": { "type": "string" }, "force_dependent_services": { "type": "string" }, "dependency_action": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "start_mode": { "type": "string" }, "state": { "type": "string" }, "dependencies": { "items": { "type": "string" }, "type": "array" }, "path": { "type": "string" }, "password": { "type": "string" }, "desktop_interact": { "type": "string" } } }, "ec2_elb": { "required": [ "instance_id", "state" ], "type": "object", "description": "This module de-registers or registers an AWS EC2 instance from the ELBs that it belongs to.\nReturns fact \"ec2_elbs\" which is a list of elbs attached to the instance if state=absent is passed as an argument.\nWill be marked changed when called only if there are ELBs found to operate on.", "properties": { "instance_id": { "type": "string" }, "state": { "type": "string" }, "wait_timeout": { "type": "integer" }, "ec2_elbs": { "items": { "type": "string" }, "type": "array" }, "validate_certs": { "type": "string" }, "enable_availability_zone": { "type": "boolean" }, "wait": { "type": "boolean" } } }, "ovirt_api_facts": { "required": [], "type": "object", "description": "Retrieve facts about the oVirt/RHV API.", "properties": {} }, "win_tempfile": { "required": [], "type": "object", "description": "Creates temporary files and directories.\nFor non-Windows targets, please use the M(tempfile) module instead.", "properties": { "path": { "type": "string" }, "state": { "type": "string" }, "prefix": { "type": "string" }, "suffix": { "type": "string" } } }, "win_reboot": { "required": [], "type": "object", "description": "Reboot a Windows machine, wait for it to go down, come back up, and respond to commands.", "properties": { "pre_reboot_delay": { "type": "integer" }, "test_command": { "type": "string" }, "reboot_timeout": { "type": "integer" }, "post_reboot_delay": { "type": "integer" }, "shutdown_timeout": { "type": "integer" }, "msg": { "type": "string" }, "connect_timeout": { "type": "integer" } } }, "avi_alertemailconfig": { "required": [ "to_emails", "name" ], "type": "object", "description": "This module is used to configure AlertEmailConfig object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "to_emails": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" }, "url": { "type": "string" }, "cc_emails": { "items": { "type": "string" }, "type": "array" }, "tenant_ref": { "type": "string" }, "uuid": { "type": "string" }, "state": { "type": "string" }, "name": { "type": "string" } } }, "avi_useraccountprofile": { "required": [ "name" ], "type": "object", "description": "This module is used to configure UserAccountProfile object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "max_concurrent_sessions": { "type": "string" }, "uuid": { "type": "string" }, "url": { "type": "string" }, "account_lock_timeout": { "type": "string" }, "name": { "type": "string" }, "state": { "type": "string" }, "max_login_failure_count": { "type": "string" }, "max_password_history_count": { "type": "string" }, "credentials_timeout_threshold": { "type": "string" } } }, "mysql_user": { "required": [ "name" ], "type": "object", "description": "Adds or removes a user from a MySQL database.", "properties": { "update_password": { "type": "string" }, "name": { "type": "string" }, "encrypted": { "type": "string" }, "append_privs": { "type": "string" }, "state": { "type": "string" }, "host_all": { "type": "string" }, "sql_log_bin": { "type": "string" }, "host": { "type": "string" }, "check_implicit_admin": { "type": "string" }, "password": { "type": "string" }, "priv": { "type": "string" } } }, "ec2_group": { "required": [], "type": "object", "description": "maintains ec2 security groups. This module has a dependency on python-boto >= 2.5", "properties": { "rules_egress": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "purge_rules": { "type": "string" }, "tags": { "type": "string" }, "rules": { "items": { "type": "string" }, "type": "array" }, "purge_tags": { "type": "boolean" }, "purge_rules_egress": { "type": "string" }, "state": { "type": "string" }, "vpc_id": { "type": "string" }, "group_id": { "type": "string" }, "description": { "type": "string" } } }, "junos_l3_interface": { "required": [], "type": "object", "description": "This module provides declarative management of L3 interfaces on Juniper JUNOS network devices.", "properties": { "name": { "type": "string" }, "active": { "type": "boolean" }, "state": { "type": "string" }, "ipv4": { "type": "string" }, "ipv6": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" }, "unit": { "type": "integer" } } }, "cs_storage_pool": { "required": [ "name" ], "type": "object", "description": "Create, update, put into maintenance, disable, enable and remove storage pools.", "properties": { "managed": { "type": "string" }, "name": { "type": "string" }, "zone": { "type": "string" }, "capacity_iops": { "type": "string" }, "hypervisor": { "type": "string" }, "storage_tags": { "type": "string" }, "cluster": { "type": "string" }, "state": { "type": "string" }, "capacity_bytes": { "type": "string" }, "provider": { "type": "string" }, "scope": { "type": "string" }, "pod": { "type": "string" }, "allocation_state": { "type": "string" }, "storage_url": { "type": "string" } } }, "consul_session": { "required": [], "type": "object", "description": "Allows the addition, modification and deletion of sessions in a consul cluster. These sessions can then be used in conjunction with key value pairs to implement distributed locks. In depth documentation for working with sessions can be found at http://www.consul.io/docs/internals/sessions.html", "properties": { "node": { "type": "string" }, "datacenter": { "type": "string" }, "name": { "type": "string" }, "host": { "type": "string" }, "port": { "type": "integer" }, "delay": { "type": "integer" }, "state": { "items": { "type": "string" }, "type": "array" }, "behavior": { "type": "string" }, "scheme": { "type": "string" }, "validate_certs": { "type": "boolean" }, "checks": { "items": { "type": "string" }, "type": "array" } } }, "ec2_win_password": { "required": [ "instance_id", "key_file" ], "type": "object", "description": "Gets the default administrator password from any EC2 Windows instance. The instance is referenced by its id (e.g. i-XXXXXXX). This module has a dependency on python-boto.", "properties": { "instance_id": { "type": "string" }, "key_file": { "type": "string" }, "wait_timeout": { "type": "integer" }, "key_passphrase": { "type": "string" }, "wait": { "type": "string" } } }, "sros_config": { "required": [], "type": "object", "description": "Nokia SR OS configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with SR OS configuration sections in a deterministic way.", "properties": { "src": { "type": "string" }, "force": { "type": "boolean" }, "config": { "type": "string" }, "after": { "type": "string" }, "lines": { "type": "string" }, "replace": { "type": "string" }, "parents": { "type": "string" }, "defaults": { "type": "boolean" }, "save": { "type": "boolean" }, "backup": { "type": "boolean" }, "match": { "type": "string" }, "before": { "type": "string" } } }, "jenkins_job": { "required": [ "name" ], "type": "object", "description": "Manage Jenkins jobs by using Jenkins REST API.", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "enabled": { "type": "string" }, "token": { "type": "string" }, "state": { "type": "string" }, "user": { "type": "string" }, "password": { "type": "string" }, "config": { "type": "string" } } }, "ce_netstream_global": { "required": [ "interface" ], "type": "object", "description": "Manages global parameters of NetStream on HUAWEI CloudEngine switches.", "properties": { "index_switch": { "type": "string" }, "statistics_direction": { "type": "string" }, "statistics_record": { "type": "string" }, "sampler_interval": { "type": "string" }, "state": { "type": "string" }, "sampler_direction": { "type": "string" }, "interface": { "type": "string" }, "type": { "type": "string" } } }, "ec2_vpc_peer": { "required": [], "type": "object", "description": "Read the AWS documentation for VPC Peering Connections U(http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/vpc-peering.html)", "properties": { "peering_id": { "type": "string" }, "tags": { "type": "string" }, "peer_owner_id": { "type": "string" }, "state": { "type": "string" }, "peer_vpc_id": { "type": "string" }, "vpc_id": { "type": "string" } } }, "ec2_vpc_subnet_facts": { "required": [], "type": "object", "description": "Gather facts about ec2 VPC subnets in AWS", "properties": { "subnet_ids": { "items": { "type": "string" }, "type": "array" }, "filters": { "type": "string" } } }, "gunicorn": { "required": [ "app" ], "type": "object", "description": "Starts gunicorn with the parameters specified. Common settings for gunicorn configuration are supported. For additional configuration use a config file See U(https://gunicorn-docs.readthedocs.io/en/latest/settings.html) for more options. It's recommended to always use the chdir option to avoid problems with the location of the app.", "properties": { "venv": { "type": "string" }, "pid": { "type": "string" }, "app": { "type": "string" }, "worker": { "type": "string" }, "chdir": { "type": "string" }, "user": { "type": "string" }, "config": { "type": "string" } } }, "airbrake_deployment": { "required": [ "environment", "token" ], "type": "object", "description": "Notify airbrake about app deployments (see http://help.airbrake.io/kb/api-2/deploy-tracking)", "properties": { "environment": { "type": "string" }, "url": { "type": "string" }, "repo": { "type": "string" }, "token": { "type": "string" }, "user": { "type": "string" }, "validate_certs": { "type": "string" }, "revision": { "type": "string" } } }, "yum_repository": { "required": [ "name" ], "type": "object", "description": "Add or remove YUM repositories in RPM-based Linux distributions.", "properties": { "ip_resolve": { "type": "string" }, "reposdir": { "type": "string" }, "proxy_password": { "type": "string" }, "bandwidth": { "type": "integer" }, "cost": { "type": "integer" }, "file": { "type": "string" }, "mirrorlist_expire": { "items": { "type": "integer" }, "type": "array" }, "exclude": { "items": { "type": "string" }, "type": "array" }, "keepalive": { "type": "string" }, "repo_gpgcheck": { "type": "string" }, "sslverify": { "type": "string" }, "failovermethod": { "items": { "type": "string" }, "type": "array" }, "deltarpm_metadata_percentage": { "type": "integer" }, "gpgkey": { "items": { "type": "string" }, "type": "array" }, "http_caching": { "type": "string" }, "priority": { "type": "integer" }, "state": { "type": "string" }, "mirrorlist": { "items": { "type": "string" }, "type": "array" }, "gpgcheck": { "type": "string" }, "include": { "type": "string" }, "sslcacert": { "type": "string" }, "username": { "type": "string" }, "metadata_expire": { "type": "integer" }, "description": { "type": "string" }, "ui_repoid_vars": { "items": { "type": "string" }, "type": "array" }, "sslclientcert": { "type": "string" }, "baseurl": { "items": { "type": "string" }, "type": "array" }, "gpgcakey": { "type": "string" }, "s3_enabled": { "type": "string" }, "includepkgs": { "items": { "type": "string" }, "type": "array" }, "async": { "type": "string" }, "password": { "type": "string" }, "retries": { "type": "integer" }, "protect": { "type": "string" }, "ssl_check_cert_permissions": { "type": "string" }, "throttle": { "type": "string" }, "name": { "type": "string" }, "deltarpm_percentage": { "type": "integer" }, "sslclientkey": { "type": "string" }, "metalink": { "items": { "type": "string" }, "type": "array" }, "enabled": { "type": "string" }, "skip_if_unavailable": { "type": "string" }, "keepcache": { "type": "string" }, "proxy_username": { "type": "string" }, "timeout": { "type": "integer" }, "enablegroups": { "type": "string" }, "metadata_expire_filter": { "items": { "type": "string" }, "type": "array" }, "proxy": { "type": "string" } } }, "bigmon_policy": { "required": [ "name", "controller" ], "type": "object", "description": "Create and remove a bigmon out-of-band policy.", "properties": { "policy_description": { "type": "string" }, "name": { "type": "string" }, "access_token": { "type": "string" }, "start_time": { "type": "string" }, "controller": { "type": "string" }, "priority": { "type": "integer" }, "duration": { "type": "integer" }, "state": { "type": "string" }, "action": { "type": "string" }, "validate_certs": { "type": "boolean" }, "delivery_packet_count": { "type": "integer" } } }, "cl_license": { "required": [ "src" ], "type": "object", "description": "Installs a Cumulus Linux license. The module reports no change of status when a license is installed. For more details go the Cumulus Linux License Documentation at U(http://docs.cumulusnetwork.com) and the Licensing KB Site at U(https://support.cumulusnetworks.com/hc/en-us/sections/200507688)", "properties": { "src": { "type": "string" }, "force": { "type": "string" } } }, "aos_template": { "required": [ "session" ], "type": "object", "description": "Apstra AOS Template module let you manage your Template easily. You can create create and delete Template by Name, ID or by using a JSON File. This module is idempotent and support the I(check) mode. It's using the AOS REST API.", "properties": { "content": { "type": "string" }, "state": { "type": "string" }, "session": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "string" } } }, "ec2_ami_find": { "required": [ "region" ], "type": "object", "description": "Returns list of matching AMIs with AMI ID, along with other useful information\nCan search AMIs with different owners\nCan search by matching tag(s), by AMI name and/or other criteria\nResults can be sorted and sliced", "properties": { "sort": { "type": "string" }, "no_result_action": { "type": "string" }, "sort_end": { "type": "string" }, "ami_id": { "type": "string" }, "root_device_type": { "type": "string" }, "name": { "type": "string" }, "platform": { "type": "string" }, "hypervisor": { "type": "string" }, "region": { "type": "string" }, "sort_start": { "type": "string" }, "virtualization_type": { "type": "string" }, "ami_tags": { "type": "string" }, "state": { "type": "string" }, "sort_order": { "type": "string" }, "architecture": { "type": "string" }, "owner": { "type": "string" }, "is_public": { "type": "string" }, "product_code": { "type": "string" }, "sort_tag": { "type": "string" } } }, "include_role": { "required": [ "name" ], "type": "object", "description": "Loads and executes a role as a task dynamically. This frees roles from the `roles:` directive and allows them to be treated more as tasks.\nUnlike M(import_role), most keywords, including loops and conditionals, apply to this statement.\nThis module is also supported for Windows targets.", "properties": { "name": { "type": "string" }, "private": { "type": "string" }, "allow_duplicates": { "type": "boolean" }, "tasks_from": { "type": "string" }, "vars_from": { "type": "string" }, "defaults_from": { "type": "string" } } }, "bigip_asm_policy": { "required": [ "name" ], "type": "object", "description": "Manage BIG-IP ASM policies.", "properties": { "name": { "type": "string" }, "partition": { "type": "string" }, "state": { "type": "string" }, "file": { "type": "string" }, "active": { "type": "boolean" }, "template": { "type": "string" } } }, "aci_tenant_action_rule_profile": { "required": [], "type": "object", "description": "Manage action rule profiles on Cisco ACI fabrics.\nMore information from the internal APIC class I(rtctrl:AttrP) at U(https://developer.cisco.com/media/mim-ref/MO-rtctrlAttrP.html).", "properties": { "action_rule": { "type": "string" }, "state": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" }, "tenant": { "type": "string" } } }, "sensu_client": { "required": [ "subscriptions" ], "type": "object", "description": "Manages Sensu client configuration.\nFor more information, refer to the Sensu documentation: U(https://sensuapp.org/docs/latest/reference/clients.html)", "properties": { "deregister": { "type": "boolean" }, "socket": { "type": "string" }, "subscriptions": { "items": { "type": "string" }, "type": "array" }, "registration": { "type": "string" }, "name": { "type": "string" }, "chef": { "type": "string" }, "redact": { "type": "string" }, "state": { "type": "string" }, "puppet": { "type": "string" }, "ec2": { "type": "string" }, "safe_mode": { "type": "boolean" }, "address": { "type": "string" }, "keepalives": { "type": "boolean" }, "deregistration": { "type": "string" }, "servicenow": { "type": "string" }, "keepalive": { "type": "string" } } }, "win_webpicmd": { "required": [ "name" ], "type": "object", "description": "Installs packages using Web Platform Installer command-line (U(http://www.iis.net/learn/install/web-platform-installer/web-platform-installer-v4-command-line-webpicmdexe-rtw-release)).\nMust be installed and present in PATH (see M(win_chocolatey) module; 'webpicmd' is the package name, and you must install 'lessmsi' first too)\nInstall IIS first (see M(win_feature) module)", "properties": { "name": { "type": "string" } } }, "ecs_service_facts": { "required": [], "type": "object", "description": "Lists or describes services in ecs.", "properties": { "cluster": { "items": { "type": "string" }, "type": "array" }, "details": { "type": "string" }, "service": { "type": "string" } } }, "sf_account_manager": { "required": [ "name", "state" ], "type": "object", "description": "Create, destroy, or update accounts on SolidFire", "properties": { "new_name": { "type": "string" }, "status": { "type": "string" }, "name": { "type": "string" }, "initiator_secret": { "type": "string" }, "state": { "type": "string" }, "attributes": { "items": { "type": "string" }, "type": "array" }, "target_secret": { "type": "string" }, "account_id": { "type": "string" } } }, "cloudformation": { "required": [ "stack_name" ], "type": "object", "description": "Launches or updates an AWS CloudFormation stack and waits for it complete.", "properties": { "disable_rollback": { "type": "string" }, "role_arn": { "type": "string" }, "notification_arns": { "type": "string" }, "tags": { "type": "string" }, "stack_name": { "type": "string" }, "stack_policy": { "type": "string" }, "template_format": { "type": "string" }, "termination_protection": { "type": "string" }, "template_parameters": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "template_url": { "type": "string" }, "template": { "type": "string" }, "changeset_name": { "type": "string" }, "create_changeset": { "type": "boolean" } } }, "avi_microservicegroup": { "required": [ "name" ], "type": "object", "description": "This module is used to configure MicroServiceGroup object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "description": { "type": "string" }, "url": { "type": "string" }, "tenant_ref": { "type": "string" }, "uuid": { "type": "string" }, "created_by": { "type": "string" }, "state": { "type": "string" }, "service_refs": { "type": "string" }, "name": { "type": "string" } } }, "panos_cert_gen_ssh": { "required": [ "password", "cert_cn", "cert_friendly_name", "key_filename", "ip_address", "signed_by" ], "type": "object", "description": "This module generates a self-signed certificate that can be used by GlobalProtect client, SSL connector, or\notherwise. Root certificate must be preset on the system first. This module depends on paramiko for ssh.", "properties": { "cert_friendly_name": { "type": "string" }, "key_filename": { "type": "string" }, "rsa_nbits": { "type": "string" }, "cert_cn": { "type": "string" }, "password": { "type": "string" }, "ip_address": { "type": "string" }, "signed_by": { "type": "string" } } }, "netscaler_cs_policy": { "required": [], "type": "object", "description": "Manage content switching policy.\nThis module is intended to run either on the ansible control node or a bastion (jumpserver) with access to the actual netscaler instance.", "properties": { "url": { "type": "string" }, "policyname": { "type": "string" }, "domain": { "type": "string" }, "action": { "type": "string" }, "rule": { "type": "string" } } }, "panos_security_rule": { "required": [ "password", "ip_address", "rule_name" ], "type": "object", "description": "Security policies allow you to enforce rules and take action, and can be as general or specific as needed. The policy rules are compared against the incoming traffic in sequence, and because the first rule that matches the traffic is applied, the more specific rules must precede the more general ones.", "properties": { "username": { "type": "string" }, "vulnerability": { "type": "string" }, "spyware": { "type": "string" }, "hip_profiles": { "type": "string" }, "file_blocking": { "type": "string" }, "log_start": { "type": "boolean" }, "operation": { "type": "string" }, "description": { "type": "string" }, "service": { "items": { "type": "string" }, "type": "array" }, "url_filtering": { "type": "string" }, "source_user": { "type": "string" }, "application": { "items": { "type": "string" }, "type": "array" }, "destination_zone": { "items": { "type": "string" }, "type": "array" }, "group_profile": { "type": "string" }, "api_key": { "type": "string" }, "wildfire_analysis": { "type": "string" }, "destination_ip": { "items": { "type": "string" }, "type": "array" }, "devicegroup": { "type": "string" }, "data_filtering": { "type": "string" }, "antivirus": { "type": "string" }, "rule_name": { "type": "string" }, "password": { "type": "string" }, "ip_address": { "type": "string" }, "rule_type": { "type": "string" }, "source_zone": { "items": { "type": "string" }, "type": "array" }, "source_ip": { "items": { "type": "string" }, "type": "array" }, "tag_name": { "type": "string" }, "action": { "type": "string" }, "commit": { "type": "boolean" }, "log_end": { "type": "boolean" } } }, "ce_ospf_vrf": { "required": [ "ospf" ], "type": "object", "description": "Manages configuration of an OSPF VPN instance on HUAWEI CloudEngine switches.", "properties": { "lsaostartinterval": { "type": "string" }, "bandwidth": { "type": "string" }, "spfintervalmi": { "type": "string" }, "lsaomaxinterval": { "type": "string" }, "lsaamaxinterval": { "type": "string" }, "lsaoholdinterval": { "type": "string" }, "state": { "type": "string" }, "spfholdinterval": { "type": "string" }, "lsaaholdinterval": { "type": "string" }, "lsaointerval": { "type": "string" }, "description": { "type": "string" }, "lsaalflag": { "type": "boolean" }, "vrf": { "type": "string" }, "lsaointervalflag": { "type": "boolean" }, "lsaastartinterval": { "type": "string" }, "spfintervaltype": { "type": "string" }, "lsaainterval": { "type": "string" }, "spfstartinterval": { "type": "string" }, "route_id": { "type": "string" }, "spfmaxinterval": { "type": "string" }, "spfinterval": { "type": "string" }, "ospf": { "type": "string" } } }, "logicmonitor": { "required": [ "company", "user", "password", "target", "action" ], "type": "object", "description": "LogicMonitor is a hosted, full-stack, infrastructure monitoring platform.\nThis module manages hosts, host groups, and collectors within your LogicMonitor account.", "properties": { "displayname": { "type": "string" }, "description": { "type": "string" }, "company": { "type": "string" }, "hostname": { "type": "string" }, "fullpath": { "type": "string" }, "properties": { "type": "string" }, "action": { "type": "string" }, "user": { "type": "string" }, "groups": { "items": { "type": "string" }, "type": "array" }, "duration": { "type": "integer" }, "alertenable": { "type": "boolean" }, "starttime": { "type": "string" }, "password": { "type": "string" }, "collector": { "type": "string" }, "id": { "type": "string" }, "target": { "type": "string" } } }, "nxos_snapshot": { "required": [ "action" ], "type": "object", "description": "Create snapshots of the running states of selected features, add new show commands for snapshot creation, delete and compare existing snapshots.", "properties": { "description": { "type": "string" }, "section": { "type": "string" }, "snapshot1": { "type": "string" }, "comparison_results_file": { "type": "string" }, "snapshot2": { "type": "string" }, "element_key1": { "type": "string" }, "element_key2": { "type": "string" }, "snapshot_name": { "type": "string" }, "show_command": { "type": "string" }, "action": { "type": "string" }, "path": { "type": "string" }, "row_id": { "type": "string" }, "save_snapshot_locally": { "type": "boolean" }, "compare_option": { "type": "string" } } }, "ce_file_copy": { "required": [ "local_file" ], "type": "object", "description": "Copy a file to a remote cloudengine device over SCP on HUAWEI CloudEngine switches.", "properties": { "remote_file": { "type": "string" }, "local_file": { "type": "string" }, "file_system": { "type": "string" } } }, "sorcery": { "required": [], "type": "object", "description": "Manages \"spells\" on Source Mage GNU/Linux using I(sorcery) toolchain", "properties": { "name": { "type": "string" }, "state": { "type": "string" }, "update": { "type": "string" }, "depends": { "items": { "type": "string" }, "type": "array" }, "update_cache": { "type": "string" }, "cache_valid_time": { "type": "string" } } }, "aws_kms_facts": { "required": [], "type": "object", "description": "Gather facts about AWS KMS keys including tags and grants", "properties": { "pending_deletion": { "type": "boolean" }, "filters": { "type": "string" } } }, "azure_rm_functionapp": { "required": [ "name", "resource_group" ], "type": "object", "description": "Create, update or delete an Azure Function App", "properties": { "state": { "type": "string" }, "name": { "type": "string" }, "resource_group": { "type": "string" } } }, "known_hosts": { "required": [ "name" ], "type": "object", "description": "The C(known_hosts) module lets you add or remove a host keys from the C(known_hosts) file.\nStarting at Ansible 2.2, multiple entries per host are allowed, but only one for each key type supported by ssh. This is useful if you're going to want to use the M(git) module over ssh, for example.\nIf you have a very large number of host keys to manage, you will find the M(template) module more useful.", "properties": { "path": { "type": "string" }, "state": { "type": "string" }, "hash_host": { "type": "boolean" }, "name": { "type": "string" }, "key": { "type": "string" } } }, "net_vlan": { "required": [], "type": "object", "description": "This module provides declarative management of VLANs on network devices.", "properties": { "name": { "type": "string" }, "interfaces": { "items": { "type": "string" }, "type": "array" }, "purge": { "type": "boolean" }, "state": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" }, "vlan_id": { "type": "string" } } }, "snmp_facts": { "required": [ "host", "version" ], "type": "object", "description": "Retrieve facts for a device using SNMP, the facts will be inserted to the ansible_facts key.", "properties": { "username": { "type": "string" }, "privacy": { "type": "string" }, "level": { "type": "string" }, "community": { "type": "string" }, "authkey": { "type": "string" }, "host": { "type": "string" }, "version": { "type": "string" }, "integrity": { "type": "string" }, "privkey": { "type": "string" } } }, "clc_loadbalancer": { "required": [ "name", "alias", "location" ], "type": "object", "description": "An Ansible module to Create, Delete shared loadbalancers in CenturyLink Cloud.", "properties": { "status": { "type": "string" }, "name": { "type": "string" }, "port": { "type": "string" }, "alias": { "type": "string" }, "state": { "type": "string" }, "location": { "type": "string" }, "nodes": { "items": { "type": "string" }, "type": "array" }, "method": { "type": "string" }, "persistence": { "type": "string" }, "description": { "type": "string" } } }, "eos_banner": { "required": [ "banner" ], "type": "object", "description": "This will configure both login and motd banners on remote devices running Arista EOS. It allows playbooks to add or remote banner text from the active running configuration.", "properties": { "text": { "type": "string" }, "state": { "type": "string" }, "banner": { "type": "string" } } }, "zpool_facts": { "required": [], "type": "object", "description": "Gather facts from ZFS pool properties.", "properties": { "parsable": { "type": "boolean" }, "name": { "type": "string" }, "properties": { "type": "string" } } }, "net_vrf": { "required": [], "type": "object", "description": "This module provides declarative management of VRFs on network devices.", "properties": { "aggregate": { "items": { "type": "string" }, "type": "array" }, "purge": { "type": "boolean" }, "interfaces": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "state": { "type": "string" } } }, "gce_net": { "required": [], "type": "object", "description": "This module can create and destroy Google Compute Engine networks and firewall rules U(https://cloud.google.com/compute/docs/networking). The I(name) parameter is reserved for referencing a network while the I(fwname) parameter is used to reference firewall rules. IPv4 Address ranges must be specified using the CIDR U(http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) format. Full install/configuration instructions for the gce* modules can be found in the comments of ansible/test/gce_tests.py.", "properties": { "src_tags": { "type": "string" }, "subnet_region": { "type": "string" }, "name": { "type": "string" }, "state": { "type": "string" }, "src_range": { "type": "string" }, "credentials_file": { "type": "string" }, "fwname": { "type": "string" }, "pem_file": { "type": "string" }, "service_account_email": { "type": "string" }, "target_tags": { "type": "string" }, "subnet_name": { "type": "string" }, "mode": { "type": "string" }, "allowed": { "type": "string" }, "ipv4_range": { "type": "string" }, "project_id": { "type": "string" }, "subnet_desc": { "type": "string" } } }, "os_quota": { "required": [ "name" ], "type": "object", "description": "Manage OpenStack Quotas. Quotas can be created, updated or deleted using this module. A quota will be updated if matches an existing project and is present.", "properties": { "snapshots_lvm": { "type": "string" }, "server_groups": { "type": "string" }, "availability_zone": { "type": "string" }, "ram": { "type": "string" }, "snapshots": { "type": "string" }, "instances": { "type": "string" }, "backups": { "type": "string" }, "fixed_ips": { "type": "string" }, "port": { "type": "string" }, "subnet": { "type": "string" }, "per_volume_gigabytes": { "type": "string" }, "network": { "type": "string" }, "floatingip": { "type": "string" }, "volumes_lvm": { "type": "string" }, "floating_ips": { "type": "string" }, "security_group_rule": { "type": "string" }, "state": { "type": "string" }, "injected_files": { "type": "string" }, "gigabytes_lvm": { "type": "string" }, "injected_path_size": { "type": "string" }, "gigabytes": { "type": "string" }, "backup_gigabytes": { "type": "string" }, "subnetpool": { "type": "string" }, "key_pairs": { "type": "string" }, "rbac_policy": { "type": "string" }, "injected_file_size": { "type": "string" }, "router": { "type": "string" }, "properties": { "type": "string" }, "pool": { "type": "string" }, "server_group_members": { "type": "string" }, "name": { "type": "string" }, "volumes": { "type": "string" }, "security_group": { "type": "string" }, "cores": { "type": "string" }, "loadbalancer": { "type": "string" } } }, "ce_vrrp": { "required": [], "type": "object", "description": "Manages VRRP interface attributes on HUAWEI CloudEngine devices.", "properties": { "gratuitous_arp_interval": { "type": "string" }, "advertise_interval": { "type": "string" }, "auth_key": { "type": "string" }, "vrid": { "type": "string" }, "vrrp_type": { "type": "string" }, "auth_mode": { "type": "string" }, "priority": { "type": "string" }, "recover_delay": { "type": "string" }, "state": { "type": "string" }, "version": { "type": "string" }, "is_plain": { "type": "boolean" }, "admin_interface": { "type": "string" }, "admin_ignore_if_down": { "type": "boolean" }, "interface": { "type": "string" }, "fast_resume": { "type": "string" }, "admin_flowdown": { "type": "boolean" }, "holding_multiplier": { "type": "string" }, "preempt_timer_delay": { "type": "string" }, "admin_vrid": { "type": "string" }, "virtual_ip": { "type": "string" } } }, "net_logging": { "required": [], "type": "object", "description": "This module provides declarative management of logging on network devices.", "properties": { "name": { "type": "string" }, "level": { "type": "string" }, "dest": { "type": "string" }, "facility": { "type": "string" }, "purge": { "type": "boolean" }, "state": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" } } }, "aci_contract": { "required": [ "contract", "tenant" ], "type": "object", "description": "Manage Contract resources on Cisco ACI fabrics.\nMore information from the internal APIC class I(vz:BrCP) at U(https://developer.cisco.com/media/mim-ref/MO-vzBrCP.html).", "properties": { "description": { "type": "string" }, "contract": { "type": "string" }, "priority": { "type": "string" }, "state": { "items": { "type": "string" }, "type": "array" }, "dscp": { "type": "string" }, "scope": { "type": "string" }, "tenant": { "type": "string" } } }, "gcp_url_map": { "required": [ "default_service", "url_map_name" ], "type": "object", "description": "Create, Update or Destory a Url_Map. See U(https://cloud.google.com/compute/docs/load-balancing/http/url-map) for an overview. More details on the Url_Map API can be found at U(https://cloud.google.com/compute/docs/reference/latest/urlMaps#resource).", "properties": { "default_service": { "type": "string" }, "host_rules": { "items": { "type": "string" }, "type": "array" }, "url_map_name": { "type": "string" }, "path_matchers": { "items": { "type": "string" }, "type": "array" } } }, "pn_cluster": { "required": [ "pn_name", "state" ], "type": "object", "description": "Execute cluster-create or cluster-delete command.\nA cluster allows two switches to cooperate in high-availability (HA) deployments. The nodes that form the cluster must be members of the same fabric. Clusters are typically used in conjunction with a virtual link aggregation group (VLAG) that allows links physically connected to two separate switches appear as a single trunk to a third device. The third device can be a switch,server, or any Ethernet device.", "properties": { "pn_name": { "type": "string" }, "pn_clipassword": { "type": "string" }, "pn_cliusername": { "type": "string" }, "pn_validate": { "type": "string" }, "state": { "type": "string" }, "pn_cliswitch": { "type": "string" }, "pn_cluster_node1": { "type": "string" }, "pn_cluster_node2": { "type": "string" } } }, "route53_zone": { "required": [ "zone" ], "type": "object", "description": "Creates and deletes Route53 private and public zones", "properties": { "comment": { "type": "string" }, "vpc_region": { "type": "string" }, "zone": { "type": "string" }, "hosted_zone_id": { "type": "string" }, "state": { "type": "boolean" }, "vpc_id": { "type": "string" } } }, "avi_alertsyslogconfig": { "required": [ "name" ], "type": "object", "description": "This module is used to configure AlertSyslogConfig object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "syslog_servers": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" }, "url": { "type": "string" }, "tenant_ref": { "type": "string" }, "uuid": { "type": "string" }, "state": { "type": "string" }, "name": { "type": "string" } } }, "bigip_snmp": { "required": [], "type": "object", "description": "Manipulate general SNMP settings on a BIG-IP.", "properties": { "contact": { "type": "string" }, "agent_authentication_traps": { "type": "string" }, "location": { "type": "string" }, "device_warning_traps": { "type": "string" }, "agent_status_traps": { "type": "string" } } }, "ovirt_cluster": { "required": [ "name" ], "type": "object", "description": "Module to manage clusters in oVirt/RHV", "properties": { "comment": { "type": "string" }, "ha_reservation": { "type": "string" }, "fence_skip_if_connectivity_broken": { "type": "string" }, "mac_pool": { "type": "string" }, "virt": { "type": "string" }, "threads_as_cores": { "type": "string" }, "gluster": { "type": "string" }, "vm_reason": { "type": "string" }, "migration_bandwidth_limit": { "type": "string" }, "data_center": { "type": "string" }, "ksm_numa": { "type": "string" }, "migration_auto_converge": { "type": "string" }, "cpu_arch": { "type": "string" }, "rng_sources": { "items": { "type": "string" }, "type": "array" }, "compatibility_version": { "type": "string" }, "network": { "type": "string" }, "state": { "type": "string" }, "ksm": { "type": "string" }, "external_network_providers": { "items": { "type": "string" }, "type": "array" }, "migration_compressed": { "type": "string" }, "ballooning": { "type": "string" }, "description": { "type": "string" }, "fence_enabled": { "type": "string" }, "migration_policy": { "type": "string" }, "resilience_policy": { "type": "string" }, "fence_connectivity_threshold": { "type": "string" }, "spice_proxy": { "type": "string" }, "memory_policy": { "type": "string" }, "migration_bandwidth": { "type": "string" }, "fence_skip_if_sd_active": { "type": "string" }, "scheduling_policy": { "type": "string" }, "switch_type": { "type": "string" }, "serial_policy_value": { "type": "string" }, "name": { "type": "string" }, "host_reason": { "type": "string" }, "cpu_type": { "type": "string" }, "serial_policy": { "type": "string" }, "trusted_service": { "type": "string" } } }, "vmware_vmkernel_ip_config": { "required": [ "vmk_name", "ip_address", "subnet_mask" ], "type": "object", "description": "Configure the VMkernel IP Address", "properties": { "ip_address": { "type": "string" }, "vmk_name": { "type": "string" }, "subnet_mask": { "type": "string" } } }, "junos_netconf": { "required": [], "type": "object", "description": "This module provides an abstraction that enables and configures the netconf system service running on Junos devices. This module can be used to easily enable the Netconf API. Netconf provides a programmatic interface for working with configuration and state resources as defined in RFC 6242.", "properties": { "state": { "type": "string" }, "netconf_port": { "items": { "type": "integer" }, "type": "array" } } }, "ovirt_snapshots": { "required": [ "vm_name" ], "type": "object", "description": "Module to manage Virtual Machine Snapshots in oVirt/RHV", "properties": { "vm_name": { "type": "string" }, "state": { "type": "string" }, "use_memory": { "type": "string" }, "description": { "type": "string" }, "snapshot_id": { "type": "string" } } }, "nxos_igmp_snooping": { "required": [], "type": "object", "description": "Manages IGMP snooping global configuration.", "properties": { "link_local_grp_supp": { "type": "string" }, "report_supp": { "type": "string" }, "snooping": { "type": "string" }, "group_timeout": { "type": "string" }, "v3_report_supp": { "type": "string" }, "state": { "type": "string" } } }, "udm_user": { "required": [ "username" ], "type": "object", "description": "This module allows to manage posix users on a univention corporate server (UCS). It uses the python API of the UCS to create a new object or edit it.", "properties": { "update_password": { "type": "string" }, "samba_user_workstations": { "type": "string" }, "pager_telephonenumber": { "items": { "type": "string" }, "type": "array" }, "subpath": { "type": "string" }, "shell": { "type": "string" }, "postcode": { "type": "string" }, "scriptpath": { "type": "string" }, "home_share": { "type": "string" }, "override_pw_history": { "type": "boolean" }, "city": { "type": "string" }, "display_name": { "type": "string" }, "homedrive": { "type": "string" }, "employee_number": { "type": "string" }, "serviceprovider": { "type": "string" }, "organisation": { "type": "string" }, "room_number": { "type": "string" }, "state": { "type": "string" }, "home_share_path": { "type": "string" }, "userexpiry": { "type": "string" }, "unixhome": { "type": "string" }, "mail_home_server": { "type": "string" }, "email": { "items": { "type": "string" }, "type": "array" }, "sambahome": { "type": "string" }, "username": { "type": "string" }, "home_telephone_number": { "items": { "type": "string" }, "type": "array" }, "primary_group": { "type": "string" }, "description": { "type": "string" }, "firstname": { "type": "string" }, "lastname": { "type": "string" }, "mail_alternative_address": { "items": { "type": "string" }, "type": "array" }, "phone": { "items": { "type": "string" }, "type": "array" }, "birthday": { "type": "string" }, "groups": { "type": "string" }, "position": { "type": "string" }, "employee_type": { "type": "string" }, "password": { "type": "string" }, "pwd_change_next_login": { "type": "string" }, "mail_primary_address": { "type": "string" }, "country": { "type": "string" }, "title": { "type": "string" }, "override_pw_length": { "type": "boolean" }, "street": { "type": "string" }, "gecos": { "type": "string" }, "mobile_telephone_number": { "type": "string" }, "profilepath": { "type": "string" }, "ou": { "type": "string" }, "secretary": { "items": { "type": "string" }, "type": "array" }, "samba_privileges": { "type": "string" }, "department_number": { "type": "string" } } }, "efs_facts": { "required": [], "type": "object", "description": "Module searches Amazon EFS file systems", "properties": { "tags": { "items": { "type": "string" }, "type": "array" }, "id": { "type": "string" }, "name": { "type": "string" }, "targets": { "items": { "type": "string" }, "type": "array" } } }, "rax_identity": { "required": [], "type": "object", "description": "Verifies Rackspace Cloud credentials and returns identity information", "properties": { "state": { "type": "string" } } }, "github_deploy_key": { "required": [ "name", "repo", "owner", "key" ], "type": "object", "description": "Adds or removes deploy keys for GitHub repositories. Supports authentication using username and password, username and password and 2-factor authentication code (OTP), OAuth2 token, or personal access token.", "properties": { "read_only": { "type": "boolean" }, "username": { "type": "string" }, "force": { "type": "boolean" }, "name": { "type": "string" }, "token": { "type": "string" }, "repo": { "type": "string" }, "otp": { "type": "string" }, "state": { "type": "string" }, "key": { "type": "string" }, "owner": { "type": "string" }, "password": { "type": "string" } } }, "gcdns_record": { "required": [ "record", "type" ], "type": "object", "description": "Creates or removes resource records in Google Cloud DNS.", "properties": { "zone_id": { "type": "string" }, "zone": { "type": "string" }, "record_data": { "items": { "type": "string" }, "type": "array" }, "service_account_email": { "type": "string" }, "credentials_file": { "type": "string" }, "pem_file": { "type": "string" }, "record": { "type": "string" }, "state": { "type": "string" }, "ttl": { "type": "integer" }, "project_id": { "type": "string" }, "type": { "type": "string" }, "overwrite": { "type": "boolean" } } }, "vyos_lldp": { "required": [], "type": "object", "description": "This module provides declarative management of LLDP service on VyOS network devices.", "properties": { "state": { "type": "string" } } }, "na_cdot_lun": { "required": [ "name", "vserver", "state" ], "type": "object", "description": "Create, destroy, resize luns on NetApp cDOT.", "properties": { "vserver": { "type": "string" }, "name": { "type": "string" }, "flexvol_name": { "type": "string" }, "size_unit": { "type": "string" }, "force_remove": { "type": "boolean" }, "state": { "type": "string" }, "force_resize": { "type": "boolean" }, "force_remove_fenced": { "type": "boolean" }, "size": { "type": "string" } } }, "sysctl": { "required": [ "name" ], "type": "object", "description": "This module manipulates sysctl entries and optionally performs a C(/sbin/sysctl -p) after changing them.", "properties": { "name": { "type": "string" }, "ignoreerrors": { "type": "boolean" }, "value": { "type": "string" }, "reload": { "type": "string" }, "state": { "type": "string" }, "sysctl_set": { "type": "boolean" }, "sysctl_file": { "type": "string" } } }, "win_shortcut": { "required": [ "dest" ], "type": "object", "description": "Create, manage and delete Windows shortcuts", "properties": { "windowstyle": { "type": "string" }, "src": { "type": "string" }, "description": { "type": "string" }, "dest": { "type": "string" }, "args": { "type": "string" }, "hotkey": { "type": "string" }, "state": { "type": "string" }, "directory": { "type": "string" }, "icon": { "type": "string" } } }, "zabbix_proxy": { "required": [ "proxy_name" ], "type": "object", "description": "This module allows you to create, modify, get and delete Zabbix proxy entries.", "properties": { "status": { "type": "string" }, "tls_psk": { "type": "string" }, "description": { "type": "string" }, "tls_connect": { "type": "string" }, "tls_accept": { "type": "string" }, "proxy_name": { "type": "string" }, "state": { "type": "string" }, "tls_subject": { "type": "string" }, "interface": { "type": "string" }, "tls_issuer": { "type": "string" }, "tls_psk_identity": { "type": "string" } } }, "panos_import": { "required": [ "password", "ip_address" ], "type": "object", "description": "Import file on PAN-OS device", "properties": { "username": { "type": "string" }, "category": { "type": "string" }, "url": { "type": "string" }, "file": { "type": "string" }, "password": { "type": "string" }, "ip_address": { "type": "string" } } }, "win_pagefile": { "required": [], "type": "object", "description": "Query current pagefile configuration.\nEnable/Disable AutomaticManagedPagefile.\nCreate new or override pagefile configuration.", "properties": { "test_path": { "type": "string" }, "initial_size": { "type": "string" }, "drive": { "type": "string" }, "state": { "type": "string" }, "system_managed": { "type": "string" }, "remove_all": { "type": "string" }, "override": { "type": "string" }, "maximum_size": { "type": "string" }, "automatic": { "type": "string" } } }, "helm": { "required": [], "type": "object", "description": "Install, upgrade, delete and list packages with the Helm package manage", "properties": { "disable_hooks": { "type": "boolean" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "chart": { "type": "string" }, "state": { "type": "string" }, "values": { "type": "string" }, "host": { "type": "string" }, "port": { "type": "integer" } } }, "postgresql_privs": { "required": [ "roles", "database" ], "type": "object", "description": "Grant or revoke privileges on PostgreSQL database objects.\nThis module is basically a wrapper around most of the functionality of PostgreSQL's GRANT and REVOKE statements with detection of changes (GRANT/REVOKE I(privs) ON I(type) I(objs) TO/FROM I(roles))", "properties": { "objs": { "items": { "type": "string" }, "type": "array" }, "ssl_rootcert": { "type": "string" }, "ssl_mode": { "type": "string" }, "roles": { "items": { "type": "string" }, "type": "array" }, "database": { "type": "string" }, "privs": { "items": { "type": "string" }, "type": "array" }, "host": { "type": "string" }, "unix_socket": { "type": "string" }, "state": { "type": "string" }, "login": { "type": "string" }, "password": { "type": "string" }, "type": { "type": "string" }, "port": { "type": "integer" }, "grant_option": { "type": "string" }, "schema": { "type": "string" } } }, "nxos_interface": { "required": [ "state", "interface" ], "type": "object", "description": "Manages physical attributes of interfaces of NX-OS switches.", "properties": { "description": { "type": "string" }, "fabric_forwarding_anycast_gateway": { "type": "string" }, "interface_type": { "type": "string" }, "ip_forward": { "type": "string" }, "mtu": { "type": "string" }, "state": { "type": "string" }, "admin_state": { "type": "string" }, "mode": { "type": "string" }, "interface": { "type": "string" } } }, "cnos_facts": { "required": [], "type": "object", "description": "This module allows you to view the switch information. It executes the show sysinfo CLI command on a switch and returns a file containing all the system information of the target network device. This module uses SSH to manage network device configuration. The results of the operation can be viewed in results directory. For more information about this module from Lenovo and customizing it usage for your use cases, please visit U(http://systemx.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.switchmgt.ansible.doc%2Fcnos_facts.html)", "properties": {} }, "tower_job_cancel": { "required": [ "job_id" ], "type": "object", "description": "Cancel Ansible Tower jobs. See U(https://www.ansible.com/tower) for an overview.", "properties": { "job_id": { "type": "string" }, "fail_if_not_running": { "type": "boolean" } } }, "systemd": { "required": [], "type": "object", "description": "Controls systemd services on remote hosts.", "properties": { "no_block": { "type": "string" }, "name": { "type": "string" }, "enabled": { "type": "string" }, "daemon_reload": { "type": "string" }, "state": { "type": "string" }, "masked": { "type": "string" }, "user": { "type": "string" } } }, "cs_sshkeypair": { "required": [ "name" ], "type": "object", "description": "Create, register and remove SSH keys.\nIf no key was found and no public key was provided and a new SSH private/public key pair will be created and the private key will be returned.", "properties": { "public_key": { "type": "string" }, "account": { "type": "string" }, "name": { "type": "string" }, "domain": { "type": "string" }, "project": { "type": "string" }, "state": { "type": "string" } } }, "icinga2_feature": { "required": [ "name" ], "type": "object", "description": "Enable or disable an Icinga2 feature", "properties": { "state": { "type": "string" }, "name": { "type": "string" } } }, "cs_securitygroup": { "required": [ "name" ], "type": "object", "description": "Create and remove security groups.", "properties": { "account": { "type": "string" }, "description": { "type": "string" }, "domain": { "type": "string" }, "project": { "type": "string" }, "state": { "type": "string" }, "name": { "type": "string" } } }, "sts_session_token": { "required": [], "type": "object", "description": "Obtain a session token from the AWS Security Token Service", "properties": { "mfa_token": { "type": "string" }, "mfa_serial_number": { "type": "string" }, "duration_seconds": { "type": "string" } } }, "aci_intf_policy_mcp": { "required": [ "mcp" ], "type": "object", "description": "Manage MCP interface policies on Cisco ACI fabrics.\nMore information from the internal APIC class I(mcp:IfPol) at U(https://developer.cisco.com/media/mim-ref/MO-mcpIfPol.html).", "properties": { "state": { "items": { "type": "string" }, "type": "array" }, "admin_state": { "type": "string" }, "description": { "type": "string" }, "mcp": { "type": "string" } } }, "gcspanner": { "required": [ "instance_id", "configuration" ], "type": "object", "description": "Create and Delete Instances/Databases on Spanner. See U(https://cloud.google.com/spanner/docs) for an overview.", "properties": { "instance_display_name": { "type": "string" }, "database_name": { "type": "string" }, "force_instance_delete": { "type": "string" }, "instance_id": { "type": "string" }, "state": { "type": "string" }, "node_count": { "type": "integer" }, "configuration": { "type": "string" } } }, "ironware_config": { "required": [], "type": "object", "description": "Brocade Ironware configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with Ironware configuration sections in a deterministic way.", "properties": { "src": { "type": "string" }, "config": { "type": "string" }, "after": { "type": "string" }, "lines": { "type": "string" }, "update": { "type": "string" }, "replace": { "type": "string" }, "parents": { "type": "string" }, "commit": { "type": "string" }, "save_when": { "type": "string" }, "backup": { "type": "boolean" }, "match": { "type": "string" }, "before": { "type": "string" } } }, "rundeck_project": { "required": [ "url", "token", "name" ], "type": "object", "description": "Create and remove Rundeck projects through HTTP API.", "properties": { "url": { "type": "string" }, "token": { "type": "string" }, "state": { "type": "string" }, "api_version": { "type": "integer" }, "name": { "type": "string" } } }, "rax_mon_alarm": { "required": [ "entity_id", "notification_plan_id", "check_id", "label" ], "type": "object", "description": "Create or delete a Rackspace Cloud Monitoring alarm that associates an existing rax_mon_entity, rax_mon_check, and rax_mon_notification_plan with criteria that specify what conditions will trigger which levels of notifications. Rackspace monitoring module flow | rax_mon_entity -> rax_mon_check -> rax_mon_notification -> rax_mon_notification_plan -> *rax_mon_alarm*", "properties": { "entity_id": { "type": "string" }, "notification_plan_id": { "type": "string" }, "check_id": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "string" }, "state": { "type": "string" }, "criteria": { "type": "string" }, "metadata": { "type": "string" } } }, "proxysql_backend_servers": { "required": [ "hostname" ], "type": "object", "description": "The M(proxysql_backend_servers) module adds or removes mysql hosts using the proxysql admin interface.", "properties": { "status": { "type": "string" }, "comment": { "type": "string" }, "hostname": { "type": "string" }, "config_file": { "type": "string" }, "compression": { "type": "string" }, "weight": { "type": "string" }, "login_port": { "type": "integer" }, "login_user": { "type": "string" }, "login_host": { "type": "string" }, "login_password": { "type": "string" }, "hostgroup_id": { "type": "integer" }, "state": { "type": "string" }, "load_to_runtime": { "type": "boolean" }, "save_to_disk": { "type": "boolean" }, "use_ssl": { "type": "string" }, "max_replication_lag": { "type": "string" }, "port": { "type": "integer" }, "max_latency_ms": { "type": "string" }, "max_connections": { "type": "string" } } }, "kibana_plugin": { "required": [ "name" ], "type": "object", "description": "Manages Kibana plugins.", "properties": { "force": { "type": "boolean" }, "name": { "type": "string" }, "url": { "type": "string" }, "state": { "type": "string" }, "version": { "type": "string" }, "timeout": { "type": "string" }, "plugin_dir": { "type": "string" }, "plugin_bin": { "type": "string" } } }, "ovirt_disk": { "required": [], "type": "object", "description": "Module to manage Virtual Machine and floating disks in oVirt/RHV.", "properties": { "vm_name": { "type": "string" }, "profile": { "type": "string" }, "storage_domains": { "type": "string" }, "force": { "type": "string" }, "openstack_volume_type": { "type": "string" }, "format": { "type": "string" }, "bootable": { "type": "string" }, "logical_unit": { "type": "string" }, "sparsify": { "type": "string" }, "upload_image_path": { "type": "string" }, "name": { "type": "string" }, "state": { "type": "string" }, "download_image_path": { "type": "string" }, "shareable": { "type": "string" }, "interface": { "type": "string" }, "storage_domain": { "type": "string" }, "image_provider": { "type": "string" }, "vm_id": { "type": "string" }, "id": { "type": "string" }, "size": { "type": "string" } } }, "win_mapped_drive": { "required": [ "letter" ], "type": "object", "description": "Allows you to modify mapped network drives for individual users.", "properties": { "username": { "type": "string" }, "path": { "type": "string" }, "state": { "type": "string" }, "password": { "type": "string" }, "letter": { "type": "string" } } }, "nxos_vtp_version": { "required": [ "version" ], "type": "object", "description": "Manages VTP version configuration.", "properties": { "version": { "type": "string" } } }, "aos_ip_pool": { "required": [ "session" ], "type": "object", "description": "Apstra AOS Ip Pool module let you manage your IP Pool easily. You can create create and delete IP Pool by Name, ID or by using a JSON File. This module is idempotent and support the I(check) mode. It's using the AOS REST API.", "properties": { "subnets": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "content": { "type": "string" }, "state": { "type": "string" }, "session": { "type": "string" }, "id": { "type": "string" } } }, "vertica_role": { "required": [ "name" ], "type": "object", "description": "Adds or removes Vertica database role and, optionally, assign other roles.", "properties": { "assigned_roles": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "login_user": { "type": "string" }, "db": { "type": "string" }, "cluster": { "type": "string" }, "state": { "type": "string" }, "login_password": { "type": "string" }, "port": { "type": "integer" } } }, "expect": { "required": [ "command", "responses" ], "type": "object", "description": "The C(expect) module executes a command and responds to prompts.\nThe given command will be executed on all selected nodes. It will not be processed through the shell, so variables like C($HOME) and operations like C(\"<\"), C(\">\"), C(\"|\"), and C(\"&\") will not work.", "properties": { "chdir": { "type": "string" }, "responses": { "items": { "type": "string" }, "type": "array" }, "removes": { "type": "string" }, "echo": { "type": "boolean" }, "creates": { "type": "string" }, "command": { "type": "string" }, "timeout": { "type": "integer" } } }, "awall": { "required": [], "type": "object", "description": "This modules allows for enable/disable/activate of I(awall) policies. Alpine Wall (I(awall)) generates a firewall configuration from the enabled policy files and activates the configuration on the system.", "properties": { "state": { "type": "string" }, "activate": { "type": "boolean" }, "name": { "type": "string" } } }, "avi_vrfcontext": { "required": [ "name" ], "type": "object", "description": "This module is used to configure VrfContext object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "description": { "type": "string" }, "static_routes": { "items": { "type": "string" }, "type": "array" }, "cloud_ref": { "type": "string" }, "tenant_ref": { "type": "string" }, "uuid": { "type": "string" }, "url": { "type": "string" }, "state": { "type": "string" }, "system_default": { "type": "string" }, "gateway_mon": { "type": "string" }, "internal_gateway_monitor": { "type": "string" }, "debugvrfcontext": { "type": "string" }, "bgp_profile": { "type": "string" }, "name": { "type": "string" } } }, "opendj_backendprop": { "required": [ "name", "hostname", "value", "port", "backend" ], "type": "object", "description": "This module will update settings for OpenDJ with the command set-backend-prop.\nIt will check first via de get-backend-prop if configuration needs to be applied.", "properties": { "username": { "type": "string" }, "name": { "type": "string" }, "hostname": { "type": "string" }, "value": { "type": "string" }, "state": { "type": "string" }, "passwordfile": { "type": "string" }, "password": { "type": "string" }, "opendj_bindir": { "type": "string" }, "port": { "type": "string" }, "backend": { "type": "string" } } }, "aci_config_rollback": { "required": [ "export_policy", "snapshot" ], "type": "object", "description": "Provides rollback and rollback preview functionality for Cisco ACI fabric.\nConfig Rollbacks are done using snapshots C(aci_snapshot) with the configImportP class.\nMore information from the internal APIC class I(config:ImportP) at U(https://developer.cisco.com/media/mim-ref/MO-configImportP.html).", "properties": { "export_policy": { "type": "string" }, "import_mode": { "type": "string" }, "description": { "type": "string" }, "compare_export_policy": { "type": "string" }, "state": { "type": "string" }, "snapshot": { "items": { "type": "string" }, "type": "array" }, "import_policy": { "type": "string" }, "import_type": { "type": "string" }, "compare_snapshot": { "type": "string" }, "fail_on_decrypt": { "type": "string" } } }, "s3_sync": { "required": [ "file_root", "bucket", "mode" ], "type": "object", "description": "The S3 module is great, but it is very slow for a large volume of files- even a dozen will be noticeable. In addition to speed, it handles globbing, inclusions/exclusions, mime types, expiration mapping, recursion, cache control and smart directory mapping.", "properties": { "file_change_strategy": { "type": "string" }, "file_root": { "type": "string" }, "permission": { "type": "string" }, "bucket": { "type": "string" }, "include": { "type": "string" }, "mode": { "type": "string" }, "exclude": { "type": "string" }, "mime_map": { "type": "string" }, "cache_control": { "type": "string" }, "key_prefix": { "type": "string" }, "delete": { "type": "boolean" } } }, "vmware_guest_find": { "required": [ "datacenter" ], "type": "object", "description": "Find the folder path(s) for a VM by name or UUID", "properties": { "datacenter": { "type": "string" }, "name": { "type": "string" }, "uuid": { "type": "string" } } }, "ec2_metric_alarm": { "required": [ "name", "state" ], "type": "object", "description": "Can create or delete AWS metric alarms.\nMetrics you wish to alarm on must already exist.", "properties": { "comparison": { "type": "string" }, "alarm_actions": { "items": { "type": "string" }, "type": "array" }, "ok_actions": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "evaluation_periods": { "type": "string" }, "metric": { "type": "string" }, "namespace": { "type": "string" }, "period": { "type": "string" }, "dimensions": { "type": "string" }, "state": { "type": "string" }, "insufficient_data_actions": { "items": { "type": "string" }, "type": "array" }, "statistic": { "type": "string" }, "threshold": { "type": "string" }, "unit": { "type": "string" }, "description": { "type": "string" } } }, "logstash_plugin": { "required": [ "name" ], "type": "object", "description": "Manages Logstash plugins.", "properties": { "name": { "type": "string" }, "proxy_host": { "type": "string" }, "proxy_port": { "type": "string" }, "state": { "type": "string" }, "version": { "type": "string" }, "plugin_bin": { "type": "string" } } }, "ovirt_storage_templates_facts": { "required": [], "type": "object", "description": "Retrieve facts about one or more oVirt/RHV templates relate to a storage domain.", "properties": { "unregistered": { "type": "string" } } }, "net_lldp_interface": { "required": [], "type": "object", "description": "This module provides declarative management of LLDP interfaces configuration on network devices.", "properties": { "aggregate": { "items": { "type": "string" }, "type": "array" }, "purge": { "type": "boolean" }, "state": { "type": "string" }, "name": { "type": "string" } } }, "nxos_user": { "required": [], "type": "object", "description": "This module provides declarative management of the local usernames configured on Cisco Nexus devices. It allows playbooks to manage either individual usernames or the collection of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined.", "properties": { "update_password": { "type": "string" }, "configured_password": { "type": "string" }, "name": { "type": "string" }, "purge": { "type": "boolean" }, "state": { "type": "string" }, "role": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" }, "sshkey": { "type": "string" } } }, "sefcontext": { "required": [ "setype", "target" ], "type": "object", "description": "Manages SELinux file context mapping definitions.\nSimilar to the C(semanage fcontext) command.", "properties": { "target": { "type": "string" }, "selevel": { "type": "string" }, "seuser": { "type": "string" }, "state": { "type": "string" }, "reload": { "type": "string" }, "setype": { "type": "string" }, "ftype": { "type": "string" } } }, "service": { "required": [ "name" ], "type": "object", "description": "Controls services on remote hosts. Supported init systems include BSD init, OpenRC, SysV, Solaris SMF, systemd, upstart.\nFor Windows targets, use the M(win_service) module instead.", "properties": { "use": { "type": "string" }, "name": { "type": "string" }, "pattern": { "type": "string" }, "enabled": { "type": "string" }, "state": { "type": "string" }, "sleep": { "type": "string" }, "arguments": { "type": "string" }, "runlevel": { "type": "string" } } }, "vmware_dvs_host": { "required": [ "state", "vmnics", "switch_name", "esxi_hostname" ], "type": "object", "description": "Add or remove a host from distributed virtual switch", "properties": { "state": { "type": "string" }, "vmnics": { "type": "string" }, "switch_name": { "type": "string" }, "esxi_hostname": { "type": "string" } } }, "redshift_facts": { "required": [], "type": "object", "description": "Gather facts about Redshift cluster(s)", "properties": { "cluster_identifier": { "type": "string" }, "tags": { "type": "string" } } }, "win_scheduled_task_stat": { "required": [], "type": "object", "description": "Will return whether the folder and task exists.\nReturns the names of tasks in the folder specified.\nIf C(name) is set and exists, will return information on the task itself.\nUse M(win_scheduled_task) to configure a scheduled task.", "properties": { "path": { "type": "string" }, "name": { "type": "string" } } }, "s3_logging": { "required": [ "name" ], "type": "object", "description": "Manage logging facility of an s3 bucket in AWS", "properties": { "target_bucket": { "type": "string" }, "state": { "type": "string" }, "name": { "type": "string" }, "target_prefix": { "type": "string" } } }, "bigip_qkview": { "required": [ "dest" ], "type": "object", "description": "Manages creating and downloading qkviews from a BIG-IP. Various options can be provided when creating qkviews. The qkview is important when dealing with F5 support. It may be required that you upload this qkview to the supported channels during resolution of an SRs that you may have opened.", "properties": { "max_file_size": { "type": "integer" }, "force": { "type": "boolean" }, "asm_request_log": { "type": "boolean" }, "dest": { "type": "string" }, "filename": { "type": "string" }, "exclude_core": { "type": "boolean" }, "complete_information": { "type": "boolean" }, "exclude": { "type": "string" } } }, "win_toast": { "required": [], "type": "object", "description": "Sends alerts which appear in the Action Center area of the windows desktop.", "properties": { "popup": { "type": "boolean" }, "group": { "type": "string" }, "title": { "type": "string" }, "tag": { "type": "string" }, "expire": { "type": "integer" }, "msg": { "type": "string" } } }, "ce_mlag_interface": { "required": [], "type": "object", "description": "Manages MLAG interface attributes on HUAWEI CloudEngine switches.", "properties": { "eth_trunk_id": { "type": "string" }, "mlag_id": { "type": "string" }, "mlag_error_down": { "type": "string" }, "mlag_system_id": { "type": "string" }, "state": { "type": "string" }, "dfs_group_id": { "type": "string" }, "interface": { "type": "string" }, "mlag_priority_id": { "type": "string" } } }, "na_cdot_aggregate": { "required": [ "state", "name" ], "type": "object", "description": "Create or destroy aggregates on NetApp cDOT.", "properties": { "state": { "type": "string" }, "name": { "type": "string" }, "disk_count": { "type": "string" } } }, "win_firewall": { "required": [], "type": "object", "description": "Enable or Disable Windows Firewall profiles.", "properties": { "state": { "type": "string" }, "profiles": { "type": "string" } } }, "asa_command": { "required": [ "commands" ], "type": "object", "description": "Sends arbitrary commands to an ASA node and returns the results read from the device. The C(asa_command) module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.", "properties": { "retries": { "type": "integer" }, "commands": { "items": { "type": "string" }, "type": "array" }, "wait_for": { "items": { "type": "string" }, "type": "array" }, "match": { "type": "string" }, "interval": { "type": "integer" } } }, "cs_volume": { "required": [ "name" ], "type": "object", "description": "Create, destroy, attach, detach volumes.", "properties": { "custom_id": { "type": "string" }, "account": { "type": "string" }, "force": { "type": "boolean" }, "disk_offering": { "type": "string" }, "name": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "domain": { "type": "string" }, "shrink_ok": { "type": "boolean" }, "project": { "type": "string" }, "display_volume": { "type": "boolean" }, "max_iops": { "type": "string" }, "state": { "type": "string" }, "snapshot": { "type": "string" }, "vm": { "type": "string" }, "poll_async": { "type": "boolean" }, "zone": { "type": "string" }, "min_iops": { "type": "string" }, "size": { "type": "string" } } }, "junos_facts": { "required": [], "type": "object", "description": "Collects fact information from a remote device running the Junos operating system. By default, the module will collect basic fact information from the device to be included with the hostvars. Additional fact information can be collected based on the configured set of arguments.", "properties": { "config_format": { "type": "string" }, "gather_subset": { "items": { "type": "string" }, "type": "array" } } }, "sros_command": { "required": [ "commands" ], "type": "object", "description": "Sends arbitrary commands to an SR OS node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.\nThis module does not support running commands in configuration mode. Please use M(sros_config) to configure SR OS devices.", "properties": { "retries": { "type": "integer" }, "commands": { "items": { "type": "string" }, "type": "array" }, "wait_for": { "items": { "type": "string" }, "type": "array" }, "match": { "type": "string" }, "interval": { "type": "integer" } } }, "jabber": { "required": [ "to", "user", "msg", "password" ], "type": "object", "description": "Send a message to jabber", "properties": { "encoding": { "type": "string" }, "to": { "type": "string" }, "host": { "type": "string" }, "user": { "type": "string" }, "msg": { "type": "string" }, "password": { "type": "string" }, "port": { "type": "integer" } } }, "iam_mfa_device_facts": { "required": [], "type": "object", "description": "List the MFA (Multi-Factor Authentication) devices registered for a user", "properties": { "user_name": { "items": { "type": "string" }, "type": "array" } } }, "cnos_conditional_template": { "required": [ "flag", "commandfile", "condition" ], "type": "object", "description": "This module allows you to work with the running configuration of a switch. It provides a way to execute a set of CNOS commands on a switch by evaluating the current running configuration and executing the commands only if the specific settings have not been already configured. The configuration source can be a set of commands or a template written in the Jinja2 templating language. This module functions the same as the cnos_template module. The only exception is that the following inventory variable can be specified [\"condition = \"] When this inventory variable is specified as the variable of a task, the template is executed for the network element that matches the flag string. Usually, templates are used when commands are the same across a group of network devices. When there is a requirement to skip the execution of the template on one or more devices, it is recommended to use this module. This module uses SSH to manage network device configuration. For more information about this module from Lenovo and customizing it usage for your use cases, please visit U(http://systemx.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.switchmgt.ansible.doc%2Fcnos_conditional_template.html)", "properties": { "flag": { "type": "string" }, "condition": { "type": "string" }, "commandfile": { "type": "string" } } }, "junos_lldp": { "required": [], "type": "object", "description": "This module provides declarative management of LLDP service on Juniper JUNOS network devices.", "properties": { "enable": { "type": "string" }, "interval": { "type": "string" }, "state": { "type": "string" }, "active": { "type": "boolean" }, "hold_multiplier": { "type": "string" }, "transmit_delay": { "type": "string" } } }, "nxos_hsrp": { "required": [ "group", "interface" ], "type": "object", "description": "Manages HSRP configuration on NX-OS switches.", "properties": { "auth_type": { "type": "string" }, "group": { "type": "string" }, "auth_string": { "type": "string" }, "state": { "type": "string" }, "priority": { "type": "string" }, "vip": { "type": "string" }, "version": { "type": "integer" }, "interface": { "type": "string" } } }, "iosxr_command": { "required": [ "commands" ], "type": "object", "description": "Sends arbitrary commands to an IOS XR node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.\nThis module does not support running commands in configuration mode. Please use M(iosxr_config) to configure iosxr devices.", "properties": { "retries": { "type": "integer" }, "commands": { "items": { "type": "string" }, "type": "array" }, "wait_for": { "items": { "type": "string" }, "type": "array" }, "match": { "type": "string" }, "interval": { "type": "integer" } } }, "ec2_snapshot": { "required": [], "type": "object", "description": "creates an EC2 snapshot from an existing EBS volume", "properties": { "description": { "type": "string" }, "snapshot_tags": { "type": "string" }, "snapshot_id": { "type": "string" }, "device_name": { "type": "string" }, "instance_id": { "type": "string" }, "state": { "type": "string" }, "wait_timeout": { "type": "integer" }, "volume_id": { "type": "string" }, "last_snapshot_min_age": { "type": "integer" }, "wait": { "type": "boolean" } } }, "cloudformation_facts": { "required": [], "type": "object", "description": "Gets information about an AWS CloudFormation stack", "properties": { "stack_template": { "type": "boolean" }, "all_facts": { "type": "boolean" }, "stack_policy": { "type": "boolean" }, "stack_events": { "type": "boolean" }, "stack_name": { "type": "string" }, "stack_resources": { "type": "boolean" } } }, "win_domain_user": { "required": [ "name" ], "type": "object", "description": "Manages Windows Active Directory user accounts.", "properties": { "update_password": { "type": "string" }, "surname": { "type": "string" }, "groups_action": { "type": "string" }, "password_expired": { "type": "string" }, "street": { "type": "string" }, "postal_code": { "type": "string" }, "password_never_expires": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "email": { "type": "string" }, "state_province": { "type": "string" }, "description": { "type": "string" }, "firstname": { "type": "string" }, "company": { "type": "string" }, "groups": { "items": { "type": "string" }, "type": "array" }, "path": { "type": "string" }, "password": { "type": "string" }, "account_locked": { "type": "string" }, "upn": { "type": "string" }, "name": { "type": "string" }, "country": { "type": "string" }, "enabled": { "type": "string" }, "user_cannot_change_password": { "type": "string" } } }, "sf_volume_access_group_manager": { "required": [ "name", "state" ], "type": "object", "description": "Create, destroy, or update volume access groups on SolidFire", "properties": { "name": { "type": "string" }, "virtual_network_id": { "type": "string" }, "state": { "type": "string" }, "volumes": { "items": { "type": "string" }, "type": "array" }, "initiators": { "items": { "type": "string" }, "type": "array" }, "attributes": { "items": { "type": "string" }, "type": "array" }, "virtual_network_tags": { "type": "string" }, "volume_access_group_id": { "type": "string" } } }, "logicmonitor_facts": { "required": [ "target", "company", "user", "password" ], "type": "object", "description": "LogicMonitor is a hosted, full-stack, infrastructure monitoring platform.\nThis module collects facts about hosts and host groups within your LogicMonitor account.", "properties": { "displayname": { "type": "string" }, "target": { "type": "string" }, "company": { "type": "string" }, "hostname": { "type": "string" }, "user": { "type": "string" }, "fullpath": { "type": "string" }, "password": { "type": "string" }, "collector": { "type": "string" } } }, "bower": { "required": [ "path" ], "type": "object", "description": "Manage bower packages with bower", "properties": { "name": { "type": "string" }, "state": { "type": "string" }, "production": { "type": "boolean" }, "version": { "type": "string" }, "relative_execpath": { "type": "string" }, "path": { "type": "string" }, "offline": { "type": "boolean" } } }, "pn_ospfarea": { "required": [ "pn_ospf_area", "pn_clipassword", "pn_vrouter_name", "pn_cliusername", "state" ], "type": "object", "description": "Execute vrouter-ospf-add, vrouter-ospf-remove command.\nThis command adds/removes Open Shortest Path First(OSPF) area to/from a virtual router(vRouter) service.", "properties": { "pn_vrouter_name": { "type": "string" }, "pn_clipassword": { "type": "string" }, "pn_ospf_area": { "type": "string" }, "pn_cliusername": { "type": "string" }, "pn_prefix_listin": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "pn_prefix_listout": { "items": { "type": "string" }, "type": "array" }, "pn_stub_type": { "type": "string" }, "pn_cliswitch": { "type": "string" }, "pn_quiet": { "type": "boolean" } } }, "cs_role": { "required": [ "name" ], "type": "object", "description": "Create, update, delete user roles.", "properties": { "name": { "type": "string" }, "state": { "type": "string" }, "id": { "type": "string" }, "role_type": { "type": "string" }, "description": { "type": "string" } } }, "unarchive": { "required": [ "src", "dest" ], "type": "object", "description": "The C(unarchive) module unpacks an archive.\nBy default, it will copy the source file from the local system to the target before unpacking.\nSet C(remote_src=yes) to unpack an archive which already exists on the target.\nFor Windows targets, use the M(win_unzip) module instead.", "properties": { "src": { "type": "string" }, "remote_src": { "type": "string" }, "dest": { "type": "string" }, "list_files": { "items": { "type": "string" }, "type": "array" }, "keep_newer": { "type": "string" }, "creates": { "type": "string" }, "extra_opts": { "type": "string" }, "exclude": { "items": { "type": "string" }, "type": "array" }, "copy": { "type": "string" }, "validate_certs": { "type": "string" } } }, "osx_say": { "required": [ "msg" ], "type": "object", "description": "makes an OS computer speak! Amuse your friends, annoy your coworkers!", "properties": { "msg": { "type": "string" }, "voice": { "type": "string" } } }, "jenkins_script": { "required": [ "script" ], "type": "object", "description": "The C(jenkins_script) module takes a script plus a dict of values to use within the script and returns the result of the script being run.", "properties": { "script": { "type": "string" }, "url": { "type": "string" }, "args": { "type": "string" }, "user": { "type": "string" }, "timeout": { "type": "integer" }, "password": { "type": "string" }, "validate_certs": { "type": "boolean" } } }, "avi_scheduler": { "required": [ "name" ], "type": "object", "description": "This module is used to configure Scheduler object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "start_date_time": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "enabled": { "type": "string" }, "tenant_ref": { "type": "string" }, "frequency_unit": { "type": "string" }, "backup_config_ref": { "type": "string" }, "state": { "type": "string" }, "frequency": { "type": "string" }, "scheduler_action": { "type": "string" }, "run_script_ref": { "type": "string" }, "end_date_time": { "type": "string" }, "uuid": { "type": "string" }, "run_mode": { "type": "string" } } }, "ini_file": { "required": [ "section", "path" ], "type": "object", "description": "Manage (add, remove, change) individual settings in an INI-style file without having to manage the file as a whole with, say, M(template) or M(assemble). Adds missing sections if they don't exist.\nBefore version 2.0, comments are discarded when the source file is read, and therefore will not show up in the destination file.\nSince version 2.3, this module adds missing ending newlines to files to keep in line with the POSIX standard, even when no other modifications need to be applied.", "properties": { "option": { "type": "string" }, "section": { "type": "string" }, "no_extra_spaces": { "type": "string" }, "value": { "type": "string" }, "state": { "type": "string" }, "others": { "type": "string" }, "path": { "type": "string" }, "backup": { "type": "string" }, "create": { "type": "string" } } }, "ce_bgp": { "required": [], "type": "object", "description": "Manages BGP configurations on HUAWEI CloudEngine switches.", "properties": { "vrf_rid_auto_sel": { "type": "string" }, "suppress_interval": { "type": "string" }, "as_number": { "type": "string" }, "is_shutdown": { "type": "string" }, "check_first_as": { "type": "string" }, "hold_interval": { "type": "string" }, "state": { "type": "string" }, "keep_all_routes": { "type": "string" }, "gr_peer_reset": { "type": "string" }, "graceful_restart": { "type": "string" }, "router_id": { "type": "string" }, "memory_limit": { "type": "string" }, "as_path_limit": { "type": "string" }, "confed_id_number": { "type": "string" }, "bgp_rid_auto_sel": { "type": "string" }, "conn_retry_time": { "type": "string" }, "confed_peer_as_num": { "type": "string" }, "min_hold_time": { "type": "string" }, "ebgp_if_sensitive": { "type": "string" }, "hold_time": { "type": "string" }, "clear_interval": { "type": "string" }, "confed_nonstanded": { "type": "string" }, "time_wait_for_rib": { "type": "string" }, "default_af_type": { "type": "string" }, "keepalive_time": { "type": "string" }, "vrf_name": { "type": "string" } } }, "vmware_datacenter": { "required": [ "username", "password", "datacenter_name", "hostname" ], "type": "object", "description": "Manage VMware vSphere Datacenters", "properties": { "username": { "type": "string" }, "state": { "type": "string" }, "password": { "type": "string" }, "datacenter_name": { "type": "string" }, "hostname": { "type": "string" } } }, "ipa_sudocmd": { "required": [ "sudocmd" ], "type": "object", "description": "Add, modify or delete sudo command within FreeIPA server using FreeIPA API.", "properties": { "state": { "type": "string" }, "description": { "type": "string" }, "sudocmd": { "type": "string" } } }, "tower_organization": { "required": [ "name" ], "type": "object", "description": "Create, update, or destroy Ansible Tower organizations. See U(https://www.ansible.com/tower) for an overview.", "properties": { "state": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } } }, "os_network": { "required": [ "name" ], "type": "object", "description": "Add or remove network from OpenStack.", "properties": { "name": { "type": "string" }, "provider_network_type": { "type": "string" }, "availability_zone": { "type": "string" }, "admin_state_up": { "type": "boolean" }, "provider_physical_network": { "type": "string" }, "project": { "type": "string" }, "state": { "type": "string" }, "provider_segmentation_id": { "type": "string" }, "external": { "type": "boolean" }, "shared": { "type": "boolean" } } }, "clc_modify_server": { "required": [ "server_ids" ], "type": "object", "description": "An Ansible module to modify servers in CenturyLink Cloud.", "properties": { "alert_policy_name": { "type": "string" }, "anti_affinity_policy_name": { "type": "string" }, "state": { "type": "string" }, "anti_affinity_policy_id": { "type": "string" }, "alert_policy_id": { "type": "string" }, "memory": { "type": "string" }, "server_ids": { "items": { "type": "string" }, "type": "array" }, "cpu": { "type": "string" }, "wait": { "type": "boolean" } } }, "cl_interface_policy": { "required": [ "allowed" ], "type": "object", "description": "This module affects the configuration files located in the interfaces folder defined by ifupdown2. Interfaces port and port ranges listed in the \"allowed\" parameter define what interfaces will be available on the switch. If the user runs this module and has an interface configured on the switch, but not found in the \"allowed\" list, this interface will be unconfigured. By default this is `/etc/network/interface.d` For more details go the Configuring Interfaces at U(http://docs.cumulusnetworks.com).", "properties": { "location": { "type": "string" }, "allowed": { "items": { "type": "string" }, "type": "array" } } }, "catapult": { "required": [ "src", "user_id", "api_secret", "dest", "api_token", "msg" ], "type": "object", "description": "Allows notifications to be sent using sms / mms via the catapult bandwidth api.", "properties": { "src": { "type": "string" }, "user_id": { "type": "string" }, "dest": { "type": "string" }, "media": { "type": "string" }, "api_secret": { "type": "string" }, "api_token": { "type": "string" }, "msg": { "type": "string" } } }, "osx_defaults": { "required": [ "key" ], "type": "object", "description": "osx_defaults allows users to read, write, and delete Mac OS X user defaults from Ansible scripts. Mac OS X applications and other programs use the defaults system to record user preferences and other information that must be maintained when the applications aren't running (such as default font for new documents, or the position of an Info panel).", "properties": { "domain": { "type": "string" }, "state": { "type": "string" }, "value": { "type": "string" }, "host": { "type": "string" }, "key": { "type": "string" }, "type": { "type": "string" }, "array_add": { "type": "boolean" } } }, "omapi_host": { "required": [ "macaddr", "key_name", "state", "key" ], "type": "object", "description": "Create, update and remove OMAPI hosts into compatible DHCPd servers.", "properties": { "macaddr": { "type": "string" }, "statements": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "key_name": { "type": "string" }, "state": { "type": "string" }, "host": { "type": "string" }, "ddns": { "type": "boolean" }, "key": { "type": "string" }, "ip": { "type": "string" }, "port": { "type": "integer" } } }, "avi_vsvip": { "required": [ "name" ], "type": "object", "description": "This module is used to configure VsVip object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "east_west_placement": { "type": "string" }, "name": { "type": "string" }, "cloud_ref": { "type": "string" }, "dns_info": { "type": "string" }, "tenant_ref": { "type": "string" }, "vip": { "items": { "type": "string" }, "type": "array" }, "url": { "type": "string" }, "state": { "type": "string" }, "vrf_context_ref": { "type": "string" }, "uuid": { "type": "string" } } }, "purefa_hg": { "required": [ "hostgroup" ], "type": "object", "description": "Create, delete or modifiy hostgroups on Pure Storage FlashArrays.", "properties": { "volume": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "host": { "items": { "type": "string" }, "type": "array" }, "hostgroup": { "type": "string" } } }, "vyos_vlan": { "required": [ "interfaces", "vlan_id" ], "type": "object", "description": "This module provides declarative management of VLANs on VyOS network devices.", "properties": { "purge": { "type": "boolean" }, "name": { "type": "string" }, "interfaces": { "items": { "type": "string" }, "type": "array" }, "delay": { "type": "integer" }, "state": { "type": "string" }, "address": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" }, "vlan_id": { "type": "string" } } }, "nxos_feature": { "required": [ "feature" ], "type": "object", "description": "Offers ability to enable and disable features in NX-OS.", "properties": { "state": { "type": "string" }, "feature": { "type": "string" } } }, "win_updates": { "required": [], "type": "object", "description": "Searches, downloads, and installs Windows updates synchronously by automating the Windows Update client", "properties": { "log_path": { "type": "string" }, "state": { "items": { "type": "string" }, "type": "array" }, "category_names": { "items": { "type": "string" }, "type": "array" } } }, "wait_for": { "required": [], "type": "object", "description": "You can wait for a set amount of time C(timeout), this is the default if nothing is specified or just C(timeout) is specified. This does not produce an error.\nWaiting for a port to become available is useful for when services are not immediately available after their init scripts return which is true of certain Java application servers. It is also useful when starting guests with the M(virt) module and needing to pause until they are ready.\nThis module can also be used to wait for a regex match a string to be present in a file.\nIn 1.6 and later, this module can also be used to wait for a file to be available or absent on the filesystem.\nIn 1.8 and later, this module can also be used to wait for active connections to be closed before continuing, useful if a node is being rotated out of a load balancer pool.\nThis module is also supported for Windows targets.", "properties": { "active_connection_states": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "port": { "type": "string" }, "delay": { "type": "integer" }, "msg": { "type": "string" }, "host": { "type": "string" }, "sleep": { "type": "integer" }, "timeout": { "type": "integer" }, "exclude_hosts": { "items": { "type": "string" }, "type": "array" }, "search_regex": { "type": "string" }, "path": { "type": "string" }, "connect_timeout": { "type": "integer" } } }, "os_subnets_facts": { "required": [], "type": "object", "description": "Retrieve facts about one or more subnets from OpenStack.", "properties": { "subnet": { "type": "string" }, "filters": { "type": "string" }, "availability_zone": { "type": "string" } } }, "vertica_facts": { "required": [], "type": "object", "description": "Gathers Vertica database facts.", "properties": { "login_user": { "type": "string" }, "login_password": { "type": "string" }, "db": { "type": "string" }, "port": { "type": "integer" }, "cluster": { "type": "string" } } }, "avi_healthmonitor": { "required": [ "name", "type" ], "type": "object", "description": "This module is used to configure HealthMonitor object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "monitor_port": { "type": "string" }, "https_monitor": { "type": "string" }, "receive_timeout": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "dns_monitor": { "type": "string" }, "tenant_ref": { "type": "string" }, "uuid": { "type": "string" }, "is_federated": { "type": "string" }, "failed_checks": { "type": "string" }, "tcp_monitor": { "type": "string" }, "state": { "type": "string" }, "send_interval": { "type": "string" }, "udp_monitor": { "type": "string" }, "http_monitor": { "type": "string" }, "external_monitor": { "type": "string" }, "type": { "type": "string" }, "successful_checks": { "type": "string" } } }, "maven_artifact": { "required": [ "group_id", "artifact_id", "dest", "state" ], "type": "object", "description": "Downloads an artifact from a maven repository given the maven coordinates provided to the module.\nCan retrieve snapshots or release versions of the artifact and will resolve the latest available version if one is not available.", "properties": { "username": { "type": "string" }, "keep_name": { "type": "string" }, "password": { "type": "string" }, "artifact_id": { "type": "string" }, "extension": { "type": "string" }, "dest": { "type": "boolean" }, "state": { "type": "string" }, "version": { "type": "string" }, "timeout": { "type": "integer" }, "repository_url": { "type": "string" }, "group_id": { "type": "string" }, "validate_certs": { "type": "string" }, "classifier": { "type": "string" } } }, "efs": { "required": [], "type": "object", "description": "Module allows create, search and destroy Amazon EFS file systems", "properties": { "name": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "id": { "type": "string" }, "state": { "type": "string" }, "wait_timeout": { "type": "integer" }, "performance_mode": { "type": "string" }, "targets": { "items": { "type": "string" }, "type": "array" }, "wait": { "type": "string" } } }, "docker_network": { "required": [ "name" ], "type": "object", "description": "Create/remove Docker networks and connect containers to them.\nPerforms largely the same function as the \"docker network\" CLI subcommand.", "properties": { "force": { "type": "boolean" }, "name": { "type": "string" }, "driver": { "type": "string" }, "ipam_options": { "type": "string" }, "state": { "items": { "type": "string" }, "type": "array" }, "driver_options": { "type": "string" }, "connected": { "items": { "type": "string" }, "type": "array" }, "ipam_driver": { "type": "string" }, "appends": { "items": { "type": "boolean" }, "type": "array" } } }, "rhn_register": { "required": [], "type": "object", "description": "Manage registration to the Red Hat Network.", "properties": { "username": { "type": "string" }, "systemorgid": { "type": "string" }, "enable_eus": { "type": "boolean" }, "server_url": { "type": "string" }, "channels": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "sslcacert": { "type": "string" }, "activationkey": { "type": "string" }, "profilename": { "type": "string" }, "password": { "type": "string" }, "nopackages": { "type": "boolean" } } }, "foreman": { "required": [ "username", "password", "params", "server_url", "entity" ], "type": "object", "description": "Allows the management of Foreman resources inside your Foreman server.", "properties": { "username": { "type": "string" }, "password": { "type": "string" }, "params": { "type": "string" }, "server_url": { "type": "string" }, "entity": { "type": "string" } } }, "ipa_sudorule": { "required": [ "cn" ], "type": "object", "description": "Add, modify or delete sudo rule within IPA server using IPA API.", "properties": { "cn": { "type": "string" }, "cmd": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "hostgroup": { "items": { "type": "string" }, "type": "array" }, "usercategory": { "type": "string" }, "hostcategory": { "type": "string" }, "user": { "items": { "type": "string" }, "type": "array" }, "usergroup": { "items": { "type": "string" }, "type": "array" }, "host": { "items": { "type": "string" }, "type": "array" }, "cmdcategory": { "type": "string" } } }, "ec2_vpc_vgw_facts": { "required": [], "type": "object", "description": "Gather facts about virtual gateways in AWS.", "properties": { "vpn_gateway_ids": { "items": { "type": "string" }, "type": "array" }, "filters": { "type": "string" } } }, "netapp_e_facts": { "required": [ "api_password", "api_username", "ssid", "api_url" ], "type": "object", "description": "Return various information about NetApp E-Series storage arrays (eg, configuration, disks)", "properties": { "api_url": { "type": "string" }, "validate_certs": { "type": "boolean" }, "api_password": { "type": "string" }, "ssid": { "type": "string" }, "api_username": { "type": "string" } } }, "bigip_vlan": { "required": [ "name" ], "type": "object", "description": "Manage VLANs on a BIG-IP system", "properties": { "description": { "type": "string" }, "untagged_interfaces": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "tag": { "type": "string" }, "tagged_interfaces": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" } } }, "cloudfront_facts": { "required": [], "type": "object", "description": "Gets information about an AWS CloudFront distribution", "properties": { "list_streaming_distributions": { "items": { "type": "boolean" }, "type": "array" }, "origin_access_identity_config": { "type": "boolean" }, "list_origin_access_identities": { "items": { "type": "boolean" }, "type": "array" }, "streaming_distribution_configuration": { "type": "boolean" }, "web_acl_id": { "items": { "type": "string" }, "type": "array" }, "invalidation": { "type": "boolean" }, "domain_name_alias": { "type": "string" }, "list_invalidations": { "items": { "type": "boolean" }, "type": "array" }, "origin_access_identity_id": { "type": "string" }, "list_distributions_by_web_acl_id": { "items": { "type": "boolean" }, "type": "array" }, "summary": { "type": "boolean" }, "distribution_id": { "items": { "type": "string" }, "type": "array" }, "origin_access_identity": { "type": "boolean" }, "distribution_config": { "type": "boolean" }, "all_lists": { "items": { "type": "boolean" }, "type": "array" }, "invalidation_id": { "type": "string" }, "list_distributions": { "items": { "type": "boolean" }, "type": "array" }, "streaming_distribution": { "type": "boolean" }, "distribution": { "type": "boolean" } } }, "ipinfoio_facts": { "required": [], "type": "object", "description": "Gather IP geolocation facts of a host's IP address using ipinfo.io API", "properties": { "http_agent": { "type": "string" }, "timeout": { "type": "integer" } } }, "bigip_gtm_facts": { "required": [ "include" ], "type": "object", "description": "Collect facts from F5 BIG-IP GTM devices.", "properties": { "filter": { "type": "string" }, "include": { "type": "string" } } }, "ce_config": { "required": [], "type": "object", "description": "Huawei CloudEngine configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with CloudEngine configuration sections in a deterministic way. This module works with CLI transports.", "properties": { "src": { "type": "string" }, "config": { "type": "string" }, "after": { "type": "string" }, "lines": { "type": "string" }, "replace": { "type": "string" }, "parents": { "type": "string" }, "defaults": { "type": "boolean" }, "save": { "type": "boolean" }, "backup": { "type": "boolean" }, "match": { "type": "string" }, "before": { "type": "string" } } }, "cnos_showrun": { "required": [], "type": "object", "description": "This module allows you to view the switch running configuration. It executes the display running-config CLI command on a switch and returns a file containing the current running configuration of the target network device. This module uses SSH to manage network device configuration. The results of the operation will be placed in a directory named 'results' that must be created by the user in their local directory to where the playbook is run. For more information about this module from Lenovo and customizing it usage for your use cases, please visit U(http://systemx.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.switchmgt.ansible.doc%2Fcnos_showrun.html)", "properties": {} }, "aci_contract_subject_to_filter": { "required": [ "tenant" ], "type": "object", "description": "Bind Contract Subjects to Filters on Cisco ACI fabrics.\nMore information from the internal APIC class I(vz:RsSubjFiltAtt) at U(https://developer.cisco.com/media/mim-ref/MO-vzRsSubjFiltAtt.html).", "properties": { "log": { "type": "string" }, "contract": { "type": "string" }, "filter": { "type": "string" }, "state": { "items": { "type": "string" }, "type": "array" }, "tenant": { "type": "string" }, "subject": { "type": "string" } } }, "taiga_issue": { "required": [ "project", "issue_type", "subject" ], "type": "object", "description": "Creates/deletes an issue in a Taiga Project Management Platform (U(https://taiga.io)).\nAn issue is identified by the combination of project, issue subject and issue type.\nThis module implements the creation or deletion of issues (not the update).", "properties": { "status": { "type": "string" }, "priority": { "type": "string" }, "severity": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" }, "project": { "type": "string" }, "taiga_host": { "type": "string" }, "state": { "type": "string" }, "attachment": { "type": "string" }, "issue_type": { "type": "string" }, "attachment_description": { "type": "string" }, "subject": { "type": "string" } } }, "rax_cbs": { "required": [ "size", "volume_type", "state", "name" ], "type": "object", "description": "Manipulate Rackspace Cloud Block Storage Volumes", "properties": { "description": { "type": "string" }, "image": { "type": "string" }, "volume_type": { "type": "string" }, "name": { "type": "string" }, "state": { "type": "string" }, "meta": { "type": "string" }, "snapshot_id": { "type": "string" }, "wait": { "type": "string" }, "wait_timeout": { "type": "integer" }, "size": { "type": "integer" } } }, "ce_acl": { "required": [ "acl_name" ], "type": "object", "description": "Manages base ACL configurations on HUAWEI CloudEngine switches.", "properties": { "acl_step": { "type": "string" }, "rule_description": { "type": "string" }, "acl_name": { "type": "string" }, "log_flag": { "type": "boolean" }, "source_ip": { "type": "string" }, "acl_num": { "type": "string" }, "rule_id": { "type": "string" }, "rule_action": { "type": "string" }, "rule_name": { "type": "string" }, "state": { "type": "string" }, "vrf_name": { "type": "string" }, "acl_description": { "type": "string" }, "time_range": { "type": "string" }, "src_mask": { "type": "string" }, "frag_type": { "type": "string" } } }, "ce_aaa_server": { "required": [], "type": "object", "description": "Manages AAA server global configuration on HUAWEI CloudEngine switches.", "properties": { "acct_scheme_name": { "type": "string" }, "first_author_mode": { "type": "string" }, "authen_scheme_name": { "type": "string" }, "radius_server_group": { "type": "string" }, "author_scheme_name": { "type": "string" }, "domain_name": { "type": "string" }, "first_authen_mode": { "type": "string" }, "state": { "type": "string" }, "local_user_group": { "type": "string" }, "hwtacas_template": { "type": "string" }, "accounting_mode": { "type": "string" } } }, "find": { "required": [ "paths" ], "type": "object", "description": "Return a list of files based on specific criteria. Multiple criteria are AND'd together.\nFor Windows targets, use the M(win_find) module instead.", "properties": { "paths": { "items": { "type": "string" }, "type": "array" }, "file_type": { "type": "string" }, "age": { "type": "string" }, "contains": { "type": "string" }, "recurse": { "type": "string" }, "age_stamp": { "type": "string" }, "patterns": { "items": { "type": "string" }, "type": "array" }, "get_checksum": { "type": "string" }, "use_regex": { "type": "string" }, "follow": { "type": "string" }, "hidden": { "type": "string" }, "size": { "type": "string" } } }, "lambda_facts": { "required": [ "query" ], "type": "object", "description": "Gathers various details related to Lambda functions, including aliases, versions and event source mappings. Use module M(lambda) to manage the lambda function itself, M(lambda_alias) to manage function aliases and M(lambda_event) to manage lambda event source mappings.", "properties": { "query": { "type": "string" }, "event_source_arn": { "type": "string" }, "function_name": { "type": "string" } } }, "influxdb_retention_policy": { "required": [ "default", "database_name", "hostname", "policy_name", "replication", "duration" ], "type": "object", "description": "Manage InfluxDB retention policies", "properties": { "username": { "type": "string" }, "default": { "type": "string" }, "database_name": { "type": "string" }, "hostname": { "items": { "type": "string" }, "type": "array" }, "policy_name": { "type": "string" }, "replication": { "type": "string" }, "duration": { "type": "string" }, "password": { "type": "string" }, "port": { "items": { "type": "integer" }, "type": "array" } } }, "rhevm": { "required": [], "type": "object", "description": "This module only supports oVirt/RHEV version 3. A newer module M(ovirt_vms) supports oVirt/RHV version 4.\nAllows you to create/remove/update or powermanage virtual machines on a RHEV/oVirt platform.", "properties": { "vmmem": { "type": "string" }, "cd_drive": { "type": "string" }, "image": { "type": "string" }, "cpu_share": { "type": "string" }, "insecure_api": { "type": "boolean" }, "cluster": { "type": "string" }, "port": { "type": "string" }, "vm_ha": { "type": "boolean" }, "ifaces": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "type": { "type": "string" }, "vmhost": { "type": "string" }, "boot_order": { "items": { "type": "string" }, "type": "array" }, "user": { "type": "string" }, "datacenter": { "type": "string" }, "name": { "type": "string" }, "disks": { "items": { "type": "string" }, "type": "array" }, "server": { "type": "string" }, "osver": { "type": "string" }, "vmcpu": { "type": "string" }, "timeout": { "type": "string" }, "del_prot": { "type": "boolean" }, "mempol": { "type": "string" } } }, "bigip_vcmp_guest": { "required": [ "name" ], "type": "object", "description": "Manages vCMP guests on a BIG-IP. This functionality only exists on actual hardware and must be enabled by provisioning C(vcmp) with the C(bigip_provision) module.", "properties": { "mgmt_address": { "type": "string" }, "mgmt_route": { "type": "string" }, "name": { "type": "string" }, "delete_virtual_disk": { "type": "boolean" }, "initial_image": { "type": "string" }, "state": { "type": "string" }, "vlans": { "items": { "type": "string" }, "type": "array" }, "mgmt_network": { "type": "string" }, "cores_per_slot": { "type": "string" } } }, "redshift_subnet_group": { "required": [ "group_name" ], "type": "object", "description": "Create, modifies, and deletes Redshift cluster subnet groups.", "properties": { "state": { "type": "string" }, "group_description": { "type": "string" }, "group_subnets": { "items": { "type": "string" }, "type": "array" }, "group_name": { "type": "string" } } }, "ovirt_auth": { "required": [ "username", "url", "password" ], "type": "object", "description": "This module authenticates to oVirt/RHV engine and creates SSO token, which should be later used in all other oVirt/RHV modules, so all modules don't need to perform login and logout. This module returns an Ansible fact called I(ovirt_auth). Every module can use this fact as C(auth) parameter, to perform authentication.", "properties": { "username": { "type": "string" }, "timeout": { "type": "string" }, "url": { "type": "string" }, "insecure": { "type": "string" }, "kerberos": { "type": "string" }, "compress": { "type": "string" }, "headers": { "type": "string" }, "state": { "type": "string" }, "ca_file": { "type": "string" }, "password": { "type": "string" } } }, "office_365_connector_card": { "required": [ "webhook" ], "type": "object", "description": "Creates Connector Card messages through\nOffice 365 Connectors U(https://dev.outlook.com/Connectors)", "properties": { "title": { "type": "string" }, "color": { "type": "string" }, "text": { "type": "string" }, "webhook": { "type": "string" }, "actions": { "type": "string" }, "summary": { "type": "string" }, "sections": { "items": { "type": "string" }, "type": "array" } } }, "ipadm_prop": { "required": [ "protocol", "property" ], "type": "object", "description": "Modify protocol properties on Solaris/illumos systems.", "properties": { "temporary": { "type": "boolean" }, "state": { "type": "string" }, "property": { "type": "string" }, "protocol": { "type": "string" }, "value": { "type": "string" } } }, "azure_rm_managed_disk": { "required": [ "disk_size_gb", "name", "resource_group" ], "type": "object", "description": "Create, update and delete an Azure Managed Disk", "properties": { "source_resource_uri": { "type": "string" }, "disk_size_gb": { "type": "string" }, "name": { "type": "string" }, "resource_group": { "type": "string" }, "tags": { "type": "string" }, "source_uri": { "type": "string" }, "storage_account_type": { "type": "string" }, "state": { "type": "string" }, "location": { "type": "string" }, "os_type": { "type": "string" }, "create_option": { "type": "string" } } }, "avi_poolgroupdeploymentpolicy": { "required": [ "name" ], "type": "object", "description": "This module is used to configure PoolGroupDeploymentPolicy object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "target_test_traffic_ratio": { "type": "string" }, "evaluation_duration": { "type": "string" }, "description": { "type": "string" }, "test_traffic_ratio_rampup": { "type": "string" }, "cloud_ref": { "type": "string" }, "auto_disable_old_prod_pools": { "type": "string" }, "tenant_ref": { "type": "string" }, "uuid": { "type": "string" }, "rules": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "url": { "type": "string" }, "webhook_ref": { "type": "string" }, "scheme": { "type": "string" }, "name": { "type": "string" } } }, "ec2_vpc_dhcp_option": { "required": [], "type": "object", "description": "This module removes, or creates DHCP option sets, and can associate them to a VPC. Optionally, a new DHCP Options set can be created that converges a VPC's existing DHCP option set with values provided. When dhcp_options_id is provided, the module will 1. remove (with state='absent') 2. ensure tags are applied (if state='present' and tags are provided 3. attach it to a VPC (if state='present' and a vpc_id is provided. If any of the optional values are missing, they will either be treated as a no-op (i.e., inherit what already exists for the VPC) To remove existing options while inheriting, supply an empty value (e.g. set ntp_servers to [] if you want to remove them from the VPC's options) Most of the options should be self-explanatory.", "properties": { "dns_servers": { "items": { "type": "string" }, "type": "array" }, "tags": { "type": "string" }, "ntp_servers": { "items": { "type": "string" }, "type": "array" }, "domain_name": { "type": "string" }, "delete_old": { "type": "boolean" }, "state": { "type": "string" }, "netbios_node_type": { "type": "string" }, "vpc_id": { "type": "string" }, "inherit_existing": { "type": "boolean" }, "dhcp_options_id": { "type": "string" }, "netbios_name_servers": { "items": { "type": "string" }, "type": "array" } } }, "a10_service_group": { "required": [ "service_group" ], "type": "object", "description": "Manage SLB (Server Load Balancing) service-group objects on A10 Networks devices via aXAPIv2.", "properties": { "service_group": { "type": "string" }, "partition": { "type": "string" }, "servers": { "items": { "type": "string" }, "type": "array" }, "service_group_protocol": { "type": "string" }, "service_group_method": { "type": "string" }, "validate_certs": { "type": "string" } } }, "nxos_gir": { "required": [ "state" ], "type": "object", "description": "Trigger a graceful removal or insertion (GIR) of the switch.", "properties": { "system_mode_maintenance_dont_generate_profile": { "type": "string" }, "system_mode_maintenance_shutdown": { "type": "string" }, "state": { "type": "string" }, "system_mode_maintenance_timeout": { "type": "string" }, "system_mode_maintenance": { "type": "string" }, "system_mode_maintenance_on_reload_reset_reason": { "type": "string" } } }, "ec2_vpc_vpn": { "required": [], "type": "object", "description": "This module creates, modifies, and deletes VPN connections. Idempotence is achieved by using the filters option or specifying the VPN connection identifier.", "properties": { "connection_type": { "type": "string" }, "filters": { "items": { "type": "string" }, "type": "array" }, "tags": { "type": "string" }, "purge_tags": { "type": "boolean" }, "purge_routes": { "type": "string" }, "state": { "type": "string" }, "vpn_connection_id": { "type": "string" }, "customer_gateway_id": { "type": "string" }, "routes": { "type": "string" }, "vpn_gateway_id": { "type": "string" }, "static_only": { "type": "boolean" } } }, "openssl_privatekey": { "required": [ "path" ], "type": "object", "description": "This module allows one to (re)generate OpenSSL private keys. It uses the pyOpenSSL python library to interact with openssl. One can generate either RSA or DSA private keys. Keys are generated in PEM format. This module uses file common arguments to specify generated file permissions.", "properties": { "force": { "type": "boolean" }, "state": { "type": "string" }, "cipher": { "items": { "type": "string" }, "type": "array" }, "passphrase": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string" }, "size": { "type": "integer" } } }, "avi_actiongroupconfig": { "required": [ "name", "level", "external_only" ], "type": "object", "description": "This module is used to configure ActionGroupConfig object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "snmp_trap_profile_ref": { "type": "string" }, "description": { "type": "string" }, "level": { "type": "string" }, "url": { "type": "string" }, "syslog_config_ref": { "type": "string" }, "tenant_ref": { "type": "string" }, "uuid": { "type": "string" }, "action_script_config_ref": { "type": "string" }, "autoscale_trigger_notification": { "type": "string" }, "state": { "type": "string" }, "external_only": { "type": "string" }, "email_config_ref": { "type": "string" }, "name": { "type": "string" } } }, "vmware_vmkernel": { "required": [ "portgroup_name", "vland_id", "subnet_mask", "vswitch_name", "ip_address" ], "type": "object", "description": "Create a VMware VMkernel Interface", "properties": { "portgroup_name": { "type": "string" }, "vland_id": { "type": "string" }, "enable_vmotion": { "type": "string" }, "vswitch_name": { "type": "string" }, "enable_mgmt": { "type": "string" }, "mtu": { "type": "string" }, "subnet_mask": { "type": "string" }, "enable_vsan": { "type": "string" }, "ip_address": { "type": "string" }, "enable_ft": { "type": "string" } } }, "bigip_device_dns": { "required": [], "type": "object", "description": "Manage BIG-IP device DNS settings", "properties": { "search": { "items": { "type": "string" }, "type": "array" }, "cache": { "type": "string" }, "ip_version": { "type": "string" }, "state": { "type": "string" }, "forwarders": { "items": { "type": "string" }, "type": "array" }, "name_servers": { "items": { "type": "string" }, "type": "array" } } }, "ec2_vol": { "required": [], "type": "object", "description": "creates an EBS volume and optionally attaches it to an instance. If both an instance ID and a device name is given and the instance has a device at the device name, then no volume is created and no attachment is made. This module has a dependency on python-boto.", "properties": { "name": { "type": "string" }, "zone": { "type": "string" }, "volume_size": { "type": "string" }, "encrypted": { "type": "boolean" }, "delete_on_termination": { "type": "string" }, "kms_key_id": { "type": "string" }, "volume_type": { "type": "string" }, "device_name": { "type": "string" }, "instance": { "type": "string" }, "state": { "items": { "type": "string" }, "type": "array" }, "iops": { "type": "integer" }, "snapshot": { "type": "string" }, "validate_certs": { "type": "string" }, "id": { "type": "string" }, "tags": { "type": "string" } } }, "aws_direct_connect_link_aggregation_group": { "required": [], "type": "object", "description": "Create, delete, or modify a Direct Connect link aggregation group.", "properties": { "name": { "type": "string" }, "delete_with_disassociation": { "type": "string" }, "force_delete": { "type": "string" }, "bandwidth": { "type": "string" }, "connection_id": { "type": "string" }, "num_connections": { "type": "string" }, "state": { "type": "string" }, "wait_timeout": { "type": "integer" }, "location": { "type": "string" }, "min_links": { "type": "string" }, "link_aggregation_group_id": { "type": "string" }, "wait": { "type": "string" } } }, "aci_rest": { "required": [ "path", "method" ], "type": "object", "description": "Enables the management of the Cisco ACI fabric through direct access to the Cisco APIC REST API.\nMore information regarding the Cisco APIC REST API is available from U(http://www.cisco.com/c/en/us/td/docs/switches/datacenter/aci/apic/sw/2-x/rest_cfg/2_1_x/b_Cisco_APIC_REST_API_Configuration_Guide.html).", "properties": { "content": { "type": "string" }, "path": { "type": "string" }, "method": { "type": "string" }, "src": { "type": "string" } } }, "postgresql_ext": { "required": [ "name", "db" ], "type": "object", "description": "Add or remove PostgreSQL extensions from a database.", "properties": { "name": { "type": "string" }, "login_user": { "type": "string" }, "login_host": { "type": "string" }, "db": { "type": "string" }, "state": { "type": "string" }, "login_password": { "type": "string" }, "port": { "type": "integer" } } }, "pamd": { "required": [ "control", "name", "module_path", "type" ], "type": "object", "description": "Edit PAM service's type, control, module path and module arguments. In order for a PAM rule to be modified, the type, control and module_path must match an existing rule. See man(5) pam.d for details.", "properties": { "control": { "type": "string" }, "new_module_path": { "type": "string" }, "name": { "type": "string" }, "new_type": { "type": "string" }, "state": { "type": "string" }, "new_control": { "type": "string" }, "module_path": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string" }, "module_arguments": { "items": { "type": "string" }, "type": "array" } } }, "dladm_iptun": { "required": [ "name" ], "type": "object", "description": "Manage IP tunnel interfaces on Solaris/illumos systems.", "properties": { "temporary": { "type": "boolean" }, "name": { "type": "string" }, "remote_address": { "type": "string" }, "state": { "type": "string" }, "local_address": { "type": "string" }, "type": { "type": "string" } } }, "profitbricks_volume": { "required": [ "image", "datacenter", "name" ], "type": "object", "description": "Allows you to create or remove a volume from a ProfitBricks datacenter. This module has a dependency on profitbricks >= 1.0.0", "properties": { "count": { "type": "integer" }, "datacenter": { "type": "string" }, "name": { "type": "string" }, "subscription_user": { "type": "string" }, "image_password": { "type": "string" }, "licence_type": { "type": "string" }, "bus": { "type": "string" }, "image": { "type": "string" }, "size": { "type": "integer" }, "instance_ids": { "items": { "type": "string" }, "type": "array" }, "subscription_password": { "type": "string" }, "state": { "type": "string" }, "wait_timeout": { "type": "integer" }, "auto_increment": { "type": "boolean" }, "disk_type": { "type": "string" }, "ssh_keys": { "type": "string" }, "wait": { "type": "string" } } }, "eos_command": { "required": [ "commands" ], "type": "object", "description": "Sends an arbitrary set of commands to an EOS node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.", "properties": { "retries": { "type": "integer" }, "commands": { "type": "string" }, "wait_for": { "type": "string" }, "match": { "type": "string" }, "interval": { "type": "integer" } } }, "gce_labels": { "required": [], "type": "object", "description": "Create, Update or Destroy GCE Labels on instances, disks, snapshots, etc. When specifying the GCE resource, users may specifiy the full URL for the resource (its 'self_link'), or the individual parameters of the resource (type, location, name). Examples for the two options can be seen in the documentaion. See U(https://cloud.google.com/compute/docs/label-or-tag-resources) for more information about GCE Labels. Labels are gradually being added to more GCE resources, so this module will need to be updated as new resources are added to the GCE (v1) API.", "properties": { "resource_url": { "type": "string" }, "labels": { "items": { "type": "string" }, "type": "array" }, "resource_type": { "type": "string" }, "resource_name": { "type": "string" }, "resource_location": { "type": "string" } } }, "elasticache_facts": { "required": [], "type": "object", "description": "Retrieve facts from AWS Elasticache clusters", "properties": { "name": { "type": "string" } } }, "ce_netconf": { "required": [ "rpc", "cfg_xml" ], "type": "object", "description": "Sends an arbitrary netconf command on HUAWEI CloudEngine switches.", "properties": { "rpc": { "type": "string" }, "cfg_xml": { "type": "string" } } }, "avi_network": { "required": [ "name" ], "type": "object", "description": "This module is used to configure Network object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "configured_subnets": { "items": { "type": "string" }, "type": "array" }, "vrf_context_ref": { "type": "string" }, "name": { "type": "string" }, "exclude_discovered_subnets": { "type": "string" }, "cloud_ref": { "type": "string" }, "tenant_ref": { "type": "string" }, "synced_from_se": { "type": "string" }, "vimgrnw_ref": { "type": "string" }, "url": { "type": "string" }, "state": { "type": "string" }, "dhcp_enabled": { "type": "string" }, "vcenter_dvs": { "type": "string" }, "uuid": { "type": "string" } } }, "nsupdate": { "required": [ "zone", "server", "record" ], "type": "object", "description": "Create, update and remove DNS records using DDNS updates\nDDNS works well with both bind and Microsoft DNS (see https://technet.microsoft.com/en-us/library/cc961412.aspx)", "properties": { "key_algorithm": { "type": "string" }, "zone": { "type": "string" }, "key_name": { "type": "string" }, "value": { "type": "string" }, "server": { "type": "string" }, "record": { "type": "string" }, "state": { "type": "string" }, "ttl": { "type": "integer" }, "type": { "type": "string" }, "port": { "type": "integer" }, "key_secret": { "type": "string" } } }, "ec2_vpc_net_facts": { "required": [], "type": "object", "description": "Gather facts about ec2 VPCs in AWS", "properties": { "vpc_ids": { "items": { "type": "string" }, "type": "array" }, "filters": { "type": "string" } } }, "asa_config": { "required": [], "type": "object", "description": "Cisco ASA configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with ASA configuration sections in a deterministic way.", "properties": { "src": { "type": "string" }, "passwords": { "type": "boolean" }, "config": { "type": "string" }, "after": { "type": "string" }, "lines": { "type": "string" }, "replace": { "type": "string" }, "parents": { "type": "string" }, "defaults": { "type": "boolean" }, "save": { "type": "boolean" }, "backup": { "type": "boolean" }, "match": { "type": "string" }, "before": { "type": "string" } } }, "cs_securitygroup_rule": { "required": [ "security_group" ], "type": "object", "description": "Add and remove security group rules.", "properties": { "icmp_code": { "type": "string" }, "start_port": { "type": "string" }, "user_security_group": { "type": "string" }, "end_port": { "type": "string" }, "project": { "type": "string" }, "state": { "type": "string" }, "poll_async": { "type": "boolean" }, "security_group": { "type": "string" }, "protocol": { "type": "string" }, "cidr": { "type": "string" }, "icmp_type": { "type": "string" }, "type": { "type": "string" } } }, "atomic_image": { "required": [ "name" ], "type": "object", "description": "Manage the container images on the atomic host platform.\nAllows to execute the commands specified by the RUN label in the container image when present.", "properties": { "started": { "type": "string" }, "state": { "type": "string" }, "name": { "type": "string" }, "backend": { "type": "string" } } }, "cnos_bgp": { "required": [ "asNum", "bgpArg1" ], "type": "object", "description": "This module allows you to work with Border Gateway Protocol (BGP) related configurations. The operators used are overloaded to ensure control over switch BGP configurations. This module is invoked using method with asNumber as one of its arguments. The first level of the BGP configuration allows to set up an AS number, with the following attributes going into various configuration operations under the context of BGP. After passing this level, there are eight BGP arguments that will perform further configurations. They are bgpArg1, bgpArg2, bgpArg3, bgpArg4, bgpArg5, bgpArg6, bgpArg7, and bgpArg8. For more details on how to use these arguments, see [Overloaded Variables]. This module uses SSH to manage network device configuration. The results of the operation will be placed in a directory named 'results' that must be created by the user in their local directory to where the playbook is run. For more information about this module from Lenovo and customizing it usage for your use cases, please visit U(http://systemx.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.switchmgt.ansible.doc%2Fcnos_bgp.html)", "properties": { "bgpArg8": { "type": "string" }, "asNum": { "type": "string" }, "bgpArg4": { "type": "string" }, "bgpArg5": { "type": "string" }, "bgpArg6": { "type": "string" }, "bgpArg7": { "type": "string" }, "bgpArg1": { "type": "string" }, "bgpArg2": { "type": "string" }, "bgpArg3": { "type": "string" } } }, "net_static_route": { "required": [ "next_hop", "mask", "prefix" ], "type": "object", "description": "This module provides declarative management of static IP routes on network devices.", "properties": { "mask": { "type": "string" }, "prefix": { "type": "string" }, "admin_distance": { "type": "string" }, "purge": { "type": "boolean" }, "state": { "type": "string" }, "next_hop": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" } } }, "cs_zone_facts": { "required": [ "name" ], "type": "object", "description": "Gathering facts from the API of a zone.", "properties": { "name": { "type": "string" } } }, "nxos_nxapi": { "required": [], "type": "object", "description": "Configures the NXAPI feature on devices running Cisco NXOS. The NXAPI feature is absent from the configuration by default. Since this module manages the NXAPI feature it only supports the use of the C(Cli) transport.", "properties": { "http_port": { "items": { "type": "integer" }, "type": "array" }, "http": { "type": "boolean" }, "https_port": { "items": { "type": "integer" }, "type": "array" }, "state": { "type": "string" }, "sandbox": { "type": "boolean" }, "https": { "type": "boolean" } } }, "fortios_ipv4_policy": { "required": [ "id" ], "type": "object", "description": "This module provides management of firewall IPv4 policies on FortiOS devices.", "properties": { "comment": { "type": "string" }, "application_list": { "type": "string" }, "service_negate": { "type": "boolean" }, "ips_sensor": { "type": "string" }, "id": { "items": { "type": "string" }, "type": "array" }, "fixedport": { "type": "boolean" }, "src_addr": { "type": "string" }, "service": { "items": { "type": "string" }, "type": "array" }, "poolname": { "type": "string" }, "state": { "type": "string" }, "nat": { "type": "boolean" }, "src_addr_negate": { "type": "boolean" }, "schedule": { "type": "string" }, "src_intf": { "type": "string" }, "dst_addr_negate": { "type": "boolean" }, "webfilter_profile": { "type": "string" }, "logtraffic_start": { "type": "boolean" }, "policy_action": { "type": "string" }, "dst_intf": { "type": "string" }, "av_profile": { "type": "string" }, "dst_addr": { "type": "string" }, "logtraffic": { "type": "string" } } }, "win_regmerge": { "required": [ "path" ], "type": "object", "description": "Wraps the reg.exe command to import the contents of a registry file.\nSuitable for use with registry files created using M(win_template).\nWindows registry files have a specific format and must be constructed correctly with carriage return and line feed line endings otherwise they will not be merged.\nExported registry files often start with a Byte Order Mark which must be removed if the file is to templated using M(win_template).\nRegistry file format is described at U(https://support.microsoft.com/en-us/kb/310516)\nSee also M(win_template), M(win_regedit)", "properties": { "path": { "type": "string" }, "compare_key": { "type": "string" } } }, "azure_rm_loadbalancer": { "required": [ "resource_group", "name" ], "type": "object", "description": "Create, update and delete Azure load balancers", "properties": { "public_ip_address_name": { "type": "string" }, "probe_fail_count": { "type": "integer" }, "probe_port": { "type": "string" }, "natpool_frontend_port_end": { "type": "string" }, "protocol": { "type": "string" }, "natpool_backend_port": { "type": "string" }, "resource_group": { "type": "string" }, "state": { "type": "string" }, "natpool_protocol": { "type": "string" }, "idle_timeout": { "type": "integer" }, "probe_interval": { "type": "integer" }, "location": { "type": "string" }, "probe_protocol": { "type": "string" }, "probe_request_path": { "type": "string" }, "load_distribution": { "type": "string" }, "frontend_port": { "type": "string" }, "natpool_frontend_port_start": { "type": "string" }, "backend_port": { "type": "string" }, "name": { "type": "string" } } }, "imgadm": { "required": [ "state" ], "type": "object", "description": "Manage SmartOS virtual machine images through imgadm(1M)", "properties": { "force": { "type": "string" }, "uuid": { "type": "string" }, "source": { "type": "string" }, "state": { "type": "string" }, "type": { "type": "string" }, "pool": { "type": "string" } } }, "ce_mtu": { "required": [], "type": "object", "description": "Manages MTU settings on HUAWEI CloudEngine switches.", "properties": { "interface": { "type": "string" }, "state": { "type": "string" }, "jumbo_max": { "type": "string" }, "jumbo_min": { "type": "string" }, "mtu": { "type": "string" } } }, "ldap_entry": { "required": [ "dn" ], "type": "object", "description": "Add or remove LDAP entries. This module only asserts the existence or non-existence of an LDAP entry, not its attributes. To assert the attribute values of an entry, see M(ldap_attr).", "properties": { "dn": { "type": "string" }, "objectClass": { "items": { "type": "string" }, "type": "array" }, "start_tls": { "type": "string" }, "bind_dn": { "type": "string" }, "server_uri": { "type": "string" }, "state": { "type": "string" }, "params": { "items": { "type": "string" }, "type": "array" }, "bind_pw": { "type": "string" }, "attributes": { "type": "string" }, "validate_certs": { "type": "string" } } }, "ovirt_quotas": { "required": [ "data_center", "name" ], "type": "object", "description": "Module to manage datacenter quotas in oVirt/RHV", "properties": { "description": { "type": "string" }, "cluster_grace": { "type": "string" }, "data_center": { "type": "string" }, "state": { "type": "string" }, "storage_grace": { "type": "string" }, "storage_threshold": { "type": "string" }, "cluster_threshold": { "type": "string" }, "clusters": { "items": { "type": "string" }, "type": "array" }, "storages": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" } } }, "ce_interface": { "required": [ "state" ], "type": "object", "description": "Manages physical attributes of interfaces on HUAWEI CloudEngine switches.", "properties": { "description": { "type": "string" }, "interface_type": { "type": "string" }, "state": { "type": "string" }, "admin_state": { "type": "string" }, "mode": { "type": "string" }, "interface": { "type": "string" }, "l2sub": { "type": "boolean" } } }, "digital_ocean_sshkey_facts": { "required": [ "oauth_token" ], "type": "object", "description": "Fetch DigitalOcean SSH keys facts.", "properties": { "oauth_token": { "type": "string" }, "timeout": { "type": "integer" } } }, "vmware_guest_facts": { "required": [ "datacenter" ], "type": "object", "description": "Gather facts about a single VM on a VMware ESX cluster", "properties": { "datacenter": { "type": "string" }, "folder": { "type": "string" }, "uuid": { "type": "string" }, "name": { "type": "string" }, "name_match": { "type": "string" } } }, "cl_bridge": { "required": [ "name", "ports" ], "type": "object", "description": "Configures a bridge interface on Cumulus Linux To configure a bond port use the cl_bond module. To configure any other type of interface use the cl_interface module. Follow the guidelines for bridging found in the Cumulus User Guide at U(http://docs.cumulusnetworks.com)", "properties": { "addr_method": { "type": "string" }, "name": { "type": "string" }, "vlan_aware": { "type": "string" }, "mstpctl_treeprio": { "type": "string" }, "virtual_mac": { "type": "string" }, "mtu": { "type": "string" }, "pvid": { "type": "string" }, "ipv4": { "items": { "type": "string" }, "type": "array" }, "stp": { "type": "string" }, "virtual_ip": { "type": "string" }, "ipv6": { "items": { "type": "string" }, "type": "array" }, "vids": { "items": { "type": "string" }, "type": "array" }, "alias_name": { "type": "string" }, "ports": { "items": { "type": "string" }, "type": "array" }, "location": { "type": "string" } } }, "aci_tenant_span_src_group_to_dst_group": { "required": [], "type": "object", "description": "Manage SPAN source groups' associated destinaton group on Cisco ACI fabrics.\nMore information from the internal APIC class I(span:SrcGrp) at U(https://developer.cisco.com/media/mim-ref/MO-spanSpanLbl.html).", "properties": { "state": { "items": { "type": "string" }, "type": "array" }, "dst_group": { "type": "string" }, "description": { "type": "string" }, "tenant": { "type": "string" }, "src_group": { "type": "string" } } }, "avi_applicationpersistenceprofile": { "required": [ "persistence_type", "name" ], "type": "object", "description": "This module is used to configure ApplicationPersistenceProfile object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "uuid": { "type": "string" }, "app_cookie_persistence_profile": { "type": "string" }, "persistence_type": { "type": "string" }, "description": { "type": "string" }, "tenant_ref": { "type": "string" }, "is_federated": { "type": "string" }, "server_hm_down_recovery": { "type": "string" }, "http_cookie_persistence_profile": { "type": "string" }, "url": { "type": "string" }, "state": { "type": "string" }, "ip_persistence_profile": { "type": "string" }, "hdr_persistence_profile": { "type": "string" }, "name": { "type": "string" } } }, "rax_cdb_database": { "required": [], "type": "object", "description": "create / delete a database in the Cloud Databases.", "properties": { "cdb_id": { "type": "string" }, "state": { "type": "string" }, "character_set": { "type": "string" }, "name": { "type": "string" }, "collate": { "type": "string" } } }, "nxos_ping": { "required": [ "dest" ], "type": "object", "description": "Tests reachability using ping from switch to a remote destination.", "properties": { "dest": { "type": "string" }, "count": { "type": "integer" }, "state": { "type": "string" }, "vrf": { "type": "string" }, "source": { "type": "string" } } }, "aci_bd_subnet": { "required": [], "type": "object", "description": "Manage Subnets on Cisco ACI fabrics.\nMore information from the internal APIC class I(fv:Subnet) at U(https://developer.cisco.com/media/mim-ref/MO-fvSubnet.html).", "properties": { "bd": { "type": "string" }, "description": { "type": "string" }, "nd_prefix_policy": { "type": "string" }, "enable_vip": { "type": "boolean" }, "mask": { "type": "string" }, "preferred": { "type": "boolean" }, "subnet_control": { "type": "string" }, "route_profile": { "type": "string" }, "route_profile_l3_out": { "type": "string" }, "scope": { "items": { "type": "string" }, "type": "array" }, "gateway": { "type": "string" }, "tenant": { "type": "string" }, "subnet_name": { "type": "string" } } }, "profitbricks_volume_attachments": { "required": [ "datacenter", "server", "volume" ], "type": "object", "description": "Allows you to attach or detach a volume from a ProfitBricks server. This module has a dependency on profitbricks >= 1.0.0", "properties": { "datacenter": { "type": "string" }, "subscription_user": { "type": "string" }, "server": { "type": "string" }, "volume": { "type": "string" }, "state": { "type": "string" }, "wait_timeout": { "type": "integer" }, "subscription_password": { "type": "string" }, "wait": { "type": "string" } } }, "aci_intf_policy_port_channel": { "required": [ "port_channel" ], "type": "object", "description": "Manage port channel interface policies on Cisco ACI fabrics.\nMore information from the internal APIC class I(lacp:LagPol) at U(https://developer.cisco.com/media/mim-ref/MO-lacpLagPol.html).", "properties": { "graceful_convergence": { "type": "boolean" }, "description": { "type": "string" }, "load_defer": { "type": "boolean" }, "symmetric_hash": { "type": "boolean" }, "suspend_individual": { "type": "boolean" }, "state": { "items": { "type": "string" }, "type": "array" }, "mode": { "type": "boolean" }, "min_links": { "type": "integer" }, "port_channel": { "type": "string" }, "fast_select": { "type": "boolean" }, "max_links": { "type": "integer" } } }, "znode": { "required": [ "hosts", "name" ], "type": "object", "description": "Create, delete, retrieve, and update znodes using ZooKeeper.", "properties": { "name": { "type": "string" }, "recursive": { "type": "boolean" }, "value": { "type": "string" }, "state": { "type": "string" }, "hosts": { "items": { "type": "string" }, "type": "array" }, "timeout": { "type": "integer" }, "op": { "type": "string" } } }, "sendgrid": { "required": [ "from_address", "subject", "to_addresses" ], "type": "object", "description": "Sends an email with a SendGrid account through their API, not through the SMTP service.", "properties": { "username": { "type": "string" }, "password": { "type": "string" }, "from_name": { "type": "string" }, "from_address": { "type": "string" }, "cc": { "items": { "type": "string" }, "type": "array" }, "bcc": { "items": { "type": "string" }, "type": "array" }, "attachments": { "items": { "type": "string" }, "type": "array" }, "headers": { "type": "string" }, "to_addresses": { "items": { "type": "string" }, "type": "array" }, "api_key": { "type": "string" }, "html_body": { "type": "boolean" }, "subject": { "type": "string" } } }, "profitbricks_datacenter": { "required": [ "name" ], "type": "object", "description": "This is a simple module that supports creating or removing vDCs. A vDC is required before you can create servers. This module has a dependency on profitbricks >= 1.0.0", "properties": { "name": { "type": "string" }, "subscription_user": { "type": "string" }, "description": { "type": "string" }, "subscription_password": { "type": "string" }, "state": { "type": "string" }, "wait_timeout": { "type": "integer" }, "location": { "type": "string" }, "wait": { "type": "string" } } }, "nxos_igmp_interface": { "required": [ "interface" ], "type": "object", "description": "Manages IGMP interface configuration settings.", "properties": { "startup_query_interval": { "type": "string" }, "report_llg": { "type": "boolean" }, "last_member_qrt": { "type": "string" }, "group_timeout": { "type": "string" }, "robustness": { "type": "string" }, "startup_query_count": { "type": "string" }, "oif_routemap": { "type": "string" }, "immediate_leave": { "type": "boolean" }, "oif_source": { "type": "string" }, "state": { "type": "string" }, "version": { "type": "string" }, "oif_prefix": { "type": "string" }, "interface": { "type": "string" }, "querier_timeout": { "type": "string" }, "last_member_query_count": { "type": "string" }, "query_interval": { "type": "string" }, "restart": { "type": "string" }, "query_mrt": { "type": "string" } } }, "sros_rollback": { "required": [], "type": "object", "description": "Configure the rollback feature on remote Nokia devices running the SR OS operating system. this module provides a stateful implementation for managing the configuration of the rollback feature", "properties": { "state": { "type": "string" }, "local_max_checkpoints": { "type": "string" }, "rescue_location": { "type": "string" }, "remote_max_checkpoints": { "type": "string" }, "rollback_location": { "type": "string" } } }, "udm_dns_record": { "required": [ "type", "name", "zone" ], "type": "object", "description": "This module allows to manage dns records on a univention corporate server (UCS). It uses the python API of the UCS to create a new object or edit it.", "properties": { "data": { "type": "string" }, "state": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" }, "zone": { "type": "string" } } }, "user": { "required": [ "name" ], "type": "object", "description": "Manage user accounts and user attributes.\nFor Windows targets, use the M(win_user) module instead.", "properties": { "comment": { "type": "string" }, "ssh_key_bits": { "type": "string" }, "update_password": { "type": "string" }, "non_unique": { "type": "string" }, "force": { "type": "string" }, "ssh_key_type": { "type": "string" }, "create_home": { "type": "string" }, "ssh_key_passphrase": { "type": "string" }, "home": { "type": "string" }, "skeleton": { "type": "string" }, "append": { "items": { "type": "string" }, "type": "array" }, "uid": { "type": "string" }, "ssh_key_comment": { "type": "string" }, "group": { "type": "string" }, "system": { "type": "string" }, "state": { "type": "string" }, "local": { "type": "string" }, "shell": { "type": "string" }, "expires": { "type": "string" }, "ssh_key_file": { "type": "string" }, "groups": { "items": { "type": "string" }, "type": "array" }, "move_home": { "type": "string" }, "password": { "type": "string" }, "name": { "type": "string" }, "seuser": { "type": "string" }, "remove": { "type": "string" }, "login_class": { "type": "string" }, "generate_ssh_key": { "type": "string" } } }, "pn_vrouterif": { "required": [ "pn_vrouter_name", "state" ], "type": "object", "description": "Execute vrouter-interface-add, vrouter-interface-remove, vrouter-interface-modify command.\nYou configure interfaces to vRouter services on a fabric, cluster, standalone switch or virtual network(VNET).", "properties": { "pn_nic_enable": { "type": "string" }, "pn_clipassword": { "type": "string" }, "pn_exclusive": { "type": "string" }, "pn_nic_str": { "type": "string" }, "pn_vrouter_name": { "type": "string" }, "pn_vrrp_adv_int": { "type": "string" }, "pn_vrrp_priority": { "type": "string" }, "pn_alias": { "type": "string" }, "pn_secondary_macs": { "type": "string" }, "pn_cliusername": { "type": "string" }, "pn_interface_ip": { "type": "string" }, "state": { "type": "string" }, "pn_vrrp_id": { "type": "string" }, "pn_vlan": { "type": "string" }, "pn_interface": { "type": "string" }, "pn_l3port": { "type": "string" }, "pn_vxlan": { "type": "string" }, "pn_cliswitch": { "type": "string" }, "pn_assignment": { "type": "string" } } }, "gcpubsub": { "required": [ "topic" ], "type": "object", "description": "Create and Delete Topics/Subscriptions, Publish and pull messages on PubSub. See U(https://cloud.google.com/pubsub/docs) for an overview.", "properties": { "pull": { "type": "string" }, "ack_deadline": { "type": "string" }, "name": { "type": "string" }, "publish": { "items": { "type": "string" }, "type": "array" }, "topic": { "type": "string" }, "state": { "type": "string" }, "push_endpoint": { "type": "string" }, "subscription": { "type": "string" } } }, "ipadm_ifprop": { "required": [ "interface", "protocol", "property" ], "type": "object", "description": "Modify IP interface properties on Solaris/illumos systems.", "properties": { "protocol": { "type": "string" }, "value": { "type": "string" }, "state": { "type": "string" }, "interface": { "type": "string" }, "temporary": { "type": "boolean" }, "property": { "type": "string" } } }, "rax_files": { "required": [ "container" ], "type": "object", "description": "Manipulate Rackspace Cloud Files Containers", "properties": { "web_index": { "type": "string" }, "container": { "type": "string" }, "region": { "type": "string" }, "private": { "type": "string" }, "state": { "type": "string" }, "clear_meta": { "type": "string" }, "meta": { "type": "string" }, "ttl": { "type": "string" }, "web_error": { "type": "string" }, "type": { "type": "string" }, "public": { "type": "string" } } }, "docker": { "required": [ "image" ], "type": "object", "description": "This is the original Ansible module for managing the Docker container life cycle.\nNOTE - Additional and newer modules are available. For the latest on orchestrating containers with Ansible visit our Getting Started with Docker Guide at U(https://github.com/ansible/ansible/blob/devel/docs/docsite/rst/guide_docker.rst).", "properties": { "publish_all_ports": { "type": "string" }, "tty": { "type": "string" }, "cap_add": { "type": "string" }, "insecure_registry": { "type": "string" }, "links": { "items": { "type": "string" }, "type": "array" }, "docker_user": { "type": "string" }, "lxc_conf": { "type": "string" }, "image": { "type": "string" }, "labels": { "type": "string" }, "pid": { "type": "string" }, "docker_api_version": { "type": "string" }, "stop_timeout": { "type": "integer" }, "tls_client_key": { "type": "string" }, "env_file": { "type": "string" }, "read_only": { "type": "string" }, "tls_ca_cert": { "type": "string" }, "timeout": { "type": "integer" }, "detach": { "type": "string" }, "hostname": { "type": "string" }, "docker_url": { "type": "string" }, "use_tls": { "type": "string" }, "state": { "type": "string" }, "tls_client_cert": { "type": "string" }, "entrypoint": { "type": "string" }, "env": { "type": "string" }, "volumes_from": { "items": { "type": "string" }, "type": "array" }, "net": { "type": "string" }, "privileged": { "type": "string" }, "username": { "type": "string" }, "memory_limit": { "type": "integer" }, "extra_hosts": { "type": "string" }, "log_driver": { "type": "string" }, "expose": { "items": { "type": "string" }, "type": "array" }, "stdin_open": { "type": "string" }, "tls_hostname": { "type": "string" }, "domainname": { "type": "string" }, "registry": { "type": "string" }, "password": { "type": "string" }, "cpu_set": { "type": "string" }, "pull": { "type": "string" }, "dns": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "signal": { "type": "string" }, "log_opt": { "type": "string" }, "restart_policy": { "type": "string" }, "count": { "type": "integer" }, "devices": { "items": { "type": "string" }, "type": "array" }, "email": { "type": "string" }, "command": { "type": "string" }, "restart_policy_retry": { "type": "integer" }, "volumes": { "items": { "type": "string" }, "type": "array" }, "cap_drop": { "type": "string" }, "ports": { "items": { "type": "string" }, "type": "array" }, "ulimits": { "items": { "type": "string" }, "type": "array" }, "cpu_shares": { "type": "integer" } } }, "telegram": { "required": [ "msg", "token", "chat_id" ], "type": "object", "description": "Send notifications via telegram bot, to a verified group or user", "properties": { "msg": { "type": "string" }, "msg_format": { "type": "string" }, "token": { "type": "string" }, "chat_id": { "type": "string" } } }, "ce_vxlan_gateway": { "required": [], "type": "object", "description": "Configuring Centralized All-Active Gateways or Distributed Gateway for the VXLAN Network on HUAWEI CloudEngine devices.", "properties": { "dfs_source_vpn": { "type": "string" }, "dfs_id": { "type": "string" }, "arp_direct_route": { "type": "string" }, "dfs_peer_vpn": { "type": "string" }, "vbdif_name": { "type": "string" }, "vpn_vni": { "type": "string" }, "vbdif_mac": { "type": "string" }, "arp_distribute_gateway": { "type": "string" }, "dfs_source_ip": { "type": "string" }, "dfs_udp_port": { "type": "string" }, "vbdif_bind_vpn": { "type": "string" }, "state": { "type": "string" }, "dfs_all_active": { "type": "string" }, "vpn_instance": { "type": "string" }, "dfs_peer_ip": { "type": "string" } } }, "dladm_etherstub": { "required": [ "name" ], "type": "object", "description": "Create or delete etherstubs on Solaris/illumos systems.", "properties": { "state": { "type": "string" }, "temporary": { "type": "boolean" }, "name": { "type": "string" } } }, "ce_snmp_community": { "required": [], "type": "object", "description": "Manages SNMP community configuration on HUAWEI CloudEngine switches.", "properties": { "notify_view": { "type": "string" }, "write_view": { "type": "string" }, "community_mib_view": { "type": "string" }, "read_view": { "type": "string" }, "acl_number": { "items": { "type": "string" }, "type": "array" }, "group_name": { "type": "string" }, "community_name": { "type": "string" }, "state": { "type": "string" }, "security_level": { "type": "string" }, "access_right": { "type": "string" } } }, "azure_rm_storageblob": { "required": [ "resource_group", "container", "storage_account_name" ], "type": "object", "description": "Create, update and delete blob containers and blob objects. Use to upload a file and store it as a blob object, or download a blob object to a file.", "properties": { "src": { "type": "string" }, "force": { "type": "boolean" }, "resource_group": { "type": "string" }, "dest": { "type": "string" }, "blob_type": { "type": "string" }, "state": { "type": "string" }, "container": { "type": "string" }, "content_language": { "type": "string" }, "blob": { "type": "string" }, "content_type": { "type": "string" }, "content_md5": { "type": "string" }, "public_access": { "type": "string" }, "storage_account_name": { "type": "string" }, "content_disposition": { "type": "string" }, "cache_control": { "type": "string" }, "content_encoding": { "type": "string" } } }, "bigip_device_connectivity": { "required": [], "type": "object", "description": "Manages device IP configuration settings for HA on a BIG-IP. Each BIG-IP device has synchronization and failover connectivity information (IP addresses) that you define as part of HA pairing or clustering. This module allows you to configure that information.", "properties": { "multicast_interface": { "type": "string" }, "mirror_primary_address": { "type": "string" }, "mirror_secondary_address": { "type": "string" }, "config_sync_ip": { "type": "string" }, "multicast_address": { "type": "string" }, "failover_multicast": { "type": "string" }, "unicast_failover": { "type": "string" }, "multicast_port": { "type": "string" } } }, "netapp_e_auth": { "required": [ "new_password" ], "type": "object", "description": "Sets or updates the password for a storage array. When the password is updated on the storage array, it must be updated on the SANtricity Web Services proxy. Note, all storage arrays do not have a Monitor or RO role.", "properties": { "ssid": { "type": "string" }, "new_password": { "type": "string" }, "api_password": { "type": "string" }, "current_password": { "type": "string" }, "api_username": { "type": "string" }, "api_url": { "type": "string" }, "validate_certs": { "type": "boolean" }, "set_admin": { "type": "boolean" }, "name": { "type": "string" } } }, "os_keystone_domain": { "required": [ "name" ], "type": "object", "description": "Create, update, or delete OpenStack Identity domains. If a domain with the supplied name already exists, it will be updated with the new description and enabled attributes.", "properties": { "state": { "type": "string" }, "availability_zone": { "type": "string" }, "enabled": { "type": "boolean" }, "description": { "type": "string" }, "name": { "type": "string" } } }, "ovirt": { "required": [ "user", "password", "url", "instance_name" ], "type": "object", "description": "This module only supports oVirt/RHEV version 3. A newer module M(ovirt_vms) supports oVirt/RHV version 4.\nAllows you to create new instances, either from scratch or an image, in addition to deleting or stopping instances on the oVirt/RHEV platform.", "properties": { "instance_mem": { "type": "string" }, "instance_cores": { "type": "integer" }, "instance_cpus": { "type": "integer" }, "image": { "type": "string" }, "instance_disksize": { "type": "string" }, "instance_nic": { "type": "string" }, "zone": { "type": "string" }, "instance_netmask": { "type": "string" }, "state": { "type": "string" }, "instance_key": { "type": "string" }, "instance_domain": { "type": "string" }, "instance_rootpw": { "type": "string" }, "instance_hostname": { "type": "string" }, "user": { "type": "string" }, "instance_network": { "type": "string" }, "password": { "type": "string" }, "sdomain": { "type": "string" }, "instance_os": { "type": "string" }, "instance_ip": { "type": "string" }, "disk_alloc": { "type": "string" }, "url": { "type": "string" }, "region": { "type": "string" }, "instance_dns": { "type": "string" }, "instance_name": { "type": "string" }, "instance_type": { "type": "string" }, "resource_type": { "type": "string" }, "disk_int": { "type": "string" } } }, "redhat_subscription": { "required": [], "type": "object", "description": "Manage registration and subscription to the Red Hat Subscription Management entitlement platform using the C(subscription-manager) command", "properties": { "username": { "type": "string" }, "server_hostname": { "type": "string" }, "password": { "type": "string" }, "pool_ids": { "type": "string" }, "consumer_type": { "type": "string" }, "org_id": { "type": "string" }, "server_proxy_hostname": { "type": "string" }, "consumer_id": { "type": "string" }, "environment": { "type": "string" }, "force_register": { "type": "boolean" }, "state": { "type": "string" }, "server_proxy_user": { "type": "string" }, "auto_attach": { "type": "boolean" }, "server_proxy_password": { "type": "string" }, "activationkey": { "type": "string" }, "server_insecure": { "type": "string" }, "consumer_name": { "type": "string" }, "rhsm_baseurl": { "type": "string" }, "pool": { "type": "string" }, "server_proxy_port": { "type": "string" } } }, "cv_server_provision": { "required": [ "username", "switch_port", "server_name", "host", "template", "password", "switch_name" ], "type": "object", "description": "This module allows a server team to provision server network ports for new servers without having to access Arista CVP or asking the network team to do it for them. Provide the information for connecting to CVP, switch rack, port the new server is connected to, optional vlan, and an action and the module will apply the configuration to the switch port via CVP. Actions are add (applies template config to port), remove (defaults the interface config) and show (returns the current port config).", "properties": { "username": { "type": "string" }, "port_vlan": { "type": "string" }, "protocol": { "type": "string" }, "switch_port": { "type": "string" }, "server_name": { "type": "string" }, "switch_name": { "type": "string" }, "host": { "type": "string" }, "template": { "type": "string" }, "auto_run": { "type": "boolean" }, "action": { "type": "string" }, "password": { "type": "string" }, "port": { "type": "string" } } }, "gitlab_group": { "required": [ "name", "server_url" ], "type": "object", "description": "When the group does not exists in Gitlab, it will be created.\nWhen the group does exists and state=absent, the group will be deleted.", "properties": { "name": { "type": "string" }, "login_user": { "type": "string" }, "login_token": { "type": "string" }, "server_url": { "type": "string" }, "state": { "type": "string" }, "login_password": { "type": "string" }, "path": { "type": "string" }, "validate_certs": { "type": "boolean" } } }, "win_iis_website": { "required": [ "name" ], "type": "object", "description": "Creates, Removes and configures a IIS Web site", "properties": { "hostname": { "type": "string" }, "name": { "type": "string" }, "parameters": { "type": "string" }, "ip": { "type": "string" }, "physical_path": { "type": "string" }, "application_pool": { "type": "string" }, "site_id": { "type": "string" }, "ssl": { "type": "string" }, "state": { "type": "string" }, "port": { "type": "string" } } }, "ipa_dnszone": { "required": [ "ipa_pass", "zone_name" ], "type": "object", "description": "Add and delete an IPA DNS Zones using IPA API", "properties": { "ipa_port": { "type": "integer" }, "ipa_prot": { "type": "string" }, "state": { "type": "string" }, "ipa_host": { "type": "string" }, "ipa_user": { "type": "string" }, "ipa_pass": { "type": "string" }, "zone_name": { "type": "string" }, "validate_certs": { "type": "boolean" } } }, "kinesis_stream": { "required": [ "name" ], "type": "object", "description": "Create or Delete a Kinesis Stream.\nUpdate the retention period of a Kinesis Stream.\nUpdate Tags on a Kinesis Stream.", "properties": { "name": { "type": "string" }, "state": { "type": "string" }, "tags": { "type": "string" }, "shards": { "type": "string" }, "retention_period": { "type": "string" }, "wait_timeout": { "type": "integer" }, "wait": { "type": "boolean" } } }, "nxos_vtp_password": { "required": [], "type": "object", "description": "Manages VTP password configuration.", "properties": { "vtp_password": { "type": "string" }, "state": { "type": "string" } } }, "sqs_queue": { "required": [ "name" ], "type": "object", "description": "Create or delete AWS SQS queues.\nUpdate attributes on existing queues.", "properties": { "message_retention_period": { "type": "string" }, "name": { "type": "string" }, "delivery_delay": { "type": "string" }, "default_visibility_timeout": { "type": "string" }, "state": { "type": "string" }, "maximum_message_size": { "type": "string" }, "policy": { "type": "string" }, "redrive_policy": { "type": "string" }, "receive_message_wait_time": { "type": "string" } } }, "fortios_config": { "required": [], "type": "object", "description": "This module provides management of FortiOS Devices configuration.", "properties": { "filter": { "type": "string" }, "src": { "type": "string" } } }, "s3_lifecycle": { "required": [ "name" ], "type": "object", "description": "Manage s3 bucket lifecycle rules in AWS", "properties": { "status": { "type": "string" }, "transition_days": { "type": "string" }, "name": { "type": "string" }, "expiration_date": { "type": "string" }, "state": { "type": "string" }, "prefix": { "type": "string" }, "storage_class": { "type": "string" }, "expiration_days": { "type": "string" }, "rule_id": { "type": "string" }, "transition_date": { "type": "string" } } }, "os_port": { "required": [ "network" ], "type": "object", "description": "Add, Update or Remove ports from an OpenStack cloud. A I(state) of 'present' will ensure the port is created or updated if required.", "properties": { "network": { "type": "string" }, "allowed_address_pairs": { "items": { "type": "string" }, "type": "array" }, "availability_zone": { "type": "string" }, "extra_dhcp_opts": { "type": "string" }, "admin_state_up": { "type": "string" }, "state": { "type": "string" }, "device_owner": { "type": "string" }, "no_security_groups": { "type": "boolean" }, "mac_address": { "type": "string" }, "device_id": { "type": "string" }, "fixed_ips": { "type": "string" }, "security_groups": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" } } }, "seport": { "required": [ "setype", "proto", "state", "ports" ], "type": "object", "description": "Manages SELinux network port type definitions.", "properties": { "ports": { "type": "string" }, "reload": { "type": "string" }, "setype": { "type": "string" }, "state": { "type": "string" }, "proto": { "type": "string" } } }, "s3_website": { "required": [ "name" ], "type": "object", "description": "Configure an s3 bucket as a website", "properties": { "redirect_all_requests": { "type": "string" }, "suffix": { "type": "string" }, "region": { "type": "string" }, "error_key": { "type": "string" }, "state": { "type": "string" }, "name": { "type": "string" } } }, "ipa_hostgroup": { "required": [ "cn" ], "type": "object", "description": "Add, modify and delete an IPA host-group using IPA API", "properties": { "host": { "items": { "type": "string" }, "type": "array" }, "cn": { "type": "string" }, "description": { "type": "string" }, "hostgroup": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" } } }, "typetalk": { "required": [ "topic", "client_secret", "client_id", "msg" ], "type": "object", "description": "Send a message to typetalk using typetalk API ( http://developers.typetalk.in/ )", "properties": { "topic": { "type": "string" }, "client_secret": { "type": "string" }, "client_id": { "type": "string" }, "msg": { "type": "string" } } }, "postgresql_db": { "required": [ "name" ], "type": "object", "description": "Add or remove PostgreSQL databases from a remote host.", "properties": { "name": { "type": "string" }, "encoding": { "type": "string" }, "lc_collate": { "type": "string" }, "target_opts": { "type": "string" }, "lc_ctype": { "type": "string" }, "maintenance_db": { "type": "string" }, "state": { "type": "string" }, "template": { "type": "string" }, "owner": { "type": "string" }, "target": { "type": "string" } } }, "ce_ip_interface": { "required": [ "interface" ], "type": "object", "description": "Manages Layer 3 attributes for IPv4 and IPv6 interfaces on HUAWEI CloudEngine switches.", "properties": { "addr": { "type": "string" }, "mask": { "type": "string" }, "ipv4_type": { "type": "string" }, "state": { "type": "string" }, "version": { "type": "string" }, "interface": { "type": "string" } } }, "win_get_url": { "required": [ "url", "dest" ], "type": "object", "description": "Fetches a file from a URL and saves it locally.\nFor non-Windows targets, use the M(get_url) module instead.", "properties": { "url_password": { "type": "string" }, "force": { "type": "string" }, "use_proxy": { "type": "string" }, "headers": { "type": "string" }, "url": { "type": "string" }, "skip_certificate_validation": { "type": "string" }, "proxy_url": { "type": "string" }, "proxy_password": { "type": "string" }, "dest": { "type": "string" }, "proxy_username": { "type": "string" }, "timeout": { "type": "integer" }, "url_username": { "type": "string" }, "validate_certs": { "type": "string" } } }, "net_lldp": { "required": [], "type": "object", "description": "This module provides declarative management of LLDP service configuration on network devices.", "properties": { "state": { "type": "string" } } }, "ec2_key": { "required": [ "name" ], "type": "object", "description": "maintains ec2 key pairs. This module has a dependency on python-boto >= 2.5", "properties": { "force": { "type": "boolean" }, "name": { "type": "string" }, "key_material": { "type": "string" }, "state": { "type": "string" }, "wait_timeout": { "type": "integer" }, "wait": { "type": "boolean" } } }, "cs_network": { "required": [ "name" ], "type": "object", "description": "Create, update, restart and delete networks.", "properties": { "domain": { "type": "string" }, "end_ipv6": { "type": "string" }, "gateway": { "type": "string" }, "poll_async": { "type": "boolean" }, "zone": { "type": "string" }, "start_ipv6": { "type": "string" }, "cidr_ipv6": { "type": "string" }, "state": { "type": "string" }, "end_ip": { "type": "string" }, "vlan": { "type": "string" }, "clean_up": { "type": "boolean" }, "netmask": { "type": "string" }, "network_offering": { "type": "string" }, "vpc": { "type": "string" }, "start_ip": { "type": "string" }, "gateway_ipv6": { "type": "string" }, "display_text": { "type": "string" }, "isolated_pvlan": { "type": "string" }, "account": { "type": "string" }, "network_domain": { "type": "string" }, "name": { "type": "string" }, "project": { "type": "string" }, "acl_type": { "type": "string" } } }, "accelerate": { "required": [], "type": "object", "description": "This module has been removed, this file is kept for historicaly documentation purposes\nThis modules launches an ephemeral I(accelerate) daemon on the remote node which Ansible can use to communicate with nodes at high speed.\nThe daemon listens on a configurable port for a configurable amount of time.\nFireball mode is AES encrypted", "properties": { "ipv6": { "items": { "type": "boolean" }, "type": "array" }, "minutes": { "items": { "type": "integer" }, "type": "array" }, "port": { "type": "integer" }, "timeout": { "type": "integer" }, "multi_key": { "type": "boolean" } } }, "iosxr_banner": { "required": [ "banner" ], "type": "object", "description": "This will configure both exec and motd banners on remote devices running Cisco IOS XR. It allows playbooks to add or remote banner text from the active running configuration.", "properties": { "text": { "type": "string" }, "state": { "type": "string" }, "banner": { "type": "string" } } }, "openvswitch_bridge": { "required": [ "bridge" ], "type": "object", "description": "Manage Open vSwitch bridges", "properties": { "bridge": { "type": "string" }, "fail_mode": { "type": "string" }, "parent": { "type": "string" }, "vlan": { "type": "string" }, "state": { "type": "string" }, "set": { "type": "string" }, "timeout": { "type": "integer" }, "external_ids": { "type": "string" } } }, "digital_ocean_domain": { "required": [], "type": "object", "description": "Create/delete a DNS record in DigitalOcean.", "properties": { "ip": { "type": "string" }, "state": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "api_token": { "type": "string" } } }, "oneview_network_set": { "required": [ "data" ], "type": "object", "description": "Provides an interface to manage Network Set resources. Can create, update, or delete.", "properties": { "state": { "type": "string" }, "data": { "items": { "type": "string" }, "type": "array" } } }, "panos_mgtconfig": { "required": [ "password", "ip_address" ], "type": "object", "description": "Configure management settings of device", "properties": { "username": { "type": "string" }, "panorama_primary": { "type": "string" }, "dns_server_secondary": { "type": "string" }, "dns_server_primary": { "type": "string" }, "panorama_secondary": { "type": "string" }, "commit": { "type": "boolean" }, "password": { "type": "string" }, "ip_address": { "type": "string" } } }, "panos_sag": { "required": [ "static_match_filter", "sag_name", "operation", "password", "ip_address" ], "type": "object", "description": "Create a static address group object in the firewall used for policy rules.", "properties": { "username": { "type": "string" }, "password": { "type": "string" }, "devicegroup": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "string" }, "static_match_filter": { "type": "string" }, "sag_name": { "type": "string" }, "commit": { "type": "boolean" }, "operation": { "items": { "type": "string" }, "type": "array" }, "api_key": { "type": "string" }, "ip_address": { "type": "string" } } }, "tower_job_list": { "required": [], "type": "object", "description": "List Ansible Tower jobs. See U(https://www.ansible.com/tower) for an overview.", "properties": { "status": { "items": { "type": "string" }, "type": "array" }, "query": { "items": { "type": "string" }, "type": "array" }, "page": { "type": "string" }, "all_pages": { "type": "boolean" } } }, "avi_authprofile": { "required": [ "name", "type" ], "type": "object", "description": "This module is used to configure AuthProfile object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "http": { "type": "string" }, "description": { "type": "string" }, "url": { "type": "string" }, "tenant_ref": { "type": "string" }, "uuid": { "type": "string" }, "state": { "type": "string" }, "tacacs_plus": { "type": "string" }, "ldap": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" } } }, "infini_fs": { "required": [ "name", "pool" ], "type": "object", "description": "This module creates, deletes or modifies filesystems on Infinibox.", "properties": { "state": { "type": "string" }, "name": { "type": "string" }, "pool": { "type": "string" }, "size": { "type": "string" } } }, "ironware_command": { "required": [ "commands" ], "type": "object", "description": "Sends arbitrary commands to a Brocade Ironware node and returns the results read from the device. This module includes a I(wait_for) argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.", "properties": { "retries": { "type": "integer" }, "commands": { "items": { "type": "string" }, "type": "array" }, "wait_for": { "items": { "type": "string" }, "type": "array" }, "match": { "type": "string" }, "interval": { "type": "integer" } } }, "mssql_db": { "required": [ "name" ], "type": "object", "description": "Add or remove MSSQL databases from a remote host.", "properties": { "autocommit": { "type": "boolean" }, "login_port": { "type": "integer" }, "name": { "type": "string" }, "login_user": { "type": "string" }, "login_host": { "type": "string" }, "state": { "type": "string" }, "login_password": { "type": "string" }, "target": { "type": "string" } } }, "bigip_sys_db": { "required": [ "key" ], "type": "object", "description": "Manage BIG-IP system database variables", "properties": { "state": { "type": "string" }, "value": { "type": "string" }, "key": { "type": "string" } } }, "ovirt_external_provider_facts": { "required": [ "type" ], "type": "object", "description": "Retrieve facts about one or more oVirt/RHV external providers.", "properties": { "type": { "type": "string" }, "name": { "type": "string" } } }, "nxos_mtu": { "required": [], "type": "object", "description": "Manages MTU settings on Nexus switch.", "properties": { "interface": { "type": "string" }, "state": { "type": "string" }, "sysmtu": { "type": "string" }, "mtu": { "type": "string" } } }, "netapp_e_hostgroup": { "required": [ "ssid", "api_password", "state", "api_username", "api_url" ], "type": "object", "description": "Create, update or destroy host groups on a NetApp E-Series storage array.", "properties": { "new_name": { "type": "string" }, "ssid": { "type": "string" }, "name": { "type": "string" }, "api_password": { "type": "string" }, "hosts:": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "api_username": { "type": "string" }, "validate_certs": { "type": "boolean" }, "id": { "type": "string" }, "api_url": { "type": "string" } } }, "ufw": { "required": [], "type": "object", "description": "Manage firewall with UFW.", "properties": { "comment": { "type": "string" }, "insert": { "type": "string" }, "direction": { "type": "string" }, "from_port": { "type": "string" }, "to_ip": { "type": "string" }, "name": { "type": "string" }, "proto": { "type": "string" }, "to_port": { "type": "string" }, "route": { "type": "string" }, "from_ip": { "type": "string" }, "rule": { "type": "string" }, "policy": { "type": "string" }, "state": { "type": "string" }, "interface": { "type": "string" }, "logging": { "type": "string" }, "delete": { "type": "string" }, "log": { "type": "string" } } }, "ce_acl_interface": { "required": [ "interface", "direction", "acl_name" ], "type": "object", "description": "Manages applying ACLs to interfaces on HUAWEI CloudEngine switches.", "properties": { "interface": { "type": "string" }, "direction": { "type": "string" }, "state": { "type": "string" }, "acl_name": { "type": "string" } } }, "katello": { "required": [ "username", "password", "params", "server_url", "entity" ], "type": "object", "description": "Allows the management of Katello resources inside your Foreman server.", "properties": { "username": { "type": "string" }, "password": { "type": "string" }, "params": { "type": "string" }, "server_url": { "type": "string" }, "entity": { "type": "string" } } }, "netscaler_gslb_site": { "required": [], "type": "object", "description": "Manage gslb site entities in Netscaler.", "properties": { "naptrreplacementsuffix": { "type": "string" }, "siteipaddress": { "type": "string" }, "metricexchange": { "type": "string" }, "nwmetricexchange": { "type": "string" }, "sitename": { "type": "string" }, "sitetype": { "type": "string" }, "sessionexchange": { "type": "string" }, "publicclip": { "type": "string" }, "publicip": { "type": "string" }, "parentsite": { "type": "string" }, "clip": { "type": "string" }, "triggermonitor": { "type": "string" } } }, "iam_cert": { "required": [ "name", "state" ], "type": "object", "description": "Allows for the management of server certificates", "properties": { "new_name": { "type": "string" }, "dup_ok": { "type": "boolean" }, "new_path": { "type": "string" }, "name": { "type": "string" }, "state": { "type": "string" }, "cert": { "type": "string" }, "key": { "type": "string" }, "path": { "type": "string" }, "cert_chain": { "type": "string" } } }, "aci_intf_policy_lldp": { "required": [ "receive_state", "lldp_policy" ], "type": "object", "description": "Manage LLDP interface policies on Cisco ACI fabrics.\nMore information from the internal APIC class I(lldp:IfPol) at U(https://developer.cisco.com/media/mim-ref/MO-lldpIfPol.html).", "properties": { "transmit_state": { "type": "string" }, "lldp_policy": { "type": "string" }, "receive_state": { "type": "string" }, "description": { "type": "string" }, "state": { "items": { "type": "string" }, "type": "array" } } }, "junos_logging": { "required": [], "type": "object", "description": "This module provides declarative management of logging on Juniper JUNOS devices.", "properties": { "files": { "type": "string" }, "name": { "type": "string" }, "facility": { "type": "string" }, "dest": { "type": "string" }, "level": { "type": "string" }, "active": { "type": "boolean" }, "state": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" }, "rotate_frequency": { "type": "string" }, "size": { "type": "string" } } }, "digital_ocean_tag": { "required": [ "name" ], "type": "object", "description": "Create and remove tag(s) to DigitalOcean resource.", "properties": { "state": { "type": "string" }, "api_token": { "type": "string" }, "name": { "type": "string" }, "resource_type": { "type": "string" }, "resource_id": { "type": "string" } } }, "zabbix_host": { "required": [ "host_name" ], "type": "object", "description": "This module allows you to create, modify and delete Zabbix host entries and associated group and template data.", "properties": { "status": { "type": "string" }, "link_templates": { "items": { "type": "string" }, "type": "array" }, "tls_psk": { "type": "string" }, "force": { "type": "string" }, "description": { "type": "string" }, "interfaces": { "items": { "type": "string" }, "type": "array" }, "tls_connect": { "type": "integer" }, "tls_accept": { "type": "integer" }, "tls_subject": { "type": "string" }, "visible_name": { "type": "string" }, "state": { "type": "string" }, "proxy": { "type": "string" }, "host_groups": { "items": { "type": "string" }, "type": "array" }, "inventory_zabbix": { "type": "string" }, "inventory_mode": { "type": "string" }, "tls_psk_identity": { "type": "string" }, "tls_issuer": { "type": "string" }, "host_name": { "type": "string" } } }, "docker_image_facts": { "required": [ "name" ], "type": "object", "description": "Provide one or more image names, and the module will inspect each, returning an array of inspection results.", "properties": { "name": { "items": { "type": "string" }, "type": "array" } } }, "enos_command": { "required": [ "commands" ], "type": "object", "description": "Sends arbitrary commands to an ENOS node and returns the results read from the device. The C(enos_command) module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.", "properties": { "retries": { "type": "integer" }, "commands": { "items": { "type": "string" }, "type": "array" }, "wait_for": { "items": { "type": "string" }, "type": "array" }, "match": { "type": "string" }, "interval": { "type": "integer" } } }, "profitbricks_nic": { "required": [ "datacenter", "lan", "name", "server" ], "type": "object", "description": "This module allows you to create or restore a volume snapshot. This module has a dependency on profitbricks >= 1.0.0", "properties": { "datacenter": { "type": "string" }, "lan": { "type": "string" }, "name": { "type": "string" }, "subscription_user": { "type": "string" }, "server": { "type": "string" }, "subscription_password": { "type": "string" }, "state": { "type": "string" }, "wait_timeout": { "type": "integer" }, "wait": { "type": "string" } } }, "ovirt_networks": { "required": [ "name" ], "type": "object", "description": "Module to manage logical networks in oVirt/RHV", "properties": { "comment": { "type": "string" }, "description": { "type": "string" }, "mtu": { "type": "string" }, "state": { "type": "string" }, "vm_network": { "type": "string" }, "data_center": { "type": "string" }, "clusters": { "items": { "type": "string" }, "type": "array" }, "vlan_tag": { "type": "string" }, "label": { "type": "string" }, "name": { "type": "string" } } }, "cs_account": { "required": [ "name" ], "type": "object", "description": "Create, disable, lock, enable and remove accounts.", "properties": { "username": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "account_type": { "type": "string" }, "name": { "type": "string" }, "network_domain": { "type": "string" }, "domain": { "type": "string" }, "state": { "type": "string" }, "poll_async": { "type": "boolean" }, "timezone": { "type": "string" }, "password": { "type": "string" }, "email": { "type": "string" } } }, "postgresql_lang": { "required": [ "lang" ], "type": "object", "description": "Adds, removes or changes procedural languages with a PostgreSQL database.\nThis module allows you to add a language, remote a language or change the trust relationship with a PostgreSQL database. The module can be used on the machine where executed or on a remote host.\nWhen removing a language from a database, it is possible that dependencies prevent the database from being removed. In that case, you can specify casade to automatically drop objects that depend on the language (such as functions in the language). In case the language can't be deleted because it is required by the database system, you can specify fail_on_drop=no to ignore the error.\nBe carefull when marking a language as trusted since this could be a potential security breach. Untrusted languages allow only users with the PostgreSQL superuser privilege to use this language to create new functions.", "properties": { "lang": { "type": "string" }, "cascade": { "type": "boolean" }, "login_user": { "type": "string" }, "login_host": { "type": "string" }, "db": { "type": "string" }, "force_trust": { "type": "boolean" }, "state": { "type": "string" }, "login_password": { "type": "string" }, "trust": { "type": "boolean" }, "fail_on_drop": { "type": "string" }, "port": { "type": "integer" } } }, "lldp": { "required": [], "type": "object", "description": "Reads data out of lldpctl", "properties": {} }, "netscaler_lb_monitor": { "required": [], "type": "object", "description": "Manage load balancing monitors.\nThis module is intended to run either on the ansible control node or a bastion (jumpserver) with access to the actual netscaler instance.", "properties": { "lasversion": { "type": "string" }, "Snmpoid": { "type": "string" }, "storefrontacctservice": { "type": "string" }, "firmwarerevision": { "type": "string" }, "query": { "type": "string" }, "authapplicationid": { "items": { "type": "string" }, "type": "array" }, "group": { "type": "string" }, "maxforwards": { "type": "string" }, "send": { "type": "string" }, "rtsprequest": { "type": "string" }, "trofscode": { "type": "string" }, "monitorname": { "type": "string" }, "units1": { "type": "string" }, "units3": { "type": "string" }, "units2": { "type": "string" }, "respcode": { "type": "string" }, "scriptargs": { "type": "string" }, "resptimeout": { "type": "string" }, "downtime": { "type": "string" }, "password": { "type": "string" }, "transparent": { "type": "string" }, "failureretries": { "type": "string" }, "radkey": { "type": "string" }, "productname": { "type": "string" }, "oraclesid": { "type": "string" }, "radaccounttype": { "type": "string" }, "binddn": { "type": "string" }, "domain": { "type": "string" }, "resptimeoutthresh": { "type": "string" }, "hostipaddress": { "type": "string" }, "sipuri": { "type": "string" }, "vendorspecificvendorid": { "type": "string" }, "scriptname": { "type": "string" }, "originrealm": { "type": "string" }, "radmsisdn": { "type": "string" }, "trofsstring": { "type": "string" }, "kcdaccount": { "type": "string" }, "filename": { "type": "string" }, "state": { "type": "string" }, "netprofile": { "type": "string" }, "alertretries": { "type": "string" }, "radaccountsession": { "type": "string" }, "recv": { "type": "string" }, "basedn": { "type": "string" }, "mssqlprotocolversion": { "type": "string" }, "dispatcherport": { "items": { "type": "string" }, "type": "array" }, "querytype": { "type": "string" }, "tosid": { "type": "string" }, "reverse": { "type": "string" }, "storename": { "type": "string" }, "lrtm": { "type": "string" }, "filter": { "type": "string" }, "evalrule": { "type": "string" }, "secure": { "type": "string" }, "radnasip": { "type": "string" }, "radnasid": { "type": "string" }, "ipaddress": { "type": "string" }, "storedb": { "items": { "type": "string" }, "type": "array" }, "vendorid": { "type": "string" }, "storefrontcheckbackendservices": { "type": "string" }, "tos": { "type": "string" }, "successretries": { "type": "string" }, "iptunnel": { "type": "string" }, "type": { "type": "string" }, "username": { "type": "string" }, "sipreguri": { "type": "string" }, "retries": { "type": "string" }, "snmpthreshold": { "type": "string" }, "validatecred": { "type": "string" }, "metrictable": { "type": "string" }, "acctapplicationid": { "items": { "type": "string" }, "type": "array" }, "vendorspecificacctapplicationids": { "items": { "type": "string" }, "type": "array" }, "secondarypassword": { "type": "string" }, "attribute": { "type": "string" }, "destip": { "type": "string" }, "snmpcommunity": { "type": "string" }, "units4": { "type": "string" }, "httprequest": { "type": "string" }, "logonpointname": { "type": "string" }, "radapn": { "type": "string" }, "hostname": { "type": "string" }, "radframedip": { "type": "string" }, "application": { "type": "string" }, "deviation": { "type": "string" }, "supportedvendorids": { "items": { "type": "string" }, "type": "array" }, "inbandsecurityid": { "type": "string" }, "sqlquery": { "type": "string" }, "action": { "type": "string" }, "sipmethod": { "type": "string" }, "customheaders": { "type": "string" }, "sitepath": { "type": "string" }, "destport": { "type": "string" }, "database": { "type": "string" }, "interval": { "type": "string" }, "originhost": { "type": "string" }, "vendorspecificauthapplicationids": { "items": { "type": "string" }, "type": "array" }, "snmpversion": { "type": "string" }, "dispatcherip": { "type": "string" } } }, "vertica_schema": { "required": [ "name" ], "type": "object", "description": "Adds or removes Vertica database schema and, optionally, roles with schema access privileges.\nA schema will not be removed until all the objects have been dropped.\nIn such a situation, if the module tries to remove the schema it will fail and only remove roles created for the schema if they have no dependencies.", "properties": { "create_roles": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "login_user": { "type": "string" }, "db": { "type": "string" }, "usage_roles": { "items": { "type": "string" }, "type": "array" }, "cluster": { "type": "string" }, "state": { "type": "string" }, "login_password": { "type": "string" }, "owner": { "type": "string" }, "port": { "type": "integer" } } }, "win_firewall_rule": { "required": [ "direction", "name", "action" ], "type": "object", "description": "Allows you to create/remove/update firewall rules.", "properties": { "remoteport": { "type": "string" }, "direction": { "type": "string" }, "protocol": { "type": "string" }, "name": { "type": "string" }, "service": { "type": "string" }, "enabled": { "type": "string" }, "profiles": { "type": "string" }, "localport": { "type": "string" }, "localip": { "type": "string" }, "state": { "type": "string" }, "program": { "type": "string" }, "remoteip": { "type": "string" }, "action": { "type": "string" }, "force": { "type": "string" }, "description": { "type": "string" } } }, "vmware_vm_shell": { "required": [ "vm_password", "vm_shell", "vm_username", "vm_id" ], "type": "object", "description": "Module allows user to run common system administration commands in the guest operating system.", "properties": { "datacenter": { "type": "string" }, "vm_password": { "type": "string" }, "vm_shell_cwd": { "type": "string" }, "vm_shell_args": { "type": "string" }, "vm_username": { "type": "string" }, "vm_shell_env": { "items": { "type": "string" }, "type": "array" }, "vm_shell": { "type": "string" }, "cluster": { "type": "string" }, "vm_id_type": { "type": "string" }, "folder": { "type": "string" }, "vm_id": { "type": "string" } } }, "netscaler_gslb_service": { "required": [], "type": "object", "description": "Manage gslb service entities in Netscaler.", "properties": { "comment": { "type": "string" }, "cnameentry": { "type": "string" }, "servername": { "type": "string" }, "servicename": { "type": "string" }, "sitepersistence": { "type": "string" }, "monitor_bindings": { "type": "string" }, "maxbandwidth": { "type": "string" }, "publicport": { "type": "string" }, "port": { "items": { "type": "string" }, "type": "array" }, "clttimeout": { "type": "string" }, "servicetype": { "type": "string" }, "monthreshold": { "type": "string" }, "maxaaausers": { "type": "string" }, "maxclient": { "type": "string" }, "sitename": { "type": "string" }, "publicip": { "type": "string" }, "appflowlog": { "type": "string" }, "hashid": { "type": "string" }, "ipaddress": { "type": "string" }, "downstateflush": { "type": "string" }, "cipheader": { "type": "string" }, "siteprefix": { "type": "string" }, "cip": { "type": "string" }, "healthmonitor": { "type": "string" } } }, "ios_vrf": { "required": [], "type": "object", "description": "This module provides declarative management of VRF definitions on Cisco IOS devices. It allows playbooks to manage individual or the entire VRF collection. It also supports purging VRF definitions from the configuration that are not explicitly defined.", "properties": { "delay": { "type": "integer" }, "description": { "type": "string" }, "interfaces": { "type": "string" }, "rd": { "type": "string" }, "purge": { "type": "boolean" }, "state": { "type": "string" }, "vrfs": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" } } }, "win_uri": { "required": [ "url" ], "type": "object", "description": "Interacts with FTP, HTTP and HTTPS web services.\nSupports Digest, Basic and WSSE HTTP authentication mechanisms.\nFor non-Windows targets, use the M(uri) module instead.", "properties": { "body": { "type": "string" }, "timeout": { "type": "integer" }, "headers": { "type": "string" }, "dest": { "type": "string" }, "status_code": { "items": { "type": "integer" }, "type": "array" }, "removes": { "type": "string" }, "use_basic_parsing": { "type": "string" }, "client_cert": { "type": "string" }, "creates": { "type": "string" }, "url": { "type": "string" }, "maximum_redirection": { "type": "integer" }, "content_type": { "type": "string" }, "follow_redirects": { "type": "string" }, "return_content": { "type": "string" }, "password": { "type": "string" }, "validate_certs": { "type": "string" }, "method": { "type": "string" }, "user": { "type": "string" } } }, "bzr": { "required": [ "dest", "name" ], "type": "object", "description": "Manage I(bzr) branches to deploy files or software.", "properties": { "dest": { "type": "string" }, "executable": { "type": "string" }, "version": { "type": "string" }, "force": { "type": "string" }, "name": { "type": "string" } } }, "rabbitmq_plugin": { "required": [ "names" ], "type": "object", "description": "Manage RabbitMQ plugins.", "properties": { "state": { "type": "string" }, "names": { "items": { "type": "string" }, "type": "array" }, "prefix": { "type": "string" }, "new_only": { "items": { "type": "string" }, "type": "array" } } }, "include_tasks": { "required": [], "type": "object", "description": "Includes a file with a list of tasks to be executed in the current playbook.", "properties": { "free-form": { "type": "string" } } }, "vmware_dvs_portgroup": { "required": [ "portgroup_name", "state", "num_ports", "vlan_id", "portgroup_type", "switch_name" ], "type": "object", "description": "Create or remove a Distributed vSwitch portgroup.", "properties": { "portgroup_name": { "type": "string" }, "port_policy": { "type": "string" }, "network_policy": { "type": "string" }, "state": { "type": "string" }, "num_ports": { "type": "string" }, "vlan_trunk": { "type": "boolean" }, "portgroup_type": { "type": "string" }, "switch_name": { "type": "string" }, "vlan_id": { "type": "string" } } }, "ec2_snapshot_copy": { "required": [ "source_region", "source_snapshot_id" ], "type": "object", "description": "Copies an EC2 Snapshot from a source region to a destination region.", "properties": { "description": { "type": "string" }, "tags": { "type": "string" }, "encrypted": { "type": "boolean" }, "kms_key_id": { "type": "string" }, "source_region": { "type": "string" }, "source_snapshot_id": { "type": "string" }, "wait": { "type": "string" } } }, "bigip_user": { "required": [ "username_credential" ], "type": "object", "description": "Manage user accounts and user attributes on a BIG-IP. Typically this module operates only on the REST API users and not the CLI users. There is one exception though and that is if you specify the C(username_credential) of C(root). When specifying C(root), you may only change the password. Your other parameters will be ignored in this case. Changing the C(root) password is not an idempotent operation. Therefore, it will change it every time this module attempts to change it.", "properties": { "update_password": { "type": "string" }, "shell": { "type": "string" }, "password_credential": { "type": "string" }, "partition_access": { "type": "string" }, "state": { "type": "string" }, "full_name": { "type": "string" }, "username_credential": { "type": "string" } } }, "vyos_user": { "required": [], "type": "object", "description": "This module provides declarative management of the local usernames configured on network devices. It allows playbooks to manage either individual usernames or the collection of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined.", "properties": { "update_password": { "type": "string" }, "configured_password": { "type": "string" }, "name": { "type": "string" }, "level": { "type": "string" }, "purge": { "type": "boolean" }, "state": { "type": "string" }, "full_name": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" } } }, "cs_project": { "required": [ "name" ], "type": "object", "description": "Create, update, suspend, activate and remove projects.", "properties": { "display_text": { "type": "string" }, "account": { "type": "string" }, "poll_async": { "type": "boolean" }, "name": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "domain": { "type": "string" }, "state": { "type": "string" } } }, "cs_pod": { "required": [ "name" ], "type": "object", "description": "Create, update, delete pods.", "properties": { "name": { "type": "string" }, "zone": { "type": "string" }, "state": { "type": "string" }, "id": { "type": "string" }, "netmask": { "type": "string" }, "end_ip": { "type": "string" }, "start_ip": { "type": "string" }, "gateway": { "type": "string" } } }, "cpanm": { "required": [], "type": "object", "description": "Manage Perl library dependencies.", "properties": { "executable": { "type": "string" }, "name": { "type": "string" }, "installdeps": { "type": "boolean" }, "system_lib": { "type": "boolean" }, "mirror_only": { "type": "boolean" }, "from_path": { "type": "string" }, "version": { "type": "boolean" }, "mirror": { "type": "boolean" }, "locallib": { "type": "boolean" }, "notest": { "type": "boolean" } } }, "clc_publicip": { "required": [ "server_ids" ], "type": "object", "description": "An Ansible module to add or delete public ip addresses on an existing server or servers in CenturyLink Cloud.", "properties": { "server_ids": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "protocol": { "items": { "type": "string" }, "type": "array" }, "ports": { "items": { "type": "string" }, "type": "array" }, "wait": { "type": "boolean" } } }, "clc_aa_policy": { "required": [ "location", "name" ], "type": "object", "description": "An Ansible module to Create or Delete Anti Affinity Policies at CenturyLink Cloud.", "properties": { "state": { "type": "string" }, "wait": { "type": "boolean" }, "location": { "type": "string" }, "name": { "type": "string" } } }, "azure_rm_virtualmachine_scaleset_facts": { "required": [], "type": "object", "description": "Get facts for a virtual machine scale set", "properties": { "name": { "type": "string" }, "resource_group": { "type": "string" } } }, "rabbitmq_exchange": { "required": [ "name" ], "type": "object", "description": "This module uses rabbitMQ Rest API to create/delete exchanges", "properties": { "login_port": { "type": "integer" }, "name": { "type": "string" }, "login_user": { "type": "string" }, "login_host": { "type": "string" }, "exchange_type": { "type": "string" }, "vhost": { "type": "string" }, "state": { "type": "string" }, "internal": { "type": "boolean" }, "arguments": { "type": "string" }, "auto_delete": { "type": "boolean" }, "login_password": { "type": "boolean" }, "durable": { "type": "boolean" } } }, "execute_lambda": { "required": [], "type": "object", "description": "This module executes AWS Lambda functions, allowing synchronous and asynchronous invocation.", "properties": { "name": { "type": "string" }, "dry_run": { "type": "boolean" }, "function_arn": { "type": "string" }, "tail_log": { "type": "boolean" }, "version_qualifier": { "type": "string" }, "payload": { "type": "string" }, "wait": { "type": "boolean" } } }, "aos_asn_pool": { "required": [ "session" ], "type": "object", "description": "Apstra AOS ASN Pool module let you manage your ASN Pool easily. You can create and delete ASN Pool by Name, ID or by using a JSON File. This module is idempotent and support the I(check) mode. It's using the AOS REST API.", "properties": { "content": { "type": "string" }, "name": { "type": "string" }, "ranges": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "session": { "type": "string" }, "id": { "type": "string" } } }, "dpkg_selections": { "required": [ "selection", "name" ], "type": "object", "description": "Change dpkg package selection state via --get-selections and --set-selections.", "properties": { "selection": { "type": "string" }, "name": { "type": "string" } } }, "digital_ocean_floating_ip": { "required": [ "oauth_token" ], "type": "object", "description": "Create/delete/assign a floating IP.", "properties": { "ip": { "type": "string" }, "state": { "type": "string" }, "oauth_token": { "type": "string" }, "region": { "type": "string" }, "droplet_id": { "type": "string" } } }, "clc_alert_policy": { "required": [ "alias" ], "type": "object", "description": "An Ansible module to Create or Delete Alert Policies at CenturyLink Cloud.", "properties": { "name": { "type": "string" }, "metric": { "type": "string" }, "id": { "type": "string" }, "alias": { "type": "string" }, "state": { "type": "string" }, "threshold": { "type": "string" }, "alert_recipients": { "items": { "type": "string" }, "type": "array" }, "duration": { "type": "string" } } }, "nxos_aaa_server_host": { "required": [ "server_type", "address" ], "type": "object", "description": "Manages AAA server host-specific configuration.", "properties": { "server_type": { "type": "string" }, "encrypt_type": { "type": "string" }, "state": { "type": "string" }, "auth_port": { "type": "string" }, "tacacs_port": { "type": "string" }, "host_timeout": { "type": "string" }, "key": { "type": "string" }, "address": { "type": "string" }, "acct_port": { "type": "string" } } }, "os_zone": { "required": [ "name" ], "type": "object", "description": "Manage OpenStack DNS zones. Zones can be created, deleted or updated. Only the I(email), I(description), I(ttl) and I(masters) values can be updated.", "properties": { "masters": { "type": "string" }, "description": { "type": "string" }, "availability_zone": { "type": "string" }, "state": { "type": "string" }, "ttl": { "type": "string" }, "zone_type": { "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" } } }, "ec2_instance_facts": { "required": [], "type": "object", "description": "Gather facts about ec2 instances in AWS", "properties": { "filters": { "type": "string" }, "instance_ids": { "type": "string" } } }, "gcp_target_proxy": { "required": [ "target_proxy_type", "target_proxy_name" ], "type": "object", "description": "Create, Update or Destroy a Target_Proxy. See U(https://cloud.google.com/compute/docs/load-balancing/http/target-proxies) for an overview. More details on the Target_Proxy API can be found at U(https://cloud.google.com/compute/docs/reference/latest/targetHttpProxies#resource-representations).", "properties": { "target_proxy_type": { "type": "string" }, "target_proxy_name": { "type": "string" }, "url_map_name": { "type": "string" } } }, "ec2_vol_facts": { "required": [], "type": "object", "description": "Gather facts about ec2 volumes in AWS", "properties": { "filters": { "type": "string" } } }, "ipa_sudocmdgroup": { "required": [ "cn" ], "type": "object", "description": "Add, modify or delete sudo command group within IPA server using IPA API.", "properties": { "state": { "type": "string" }, "cn": { "type": "string" }, "sudocmd": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" } } }, "nxos_ntp_auth": { "required": [ "key_id", "md5string" ], "type": "object", "description": "Manages NTP authentication.", "properties": { "auth_type": { "type": "string" }, "trusted_key": { "type": "boolean" }, "md5string": { "type": "string" }, "authentication": { "type": "string" }, "state": { "type": "string" }, "key_id": { "type": "string" } } }, "ovirt_host_networks": { "required": [ "name" ], "type": "object", "description": "Module to manage host networks in oVirt/RHV.", "properties": { "name": { "type": "string" }, "labels": { "items": { "type": "string" }, "type": "array" }, "check": { "type": "string" }, "state": { "type": "string" }, "interface": { "type": "string" }, "save": { "type": "string" }, "networks": { "items": { "type": "string" }, "type": "array" }, "bond": { "items": { "type": "string" }, "type": "array" } } }, "rax_meta": { "required": [], "type": "object", "description": "Manipulate metadata for Rackspace Cloud Servers", "properties": { "meta": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "address": { "type": "string" } } }, "svc": { "required": [ "name" ], "type": "object", "description": "Controls daemontools services on remote hosts using the svc utility.", "properties": { "name": { "type": "string" }, "downed": { "type": "string" }, "enabled": { "type": "string" }, "state": { "type": "string" }, "service_dir": { "type": "string" }, "service_src": { "type": "string" } } }, "dellos10_facts": { "required": [], "type": "object", "description": "Collects a base set of device facts from a remote device that is running OS10. This module prepends all of the base network fact keys with C(ansible_net_). The facts module always collects a base set of facts from the device and can enable or disable collection of additional facts.", "properties": { "gather_subset": { "items": { "type": "string" }, "type": "array" } } }, "dnsmadeeasy": { "required": [ "domain", "protocol", "autoFailover", "sensitivity", "contactList", "account_key", "port", "monitor", "failover", "maxEmails", "state", "systemDescription", "account_secret" ], "type": "object", "description": "Manages DNS records via the v2 REST API of the DNS Made Easy service. It handles records only; there is no manipulation of domains or monitor/account support yet. See: U(https://www.dnsmadeeasy.com/integration/restapi/)\n", "properties": { "httpFqdn": { "type": "string" }, "domain": { "type": "string" }, "protocol": { "type": "string" }, "autoFailover": { "type": "string" }, "sensitivity": { "type": "string" }, "contactList": { "items": { "type": "string" }, "type": "array" }, "account_key": { "type": "string" }, "record_type": { "type": "string" }, "port": { "type": "integer" }, "monitor": { "type": "string" }, "httpQueryString": { "type": "string" }, "state": { "type": "string" }, "systemDescription": { "type": "string" }, "httpFile": { "type": "string" }, "record_name": { "type": "string" }, "record_ttl": { "type": "integer" }, "account_secret": { "type": "string" }, "ip2": { "type": "string" }, "ip3": { "type": "string" }, "ip1": { "type": "string" }, "ip4": { "type": "string" }, "ip5": { "type": "string" }, "failover": { "type": "string" }, "maxEmails": { "items": { "type": "integer" }, "type": "array" }, "record_value": { "type": "string" }, "validate_certs": { "type": "string" } } }, "monit": { "required": [ "state", "name" ], "type": "object", "description": "Manage the state of a program monitored via I(Monit)", "properties": { "state": { "type": "string" }, "name": { "type": "string" }, "timeout": { "type": "integer" } } }, "nxos_udld": { "required": [], "type": "object", "description": "Manages UDLD global configuration params.", "properties": { "reset": { "type": "string" }, "msg_time": { "type": "string" }, "aggressive": { "type": "string" }, "state": { "type": "string" } } }, "ecs_cluster": { "required": [ "state", "name" ], "type": "object", "description": "Creates or terminates ecs clusters.", "properties": { "delay": { "type": "string" }, "state": { "type": "string" }, "repeat": { "type": "string" }, "name": { "type": "string" } } }, "ironware_facts": { "required": [], "type": "object", "description": "Collects a base set of device facts from a remote device that is running Ironware. This module prepends all of the base network fact keys with C(ansible_net_). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.", "properties": { "gather_subset": { "items": { "type": "string" }, "type": "array" } } }, "virt_pool": { "required": [], "type": "object", "description": "Manage I(libvirt) storage pools.", "properties": { "xml": { "type": "string" }, "name": { "type": "string" }, "uri": { "type": "string" }, "state": { "type": "string" }, "command": { "type": "string" }, "mode": { "type": "string" }, "autostart": { "type": "string" } } }, "infini_export_client": { "required": [ "export", "client" ], "type": "object", "description": "This module creates, deletes or modifys NFS client(s) for existing exports on Infinibox.", "properties": { "state": { "type": "string" }, "access_mode": { "type": "string" }, "export": { "type": "string" }, "no_root_squash": { "type": "boolean" }, "client": { "type": "string" } } }, "rabbitmq_parameter": { "required": [ "name", "component" ], "type": "object", "description": "Manage dynamic, cluster-wide parameters for RabbitMQ", "properties": { "node": { "type": "string" }, "name": { "type": "string" }, "component": { "type": "string" }, "value": { "type": "string" }, "vhost": { "type": "string" }, "state": { "type": "string" } } }, "openwrt_init": { "required": [ "name" ], "type": "object", "description": "Controls OpenWrt services on remote hosts.", "properties": { "pattern": { "type": "string" }, "state": { "type": "string" }, "enabled": { "type": "string" }, "name": { "type": "string" } } }, "smartos_image_facts": { "required": [], "type": "object", "description": "Retrieve facts about all installed images on SmartOS. Facts will be inserted to the ansible_facts key.", "properties": { "filters": { "items": { "type": "string" }, "type": "array" } } }, "ce_evpn_bgp": { "required": [ "bgp_instance" ], "type": "object", "description": "This module offers the ability to configure a BGP EVPN peer relationship on HUAWEI CloudEngine switches.", "properties": { "as_number": { "type": "string" }, "advertise_l2vpn_evpn": { "type": "string" }, "advertise_router_type": { "type": "string" }, "vpn_name": { "type": "string" }, "peer_group_name": { "type": "string" }, "state": { "type": "string" }, "bgp_instance": { "type": "string" }, "peer_enable": { "type": "string" }, "peer_address": { "type": "string" } } }, "include": { "required": [], "type": "object", "description": "Includes a file with a list of plays or tasks to be executed in the current playbook.\nFiles with a list of plays can only be included at the top level. Lists of tasks can only be included where tasks normally run (in play).\nBefore Ansible version 2.0, all includes were 'static' and were executed when the play was compiled.\nStatic includes are not subject to most directives. For example, loops or conditionals are applied instead to each inherited task.\nSince Ansible 2.0, task includes are dynamic and behave more like real tasks. This means they can be looped, skipped and use variables from any source. Ansible tries to auto detect this, but you can use the `static` directive (which was added in Ansible 2.1) to bypass autodetection.\nThis module is also supported for Windows targets.", "properties": { "free-form": { "type": "string" } } }, "junos_lldp_interface": { "required": [], "type": "object", "description": "This module provides declarative management of LLDP interfaces configuration on Juniper JUNOS network devices.", "properties": { "active": { "type": "boolean" }, "state": { "type": "string" }, "name": { "type": "string" } } }, "git_config": { "required": [], "type": "object", "description": "The C(git_config) module changes git configuration by invoking 'git config'. This is needed if you don't want to use M(template) for the entire git config file (e.g. because you need to change just C(user.email) in /etc/.git/config). Solutions involving M(command) are cumbersone or don't work correctly in check mode.", "properties": { "repo": { "type": "string" }, "scope": { "items": { "type": "string" }, "type": "array" }, "list_all": { "items": { "type": "boolean" }, "type": "array" }, "name": { "type": "string" }, "value": { "type": "string" } } }, "nxos_vxlan_vtep": { "required": [ "interface" ], "type": "object", "description": "Manages VXLAN Network Virtualization Endpoint (NVE) overlay interface that terminates VXLAN tunnels.", "properties": { "description": { "type": "string" }, "host_reachability": { "type": "string" }, "source_interface_hold_down_time": { "type": "string" }, "state": { "type": "string" }, "shutdown": { "type": "boolean" }, "source_interface": { "type": "string" }, "interface": { "type": "string" } } }, "elasticache_parameter_group": { "required": [ "state", "name" ], "type": "object", "description": "Manage cache security groups in Amazon Elasticache.\nReturns information about the specified cache cluster.", "properties": { "group_family": { "type": "string" }, "state": { "type": "string" }, "values": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } } }, "postgresql_schema": { "required": [ "name" ], "type": "object", "description": "Add or remove PostgreSQL schema from a remote host.", "properties": { "name": { "type": "string" }, "database": { "type": "string" }, "login_user": { "type": "string" }, "login_host": { "type": "string" }, "login_unix_socket": { "type": "string" }, "state": { "type": "string" }, "login_password": { "type": "string" }, "owner": { "type": "string" }, "port": { "type": "integer" } } }, "aci_taboo_contract": { "required": [ "taboo_contract", "tenant" ], "type": "object", "description": "Manage taboo contracts on Cisco ACI fabrics.\nMore information from the internal APIC class I(vz:BrCP) at U(https://developer.cisco.com/media/mim-ref/MO-vzBrCP.html).", "properties": { "scope": { "type": "string" }, "taboo_contract": { "type": "string" }, "description": { "type": "string" }, "tenant": { "type": "string" }, "state": { "items": { "type": "string" }, "type": "array" } } }, "import_tasks": { "required": [], "type": "object", "description": "Imports a list of tasks to be added to the current playbook for subsequent execution.", "properties": { "free-form": { "type": "string" } } }, "ovirt_affinity_label_facts": { "required": [], "type": "object", "description": "Retrieve facts about one or more oVirt/RHV affinity labels.", "properties": { "host": { "items": { "type": "string" }, "type": "array" }, "name": { "items": { "type": "string" }, "type": "array" }, "vm": { "items": { "type": "string" }, "type": "array" } } }, "net_linkagg": { "required": [ "name", "members" ], "type": "object", "description": "This module provides declarative management of link aggregation groups on network devices.", "properties": { "name": { "type": "string" }, "purge": { "type": "boolean" }, "state": { "type": "string" }, "mode": { "type": "boolean" }, "members": { "items": { "type": "string" }, "type": "array" }, "min_links": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" } } }, "ce_snmp_contact": { "required": [ "contact" ], "type": "object", "description": "Manages SNMP contact configurations on HUAWEI CloudEngine switches.", "properties": { "state": { "type": "string" }, "contact": { "type": "string" } } }, "ec2_group_facts": { "required": [], "type": "object", "description": "Gather facts about ec2 security groups in AWS.", "properties": { "filters": { "type": "string" } } }, "rundeck_acl_policy": { "required": [ "name", "url", "token" ], "type": "object", "description": "Create, update and remove Rundeck ACL policies through HTTP API.", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "token": { "type": "string" }, "project": { "type": "string" }, "state": { "type": "string" }, "policy": { "type": "string" }, "api_version": { "type": "integer" } } }, "netscaler_save_config": { "required": [ "nsip", "nitro_user", "nitro_pass" ], "type": "object", "description": "This module uncoditionally saves the configuration on the target netscaler node.\nThis module does not support check mode.\nThis module is intended to run either on the ansible control node or a bastion (jumpserver) with access to the actual netscaler instance.", "properties": { "nitro_protocol": { "type": "string" }, "nsip": { "type": "string" }, "nitro_user": { "type": "string" }, "nitro_pass": { "type": "string" }, "validate_certs": { "type": "string" }, "nitro_timeout": { "type": "integer" } } }, "cron": { "required": [], "type": "object", "description": "Use this module to manage crontab and environment variables entries. This module allows you to create environment variables and named crontab entries, update, or delete them.\nWhen crontab jobs are managed: the module includes one line with the description of the crontab entry C(\"#Ansible: \") corresponding to the \"name\" passed to the module, which is used by future ansible/module calls to find/check the state. The \"name\" parameter should be unique, and changing the \"name\" value will result in a new cron task being created (or a different one being removed).\nWhen environment variables are managed: no comment line is added, but, when the module needs to find/check the state, it uses the \"name\" parameter to find the environment variable definition line.\nWhen using symbols such as %, they must be properly escaped.", "properties": { "name": { "type": "string" }, "insertbefore": { "type": "string" }, "state": { "type": "string" }, "cron_file": { "type": "string" }, "reboot": { "type": "string" }, "hour": { "type": "string" }, "month": { "type": "string" }, "disabled": { "type": "string" }, "job": { "type": "string" }, "special_time": { "type": "string" }, "user": { "type": "string" }, "env": { "type": "string" }, "insertafter": { "type": "string" }, "backup": { "type": "string" }, "day": { "type": "string" }, "minute": { "type": "string" }, "weekday": { "type": "string" } } }, "rax_cdb": { "required": [], "type": "object", "description": "creates / deletes or resize a Rackspace Cloud Databases instance and optionally waits for it to be 'running'. The name option needs to be unique since it's used to identify the instance.", "properties": { "cdb_type": { "type": "string" }, "name": { "type": "string" }, "cdb_version": { "type": "string" }, "volume": { "type": "integer" }, "state": { "type": "string" }, "wait_timeout": { "type": "integer" }, "flavor": { "type": "integer" }, "wait": { "type": "string" } } }, "nxos_switchport": { "required": [ "interface" ], "type": "object", "description": "Manages Layer 2 interfaces", "properties": { "native_vlan": { "type": "string" }, "access_vlan": { "type": "string" }, "trunk_vlans": { "type": "string" }, "state": { "type": "string" }, "trunk_allowed_vlans": { "type": "string" }, "mode": { "type": "string" }, "interface": { "type": "string" } } }, "eos_logging": { "required": [], "type": "object", "description": "This module provides declarative management of logging on Arista Eos devices.", "properties": { "name": { "type": "string" }, "facility": { "type": "string" }, "dest": { "type": "string" }, "level": { "type": "string" }, "state": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" }, "size": { "type": "string" } } }, "bigip_gtm_wide_ip": { "required": [ "lb_method", "name" ], "type": "object", "description": "Manages F5 BIG-IP GTM wide ip.", "properties": { "state": { "type": "string" }, "lb_method": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" }, "partition": { "type": "string" } } }, "jboss": { "required": [ "deployment" ], "type": "object", "description": "Deploy applications to JBoss standalone using the filesystem", "properties": { "src": { "type": "string" }, "deploy_path": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "deployment": { "type": "string" } } }, "avi_systemconfiguration": { "required": [], "type": "object", "description": "This module is used to configure SystemConfiguration object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "email_configuration": { "type": "string" }, "docker_mode": { "type": "string" }, "snmp_configuration": { "type": "string" }, "uuid": { "type": "string" }, "dns_configuration": { "type": "string" }, "proxy_configuration": { "type": "string" }, "ssh_hmacs": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "global_tenant_config": { "type": "string" }, "url": { "type": "string" }, "linux_configuration": { "type": "string" }, "portal_configuration": { "type": "string" }, "dns_virtualservice_refs": { "type": "string" }, "admin_auth_configuration": { "type": "string" }, "mgmt_ip_access_control": { "type": "string" }, "ssh_ciphers": { "items": { "type": "string" }, "type": "array" }, "ntp_configuration": { "type": "string" } } }, "oneview_san_manager": { "required": [ "data" ], "type": "object", "description": "Provides an interface to manage SAN Manager resources. Can create, update, or delete.", "properties": { "state": { "type": "string" }, "data": { "items": { "type": "string" }, "type": "array" } } }, "circonus_annotation": { "required": [ "category", "description", "title", "api_key" ], "type": "object", "description": "Create an annotation event with a given category, title and description. Optionally start, end or durations can be provided", "properties": { "category": { "type": "string" }, "description": { "type": "string" }, "title": { "type": "string" }, "stop": { "type": "string" }, "start": { "type": "string" }, "duration": { "type": "integer" }, "api_key": { "type": "string" } } }, "cs_cluster": { "required": [ "name" ], "type": "object", "description": "Create, update and remove clusters.", "properties": { "username": { "type": "string" }, "guest_vswitch_type": { "type": "string" }, "ovm3_cluster": { "type": "string" }, "ovm3_pool": { "type": "string" }, "zone": { "type": "string" }, "vms_username": { "type": "string" }, "url": { "type": "string" }, "hypervisor": { "type": "string" }, "ovm3_vip": { "type": "string" }, "vms_ip_address": { "type": "string" }, "name": { "type": "string" }, "state": { "type": "string" }, "public_vswitch_name": { "type": "string" }, "cluster_type": { "type": "string" }, "public_vswitch_type": { "type": "string" }, "pod": { "type": "string" }, "password": { "type": "string" }, "vms_password": { "type": "string" }, "guest_vswitch_name": { "type": "string" } } }, "junos_vlan": { "required": [ "name", "vlan_id" ], "type": "object", "description": "This module provides declarative management of VLANs on Juniper JUNOS network devices.", "properties": { "name": { "type": "string" }, "interfaces": { "items": { "type": "string" }, "type": "array" }, "active": { "type": "boolean" }, "state": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" }, "vlan_id": { "type": "string" }, "description": { "type": "string" } } }, "nxos_snmp_community": { "required": [ "state", "community" ], "type": "object", "description": "Manages SNMP community configuration.", "properties": { "access": { "type": "string" }, "state": { "type": "string" }, "group": { "type": "string" }, "community": { "type": "string" }, "acl": { "type": "integer" } } }, "ec2_ami_search": { "required": [ "release", "distro" ], "type": "object", "description": "Look up the most recent AMI on AWS for a given operating system.\nReturns C(ami), C(aki), C(ari), C(serial), C(tag)\nIf there is no AKI or ARI associated with an image, these will be C(null).\nOnly supports images from cloud-images.ubuntu.com\nExample output: C({\"ami\": \"ami-69f5a900\", \"changed\": false, \"aki\": \"aki-88aa75e1\", \"tag\": \"release\", \"ari\": null, \"serial\": \"20131024\"})", "properties": { "stream": { "type": "string" }, "virt": { "type": "string" }, "region": { "type": "string" }, "release": { "type": "string" }, "arch": { "type": "string" }, "store": { "type": "string" }, "distro": { "type": "string" } } }, "sl_vm": { "required": [ "disks", "cpus", "memory" ], "type": "object", "description": "Creates or cancels SoftLayer instances.\nWhen created, optionally waits for it to be 'running'.", "properties": { "domain": { "type": "string" }, "dedicated": { "type": "string" }, "private": { "type": "string" }, "private_vlan": { "type": "string" }, "hourly": { "type": "string" }, "ssh_keys": { "items": { "type": "string" }, "type": "array" }, "hostname": { "type": "string" }, "os_code": { "type": "string" }, "wait_time": { "type": "integer" }, "state": { "type": "string" }, "post_uri": { "type": "string" }, "memory": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "cpus": { "type": "string" }, "image_id": { "type": "string" }, "nic_speed": { "type": "integer" }, "public_vlan": { "type": "string" }, "wait": { "type": "string" }, "datacenter": { "type": "string" }, "disks": { "items": { "type": "string" }, "type": "array" }, "instance_id": { "type": "string" }, "local_disk": { "type": "string" } } }, "na_cdot_qtree": { "required": [ "vserver", "state", "name" ], "type": "object", "description": "Create or destroy Qtrees.", "properties": { "vserver": { "type": "string" }, "state": { "type": "string" }, "name": { "type": "string" }, "flexvol_name": { "type": "string" } } }, "rds_param_group": { "required": [ "name", "state" ], "type": "object", "description": "Creates, modifies, and deletes RDS parameter groups. This module has a dependency on python-boto >= 2.5.", "properties": { "engine": { "type": "string" }, "name": { "type": "string" }, "tags": { "type": "string" }, "purge_tags": { "items": { "type": "string" }, "type": "array" }, "immediate": { "type": "string" }, "state": { "type": "string" }, "params": { "type": "string" }, "description": { "type": "string" } } }, "xenserver_facts": { "required": [], "type": "object", "description": "Reads data out of XenAPI, can be used instead of multiple xe commands.", "properties": {} }, "junos_linkagg": { "required": [ "members", "name" ], "type": "object", "description": "This module provides declarative management of link aggregation groups on Juniper JUNOS network devices.", "properties": { "description": { "type": "string" }, "device_count": { "type": "string" }, "active": { "type": "boolean" }, "state": { "type": "string" }, "mode": { "type": "boolean" }, "members": { "items": { "type": "string" }, "type": "array" }, "min_links": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" } } }, "vertica_configuration": { "required": [ "name", "value" ], "type": "object", "description": "Updates Vertica configuration parameters.", "properties": { "name": { "type": "string" }, "login_user": { "type": "string" }, "db": { "type": "string" }, "value": { "type": "string" }, "cluster": { "type": "string" }, "login_password": { "type": "string" }, "port": { "type": "integer" } } }, "nxos_system": { "required": [], "type": "object", "description": "This module provides declarative management of node system attributes on Cisco NXOS devices. It provides an option to configure host system parameters or remove those parameters from the device active configuration.", "properties": { "domain_search": { "items": { "type": "string" }, "type": "array" }, "hostname": { "type": "string" }, "system_mtu": { "type": "string" }, "domain_name": { "items": { "type": "string" }, "type": "array" }, "name_servers": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "domain_lookup": { "type": "string" } } }, "rds": { "required": [ "command", "region" ], "type": "object", "description": "Creates, deletes, or modifies rds instances. When creating an instance it can be either a new instance or a read-only replica of an existing instance. This module has a dependency on python-boto >= 2.5. The 'promote' command requires boto >= 2.18.0. Certain features such as tags rely on boto.rds2 (boto >= 2.26.0)", "properties": { "db_engine": { "type": "string" }, "force_failover": { "type": "string" }, "iops": { "type": "string" }, "backup_window": { "type": "string" }, "backup_retention": { "type": "string" }, "port": { "type": "string" }, "security_groups": { "items": { "type": "string" }, "type": "array" }, "size": { "type": "string" }, "aws_secret_key": { "type": "string" }, "subnet": { "type": "string" }, "vpc_security_groups": { "items": { "type": "string" }, "type": "array" }, "upgrade": { "type": "boolean" }, "zone": { "type": "string" }, "source_instance": { "type": "string" }, "parameter_group": { "type": "string" }, "snapshot": { "type": "string" }, "multi_zone": { "type": "string" }, "new_instance_name": { "type": "string" }, "username": { "type": "string" }, "tags": { "type": "string" }, "db_name": { "type": "string" }, "license_model": { "type": "string" }, "password": { "type": "string" }, "apply_immediately": { "type": "boolean" }, "wait": { "type": "string" }, "aws_access_key": { "type": "string" }, "character_set_name": { "type": "string" }, "region": { "type": "string" }, "option_group": { "type": "string" }, "engine_version": { "type": "string" }, "instance_name": { "type": "string" }, "instance_type": { "type": "string" }, "wait_timeout": { "type": "integer" }, "command": { "type": "string" }, "publicly_accessible": { "type": "string" }, "maint_window": { "type": "string" } } }, "ios_vlan": { "required": [ "interfaces", "vlan_id" ], "type": "object", "description": "This module provides declarative management of VLANs on Cisco IOS network devices.", "properties": { "delay": { "type": "integer" }, "name": { "type": "string" }, "interfaces": { "items": { "type": "string" }, "type": "array" }, "purge": { "type": "boolean" }, "state": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" }, "vlan_id": { "type": "string" } } }, "fetch": { "required": [ "dest", "src" ], "type": "object", "description": "This module works like M(copy), but in reverse. It is used for fetching files from remote machines and storing them locally in a file tree, organized by hostname.\nThis module is also supported for Windows targets.", "properties": { "dest": { "type": "string" }, "src": { "type": "string" }, "flat": { "type": "string" }, "fail_on_missing": { "type": "string" }, "validate_checksum": { "type": "string" } } }, "consul_kv": { "required": [ "value", "key" ], "type": "object", "description": "Allows the addition, modification and deletion of key/value entries in a consul cluster via the agent. The entire contents of the record, including the indices, flags and session are returned as 'value'.\nIf the key represents a prefix then Note that when a value is removed, the existing value if any is returned as part of the results.\nSee http://www.consul.io/docs/agent/http.html#kv for more details.", "properties": { "cas": { "type": "string" }, "recurse": { "type": "string" }, "state": { "type": "string" }, "value": { "type": "string" }, "token": { "type": "string" }, "session": { "type": "string" }, "flags": { "type": "string" }, "key": { "type": "string" }, "host": { "type": "string" }, "scheme": { "type": "string" }, "validate_certs": { "type": "string" }, "port": { "type": "integer" } } }, "win_psexec": { "required": [ "command" ], "type": "object", "description": "Run commands (remotely) through the PsExec service\nRun commands as another (domain) user (with elevated privileges)", "properties": { "username": { "type": "string" }, "limited": { "type": "string" }, "executable": { "type": "string" }, "chdir": { "type": "string" }, "nobanner": { "type": "string" }, "noprofile": { "type": "string" }, "system": { "type": "string" }, "elevated": { "type": "string" }, "priority": { "type": "string" }, "hostnames": { "type": "string" }, "command": { "type": "string" }, "timeout": { "type": "string" }, "wait": { "type": "string" }, "password": { "type": "string" }, "interactive": { "type": "string" } } }, "ejabberd_user": { "required": [ "username", "host" ], "type": "object", "description": "This module provides user management for ejabberd servers", "properties": { "username": { "type": "string" }, "host": { "type": "string" }, "password": { "type": "string" }, "logging": { "type": "boolean" }, "state": { "type": "string" } } }, "vmware_guest_snapshot": { "required": [ "datacenter", "state" ], "type": "object", "description": "Create virtual machines snapshots", "properties": { "datacenter": { "type": "string" }, "new_snapshot_name": { "type": "string" }, "uuid": { "type": "string" }, "quiesce": { "type": "string" }, "description": { "type": "string" }, "memory_dump": { "type": "string" }, "state": { "type": "string" }, "snapshot_name": { "type": "string" }, "name_match": { "type": "string" }, "remove_children": { "type": "string" }, "new_description": { "type": "string" }, "folder": { "type": "string" }, "name": { "type": "string" } } }, "hpilo_boot": { "required": [ "host" ], "type": "object", "description": "This module boots a system through its HP iLO interface. The boot media can be one of: cdrom, floppy, hdd, network or usb.\nThis module requires the hpilo python module.", "properties": { "force": { "type": "boolean" }, "media": { "type": "string" }, "image": { "type": "string" }, "ssl_version": { "type": "string" }, "state": { "type": "string" }, "host": { "type": "string" }, "login": { "type": "string" }, "password": { "type": "string" } } }, "pn_vrouterlbif": { "required": [ "pn_interface_ip", "state", "pn_vrouter_name" ], "type": "object", "description": "Execute vrouter-loopback-interface-add, vrouter-loopback-interface-remove commands.\nEach fabric, cluster, standalone switch, or virtual network (VNET) can provide its tenants with a virtual router (vRouter) service that forwards traffic between networks and implements Layer 3 protocols.", "properties": { "pn_vrouter_name": { "type": "string" }, "pn_clipassword": { "type": "string" }, "pn_cliusername": { "type": "string" }, "pn_interface_ip": { "type": "string" }, "state": { "type": "string" }, "pn_index": { "type": "string" }, "pn_cliswitch": { "type": "string" } } }, "avi_gslbgeodbprofile": { "required": [ "name" ], "type": "object", "description": "This module is used to configure GslbGeoDbProfile object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "uuid": { "type": "string" }, "url": { "type": "string" }, "description": { "type": "string" }, "tenant_ref": { "type": "string" }, "is_federated": { "type": "string" }, "state": { "type": "string" }, "entries": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" } } }, "nxos_evpn_global": { "required": [ "nv_overlay_evpn" ], "type": "object", "description": "Handles the EVPN control plane for VXLAN.", "properties": { "nv_overlay_evpn": { "type": "string" } } }, "apt": { "required": [], "type": "object", "description": "Manages I(apt) packages (such as for Debian/Ubuntu).", "properties": { "dpkg_options": { "items": { "type": "string" }, "type": "array" }, "autoremove": { "type": "boolean" }, "force": { "type": "string" }, "force_apt_get": { "type": "boolean" }, "install_recommends": { "type": "string" }, "autoclean": { "type": "boolean" }, "name": { "items": { "type": "string" }, "type": "array" }, "purge": { "type": "boolean" }, "allow_unauthenticated": { "type": "string" }, "state": { "type": "string" }, "upgrade": { "type": "string" }, "update_cache": { "type": "boolean" }, "deb": { "type": "string" }, "only_upgrade": { "type": "boolean" }, "default_release": { "type": "string" }, "cache_valid_time": { "type": "integer" } } }, "apk": { "required": [], "type": "object", "description": "Manages I(apk) packages for Alpine Linux.", "properties": { "available": { "type": "boolean" }, "upgrade": { "type": "boolean" }, "name": { "type": "string" }, "repository": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "update_cache": { "type": "boolean" } } }, "win_iis_webapplication": { "required": [ "name", "site" ], "type": "object", "description": "Creates, removes, and configures IIS web applications.", "properties": { "state": { "type": "string" }, "application_pool": { "type": "string" }, "name": { "type": "string" }, "physical_path": { "type": "string" }, "site": { "type": "string" } } }, "composer": { "required": [], "type": "object", "description": "Composer is a tool for dependency management in PHP. It allows you to declare the dependent libraries your project needs and it will install them in your project for you.\n", "properties": { "executable": { "type": "string" }, "arguments": { "type": "string" }, "prefer_dist": { "type": "boolean" }, "no_plugins": { "type": "boolean" }, "optimize_autoloader": { "type": "boolean" }, "working_dir": { "type": "string" }, "command": { "type": "string" }, "global_command": { "type": "boolean" }, "ignore_platform_reqs": { "type": "boolean" }, "no_dev": { "type": "boolean" }, "no_scripts": { "type": "boolean" }, "prefer_source": { "type": "boolean" } } }, "pubnub_blocks": { "required": [ "name", "keyset", "application" ], "type": "object", "description": "This module allows Ansible to interface with the PubNub BLOCKS infrastructure by providing the following operations: create / remove, start / stop and rename for blocks and create / modify / remove for event handlers", "properties": { "account": { "type": "string" }, "name": { "type": "string" }, "application": { "type": "string" }, "validate_certs": { "type": "boolean" }, "cache": { "type": "string" }, "keyset": { "type": "string" }, "state": { "type": "string" }, "password": { "type": "string" }, "changes": { "items": { "type": "string" }, "type": "array" }, "email": { "type": "string" }, "event_handlers": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" } } }, "bigip_command": { "required": [ "commands", "transport" ], "type": "object", "description": "Sends an arbitrary command to an BIG-IP node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.", "properties": { "retries": { "type": "integer" }, "commands": { "type": "string" }, "interval": { "type": "integer" }, "transport": { "type": "string" }, "wait_for": { "type": "string" }, "match": { "type": "string" } } }, "avi_stringgroup": { "required": [ "name", "type" ], "type": "object", "description": "This module is used to configure StringGroup object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "description": { "type": "string" }, "url": { "type": "string" }, "tenant_ref": { "type": "string" }, "uuid": { "type": "string" }, "state": { "type": "string" }, "kv": { "type": "string" }, "type": { "type": "string" }, "name": { "type": "string" } } }, "win_say": { "required": [], "type": "object", "description": "Uses .NET libraries to convert text to speech and optionally play .wav sounds. Audio Service needs to be running and some kind of speakers or headphones need to be attached to the windows target(s) for the speech to be audible.", "properties": { "start_sound_path": { "type": "string" }, "msg_file": { "type": "string" }, "end_sound_path": { "type": "string" }, "msg": { "type": "string" }, "voice": { "type": "string" }, "speech_speed": { "type": "integer" } } }, "os_nova_host_aggregate": { "required": [ "name" ], "type": "object", "description": "Create, update, or delete OpenStack host aggregates. If a aggregate with the supplied name already exists, it will be updated with the new name, new availability zone, new metadata and new list of hosts.", "properties": { "state": { "type": "string" }, "availability_zone": { "type": "string" }, "hosts": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "metadata": { "type": "string" } } }, "aruba_command": { "required": [ "commands" ], "type": "object", "description": "Sends arbitrary commands to an aruba node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.\nThis module does not support running commands in configuration mode. Please use M(aruba_config) to configure Aruba devices.", "properties": { "retries": { "type": "integer" }, "commands": { "items": { "type": "string" }, "type": "array" }, "wait_for": { "items": { "type": "string" }, "type": "array" }, "match": { "type": "string" }, "interval": { "type": "integer" } } }, "os_security_group_rule": { "required": [ "security_group" ], "type": "object", "description": "Add or Remove rule from an existing security group", "properties": { "direction": { "type": "string" }, "protocol": { "type": "string" }, "availability_zone": { "type": "string" }, "remote_ip_prefix": { "type": "string" }, "port_range_max": { "type": "string" }, "state": { "type": "string" }, "port_range_min": { "type": "string" }, "ethertype": { "type": "string" }, "security_group": { "type": "string" }, "remote_group": { "type": "string" } } }, "vmware_vm_facts": { "required": [], "type": "object", "description": "Return basic facts pertaining to a vSphere virtual machine guest.", "properties": {} }, "avi_pool": { "required": [ "name" ], "type": "object", "description": "This module is used to configure Pool object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "lb_algorithm": { "items": { "type": "string" }, "type": "array" }, "use_service_port": { "type": "string" }, "rewrite_host_header_to_server_name": { "type": "string" }, "host_check_enabled": { "type": "string" }, "tenant_ref": { "type": "string" }, "rewrite_host_header_to_sni": { "type": "string" }, "capacity_estimation": { "type": "string" }, "max_conn_rate_per_server": { "type": "string" }, "servers": { "items": { "type": "string" }, "type": "array" }, "fewest_tasks_feedback_delay": { "type": "string" }, "server_auto_scale": { "type": "string" }, "east_west": { "type": "string" }, "capacity_estimation_ttfb_thresh": { "type": "string" }, "ab_pool": { "type": "string" }, "fail_action": { "type": "string" }, "placement_networks": { "type": "string" }, "networks": { "type": "string" }, "lb_algorithm_hash": { "type": "string" }, "sni_enabled": { "type": "string" }, "server_name": { "type": "string" }, "lb_algorithm_consistent_hash_hdr": { "type": "string" }, "cloud_ref": { "type": "string" }, "lb_algorithm_core_nonaffinity": { "type": "string" }, "autoscale_policy_ref": { "type": "string" }, "ssl_profile_ref": { "type": "string" }, "ipaddrgroup_ref": { "items": { "type": "string" }, "type": "array" }, "apic_epg_name": { "type": "string" }, "server_reselect": { "type": "string" }, "state": { "type": "string" }, "nsx_securitygroup": { "items": { "type": "string" }, "type": "array" }, "a_pool": { "type": "string" }, "pki_profile_ref": { "type": "string" }, "vrf_ref": { "type": "string" }, "application_persistence_profile_ref": { "type": "string" }, "inline_health_monitor": { "type": "string" }, "default_server_port": { "type": "string" }, "description": { "type": "string" }, "request_queue_depth": { "type": "string" }, "graceful_disable_timeout": { "type": "string" }, "domain_name": { "items": { "type": "string" }, "type": "array" }, "ab_priority": { "type": "string" }, "server_count": { "type": "string" }, "ssl_key_and_certificate_ref": { "type": "string" }, "uuid": { "type": "string" }, "request_queue_enabled": { "type": "string" }, "name": { "type": "string" }, "max_concurrent_connections_per_server": { "type": "string" }, "url": { "type": "string" }, "autoscale_launch_config_ref": { "type": "string" }, "enabled": { "type": "string" }, "autoscale_networks": { "type": "string" }, "health_monitor_refs": { "items": { "type": "string" }, "type": "array" }, "connection_ramp_duration": { "type": "string" }, "cloud_config_cksum": { "type": "string" }, "external_autoscale_groups": { "type": "string" }, "created_by": { "type": "string" }, "prst_hdr_name": { "type": "string" } } }, "ec2_remote_facts": { "required": [], "type": "object", "description": "Gather facts about ec2 instances in AWS", "properties": { "filters": { "type": "string" } } }, "os_keypair": { "required": [ "name" ], "type": "object", "description": "Add or Remove key pair from OpenStack", "properties": { "public_key": { "type": "string" }, "state": { "type": "string" }, "public_key_file": { "type": "string" }, "name": { "type": "string" }, "availability_zone": { "type": "string" } } }, "ec2_vpc_route_table_facts": { "required": [], "type": "object", "description": "Gather facts about ec2 VPC route tables in AWS", "properties": { "filters": { "type": "string" } } }, "eos_config": { "required": [], "type": "object", "description": "Arista EOS configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with EOS configuration sections in a deterministic way. This module works with either CLI or eAPI transports.", "properties": { "intended_config": { "type": "string" }, "src": { "type": "string" }, "save_when": { "type": "string" }, "force": { "type": "boolean" }, "after": { "type": "string" }, "lines": { "type": "string" }, "diff_against": { "type": "string" }, "replace": { "type": "string" }, "running_config": { "type": "string" }, "defaults": { "type": "boolean" }, "before": { "type": "string" }, "parents": { "type": "string" }, "save": { "type": "boolean" }, "backup": { "type": "boolean" }, "match": { "type": "string" }, "diff_ignore_lines": { "items": { "type": "string" }, "type": "array" } } }, "os_group": { "required": [ "name" ], "type": "object", "description": "Manage OpenStack Identity Groups. Groups can be created, deleted or updated. Only the I(description) value can be updated.", "properties": { "state": { "type": "string" }, "availability_zone": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "domain_id": { "type": "string" } } }, "ce_ntp_auth": { "required": [ "key_id" ], "type": "object", "description": "Manages NTP authentication configuration on HUAWEI CloudEngine switches.", "properties": { "auth_type": { "type": "string" }, "auth_pwd": { "type": "string" }, "trusted_key": { "type": "string" }, "auth_mode": { "type": "string" }, "state": { "type": "string" }, "key_id": { "type": "string" }, "authentication": { "type": "string" } } }, "win_file_version": { "required": [ "path" ], "type": "object", "description": "Get DLL or EXE file build version\nchange state alway be false", "properties": { "path": { "type": "string" } } }, "dellos6_command": { "required": [ "commands" ], "type": "object", "description": "Sends arbitrary commands to a Dell OS6 node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.\nThis module does not support running commands in configuration mode. Please use M(dellos6_config) to configure Dell OS6 devices.", "properties": { "retries": { "type": "integer" }, "commands": { "items": { "type": "string" }, "type": "array" }, "wait_for": { "items": { "type": "string" }, "type": "array" }, "interval": { "type": "integer" } } }, "ec2_tag": { "required": [ "resource", "tags" ], "type": "object", "description": "Creates, removes and lists tags from any EC2 resource. The resource is referenced by its resource id (e.g. an instance being i-XXXXXXX). It is designed to be used with complex args (tags), see the examples. This module has a dependency on python-boto.", "properties": { "state": { "items": { "type": "string" }, "type": "array" }, "resource": { "type": "string" }, "tags": { "type": "string" } } }, "rds_subnet_group": { "required": [ "state", "name" ], "type": "object", "description": "Creates, modifies, and deletes RDS database subnet groups. This module has a dependency on python-boto >= 2.5.", "properties": { "subnets": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } } }, "enos_facts": { "required": [], "type": "object", "description": "Collects a base set of device facts from a remote Lenovo device running on ENOS. This module prepends all of the base network fact keys with C(ansible_net_). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.", "properties": { "gather_subset": { "items": { "type": "string" }, "type": "array" } } }, "nxos_banner": { "required": [ "banner" ], "type": "object", "description": "This will configure both exec and motd banners on remote devices running Cisco NXOS. It allows playbooks to add or remote banner text from the active running configuration.", "properties": { "text": { "type": "string" }, "state": { "type": "string" }, "banner": { "type": "string" } } }, "github_release": { "required": [ "repo", "user", "action" ], "type": "object", "description": "Fetch metadata about GitHub Releases", "properties": { "body": { "type": "string" }, "target": { "type": "string" }, "repo": { "type": "string" }, "token": { "type": "string" }, "tag": { "type": "string" }, "draft": { "type": "boolean" }, "user": { "type": "string" }, "action": { "type": "string" }, "prerelease": { "type": "boolean" }, "password": { "type": "string" }, "name": { "type": "string" } } }, "cloudtrail": { "required": [ "name", "state" ], "type": "object", "description": "Creates, deletes, or updates CloudTrail configuration. Ensures logging is also enabled.", "properties": { "enable_log_file_validation": { "type": "boolean" }, "kms_key_id": { "type": "string" }, "name": { "type": "string" }, "cloudwatch_logs_role_arn": { "items": { "type": "string" }, "type": "array" }, "include_global_events": { "type": "boolean" }, "cloudwatch_logs_log_group_arn": { "type": "string" }, "s3_bucket_name": { "type": "string" }, "is_multi_region_trail": { "type": "boolean" }, "state": { "type": "string" }, "sns_topic_name": { "type": "string" }, "s3_key_prefix": { "type": "string" }, "enable_logging": { "type": "boolean" }, "tags": { "type": "string" } } }, "netapp_e_volume_copy": { "required": [ "api_url", "api_password", "state", "api_username" ], "type": "object", "description": "Create and delete snapshots images on volume groups for NetApp E-series storage arrays.", "properties": { "create_copy_pair_if_does_not_exist": { "type": "boolean" }, "search_volume_id": { "type": "string" }, "api_url": { "type": "string" }, "source_volume_id": { "type": "string" }, "api_password": { "type": "string" }, "state": { "type": "string" }, "volume_copy_pair_id": { "type": "string" }, "destination_volume_id": { "type": "string" }, "api_username": { "type": "string" }, "start_stop_copy": { "type": "string" }, "validate_certs": { "type": "boolean" } } }, "lxd_container": { "required": [ "name" ], "type": "object", "description": "Management of LXD containers", "properties": { "name": { "type": "string" }, "wait_for_ipv4_addresses": { "type": "boolean" }, "url": { "type": "string" }, "trust_password": { "type": "string" }, "cert_file": { "type": "string" }, "ephemeral": { "type": "string" }, "devices": { "type": "string" }, "source": { "type": "string" }, "state": { "type": "string" }, "architecture": { "type": "string" }, "timeout": { "type": "integer" }, "key_file": { "type": "string" }, "config": { "type": "string" }, "force_stop": { "type": "boolean" } } }, "ce_link_status": { "required": [ "interface" ], "type": "object", "description": "Get interface link status on HUAWEI CloudEngine switches.", "properties": { "interface": { "type": "string" } } }, "gce": { "required": [ "zone" ], "type": "object", "description": "Creates or terminates Google Compute Engine (GCE) instances. See U(https://cloud.google.com/compute) for an overview. Full install/configuration instructions for the gce* modules can be found in the comments of ansible/test/gce_tests.py.", "properties": { "num_instances": { "type": "string" }, "ip_forward": { "type": "string" }, "image": { "type": "string" }, "service_account_permissions": { "type": "string" }, "pem_file": { "type": "string" }, "network": { "type": "string" }, "zone": { "items": { "type": "string" }, "type": "array" }, "service_account_email": { "type": "string" }, "persistent_boot_disk": { "type": "string" }, "disk_auto_delete": { "type": "string" }, "state": { "type": "string" }, "image_family": { "type": "string" }, "project_id": { "type": "string" }, "instance_names": { "items": { "type": "string" }, "type": "array" }, "metadata": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "preemptible": { "type": "string" }, "machine_type": { "type": "string" }, "disk_size": { "type": "integer" }, "name": { "type": "string" }, "external_ip": { "type": "string" }, "disks": { "items": { "type": "string" }, "type": "array" }, "external_projects": { "items": { "type": "string" }, "type": "array" }, "credentials_file": { "type": "string" }, "subnetwork": { "type": "string" } } }, "portage": { "required": [], "type": "object", "description": "Manages Gentoo packages", "properties": { "state": { "type": "string" }, "nodeps": { "type": "boolean" }, "getbinpkg": { "type": "boolean" }, "onlydeps": { "type": "boolean" }, "newuse": { "type": "boolean" }, "package": { "type": "string" }, "oneshot": { "type": "boolean" }, "update": { "type": "boolean" }, "deep": { "type": "boolean" }, "sync": { "type": "string" }, "changed_use": { "type": "boolean" }, "keepgoing": { "type": "boolean" }, "loadavg": { "type": "string" }, "usepkgonly": { "type": "boolean" }, "depclean": { "type": "boolean" }, "jobs": { "type": "string" }, "noreplace": { "type": "boolean" }, "quiet": { "type": "boolean" }, "verbose": { "type": "boolean" } } }, "pkgin": { "required": [], "type": "object", "description": "The standard package manager for SmartOS, but also usable on NetBSD or any OS that uses C(pkgsrc). (Home: U(http://pkgin.net/))", "properties": { "upgrade": { "type": "boolean" }, "force": { "type": "boolean" }, "name": { "type": "string" }, "full_upgrade": { "type": "boolean" }, "state": { "type": "string" }, "update_cache": { "type": "boolean" }, "clean": { "type": "boolean" } } }, "netapp_e_storagepool": { "required": [ "name", "raid_level", "state" ], "type": "object", "description": "Create or remove disk groups and disk pools for NetApp E-series storage arrays.", "properties": { "criteria_size_unit": { "type": "string" }, "criteria_drive_require_fde": { "type": "string" }, "criteria_min_usable_capacity": { "type": "string" }, "name": { "type": "string" }, "reserve_drive_count": { "type": "string" }, "secure_pool": { "type": "string" }, "raid_level": { "type": "string" }, "criteria_drive_min_size": { "type": "string" }, "state": { "type": "string" }, "remove_volumes": { "type": "boolean" }, "criteria_drive_type": { "type": "string" }, "criteria_drive_count": { "type": "string" }, "criteria_drive_interface_type": { "type": "string" }, "erase_secured_drives": { "type": "string" } } }, "aws_waf_facts": { "required": [], "type": "object", "description": "Retrieve facts for WAF ACLs, Rule , Conditions and Filters.", "properties": { "name": { "type": "string" } } }, "ec2_customer_gateway": { "required": [ "ip_address", "name" ], "type": "object", "description": "Manage an AWS customer gateway", "properties": { "state": { "type": "string" }, "ip_address": { "type": "string" }, "routing": { "type": "string" }, "name": { "type": "string" }, "bgp_asn": { "type": "string" } } }, "async_status": { "required": [ "jid" ], "type": "object", "description": "This module gets the status of an asynchronous task.\nThis module is also supported for Windows targets.", "properties": { "jid": { "type": "string" }, "mode": { "type": "string" } } }, "npm": { "required": [], "type": "object", "description": "Manage node.js packages with Node Package Manager (npm)", "properties": { "executable": { "type": "string" }, "name": { "type": "string" }, "global": { "type": "boolean" }, "ignore_scripts": { "type": "boolean" }, "state": { "type": "string" }, "production": { "type": "boolean" }, "registry": { "type": "string" }, "version": { "type": "string" }, "path": { "type": "string" } } }, "atomic_container": { "required": [ "state", "name", "image", "backend", "mode" ], "type": "object", "description": "Manage the containers on the atomic host platform\nAllows to manage the lifecycle of a container on the atomic host platform", "properties": { "name": { "type": "string" }, "image": { "type": "string" }, "state": { "type": "string" }, "values": { "type": "string" }, "mode": { "type": "string" }, "rootfs": { "type": "string" }, "backend": { "type": "string" } } }, "win_disk_image": { "required": [ "image_path" ], "type": "object", "description": "Manages mount behavior for a specified ISO, VHD, or VHDX image on a Windows host. When C(state) is C(present), the image will be mounted under a system-assigned drive letter, which will be returned in the C(mount_path) value of the module result. Requires Windows 8+ or Windows Server 2012+.", "properties": { "state": { "type": "string" }, "image_path": { "type": "string" } } }, "os_object": { "required": [ "container" ], "type": "object", "description": "Create or Delete objects and containers from OpenStack", "properties": { "container": { "type": "string" }, "name": { "type": "string" }, "availability_zone": { "type": "string" }, "filename": { "type": "string" }, "state": { "type": "string" }, "container_access": { "type": "string" } } }, "azure_rm_resourcegroup": { "required": [ "name" ], "type": "object", "description": "Create, update and delete a resource group.", "properties": { "state": { "type": "string" }, "force": { "type": "boolean" }, "location": { "type": "string" }, "name": { "type": "string" } } }, "nxos_portchannel": { "required": [ "group" ], "type": "object", "description": "Manages port-channel specific configuration parameters.", "properties": { "group": { "type": "string" }, "state": { "type": "string" }, "mode": { "type": "boolean" }, "members": { "items": { "type": "string" }, "type": "array" }, "min_links": { "type": "string" }, "force": { "type": "boolean" } } }, "avi_serviceengine": { "required": [], "type": "object", "description": "This module is used to configure ServiceEngine object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "container_mode": { "type": "string" }, "controller_created": { "type": "string" }, "uuid": { "type": "string" }, "mgmt_vnic": { "type": "string" }, "cloud_ref": { "type": "string" }, "hypervisor": { "type": "string" }, "se_group_ref": { "type": "string" }, "enable_state": { "type": "string" }, "tenant_ref": { "type": "string" }, "container_type": { "type": "string" }, "host_ref": { "type": "string" }, "url": { "type": "string" }, "state": { "type": "string" }, "availability_zone": { "type": "string" }, "controller_ip": { "type": "string" }, "flavor": { "type": "string" }, "data_vnics": { "items": { "type": "string" }, "type": "array" }, "resources": { "type": "string" }, "name": { "type": "string" } } }, "azure_rm_managed_disk_facts": { "required": [], "type": "object", "description": "Get facts for a specific managed disk or all managed disks.", "properties": { "name": { "type": "string" }, "resource_group": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } } }, "cloudflare_dns": { "required": [ "account_email", "account_api_token", "zone" ], "type": "object", "description": "Manages dns records via the Cloudflare API, see the docs: U(https://api.cloudflare.com/)", "properties": { "solo": { "type": "string" }, "account_email": { "type": "string" }, "weight": { "type": "string" }, "proto": { "type": "string" }, "proxied": { "type": "boolean" }, "value": { "type": "string" }, "priority": { "type": "string" }, "record": { "type": "string" }, "state": { "type": "string" }, "service": { "type": "string" }, "timeout": { "type": "integer" }, "ttl": { "type": "string" }, "zone": { "type": "string" }, "type": { "type": "string" }, "port": { "type": "string" }, "account_api_token": { "type": "string" } } }, "clc_blueprint_package": { "required": [ "server_ids", "package_id" ], "type": "object", "description": "An Ansible module to deploy blue print package on a set of servers in CenturyLink Cloud.", "properties": { "server_ids": { "items": { "type": "string" }, "type": "array" }, "package_id": { "type": "string" }, "wait": { "type": "boolean" }, "state": { "type": "string" }, "package_params": { "type": "string" } } }, "manageiq_policies": { "required": [ "resource_name", "resource_type" ], "type": "object", "description": "The manageiq_policies module supports adding and deleting policy_profiles in ManageIQ.", "properties": { "state": { "items": { "type": "string" }, "type": "array" }, "resource_name": { "type": "string" }, "policy_profiles": { "items": { "type": "string" }, "type": "array" }, "resource_type": { "type": "string" } } }, "jira": { "required": [ "username", "operation", "password", "uri" ], "type": "object", "description": "Create and modify issues in a JIRA instance.", "properties": { "username": { "type": "string" }, "comment": { "type": "string" }, "description": { "type": "string" }, "fields": { "type": "string" }, "outwardissue": { "type": "string" }, "uri": { "type": "string" }, "summary": { "type": "string" }, "project": { "type": "string" }, "assignee": { "type": "string" }, "inwardissue": { "type": "string" }, "status": { "type": "string" }, "timeout": { "type": "integer" }, "issuetype": { "type": "string" }, "linktype": { "type": "string" }, "operation": { "type": "string" }, "password": { "type": "string" }, "issue": { "type": "string" } } }, "nxos_config": { "required": [], "type": "object", "description": "Cisco NXOS configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with NXOS configuration sections in a deterministic way. This module works with either CLI or NXAPI transports.", "properties": { "intended_config": { "type": "string" }, "src": { "type": "string" }, "save_when": { "type": "string" }, "force": { "type": "boolean" }, "after": { "type": "string" }, "lines": { "type": "string" }, "diff_against": { "type": "string" }, "replace": { "type": "string" }, "running_config": { "type": "string" }, "defaults": { "type": "boolean" }, "before": { "type": "string" }, "parents": { "type": "string" }, "save": { "type": "boolean" }, "backup": { "type": "boolean" }, "match": { "type": "string" }, "diff_ignore_lines": { "items": { "type": "string" }, "type": "array" } } }, "na_cdot_volume": { "required": [ "name", "vserver", "state" ], "type": "object", "description": "Create or destroy volumes on NetApp cDOT", "properties": { "name": { "type": "string" }, "size_unit": { "type": "string" }, "vserver": { "type": "string" }, "state": { "type": "string" }, "online": { "type": "string" }, "infinite": { "type": "string" }, "aggregate_name": { "type": "string" }, "size": { "type": "string" } } }, "ecs_ecr": { "required": [ "name" ], "type": "object", "description": "Manage Elastic Container Registry repositories", "properties": { "name": { "type": "string" }, "delete_policy": { "type": "boolean" }, "force_set_policy": { "type": "boolean" }, "state": { "type": "string" }, "policy": { "type": "string" }, "registry_id": { "type": "string" } } }, "aos_blueprint": { "required": [ "session" ], "type": "object", "description": "Apstra AOS Blueprint module let you manage your Blueprint easily. You can create create and delete Blueprint by Name or ID. You can also use it to retrieve all data from a blueprint. This module is idempotent and support the I(check) mode. It's using the AOS REST API.", "properties": { "name": { "type": "string" }, "state": { "type": "string" }, "session": { "type": "string" }, "reference_arch": { "type": "string" }, "timeout": { "type": "integer" }, "id": { "type": "string" }, "template": { "type": "string" } } }, "cs_vpn_gateway": { "required": [ "vpc" ], "type": "object", "description": "Creates and removes VPN site-to-site gateways.", "properties": { "account": { "type": "string" }, "poll_async": { "type": "boolean" }, "zone": { "type": "string" }, "domain": { "type": "string" }, "project": { "type": "string" }, "state": { "type": "string" }, "vpc": { "type": "string" } } }, "cs_instance_nic": { "required": [ "network", "vm" ], "type": "object", "description": "Add and remove nic to and from network", "properties": { "domain": { "type": "string" }, "poll_async": { "type": "boolean" }, "network": { "type": "string" }, "zone": { "type": "string" }, "account": { "type": "string" }, "vm": { "type": "string" }, "project": { "type": "string" }, "state": { "type": "string" }, "vpc": { "type": "string" }, "ip_address": { "type": "string" } } }, "cs_host": { "required": [ "name" ], "type": "object", "description": "Create, update and remove hosts.", "properties": { "username": { "type": "string" }, "name": { "type": "string" }, "zone": { "type": "string" }, "host_tags": { "type": "string" }, "url": { "type": "string" }, "hypervisor": { "type": "string" }, "cluster": { "type": "string" }, "state": { "type": "string" }, "pod": { "type": "string" }, "password": { "type": "string" }, "allocation_state": { "type": "string" } } }, "netapp_e_flashcache": { "required": [ "ssid", "api_password", "state", "api_username", "api_url", "name" ], "type": "object", "description": "Create or remove SSD caches on a NetApp E-Series storage array.", "properties": { "cache_size_min": { "type": "string" }, "ssid": { "type": "string" }, "name": { "type": "string" }, "api_password": { "type": "string" }, "io_type": { "type": "string" }, "size_unit": { "type": "string" }, "disk_count": { "type": "string" }, "state": { "type": "string" }, "api_username": { "type": "string" }, "validate_certs": { "type": "boolean" }, "api_url": { "type": "string" } } }, "webfaction_app": { "required": [ "name", "login_password", "type", "login_name" ], "type": "object", "description": "Add or remove applications on a Webfaction host. Further documentation at http://github.com/quentinsf/ansible-webfaction.", "properties": { "name": { "type": "string" }, "login_name": { "type": "string" }, "machine": { "type": "string" }, "state": { "type": "string" }, "autostart": { "type": "string" }, "login_password": { "type": "string" }, "type": { "items": { "type": "string" }, "type": "array" }, "port_open": { "type": "boolean" }, "extra_info": { "type": "string" } } }, "net_interface": { "required": [ "name" ], "type": "object", "description": "This module provides declarative management of Interfaces on network devices.", "properties": { "delay": { "type": "integer" }, "name": { "type": "string" }, "duplex": { "type": "string" }, "enabled": { "type": "string" }, "mtu": { "type": "string" }, "rx_rate": { "type": "string" }, "purge": { "type": "boolean" }, "state": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" }, "speed": { "type": "string" }, "tx_rate": { "type": "string" }, "description": { "type": "string" } } }, "mqtt": { "required": [ "topic", "payload" ], "type": "object", "description": "Publish a message on an MQTT topic.", "properties": { "username": { "type": "string" }, "certfile": { "type": "string" }, "payload": { "type": "string" }, "server": { "type": "string" }, "topic": { "type": "string" }, "client_id": { "type": "string" }, "ca_certs": { "type": "string" }, "retain": { "type": "boolean" }, "password": { "type": "string" }, "keyfile": { "type": "string" }, "port": { "type": "integer" }, "qos": { "type": "integer" } } }, "iam_server_certificate_facts": { "required": [ "name" ], "type": "object", "description": "Retrieve the attributes of a server certificate", "properties": { "name": { "type": "string" } } }, "ce_rollback": { "required": [ "action" ], "type": "object", "description": "This module offers the ability to set a configuration checkpoint file or rollback to a configuration checkpoint file on HUAWEI CloudEngine switches.", "properties": { "commit_id": { "type": "string" }, "last": { "type": "string" }, "filename": { "type": "string" }, "label": { "type": "string" }, "action": { "type": "string" }, "oldest": { "type": "string" } } }, "ovirt_vmpools": { "required": [ "name" ], "type": "object", "description": "Module to manage VM pools in oVirt/RHV.", "properties": { "name": { "type": "string" }, "vm_per_user": { "type": "string" }, "cluster": { "type": "string" }, "state": { "type": "string" }, "prestarted": { "type": "string" }, "template": { "type": "string" }, "vm_count": { "type": "string" }, "type": { "type": "string" }, "description": { "type": "string" } } }, "openssl_certificate": { "required": [ "path", "provider" ], "type": "object", "description": "This module allows one to (re)generate OpenSSL certificates. It implements a notion of provider (ie. C(selfsigned), C(acme), C(assertonly)) for your certificate. The 'assertonly' provider is intended for use cases where one is only interested in checking properties of a supplied certificate. Many properties that can be specified in this module are for validation of an existing or newly generated certificate. The proper place to specify them, if you want to receive a certificate with these properties is a CSR (Certificate Signing Request). It uses the pyOpenSSL python library to interact with OpenSSL.", "properties": { "privatekey_passphrase": { "type": "string" }, "subject_alt_name_strict": { "type": "boolean" }, "force": { "type": "boolean" }, "csr_path": { "type": "string" }, "extended_key_usage_strict": { "type": "boolean" }, "key_usage": { "type": "string" }, "invalid_at": { "type": "string" }, "not_before": { "type": "string" }, "subject": { "type": "string" }, "selfsigned_version": { "type": "integer" }, "has_expired": { "type": "boolean" }, "state": { "type": "string" }, "version": { "type": "string" }, "provider": { "type": "string" }, "selfsigned_digest": { "type": "string" }, "key_usage_strict": { "type": "boolean" }, "subject_alt_name": { "type": "string" }, "selfsigned_not_after": { "type": "string" }, "acme_challenge_path": { "type": "string" }, "privatekey_path": { "type": "string" }, "path": { "type": "string" }, "extended_key_usage": { "type": "string" }, "issuer": { "type": "string" }, "not_after": { "type": "string" }, "signature_algorithms": { "items": { "type": "string" }, "type": "array" }, "selfsigned_not_before": { "type": "string" }, "acme_accountkey": { "type": "string" }, "valid_in": { "type": "string" }, "valid_at": { "type": "string" } } }, "dellos9_command": { "required": [ "commands" ], "type": "object", "description": "Sends arbitrary commands to a Dell OS9 node and returns the results read from the device. This module includes an argument that will cause the module to wait for a specific condition before returning or timing out if the condition is not met.\nThis module does not support running commands in configuration mode. Please use M(dellos9_config) to configure Dell OS9 devices.", "properties": { "retries": { "type": "integer" }, "commands": { "items": { "type": "string" }, "type": "array" }, "wait_for": { "items": { "type": "string" }, "type": "array" }, "interval": { "type": "integer" } } }, "openbsd_pkg": { "required": [ "name" ], "type": "object", "description": "Manage packages on OpenBSD using the pkg tools.", "properties": { "ports_dir": { "type": "string" }, "state": { "type": "string" }, "build": { "type": "string" }, "clean": { "items": { "type": "string" }, "type": "array" }, "quick": { "type": "string" }, "name": { "items": { "type": "string" }, "type": "array" } } }, "bigip_snat_pool": { "required": [ "name" ], "type": "object", "description": "Manage SNAT pools on a BIG-IP.", "properties": { "state": { "type": "string" }, "partition": { "type": "string" }, "name": { "type": "string" }, "members": { "items": { "type": "string" }, "type": "array" } } }, "iosxr_facts": { "required": [], "type": "object", "description": "Collects a base set of device facts from a remote device that is running IOS XR. This module prepends all of the base network fact keys with C(ansible_net_). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.", "properties": { "gather_subset": { "items": { "type": "string" }, "type": "array" } } }, "bigip_iapplx_package": { "required": [], "type": "object", "description": "Manages Javascript iApp packages on a BIG-IP. This module will allow you to deploy iAppLX packages to the BIG-IP and manage their lifecycle.", "properties": { "state": { "type": "string" }, "package": { "type": "string" } } }, "os_nova_flavor": { "required": [ "name" ], "type": "object", "description": "Add or remove flavors from OpenStack.", "properties": { "flavorid": { "type": "string" }, "name": { "type": "string" }, "availability_zone": { "type": "string" }, "ram": { "type": "string" }, "ephemeral": { "type": "integer" }, "vcpus": { "type": "string" }, "state": { "type": "string" }, "extra_specs": { "type": "string" }, "swap": { "type": "integer" }, "rxtx_factor": { "type": "number" }, "is_public": { "type": "boolean" }, "disk": { "type": "string" } } }, "udm_dns_zone": { "required": [ "zone", "type" ], "type": "object", "description": "This module allows to manage dns zones on a univention corporate server (UCS). It uses the python API of the UCS to create a new object or edit it.", "properties": { "retry": { "type": "integer" }, "zone": { "type": "string" }, "interfaces": { "items": { "type": "string" }, "type": "array" }, "refresh": { "type": "integer" }, "state": { "type": "string" }, "contact": { "type": "string" }, "expire": { "type": "integer" }, "ttl": { "type": "integer" }, "nameserver": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" }, "mx": { "items": { "type": "string" }, "type": "array" } } }, "win_reg_stat": { "required": [ "path" ], "type": "object", "description": "Like M(win_file), M(win_reg_stat) will return whether the key/property exists.\nIt also returns the sub keys and properties of the key specified.\nIf specifying a property name through I(property), it will return the information specific for that property.", "properties": { "path": { "type": "string" }, "name": { "type": "string" } } }, "win_acl_inheritance": { "required": [ "path" ], "type": "object", "description": "Change ACL (Access Control List) inheritance and optionally copy inherited ACE's (Access Control Entry) to dedicated ACE's or vice versa.", "properties": { "path": { "type": "string" }, "state": { "type": "string" }, "reorganize": { "type": "boolean" } } }, "azure_rm_securitygroup": { "required": [ "resource_group" ], "type": "object", "description": "Create, update or delete a network security group. A security group contains Access Control List (ACL) rules that allow or deny network traffic to subnets or individual network interfaces. A security group is created with a set of default security rules and an empty set of security rules. Shape traffic flow by adding rules to the empty set of security rules.", "properties": { "resource_group": { "type": "string" }, "purge_rules": { "type": "boolean" }, "rules": { "type": "string" }, "default_rules": { "type": "string" }, "purge_default_rules": { "type": "boolean" }, "state": { "type": "string" }, "location": { "type": "string" }, "name": { "type": "string" } } }, "ec2": { "required": [ "image", "instance_type" ], "type": "object", "description": "Creates or terminates ec2 instances.", "properties": { "kernel": { "type": "string" }, "image": { "type": "string" }, "user_data": { "type": "string" }, "termination_protection": { "type": "boolean" }, "private_ip": { "type": "string" }, "spot_type": { "type": "string" }, "id": { "type": "string" }, "source_dest_check": { "type": "boolean" }, "spot_wait_timeout": { "type": "integer" }, "monitoring": { "type": "boolean" }, "zone": { "type": "string" }, "exact_count": { "type": "string" }, "ebs_optimized": { "type": "string" }, "state": { "type": "string" }, "placement_group": { "type": "string" }, "spot_launch_group": { "type": "string" }, "key_name": { "type": "string" }, "ramdisk": { "type": "string" }, "count_tag": { "type": "string" }, "vpc_subnet_id": { "type": "string" }, "instance_ids": { "items": { "type": "string" }, "type": "array" }, "spot_price": { "type": "string" }, "tenancy": { "type": "string" }, "assign_public_ip": { "type": "boolean" }, "group": { "items": { "type": "string" }, "type": "array" }, "wait": { "type": "string" }, "count": { "type": "integer" }, "instance_profile_name": { "type": "string" }, "region": { "type": "string" }, "network_interfaces": { "items": { "type": "string" }, "type": "array" }, "instance_initiated_shutdown_behavior": { "type": "string" }, "instance_type": { "type": "string" }, "wait_timeout": { "type": "integer" }, "volumes": { "items": { "type": "string" }, "type": "array" }, "instance_tags": { "type": "string" }, "group_id": { "items": { "type": "string" }, "type": "array" } } }, "vca_fw": { "required": [ "fw_rules" ], "type": "object", "description": "Adds or removes firewall rules from a gateway in a vca environment", "properties": { "fw_rules": { "items": { "type": "boolean" }, "type": "array" } } }, "ordnance_facts": { "required": [], "type": "object", "description": "Collects a base set of device facts from an Ordnance Virtual router over SSH. This module prepends all of the base network fact keys with C(ansible_net_). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.", "properties": { "gather_subset": { "items": { "type": "string" }, "type": "array" } } }, "ce_vxlan_global": { "required": [], "type": "object", "description": "Manages global attributes of VXLAN and bridge domain on HUAWEI CloudEngine devices.", "properties": { "tunnel_mode_vxlan": { "type": "string" }, "nvo3_eth_trunk_hash": { "type": "string" }, "nvo3_prevent_loops": { "type": "string" }, "nvo3_acl_extend": { "type": "string" }, "bridge_domain_id": { "type": "string" }, "nvo3_gw_enhanced": { "type": "string" }, "state": { "type": "string" }, "nvo3_ecmp_hash": { "type": "string" }, "nvo3_service_extend": { "type": "string" } } }, "rax_queue": { "required": [], "type": "object", "description": "creates / deletes a Rackspace Public Cloud queue.", "properties": { "state": { "type": "string" }, "name": { "type": "string" } } }, "proxmox_template": { "required": [ "node", "api_host", "api_user" ], "type": "object", "description": "allows you to upload/delete templates in Proxmox VE cluster", "properties": { "node": { "type": "string" }, "src": { "type": "string" }, "force": { "type": "boolean" }, "api_host": { "type": "string" }, "api_user": { "type": "string" }, "storage": { "type": "string" }, "api_password": { "type": "string" }, "timeout": { "type": "integer" }, "state": { "type": "string" }, "content_type": { "type": "string" }, "validate_certs": { "type": "boolean" }, "template": { "type": "string" } } }, "docker_service": { "required": [], "type": "object", "description": "Consumes docker compose to start, shutdown and scale services.\nWorks with compose versions 1 and 2.\nCompose can be read from a docker-compose.yml (or .yaml) file or inline using the C(definition) option.\nSee the examples for more details.\nSupports check mode.", "properties": { "files": { "items": { "type": "string" }, "type": "array" }, "pull": { "type": "boolean" }, "project_name": { "type": "string" }, "nocache": { "type": "boolean" }, "project_src": { "type": "string" }, "hostname_check": { "type": "boolean" }, "recreate": { "type": "string" }, "restarted": { "type": "boolean" }, "debug": { "type": "boolean" }, "state": { "type": "string" }, "dependencies": { "type": "boolean" }, "remove_images": { "type": "string" }, "scale": { "type": "string" }, "services": { "type": "string" }, "stopped": { "type": "boolean" }, "definition": { "type": "string" }, "remove_volumes": { "type": "boolean" }, "build": { "type": "boolean" } } }, "nxos_ospf_vrf": { "required": [ "ospf" ], "type": "object", "description": "Manages a VRF for an OSPF router.", "properties": { "router_id": { "type": "string" }, "timer_throttle_lsa_max": { "type": "string" }, "timer_throttle_spf_max": { "type": "string" }, "passive_interface": { "type": "string" }, "timer_throttle_lsa_hold": { "type": "string" }, "default_metric": { "type": "string" }, "log_adjacency": { "type": "string" }, "timer_throttle_lsa_start": { "type": "string" }, "vrf": { "type": "string" }, "auto_cost": { "type": "string" }, "timer_throttle_spf_start": { "type": "string" }, "ospf": { "type": "string" }, "timer_throttle_spf_hold": { "type": "string" } } }, "os_image_facts": { "required": [ "image" ], "type": "object", "description": "Retrieve facts about a image image from OpenStack.", "properties": { "image": { "type": "string" }, "availability_zone": { "type": "string" } } }, "cnos_factory": { "required": [], "type": "object", "description": "This module allows you to reset a switch's startup configuration. The method provides a way to reset the startup configuration to its factory settings. This is helpful when you want to move the switch to another topology as a new network device. This module uses SSH to manage network device configuration. The results of the operation can be viewed in results directory. For more information about this module from Lenovo and customizing it usage for your use cases, please visit U(http://systemx.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.switchmgt.ansible.doc%2Fcnos_factory.html)", "properties": {} }, "vmware_vsan_cluster": { "required": [], "type": "object", "description": "This module can be used to configure VSAN clustering on an ESXi host", "properties": { "cluster_uuid": { "type": "string" } } }, "ovirt_permissions_facts": { "required": [ "authz_name" ], "type": "object", "description": "Retrieve facts about one or more oVirt/RHV permissions.", "properties": { "authz_name": { "type": "string" }, "namespace": { "type": "string" }, "user_name": { "type": "string" }, "group_name": { "type": "string" } } }, "librato_annotation": { "required": [ "links", "title", "api_key", "user" ], "type": "object", "description": "Create an annotation event on the given annotation stream :name. If the annotation stream does not exist, it will be created automatically", "properties": { "user": { "type": "string" }, "name": { "type": "string" }, "links": { "type": "string" }, "title": { "type": "string" }, "start_time": { "type": "string" }, "source": { "type": "string" }, "end_time": { "type": "string" }, "api_key": { "type": "string" }, "description": { "type": "string" } } }, "nxos_evpn_vni": { "required": [ "route_distinguisher", "vni" ], "type": "object", "description": "Manages Cisco Ethernet Virtual Private Network (EVPN) VXLAN Network Identifier (VNI) configurations of a Nexus device.", "properties": { "route_target_both": { "type": "string" }, "vni": { "type": "string" }, "state": { "type": "string" }, "route_distinguisher": { "type": "string" }, "route_target_import": { "type": "string" }, "route_target_export": { "type": "string" } } }, "na_cdot_user_role": { "required": [ "vserver", "state", "name", "command_directory_name" ], "type": "object", "description": "Create or destroy user roles", "properties": { "vserver": { "type": "string" }, "access_level": { "type": "string" }, "state": { "type": "string" }, "name": { "type": "string" }, "command_directory_name": { "type": "string" } } }, "s3_bucket": { "required": [ "name" ], "type": "object", "description": "Manage S3 buckets in AWS, Ceph, Walrus and FakeS3", "properties": { "force": { "type": "boolean" }, "name": { "type": "string" }, "tags": { "type": "string" }, "ceph": { "type": "string" }, "state": { "type": "string" }, "policy": { "type": "string" }, "s3_url": { "type": "string" }, "requester_pays": { "type": "boolean" }, "versioning": { "type": "string" } } }, "win_power_plan": { "required": [ "name" ], "type": "object", "description": "This module will change the power plan of a Windows system to the defined string.\nWindows defaults to C(balanced) which will cause CPU throttling. In some cases it can be preferable to change the mode to C(high performance) to increase CPU performance.", "properties": { "name": { "type": "string" } } }, "avi_webhook": { "required": [ "name" ], "type": "object", "description": "This module is used to configure Webhook object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "description": { "type": "string" }, "url": { "type": "string" }, "tenant_ref": { "type": "string" }, "uuid": { "type": "string" }, "verification_token": { "type": "string" }, "state": { "type": "string" }, "callback_url": { "type": "string" }, "name": { "type": "string" } } }, "clc_firewall_policy": { "required": [ "location", "source_account_alias" ], "type": "object", "description": "Create or delete or update firewall polices on Centurylink Cloud", "properties": { "destination_account_alias": { "type": "string" }, "destination": { "items": { "type": "string" }, "type": "array" }, "enabled": { "type": "boolean" }, "source": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "location": { "type": "string" }, "source_account_alias": { "type": "string" }, "wait": { "type": "boolean" }, "ports": { "items": { "type": "string" }, "type": "array" }, "firewall_policy_id": { "type": "string" } } }, "win_audit_rule": { "required": [ "user", "rights", "audit_flags", "path" ], "type": "object", "description": "Used to apply audit rules to files, folders or registry keys.\nOnce applied, it will begin recording the user who performed the operation defined into the Security Log in the Event viewer.\nThe behavior is designed to ignore inherited rules since those cannot be adjusted without first disabling the inheritance behavior. It will still print inherited rules in the output though for debugging purposes.", "properties": { "rights": { "items": { "type": "string" }, "type": "array" }, "audit_flags": { "items": { "type": "string" }, "type": "array" }, "propagation_flags": { "type": "string" }, "state": { "type": "string" }, "user": { "type": "string" }, "path": { "type": "string" }, "inheritance_flags": { "type": "string" } } }, "cnos_interface": { "required": [ "interfaceOption", "interfaceRange", "interfaceArg1" ], "type": "object", "description": "This module allows you to work with interface related configurations. The operators used are overloaded to ensure control over switch interface configurations. Apart from the regular device connection related attributes, there are seven interface arguments that will perform further configurations. They are interfaceArg1, interfaceArg2, interfaceArg3, interfaceArg4, interfaceArg5, interfaceArg6, and interfaceArg7. For more details on how to use these arguments, see [Overloaded Variables]. Interface configurations are taken care at six contexts in a regular CLI. They are 1. Interface Name - Configurations 2. Ethernet Interface - Configurations 3. Loopback Interface Configurations 4. Management Interface Configurations 5. Port Aggregation - Configurations 6. VLAN Configurations This module uses SSH to manage network device configuration. The results of the operation will be placed in a directory named 'results' that must be created by the user in their local directory to where the playbook is run. For more information about this module from Lenovo and customizing it usage for your use cases, please visit U(http://systemx.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.switchmgt.ansible.doc%2Fcnos_interface.html)", "properties": { "interfaceOption": { "type": "string" }, "interfaceRange": { "type": "string" }, "interfaceArg4": { "type": "string" }, "interfaceArg5": { "type": "string" }, "interfaceArg6": { "type": "string" }, "interfaceArg7": { "type": "string" }, "interfaceArg1": { "type": "string" }, "interfaceArg2": { "type": "string" }, "interfaceArg3": { "type": "string" } } }, "ec2_eip": { "required": [], "type": "object", "description": "This module can allocate or release an EIP.\nThis module can associate/disassociate an EIP with instances or network interfaces.", "properties": { "release_on_disassociation": { "type": "boolean" }, "reuse_existing_ip_allowed": { "type": "boolean" }, "allow_reassociation": { "type": "boolean" }, "public_ip": { "type": "string" }, "state": { "type": "string" }, "in_vpc": { "type": "boolean" }, "private_ip_address": { "type": "string" }, "device_id": { "type": "string" } } }, "netscaler_server": { "required": [], "type": "object", "description": "Manage server entities configuration.\nThis module is intended to run either on the ansible control node or a bastion (jumpserver) with access to the actual netscaler instance.", "properties": { "comment": { "type": "string" }, "domain": { "type": "string" }, "name": { "type": "string" }, "ipv6address": { "type": "boolean" }, "domainresolveretry": { "type": "integer" }, "translationmask": { "type": "string" }, "disabled": { "type": "boolean" }, "translationip": { "type": "string" }, "td": { "type": "string" }, "ipaddress": { "type": "string" } } }, "puppet": { "required": [], "type": "object", "description": "Runs I(puppet) agent or apply in a reliable manner.", "properties": { "logdest": { "type": "string" }, "execute": { "type": "string" }, "certname": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "puppetmaster": { "type": "string" }, "facter_basename": { "type": "string" }, "manifest": { "type": "string" }, "environment": { "type": "string" }, "timeout": { "type": "string" }, "facts": { "type": "string" }, "modulepath": { "type": "string" } } }, "cnos_vlag": { "required": [ "vlagArg1" ], "type": "object", "description": "This module allows you to work with virtual Link Aggregation Groups (vLAG) related configurations. The operators used are overloaded to ensure control over switch vLAG configurations. Apart from the regular device connection related attributes, there are four vLAG arguments which are overloaded variables that will perform further configurations. They are vlagArg1, vlagArg2, vlagArg3, and vlagArg4. For more details on how to use these arguments, see [Overloaded Variables]. This module uses SSH to manage network device configuration. The results of the operation will be placed in a directory named 'results' that must be created by the user in their local directory to where the playbook is run. For more information about this module from Lenovo and customizing it usage for your use cases, please visit U(http://systemx.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.switchmgt.ansible.doc%2Fcnos_vlag.html)", "properties": { "vlagArg2": { "type": "string" }, "vlagArg3": { "type": "string" }, "vlagArg1": { "type": "string" }, "vlagArg4": { "type": "string" } } }, "azure_rm_networkinterface": { "required": [ "name", "resource_group", "virtual_network_name", "subnet_name" ], "type": "object", "description": "Create, update or delete a network interface. When creating a network interface you must provide the name of an existing virtual network, the name of an existing subnet within the virtual network. A default security group and public IP address will be created automatically, or you can provide the name of an existing security group and public IP address. See the examples below for more details.", "properties": { "public_ip_address_name": { "type": "string" }, "name": { "type": "string" }, "resource_group": { "type": "string" }, "virtual_network_name": { "type": "string" }, "public_ip_allocation_method": { "type": "string" }, "security_group_name": { "type": "string" }, "public_ip": { "type": "boolean" }, "private_ip_allocation_method": { "type": "string" }, "state": { "type": "string" }, "subnet_name": { "type": "string" }, "location": { "type": "string" }, "private_ip_address": { "type": "string" }, "os_type": { "type": "string" }, "open_ports": { "items": { "type": "string" }, "type": "array" } } }, "cnos_vlan": { "required": [ "vlanArg1" ], "type": "object", "description": "This module allows you to work with VLAN related configurations. The operators used are overloaded to ensure control over switch VLAN configurations. The first level of VLAN configuration allows to set up the VLAN range, the VLAN tag persistence, a VLAN access map and access map filter. After passing this level, there are five VLAN arguments that will perform further configurations. They are vlanArg1, vlanArg2, vlanArg3, vlanArg4, and vlanArg5. The value of vlanArg1 will determine the way following arguments will be evaluated. For more details on how to use these arguments, see [Overloaded Variables]. This module uses SSH to manage network device configuration. The results of the operation will be placed in a directory named 'results' that must be created by the user in their local directory to where the playbook is run. For more information about this module from Lenovo and customizing it usage for your use cases, please visit U(http://systemx.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.switchmgt.ansible.doc%2Fcnos_vlan.html)", "properties": { "vlanArg5": { "type": "string" }, "vlanArg4": { "type": "string" }, "vlanArg3": { "type": "string" }, "vlanArg2": { "type": "string" }, "vlanArg1": { "type": "string" } } }, "proxysql_global_variables": { "required": [ "variable" ], "type": "object", "description": "The M(proxysql_global_variables) module gets or sets the proxysql global variables.", "properties": { "login_port": { "type": "integer" }, "config_file": { "type": "string" }, "login_user": { "type": "string" }, "login_host": { "type": "string" }, "save_to_disk": { "type": "boolean" }, "value": { "type": "string" }, "load_to_runtime": { "type": "boolean" }, "login_password": { "type": "string" }, "variable": { "type": "string" } } }, "dladm_vnic": { "required": [ "name", "link" ], "type": "object", "description": "Create or delete VNICs on Solaris/illumos systems.", "properties": { "temporary": { "type": "boolean" }, "name": { "type": "string" }, "vlan": { "type": "boolean" }, "state": { "type": "string" }, "mac": { "type": "boolean" }, "link": { "type": "string" } } }, "stacki_host": { "required": [ "name", "stacki_user", "stacki_endpoint", "stacki_password" ], "type": "object", "description": "Use this module to add or remove hosts to a stacki front-end via API.\nU(https://github.com/StackIQ/stacki)", "properties": { "prim_intf_ip": { "type": "string" }, "name": { "type": "string" }, "stacki_user": { "type": "string" }, "stacki_endpoint": { "type": "string" }, "prim_intf": { "type": "string" }, "force_install": { "type": "string" }, "stacki_password": { "type": "string" }, "prim_intf_mac": { "type": "string" } } }, "avi_pkiprofile": { "required": [ "name" ], "type": "object", "description": "This module is used to configure PKIProfile object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "crls": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "url": { "type": "string" }, "ignore_peer_chain": { "type": "string" }, "tenant_ref": { "type": "string" }, "is_federated": { "type": "string" }, "created_by": { "type": "string" }, "validate_only_leaf_crl": { "type": "string" }, "state": { "type": "string" }, "ca_certs": { "items": { "type": "string" }, "type": "array" }, "crl_check": { "type": "string" }, "uuid": { "type": "string" } } }, "include_vars": { "required": [], "type": "object", "description": "Loads variables from a YAML/JSON files dynamically from within a file or from a directory recursively during task runtime. If loading a directory, the files are sorted alphabetically before being loaded.\nThis module is also supported for Windows targets.", "properties": { "ignore_files": { "items": { "type": "string" }, "type": "array" }, "free-form": { "type": "string" }, "files_matching": { "type": "string" }, "depth": { "type": "integer" }, "extensions": { "items": { "type": "string" }, "type": "array" }, "file": { "type": "string" }, "dir": { "type": "string" }, "name": { "type": "string" } } }, "netapp_e_snapshot_group": { "required": [ "api_password", "name", "state", "storage_pool_name", "api_username", "base_volume_name", "api_url" ], "type": "object", "description": "Create, update, delete snapshot groups for NetApp E-series storage arrays", "properties": { "repo_pct": { "type": "integer" }, "name": { "type": "string" }, "rollback_priority": { "type": "string" }, "delete_limit": { "type": "integer" }, "api_password": { "type": "string" }, "state": { "type": "string" }, "storage_pool_name": { "type": "string" }, "api_username": { "type": "string" }, "api_url": { "type": "string" }, "base_volume_name": { "type": "string" }, "full_policy": { "type": "string" }, "validate_certs": { "type": "boolean" }, "warning_threshold": { "type": "integer" } } }, "datadog_event": { "required": [ "title", "text", "app_key", "api_key" ], "type": "object", "description": "Allows to post events to DataDog (www.datadoghq.com) service.\nUses http://docs.datadoghq.com/api/#events API.", "properties": { "date_happened": { "type": "string" }, "alert_type": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "text": { "type": "string" }, "title": { "type": "string" }, "app_key": { "type": "string" }, "priority": { "type": "string" }, "host": { "type": "string" }, "aggregation_key": { "type": "string" }, "api_key": { "type": "string" }, "validate_certs": { "type": "string" } } }, "ios_ping": { "required": [ "dest" ], "type": "object", "description": "Tests reachability using ping from switch to a remote destination.", "properties": { "count": { "type": "integer" }, "dest": { "type": "string" }, "state": { "type": "string" }, "vrf": { "type": "string" }, "source": { "type": "string" } } }, "bigip_sys_global": { "required": [], "type": "object", "description": "Manage BIG-IP global settings.", "properties": { "security_banner": { "type": "string" }, "net_reboot": { "type": "string" }, "banner_text": { "type": "string" }, "console_timeout": { "type": "string" }, "quiet_boot": { "type": "string" }, "mgmt_dhcp": { "type": "string" }, "state": { "type": "string" }, "gui_setup": { "type": "string" }, "lcd_display": { "type": "string" } } }, "eos_facts": { "required": [], "type": "object", "description": "Collects a base set of device facts from a remote device that is running eos. This module prepends all of the base network fact keys with C(ansible_net_). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.", "properties": { "gather_subset": { "items": { "type": "string" }, "type": "array" } } }, "slack": { "required": [ "token" ], "type": "object", "description": "The C(slack) module sends notifications to U(http://slack.com) via the Incoming WebHook integration", "properties": { "username": { "type": "string" }, "domain": { "type": "string" }, "attachments": { "items": { "type": "string" }, "type": "array" }, "color": { "type": "string" }, "icon_url": { "type": "string" }, "parse": { "type": "string" }, "token": { "type": "string" }, "icon_emoji": { "type": "string" }, "link_names": { "type": "integer" }, "msg": { "type": "string" }, "validate_certs": { "type": "string" }, "channel": { "type": "string" } } }, "vsphere_guest": { "required": [ "username", "vcenter_hostname", "password", "guest" ], "type": "object", "description": "Create/delete/reconfigure a guest VM through VMware vSphere. This module has a dependency on pysphere >= 1.7", "properties": { "username": { "type": "string" }, "resource_pool": { "type": "string" }, "password": { "type": "string" }, "force": { "type": "string" }, "guest": { "type": "string" }, "vm_disk": { "items": { "type": "string" }, "type": "array" }, "vm_hw_version": { "type": "string" }, "esxi": { "type": "string" }, "vm_nic": { "items": { "type": "string" }, "type": "array" }, "vm_hardware": { "items": { "type": "string" }, "type": "array" }, "from_template": { "type": "boolean" }, "cluster": { "type": "string" }, "state": { "type": "string" }, "vmware_guest_facts": { "type": "string" }, "vm_extra_config": { "type": "string" }, "power_on_after_clone": { "type": "boolean" }, "vcenter_hostname": { "type": "string" }, "validate_certs": { "type": "boolean" }, "template_src": { "type": "string" }, "snapshot_to_clone": { "type": "string" } } }, "iosxr_netconf": { "required": [], "type": "object", "description": "This module provides an abstraction that enables and configures the netconf system service running on Cisco IOS-XR Software. This module can be used to easily enable the Netconf API. Netconf provides a programmatic interface for working with configuration and state resources as defined in RFC 6242.", "properties": { "state": { "type": "string" }, "netconf_vrf": { "type": "string" }, "netconf_port": { "items": { "type": "integer" }, "type": "array" } } }, "pkg5_publisher": { "required": [ "name" ], "type": "object", "description": "IPS packages are the native packages in Solaris 11 and higher.\nThis modules will configure which publishers a client will download IPS packages from.", "properties": { "origin": { "type": "string" }, "name": { "type": "string" }, "enabled": { "type": "string" }, "sticky": { "type": "string" }, "state": { "type": "string" }, "mirror": { "type": "string" } } }, "aos_device": { "required": [ "session" ], "type": "object", "description": "Apstra AOS Device module let you manage your devices in AOS easily. You can approve devices and define in which state the device should be. Currently only the state I(normal) is supported but the goal is to extend this module with additional state. This module is idempotent and support the I(check) mode. It's using the AOS REST API.", "properties": { "name": { "type": "string" }, "state": { "type": "string" }, "session": { "type": "string" }, "location": { "type": "string" }, "approve": { "type": "string" }, "id": { "type": "string" } } }, "bigip_partition": { "required": [], "type": "object", "description": "Manage BIG-IP partitions.", "properties": { "route_domain": { "type": "string" }, "description": { "type": "string" }, "state": { "type": "string" } } }, "avi_hardwaresecuritymodulegroup": { "required": [ "name", "hsm" ], "type": "object", "description": "This module is used to configure HardwareSecurityModuleGroup object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "uuid": { "type": "string" }, "url": { "type": "string" }, "tenant_ref": { "type": "string" }, "hsm": { "type": "string" }, "state": { "type": "string" }, "name": { "type": "string" } } }, "ce_vrf_af": { "required": [ "vrf" ], "type": "object", "description": "Manages VPN instance address family of HUAWEI CloudEngine switches.", "properties": { "vpn_target_type": { "type": "string" }, "vpn_target_state": { "type": "string" }, "vrf_aftype": { "type": "string" }, "state": { "type": "string" }, "route_distinguisher": { "type": "string" }, "vrf": { "type": "string" }, "evpn": { "type": "boolean" }, "vpn_target_value": { "type": "string" } } }, "stackdriver": { "required": [ "key" ], "type": "object", "description": "Send code deploy and annotation events to Stackdriver", "properties": { "repository": { "type": "string" }, "level": { "type": "string" }, "annotated_by": { "type": "string" }, "deployed_by": { "type": "string" }, "deployed_to": { "type": "string" }, "instance_id": { "type": "string" }, "key": { "type": "string" }, "msg": { "type": "string" }, "event_epoch": { "type": "string" }, "revision_id": { "type": "string" }, "event": { "type": "string" } } }, "junos_static_route": { "required": [ "next_hop", "address" ], "type": "object", "description": "This module provides declarative management of static IP routes on Juniper JUNOS network devices.", "properties": { "qualified_next_hop": { "type": "string" }, "active": { "type": "boolean" }, "state": { "type": "string" }, "next_hop": { "type": "string" }, "preference": { "type": "string" }, "qualified_preference": { "type": "string" }, "address": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" } } }, "purefa_snap": { "required": [ "name" ], "type": "object", "description": "Create or delete volumes and volume snapshots on Pure Storage FlashArray.", "properties": { "name": { "type": "string" }, "state": { "type": "string" }, "suffix": { "type": "string" }, "target": { "type": "string" }, "overwrite": { "type": "string" }, "eradicate": { "type": "string" } } }, "xattr": { "required": [ "path" ], "type": "object", "description": "Manages filesystem user defined extended attributes, requires that they are enabled on the target filesystem and that the setfattr/getfattr utilities are present.", "properties": { "path": { "type": "string" }, "state": { "type": "string" }, "value": { "type": "string" }, "key": { "type": "string" }, "follow": { "type": "string" } } }, "mysql_replication": { "required": [], "type": "object", "description": "Manages MySQL server replication, slave, master status get and change master host.", "properties": { "master_ssl_cert": { "type": "string" }, "master_auto_position": { "type": "string" }, "master_log_pos": { "type": "string" }, "master_password": { "type": "string" }, "master_host": { "type": "string" }, "master_ssl": { "type": "string" }, "master_ssl_capath": { "type": "string" }, "master_ssl_ca": { "type": "string" }, "master_ssl_key": { "type": "string" }, "master_connect_retry": { "type": "string" }, "master_user": { "type": "string" }, "mode": { "type": "string" }, "master_port": { "type": "string" }, "master_log_file": { "type": "string" }, "master_ssl_cipher": { "type": "string" }, "relay_log_pos": { "type": "string" }, "relay_log_file": { "type": "string" } } }, "hpilo_facts": { "required": [ "host" ], "type": "object", "description": "This module gathers facts for a specific system using its HP iLO interface. These facts include hardware and network related information useful for provisioning (e.g. macaddress, uuid).\nThis module requires the hpilo python module.", "properties": { "host": { "type": "string" }, "password": { "type": "string" }, "ssl_version": { "type": "string" }, "login": { "type": "string" } } }, "os_image": { "required": [ "name" ], "type": "object", "description": "Add or Remove images from the OpenStack Image Repository", "properties": { "ramdisk": { "type": "string" }, "kernel": { "type": "string" }, "properties": { "type": "string" }, "name": { "type": "string" }, "availability_zone": { "type": "string" }, "container_format": { "type": "string" }, "min_ram": { "type": "string" }, "disk_format": { "type": "string" }, "filename": { "type": "string" }, "min_disk": { "type": "string" }, "state": { "type": "string" }, "checksum": { "type": "string" }, "owner": { "type": "string" }, "is_public": { "type": "string" }, "id": { "type": "string" } } }, "ovirt_permissions": { "required": [ "authz_name" ], "type": "object", "description": "Module to manage permissions of users/groups in oVirt/RHV.", "properties": { "authz_name": { "type": "string" }, "object_type": { "type": "string" }, "namespace": { "type": "string" }, "object_name": { "type": "string" }, "object_id": { "type": "string" }, "group_name": { "type": "string" }, "state": { "type": "string" }, "role": { "type": "string" }, "user_name": { "type": "string" } } }, "dladm_vlan": { "required": [ "link", "name" ], "type": "object", "description": "Create or delete VLAN interfaces on Solaris/illumos systems.", "properties": { "temporary": { "type": "boolean" }, "state": { "type": "string" }, "link": { "type": "string" }, "name": { "type": "string" }, "vlan_id": { "type": "boolean" } } }, "elasticsearch_plugin": { "required": [ "name" ], "type": "object", "description": "Manages Elasticsearch plugins.", "properties": { "name": { "type": "string" }, "proxy_host": { "type": "string" }, "url": { "type": "string" }, "proxy_port": { "type": "string" }, "state": { "type": "string" }, "version": { "type": "string" }, "timeout": { "type": "string" }, "plugin_dir": { "type": "string" }, "plugin_bin": { "type": "string" } } }, "proxysql_mysql_users": { "required": [ "username" ], "type": "object", "description": "The M(proxysql_mysql_users) module adds or removes mysql users using the proxysql admin interface.", "properties": { "username": { "type": "string" }, "default_hostgroup": { "type": "string" }, "frontend": { "type": "boolean" }, "default_schema": { "type": "string" }, "transaction_persistent": { "type": "string" }, "login_port": { "type": "integer" }, "login_user": { "type": "string" }, "login_host": { "type": "string" }, "login_password": { "type": "string" }, "use_ssl": { "type": "string" }, "backend": { "type": "boolean" }, "state": { "type": "string" }, "fast_forward": { "type": "string" }, "load_to_runtime": { "type": "boolean" }, "save_to_disk": { "type": "boolean" }, "active": { "type": "string" }, "config_file": { "type": "string" }, "password": { "type": "string" }, "max_connections": { "type": "string" } } }, "vyos_config": { "required": [], "type": "object", "description": "This module provides configuration file management of VyOS devices. It provides arguments for managing both the configuration file and state of the active configuration. All configuration statements are based on `set` and `delete` commands in the device configuration.", "properties": { "comment": { "type": "string" }, "src": { "type": "string" }, "config": { "type": "string" }, "lines": { "type": "string" }, "save": { "type": "boolean" }, "backup": { "type": "boolean" }, "match": { "type": "string" } } }, "os_project": { "required": [ "name" ], "type": "object", "description": "Manage OpenStack Projects. Projects can be created, updated or deleted using this module. A project will be updated if I(name) matches an existing project and I(state) is present. The value for I(name) cannot be updated without deleting and re-creating the project.", "properties": { "description": { "type": "string" }, "availability_zone": { "type": "string" }, "enabled": { "type": "boolean" }, "state": { "type": "string" }, "domain_id": { "type": "string" }, "name": { "type": "string" } } }, "bigip_device_sshd": { "required": [], "type": "object", "description": "Manage the SSHD settings of a BIG-IP", "properties": { "log_level": { "type": "string" }, "banner_text": { "type": "string" }, "allow": { "type": "string" }, "inactivity_timeout": { "type": "string" }, "login": { "type": "string" }, "banner": { "type": "string" }, "port": { "type": "string" } } }, "zfs": { "required": [ "state", "name" ], "type": "object", "description": "Manages ZFS file systems, volumes, clones and snapshots", "properties": { "origin": { "type": "string" }, "state": { "type": "string" }, "name": { "type": "string" }, "key_value": { "type": "string" } } }, "uri": { "required": [ "url" ], "type": "object", "description": "Interacts with HTTP and HTTPS web services and supports Digest, Basic and WSSE HTTP authentication mechanisms.\nFor Windows targets, use the M(win_uri) module instead.", "properties": { "body": { "type": "string" }, "status_code": { "items": { "type": "integer" }, "type": "array" }, "client_cert": { "type": "string" }, "headers": { "type": "string" }, "dest": { "type": "string" }, "follow_redirects": { "type": "string" }, "force_basic_auth": { "type": "string" }, "removes": { "type": "string" }, "method": { "type": "string" }, "creates": { "type": "string" }, "url": { "type": "string" }, "user": { "type": "string" }, "timeout": { "type": "integer" }, "others": { "type": "string" }, "body_format": { "type": "string" }, "return_content": { "type": "string" }, "password": { "type": "string" }, "validate_certs": { "type": "string" }, "HEADER_": { "type": "string" }, "client_key": { "type": "string" } } }, "github_hooks": { "required": [ "repo", "oauthkey", "user", "action" ], "type": "object", "description": "Adds service hooks and removes service hooks that have an error status.", "properties": { "oauthkey": { "type": "string" }, "hookurl": { "type": "string" }, "repo": { "type": "string" }, "user": { "type": "string" }, "content_type": { "type": "string" }, "action": { "type": "string" }, "validate_certs": { "type": "string" } } }, "gce_snapshot": { "required": [ "instance_name", "project_id", "credentials_file", "service_account_email" ], "type": "object", "description": "Manages snapshots for GCE instances. This module manages snapshots for the storage volumes of a GCE compute instance. If there are multiple volumes, each snapshot will be prepended with the disk name", "properties": { "service_account_email": { "type": "string" }, "disks": { "items": { "type": "string" }, "type": "array" }, "instance_name": { "type": "string" }, "state": { "type": "string" }, "snapshot_name": { "type": "string" }, "credentials_file": { "type": "string" }, "project_id": { "type": "string" } } }, "ce_ospf": { "required": [ "process_id" ], "type": "object", "description": "Manages configuration of an OSPF instance on HUAWEI CloudEngine switches.", "properties": { "addr": { "type": "string" }, "area": { "type": "string" }, "max_load_balance": { "type": "string" }, "mask": { "type": "string" }, "auth_key_id": { "type": "string" }, "auth_mode": { "type": "string" }, "auth_text_simple": { "type": "string" }, "state": { "type": "string" }, "process_id": { "type": "string" }, "nexthop_addr": { "type": "string" }, "auth_text_md5": { "type": "string" }, "nexthop_weight": { "type": "string" } } }, "win_route": { "required": [ "destination" ], "type": "object", "description": "Add or remove a static route.", "properties": { "metric": { "type": "integer" }, "destination": { "type": "string" }, "gateway": { "type": "string" }, "state": { "type": "string" } } }, "nginx_status_facts": { "required": [ "url" ], "type": "object", "description": "Gathers facts from nginx from an URL having C(stub_status) enabled.", "properties": { "url": { "type": "string" }, "timeout": { "type": "integer" } } }, "java_cert": { "required": [ "keystore_pass" ], "type": "object", "description": "This is a wrapper module around keytool. Which can be used to import/remove certificates from a given java keystore.", "properties": { "keystore_create": { "type": "string" }, "cert_alias": { "type": "string" }, "executable": { "type": "string" }, "pkcs12_alias": { "type": "integer" }, "cert_port": { "type": "integer" }, "pkcs12_password": { "type": "string" }, "state": { "type": "string" }, "keystore_pass": { "type": "string" }, "cert_path": { "type": "string" }, "cert_url": { "type": "string" }, "pkcs12_path": { "type": "string" }, "keystore_path": { "type": "string" } } }, "blockinfile": { "required": [ "path" ], "type": "object", "description": "This module will insert/update/remove a block of multi-line text surrounded by customizable marker lines.", "properties": { "insertbefore": { "type": "string" }, "create": { "type": "string" }, "insertafter": { "type": "string" }, "state": { "type": "string" }, "marker": { "type": "string" }, "path": { "type": "string" }, "backup": { "type": "string" }, "block": { "type": "string" } } }, "pause": { "required": [], "type": "object", "description": "Pauses playbook execution for a set amount of time, or until a prompt is acknowledged. All parameters are optional. The default behavior is to pause with a prompt.\nTo pause/wait/sleep per host, use the M(wait_for) module.\nYou can use C(ctrl+c) if you wish to advance a pause earlier than it is set to expire or if you need to abort a playbook run entirely. To continue early press C(ctrl+c) and then C(c). To abort a playbook press C(ctrl+c) and then C(a).\nThe pause module integrates into async/parallelized playbooks without any special considerations (see Rolling Updates). When using pauses with the C(serial) playbook parameter (as in rolling updates) you are only prompted once for the current group of hosts.\nThis module is also supported for Windows targets.", "properties": { "seconds": { "type": "string" }, "prompt": { "type": "string" }, "minutes": { "type": "string" }, "echo": { "type": "string" } } }, "ipa_group": { "required": [ "cn" ], "type": "object", "description": "Add, modify and delete group within IPA server", "properties": { "group": { "items": { "type": "string" }, "type": "array" }, "cn": { "type": "string" }, "state": { "type": "string" }, "gidnumber": { "type": "string" }, "external": { "type": "string" }, "nonposix": { "type": "string" }, "user": { "items": { "type": "string" }, "type": "array" } } }, "panos_lic": { "required": [ "ip_address", "password", "auth_code" ], "type": "object", "description": "Apply an authcode to a device.\nThe authcode should have been previously registered on the Palo Alto Networks support portal.\nThe device should have Internet access.", "properties": { "username": { "type": "string" }, "force": { "type": "string" }, "password": { "type": "string" }, "ip_address": { "type": "string" }, "auth_code": { "type": "string" } } }, "exo_dns_record": { "required": [ "domain" ], "type": "object", "description": "Create, update and delete records.", "properties": { "domain": { "type": "string" }, "multiple": { "type": "string" }, "name": { "type": "string" }, "prio": { "type": "string" }, "content": { "type": "string" }, "record_type": { "type": "string" }, "state": { "type": "string" }, "ttl": { "type": "integer" } } }, "ce_vxlan_tunnel": { "required": [], "type": "object", "description": "This module offers the ability to set the VNI and mapped to the BD, and configure an ingress replication list on HUAWEI CloudEngine devices.", "properties": { "vni_id": { "type": "string" }, "nve_mode": { "type": "string" }, "source_ip": { "type": "string" }, "bridge_domain_id": { "type": "string" }, "peer_list_ip": { "type": "string" }, "state": { "type": "string" }, "nve_name": { "type": "string" }, "protocol_type": { "type": "string" } } }, "nxos_pim_rp_address": { "required": [ "rp_address" ], "type": "object", "description": "Manages configuration of an Protocol Independent Multicast (PIM) static rendezvous point (RP) address instance.", "properties": { "route_map": { "type": "string" }, "prefix_list": { "items": { "type": "string" }, "type": "array" }, "rp_address": { "type": "string" }, "group_list": { "type": "string" }, "bidir": { "type": "string" } } }, "cnos_template": { "required": [ "commandfile" ], "type": "object", "description": "This module allows you to work with the running configuration of a switch. It provides a way to execute a set of CNOS commands on a switch by evaluating the current running configuration and executing the commands only if the specific settings have not been already configured. The configuration source can be a set of commands or a template written in the Jinja2 templating language. This module uses SSH to manage network device configuration. The results of the operation will be placed in a directory named 'results' that must be created by the user in their local directory to where the playbook is run. For more information about this module from Lenovo and customizing it usage for your use cases, please visit U(http://systemx.lenovofiles.com/help/index.jsp?topic=%2Fcom.lenovo.switchmgt.ansible.doc%2Fcnos_template.html)", "properties": { "commandfile": { "type": "string" } } }, "pulp_repo": { "required": [ "relative_url", "name" ], "type": "object", "description": "Add or remove Pulp repos from a remote host.", "properties": { "feed": { "type": "string" }, "url_password": { "type": "string" }, "repo_type": { "type": "string" }, "pulp_host": { "type": "string" }, "publish_distributor": { "type": "string" }, "name": { "type": "string" }, "relative_url": { "type": "string" }, "proxy_host": { "type": "string" }, "force_basic_auth": { "type": "string" }, "importer_ssl_client_key": { "type": "string" }, "importer_ssl_client_cert": { "type": "string" }, "proxy_port": { "type": "string" }, "state": { "type": "string" }, "serve_https": { "type": "boolean" }, "serve_http": { "type": "boolean" }, "url_username": { "type": "string" }, "wait_for_completion": { "type": "string" }, "validate_certs": { "type": "string" }, "add_export_distributor": { "type": "boolean" }, "importer_ssl_ca_cert": { "type": "string" } } }, "ordnance_config": { "required": [], "type": "object", "description": "Ordnance router configurations use a simple block indent file syntax for segmenting configuration into sections. This module provides an implementation for working with these configuration sections in a deterministic way.", "properties": { "multiline_delimiter": { "type": "string" }, "src": { "type": "string" }, "commands": { "type": "string" }, "config": { "type": "string" }, "after": { "type": "string" }, "replace": { "type": "string" }, "parents": { "type": "string" }, "defaults": { "type": "boolean" }, "save": { "type": "boolean" }, "backup": { "type": "boolean" }, "match": { "type": "string" }, "before": { "type": "string" } } }, "twilio": { "required": [ "from_number", "msg", "auth_token", "to_number", "account_sid" ], "type": "object", "description": "Sends a text message to a phone number through the Twilio messaging API.", "properties": { "auth_token": { "type": "string" }, "to_number": { "type": "string" }, "account_sid": { "type": "string" }, "from_number": { "type": "string" }, "msg": { "type": "string" }, "media_url": { "type": "string" } } }, "ce_stp": { "required": [], "type": "object", "description": "Manages STP configurations on HUAWEI CloudEngine switches.", "properties": { "tc_protection_interval": { "type": "string" }, "loop_protection": { "type": "string" }, "tc_protection_threshold": { "type": "string" }, "stp_converge": { "type": "string" }, "stp_mode": { "type": "string" }, "bpdu_protection": { "type": "string" }, "root_protection": { "type": "string" }, "state": { "type": "string" }, "bpdu_filter": { "type": "string" }, "stp_enable": { "type": "string" }, "interface": { "type": "string" }, "tc_protection": { "type": "string" }, "edged_port": { "type": "string" }, "cost": { "type": "string" } } }, "os_server_action": { "required": [ "server" ], "type": "object", "description": "Perform server actions on an existing compute instance from OpenStack. This module does not return any data other than changed true/false. When I(action) is 'rebuild', then I(image) parameter is required.", "properties": { "availability_zone": { "type": "string" }, "image": { "type": "string" }, "server": { "type": "string" }, "timeout": { "type": "integer" }, "action": { "type": "string" }, "wait": { "type": "string" } } }, "pagerduty": { "required": [ "name", "passwd", "state", "token", "user", "requester_id" ], "type": "object", "description": "This module will let you create PagerDuty maintenance windows", "properties": { "name": { "type": "string" }, "service": { "items": { "type": "string" }, "type": "array" }, "passwd": { "type": "string" }, "validate_certs": { "type": "string" }, "token": { "type": "string" }, "hours": { "type": "integer" }, "state": { "items": { "type": "string" }, "type": "array" }, "user": { "type": "string" }, "requester_id": { "type": "string" }, "minutes": { "type": "integer" }, "desc": { "type": "string" } } }, "pkgng": { "required": [ "name" ], "type": "object", "description": "Manage binary packages for FreeBSD using 'pkgng' which is available in versions after 9.0.", "properties": { "chroot": { "type": "string" }, "name": { "items": { "type": "string" }, "type": "array" }, "cached": { "type": "boolean" }, "pkgsite": { "type": "string" }, "rootdir": { "type": "string" }, "state": { "type": "string" }, "autoremove": { "type": "boolean" }, "jail": { "type": "string" }, "annotation": { "items": { "type": "string" }, "type": "array" } } }, "letsencrypt": { "required": [ "dest", "account_key", "csr" ], "type": "object", "description": "Create and renew SSL certificates with Let's Encrypt. Let's Encrypt is a free, automated, and open certificate authority (CA), run for the public's benefit. For details see U(https://letsencrypt.org). The current implementation supports the http-01, tls-sni-02 and dns-01 challenges.\nTo use this module, it has to be executed at least twice. Either as two different tasks in the same run or during multiple runs.\nBetween these two tasks you have to fulfill the required steps for the chosen challenge by whatever means necessary. For http-01 that means creating the necessary challenge file on the destination webserver. For dns-01 the necessary dns record has to be created. tls-sni-02 requires you to create a SSL certificate with the appropriate subjectAlternativeNames. It is I(not) the responsibility of this module to perform these steps.\nFor details on how to fulfill these challenges, you might have to read through U(https://tools.ietf.org/html/draft-ietf-acme-acme-02#section-7)\nAlthough the defaults are chosen so that the module can be used with the Let's Encrypt CA, the module can be used with any service using the ACME protocol.", "properties": { "acme_directory": { "type": "string" }, "account_email": { "type": "string" }, "dest": { "type": "string" }, "remaining_days": { "type": "integer" }, "challenge": { "type": "string" }, "agreement": { "type": "string" }, "account_key": { "type": "string" }, "fullchain": { "type": "boolean" }, "data": { "type": "string" }, "csr": { "type": "string" } } }, "nexmo": { "required": [ "src", "dest", "api_secret", "api_key", "msg" ], "type": "object", "description": "Send a SMS message via nexmo", "properties": { "src": { "type": "string" }, "dest": { "type": "string" }, "api_secret": { "type": "string" }, "msg": { "type": "string" }, "api_key": { "type": "string" }, "validate_certs": { "type": "string" } } }, "dimensiondata_network": { "required": [ "name" ], "type": "object", "description": "Create, update, and delete MCP 1.0 & 2.0 networks", "properties": { "service_plan": { "type": "string" }, "state": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" } } }, "debconf": { "required": [ "name" ], "type": "object", "description": "Configure a .deb package using debconf-set-selections. Or just query existing selections.", "properties": { "unseen": { "type": "boolean" }, "vtype": { "type": "string" }, "question": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string" } } }, "panos_pg": { "required": [ "pg_name", "password", "ip_address" ], "type": "object", "description": "Create a security profile group", "properties": { "username": { "type": "string" }, "wildfire": { "type": "string" }, "data_filtering": { "type": "string" }, "url_filtering": { "type": "string" }, "pg_name": { "type": "string" }, "vulnerability": { "type": "string" }, "spyware": { "type": "string" }, "file_blocking": { "type": "string" }, "virus": { "type": "string" }, "commit": { "type": "boolean" }, "password": { "type": "string" }, "ip_address": { "type": "string" } } }, "ovirt_networks_facts": { "required": [], "type": "object", "description": "Retrieve facts about one or more oVirt/RHV networks.", "properties": { "pattern": { "type": "string" } } }, "cl_bond": { "required": [ "name", "slaves" ], "type": "object", "description": "Configures a bond interface on Cumulus Linux To configure a bridge port use the cl_bridge module. To configure any other type of interface use the cl_interface module. Follow the guidelines for bonding found in the Cumulus User Guide at U(http://docs.cumulusnetworks.com).", "properties": { "clag_id": { "type": "string" }, "lacp_rate": { "type": "integer" }, "xmit_hash_policy": { "type": "string" }, "mstpctl_portadminedge": { "type": "string" }, "min_links": { "type": "integer" }, "alias_name": { "type": "string" }, "mstpctl_bpduguard": { "type": "string" }, "ipv4": { "items": { "type": "string" }, "type": "array" }, "ipv6": { "items": { "type": "string" }, "type": "array" }, "vids": { "items": { "type": "string" }, "type": "array" }, "mstpctl_portnetwork": { "type": "string" }, "location": { "type": "string" }, "miimon": { "type": "integer" }, "virtual_mac": { "type": "string" }, "lacp_bypass_all_active": { "type": "string" }, "lacp_bypass_period": { "type": "string" }, "lacp_bypass_allow": { "type": "string" }, "lacp_bypass_priority": { "items": { "type": "string" }, "type": "array" }, "addr_method": { "type": "string" }, "name": { "type": "string" }, "virtual_ip": { "type": "string" }, "mtu": { "type": "string" }, "pvid": { "type": "string" }, "mode": { "type": "string" }, "slaves": { "type": "string" } } }, "tower_job_template": { "required": [ "job_type", "playbook", "name", "project" ], "type": "object", "description": "Create, update, or destroy Ansible Tower job templates. See U(https://www.ansible.com/tower) for an overview.", "properties": { "network_credential": { "type": "string" }, "job_type": { "type": "string" }, "ask_job_type": { "type": "boolean" }, "skip_tags": { "type": "string" }, "playbook": { "type": "string" }, "job_tags": { "type": "string" }, "state": { "type": "string" }, "inventory": { "type": "string" }, "limit": { "items": { "type": "string" }, "type": "array" }, "forks": { "type": "string" }, "cloud_credential": { "type": "string" }, "become_enabled": { "type": "boolean" }, "description": { "type": "string" }, "ask_inventory": { "type": "boolean" }, "host_config_key": { "type": "string" }, "machine_credential": { "type": "string" }, "ask_credential": { "type": "boolean" }, "name": { "type": "string" }, "verbosity": { "type": "string" }, "project": { "type": "string" }, "ask_extra_vars": { "type": "boolean" }, "extra_vars_path": { "type": "string" }, "ask_tags": { "type": "boolean" } } }, "tower_label": { "required": [ "organization", "name" ], "type": "object", "description": "Create, update, or destroy Ansible Tower labels. See U(https://www.ansible.com/tower) for an overview.", "properties": { "organization": { "type": "string" }, "state": { "type": "string" }, "name": { "type": "string" } } }, "win_wait_for": { "required": [], "type": "object", "description": "You can wait for a set amount of time C(timeout), this is the default if nothing is specified.\nWaiting for a port to become available is useful for when services are not immediately available after their init scripts return which is true of certain Java application servers.\nYou can wait for a file to exist or not exist on the filesystem.\nThis module can also be used to wait for a regex match string to be present in a file.\nYou can wait for active connections to be closed before continuing on a local port.", "properties": { "state": { "type": "string" }, "connect_timeout": { "type": "integer" }, "delay": { "type": "string" }, "host": { "type": "string" }, "sleep": { "type": "integer" }, "timeout": { "type": "integer" }, "exclude_hosts": { "items": { "type": "string" }, "type": "array" }, "search_regex": { "type": "string" }, "path": { "type": "string" }, "port": { "type": "string" } } }, "na_cdot_user": { "required": [ "vserver", "application", "state", "name", "authentication_method" ], "type": "object", "description": "Create or destroy users.", "properties": { "name": { "type": "string" }, "authentication_method": { "type": "string" }, "vserver": { "type": "string" }, "application": { "type": "string" }, "state": { "type": "string" }, "role_name": { "type": "string" }, "set_password": { "type": "string" } } }, "ce_switchport": { "required": [ "interface" ], "type": "object", "description": "Manages Layer 2 switchport interfaces on HUAWEI CloudEngine switches.", "properties": { "native_vlan": { "type": "string" }, "access_vlan": { "type": "string" }, "trunk_vlans": { "type": "string" }, "state": { "type": "string" }, "mode": { "type": "string" }, "interface": { "type": "string" } } }, "atomic_host": { "required": [], "type": "object", "description": "Manage the atomic host platform.\nRebooting of Atomic host platform should be done outside this module.", "properties": { "revision": { "type": "string" } } }, "zabbix_group": { "required": [ "host_groups" ], "type": "object", "description": "Create host groups if they do not exist.\nDelete existing host groups if they exist.", "properties": { "state": { "type": "string" }, "host_groups": { "items": { "type": "string" }, "type": "array" } } }, "win_user": { "required": [ "name" ], "type": "object", "description": "Manages local Windows user accounts\nFor non-Windows targets, use the M(user) module instead.", "properties": { "update_password": { "type": "string" }, "password_never_expires": { "type": "string" }, "name": { "type": "string" }, "groups_action": { "type": "string" }, "password_expired": { "type": "string" }, "state": { "type": "string" }, "groups": { "type": "string" }, "account_disabled": { "type": "string" }, "fullname": { "type": "string" }, "password": { "type": "string" }, "account_locked": { "type": "string" }, "user_cannot_change_password": { "type": "string" }, "description": { "type": "string" } } }, "win_chocolatey": { "required": [ "name" ], "type": "object", "description": "Manage packages using Chocolatey (U(http://chocolatey.org/)).\nIf Chocolatey is missing from the system, the module will install it.\nList of packages can be found at U(http://chocolatey.org/packages).", "properties": { "upgrade": { "type": "string" }, "skip_scripts": { "type": "string" }, "name": { "type": "string" }, "ignore_checksums": { "type": "string" }, "proxy_url": { "type": "string" }, "allow_empty_checksums": { "type": "string" }, "proxy_password": { "type": "string" }, "install_args": { "type": "string" }, "source": { "type": "string" }, "state": { "type": "string" }, "version": { "type": "string" }, "params": { "type": "string" }, "ignore_dependencies": { "type": "string" }, "timeout": { "type": "integer" }, "force": { "type": "string" }, "proxy_username": { "type": "string" } } }, "ipa_hbacrule": { "required": [ "cn" ], "type": "object", "description": "Add, modify or delete an IPA HBAC rule using IPA API.", "properties": { "servicecategory": { "type": "string" }, "sourcehostcategory": { "type": "string" }, "cn": { "type": "string" }, "service": { "items": { "type": "string" }, "type": "array" }, "sourcehost": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "hostgroup": { "items": { "type": "string" }, "type": "array" }, "usercategory": { "type": "string" }, "hostcategory": { "type": "string" }, "user": { "items": { "type": "string" }, "type": "array" }, "usergroup": { "items": { "type": "string" }, "type": "array" }, "host": { "items": { "type": "string" }, "type": "array" }, "servicegroup": { "items": { "type": "string" }, "type": "array" }, "sourcehostgroup": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" } } }, "homebrew": { "required": [], "type": "object", "description": "Manages Homebrew packages", "properties": { "install_options": { "type": "string" }, "name": { "items": { "type": "string" }, "type": "array" }, "update_homebrew": { "type": "boolean" }, "upgrade_all": { "type": "boolean" }, "state": { "type": "string" }, "path": { "items": { "type": "string" }, "type": "array" } } }, "modprobe": { "required": [ "name" ], "type": "object", "description": "Load or unload kernel modules.", "properties": { "state": { "type": "string" }, "params": { "type": "string" }, "name": { "type": "string" } } }, "rax_facts": { "required": [], "type": "object", "description": "Gather facts for Rackspace Cloud Servers.", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "address": { "type": "string" } } }, "bigip_monitor_https": { "required": [ "name" ], "type": "object", "description": "Manages F5 BIG-IP LTM https monitors.", "properties": { "partition": { "type": "string" }, "name": { "type": "string" }, "parent": { "type": "string" }, "receive": { "type": "string" }, "ip": { "type": "string" }, "interval": { "type": "string" }, "send": { "type": "string" }, "target_username": { "type": "string" }, "time_until_up": { "type": "string" }, "timeout": { "type": "string" }, "target_password": { "type": "string" }, "port": { "type": "string" }, "receive_disable": { "type": "string" } } }, "tempfile": { "required": [], "type": "object", "description": "The C(tempfile) module creates temporary files and directories. C(mktemp) command takes different parameters on various systems, this module helps to avoid troubles related to that. Files/directories created by module are accessible only by creator. In case you need to make them world-accessible you need to use M(file) module.\nFor Windows targets, use the M(win_tempfile) module instead.", "properties": { "path": { "type": "string" }, "state": { "type": "string" }, "prefix": { "type": "string" }, "suffix": { "type": "string" } } }, "ec2_vpc_peering_facts": { "required": [], "type": "object", "description": "Gets various details related to AWS VPC Peers", "properties": { "peer_connection_ids": { "type": "string" }, "filters": { "type": "string" } } }, "rax_dns": { "required": [], "type": "object", "description": "Manage domains on Rackspace Cloud DNS", "properties": { "comment": { "type": "string" }, "state": { "type": "string" }, "ttl": { "type": "integer" }, "email": { "type": "string" }, "name": { "type": "string" } } }, "ce_bgp_neighbor_af": { "required": [ "af_type", "remote_address", "vrf_name" ], "type": "object", "description": "Manages BGP neighbor Address-family configurations on HUAWEI CloudEngine switches.", "properties": { "import_pref_filt_name": { "type": "string" }, "advertise_irb": { "type": "string" }, "substitute_as_enable": { "type": "string" }, "preferred_value": { "type": "string" }, "advertise_ext_community": { "type": "string" }, "advertise_remote_nexthop": { "type": "string" }, "default_rt_match_mode": { "type": "string" }, "soostring": { "type": "string" }, "advertise_arp": { "type": "string" }, "import_as_path_filter": { "type": "string" }, "public_as_only_force": { "type": "string" }, "vpls_enable": { "type": "string" }, "allow_as_loop_enable": { "type": "string" }, "route_limit": { "type": "string" }, "import_as_path_name_or_num": { "items": { "type": "string" }, "type": "array" }, "af_type": { "type": "string" }, "nexthop_configure": { "type": "string" }, "discard_ext_community": { "type": "string" }, "is_nonstd_ipprefix_mod": { "type": "string" }, "keep_all_routes": { "type": "string" }, "orftype": { "type": "string" }, "advertise_community": { "type": "string" }, "default_rt_adv_enable": { "type": "string" }, "export_as_path_name_or_num": { "items": { "type": "string" }, "type": "array" }, "adv_add_path_num": { "type": "string" }, "ipprefix_orf_enable": { "type": "string" }, "remote_address": { "type": "string" }, "public_as_only_skip_peer_as": { "type": "string" }, "origin_as_valid": { "type": "string" }, "route_limit_idle_timeout": { "type": "string" }, "reflect_client": { "type": "string" }, "import_rt_policy_name": { "type": "string" }, "route_limit_percent": { "type": "string" }, "export_rt_policy_name": { "type": "string" }, "public_as_only": { "type": "string" }, "redirect_ip_vaildation": { "type": "string" }, "import_acl_name_or_num": { "type": "string" }, "allow_as_loop_limit": { "type": "string" }, "add_path_mode": { "type": "string" }, "export_as_path_filter": { "type": "string" }, "vpls_ad_disable": { "type": "string" }, "public_as_only_replace": { "type": "string" }, "route_limit_type": { "type": "string" }, "export_acl_name_or_num": { "type": "string" }, "redirect_ip": { "type": "string" }, "update_pkt_standard_compatible": { "type": "string" }, "orf_mode": { "type": "string" }, "vrf_name": { "type": "string" }, "default_rt_adv_policy": { "type": "string" }, "export_pref_filt_name": { "type": "string" }, "public_as_only_limited": { "type": "string" }, "rt_updt_interval": { "type": "string" } } }, "ce_evpn_bgp_rr": { "required": [ "as_number" ], "type": "object", "description": "Configure an RR in BGP-EVPN address family view on HUAWEI CloudEngine switches.", "properties": { "as_number": { "type": "string" }, "bgp_evpn_enable": { "type": "string" }, "policy_vpn_target": { "type": "string" }, "reflect_client": { "type": "string" }, "bgp_instance": { "type": "string" }, "peer": { "type": "string" }, "peer_type": { "type": "string" } } }, "ovirt_users": { "required": [ "authz_name", "name" ], "type": "object", "description": "Module to manage users in oVirt/RHV.", "properties": { "state": { "type": "string" }, "authz_name": { "type": "string" }, "name": { "type": "string" } } }, "proxysql_manage_config": { "required": [ "direction", "config_settings", "action", "config_layer" ], "type": "object", "description": "The M(proxysql_global_variables) module writes the proxysql configuration settings between layers. Currently this module will always report a changed state, so should typically be used with WHEN however this will change in a future version when the CHECKSUM table commands are available for all tables in proxysql.", "properties": { "login_port": { "type": "integer" }, "direction": { "type": "string" }, "config_file": { "type": "string" }, "config_settings": { "type": "string" }, "login_user": { "type": "string" }, "login_host": { "type": "string" }, "config_layer": { "type": "string" }, "login_password": { "type": "string" }, "action": { "type": "string" } } }, "ce_bfd_view": { "required": [ "session_name" ], "type": "object", "description": "Manages BFD session view configuration on HUAWEI CloudEngine devices.", "properties": { "local_discr": { "type": "string" }, "wtr_interval": { "type": "string" }, "remote_discr": { "type": "string" }, "description": { "type": "string" }, "admin_down": { "type": "boolean" }, "tos_exp": { "type": "string" }, "min_tx_interval": { "type": "string" }, "min_rx_interval": { "type": "string" }, "state": { "type": "string" }, "session_name": { "type": "string" }, "detect_multi": { "type": "string" } } }, "digital_ocean": { "required": [], "type": "object", "description": "Create/delete a droplet in DigitalOcean and optionally wait for it to be 'running', or deploy an SSH key.", "properties": { "unique_name": { "type": "string" }, "virtio": { "type": "string" }, "region_id": { "type": "string" }, "size_id": { "type": "string" }, "ipv6": { "type": "string" }, "backups_enabled": { "type": "string" }, "user_data": { "type": "string" }, "name": { "type": "string" }, "image_id": { "type": "string" }, "state": { "type": "string" }, "wait_timeout": { "type": "integer" }, "command": { "type": "string" }, "ssh_key_ids": { "type": "string" }, "api_token": { "type": "string" }, "id": { "type": "string" }, "private_networking": { "type": "string" }, "ssh_pub_key": { "type": "string" }, "wait": { "type": "string" } } }, "rabbitmq_user": { "required": [ "user" ], "type": "object", "description": "Add or remove users to RabbitMQ and assign permissions", "properties": { "node": { "type": "string" }, "force": { "type": "string" }, "write_priv": { "type": "string" }, "tags": { "type": "string" }, "read_priv": { "type": "string" }, "state": { "type": "string" }, "user": { "type": "string" }, "configure_priv": { "type": "string" }, "vhost": { "type": "string" }, "password": { "type": "string" }, "permissions": { "items": { "type": "string" }, "type": "array" } } }, "os_port_facts": { "required": [], "type": "object", "description": "Retrieve facts about ports from OpenStack.", "properties": { "port": { "type": "string" }, "filters": { "type": "string" }, "availability_zone": { "type": "string" } } }, "sensu_subscription": { "required": [ "name" ], "type": "object", "description": "Manage which I(sensu channels) a machine should subscribe to", "properties": { "path": { "type": "string" }, "state": { "type": "string" }, "backup": { "type": "boolean" }, "name": { "type": "string" } } }, "nxos_static_route": { "required": [ "prefix", "state", "next_hop" ], "type": "object", "description": "Manages static route configuration", "properties": { "next_hop": { "type": "string" }, "pref": { "type": "string" }, "state": { "type": "string" }, "route_name": { "type": "string" }, "prefix": { "type": "string" }, "tag": { "type": "string" }, "vrf": { "type": "string" } } }, "assert": { "required": [ "that" ], "type": "object", "description": "This module asserts that given expressions are true with an optional custom message.\nThis module is also supported for Windows targets.", "properties": { "msg": { "type": "string" }, "that": { "items": { "type": "string" }, "type": "array" } } }, "ce_evpn_bd_vni": { "required": [ "vpn_target_import", "bridge_domain_id" ], "type": "object", "description": "Manages Ethernet Virtual Private Network (EVPN) VXLAN Network Identifier (VNI) configurations on HUAWEI CloudEngine switches.", "properties": { "vpn_target_both": { "items": { "type": "string" }, "type": "array" }, "vpn_target_import": { "items": { "type": "string" }, "type": "array" }, "bridge_domain_id": { "type": "string" }, "vpn_target_export": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "route_distinguisher": { "type": "string" }, "evpn": { "type": "string" } } }, "junos_interface": { "required": [ "name" ], "type": "object", "description": "This module provides declarative management of Interfaces on Juniper JUNOS network devices.", "properties": { "neighbors": { "type": "string" }, "delay": { "type": "integer" }, "name": { "type": "string" }, "duplex": { "type": "string" }, "enabled": { "type": "string" }, "mtu": { "type": "string" }, "rx_rate": { "type": "string" }, "active": { "type": "boolean" }, "state": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" }, "speed": { "type": "string" }, "tx_rate": { "type": "string" }, "description": { "type": "string" } } }, "ovirt_storage_domains": { "required": [], "type": "object", "description": "Module to manage storage domains in oVirt/RHV", "properties": { "comment": { "type": "string" }, "fcp": { "type": "string" }, "state": { "type": "string" }, "description": { "type": "string" }, "format": { "type": "string" }, "iscsi": { "type": "string" }, "posixfs": { "type": "string" }, "host": { "type": "string" }, "glusterfs": { "type": "string" }, "localfs": { "type": "string" }, "nfs": { "type": "string" }, "domain_function": { "type": "string" }, "data_center": { "type": "string" }, "destroy": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } } }, "aws_direct_connect_connection": { "required": [], "type": "object", "description": "Create, update, or delete a Direct Connect connection between a network and a specific AWS Direct Connect location. Upon creation the connection may be added to a link aggregation group or established as a standalone connection. The connection may later be associated or disassociated with a link aggregation group.", "properties": { "name": { "type": "string" }, "state": { "type": "string" }, "force_update": { "type": "string" }, "connection_id": { "type": "string" }, "bandwidth": { "type": "string" }, "link_aggregation_group": { "type": "string" }, "location": { "type": "string" } } }, "vmware_resource_pool": { "required": [ "resource_pool", "datacenter", "password", "hostname", "username", "cluster" ], "type": "object", "description": "This module can be used to add/remove a resource pool to/from vCenter", "properties": { "resource_pool": { "type": "string" }, "datacenter": { "type": "string" }, "cpu_reservation": { "type": "integer" }, "mem_reservation": { "type": "integer" }, "mem_expandable_reservations": { "type": "boolean" }, "hostname": { "type": "string" }, "state": { "type": "string" }, "username": { "type": "string" }, "cluster": { "type": "string" }, "cpu_expandable_reservations": { "type": "boolean" }, "cpu_limit": { "type": "string" }, "mem_shares": { "type": "string" }, "mem_limit": { "type": "string" }, "password": { "type": "string" }, "cpu_shares": { "type": "string" } } }, "apache2_mod_proxy": { "required": [ "balancer_vhost" ], "type": "object", "description": "Set and/or get members' attributes of an Apache httpd 2.4 mod_proxy balancer pool, using HTTP POST and GET requests. The httpd mod_proxy balancer-member status page has to be enabled and accessible, as this module relies on parsing this page. This module supports ansible check_mode, and requires BeautifulSoup python module.", "properties": { "tls": { "type": "boolean" }, "balancer_vhost": { "type": "string" }, "balancer_url_suffix": { "type": "string" }, "member_host": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "validate_certs": { "type": "boolean" } } }, "avi_analyticsprofile": { "required": [ "name" ], "type": "object", "description": "This module is used to configure AnalyticsProfile object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "hs_event_throttle_window": { "type": "string" }, "disable_se_analytics": { "type": "string" }, "hs_performance_boost": { "type": "string" }, "apdex_server_rtt_tolerated_factor": { "type": "string" }, "hs_security_encalgo_score_rc4": { "type": "string" }, "hs_security_tls12_score": { "type": "string" }, "exclude_server_tcp_reset_as_error": { "type": "string" }, "hs_min_dos_rate": { "type": "string" }, "exclude_no_dns_record_as_error": { "items": { "type": "string" }, "type": "array" }, "conn_server_lossy_zero_win_size_event_threshold": { "type": "string" }, "hs_max_resources_penalty": { "type": "string" }, "conn_lossy_total_rexmt_threshold": { "type": "string" }, "client_log_streaming_config": { "type": "string" }, "hs_pscore_traffic_threshold_l4_client": { "type": "string" }, "hs_security_ssl30_score": { "type": "string" }, "hs_security_weak_signature_algo_penalty": { "type": "string" }, "exclude_no_valid_gs_member_as_error": { "items": { "type": "string" }, "type": "array" }, "apdex_server_response_threshold": { "type": "string" }, "hs_security_cipherscore_ge128b": { "type": "string" }, "resp_code_block": { "type": "string" }, "hs_security_nonpfs_penalty": { "type": "string" }, "uuid": { "type": "string" }, "exclude_invalid_dns_domain_as_error": { "items": { "type": "string" }, "type": "array" }, "exclude_http_error_codes": { "items": { "type": "string" }, "type": "array" }, "hs_max_anomaly_penalty": { "type": "string" }, "hs_security_tls11_score": { "type": "string" }, "exclude_gs_down_as_error": { "items": { "type": "string" }, "type": "array" }, "apdex_server_response_tolerated_factor": { "type": "string" }, "state": { "type": "string" }, "disable_server_analytics": { "type": "string" }, "conn_server_lossy_ooo_threshold": { "type": "string" }, "exclude_client_close_before_request_as_error": { "type": "string" }, "exclude_persistence_change_as_error": { "items": { "type": "string" }, "type": "array" }, "hs_security_hsts_penalty": { "type": "string" }, "hs_security_selfsignedcert_penalty": { "type": "string" }, "conn_server_lossy_total_rexmt_threshold": { "type": "string" }, "conn_lossy_timeo_rexmt_threshold": { "type": "string" }, "apdex_rtt_tolerated_factor": { "type": "string" }, "hs_security_certscore_gt30d": { "type": "string" }, "description": { "type": "string" }, "client_log_config": { "type": "string" }, "apdex_rum_tolerated_factor": { "type": "string" }, "hs_security_cipherscore_eq000b": { "type": "string" }, "hs_security_certscore_le30d": { "type": "string" }, "hs_pscore_traffic_threshold_l4_server": { "type": "string" }, "exclude_syn_retransmit_as_error": { "items": { "type": "string" }, "type": "array" }, "ranges": { "items": { "type": "string" }, "type": "array" }, "apdex_server_rtt_threshold": { "type": "string" }, "exclude_server_dns_error_as_error": { "items": { "type": "string" }, "type": "array" }, "hs_security_certscore_le07d": { "type": "string" }, "conn_server_lossy_timeo_rexmt_threshold": { "type": "string" }, "conn_lossy_zero_win_size_event_threshold": { "type": "string" }, "apdex_rum_threshold": { "type": "string" }, "name": { "type": "string" }, "hs_security_chain_invalidity_penalty": { "type": "string" }, "apdex_rtt_threshold": { "type": "string" }, "tenant_ref": { "type": "string" }, "apdex_response_tolerated_factor": { "type": "string" }, "exclude_tcp_reset_as_error": { "items": { "type": "string" }, "type": "array" }, "hs_max_security_penalty": { "type": "string" }, "exclude_invalid_dns_query_as_error": { "items": { "type": "string" }, "type": "array" }, "conn_lossy_ooo_threshold": { "type": "string" }, "hs_security_cipherscore_lt128b": { "type": "string" }, "url": { "type": "string" }, "hs_security_tls10_score": { "type": "string" }, "hs_security_certscore_expired": { "type": "string" }, "apdex_response_threshold": { "type": "string" }, "hs_security_encalgo_score_none": { "type": "string" }, "exclude_unsupported_dns_query_as_error": { "items": { "type": "string" }, "type": "array" } } }, "iosxr_system": { "required": [], "type": "object", "description": "This module provides declarative management of node system attributes on Cisco IOS XR devices. It provides an option to configure host system parameters or remove those parameters from the device active configuration.", "properties": { "lookup_source": { "type": "string" }, "domain_search": { "items": { "type": "string" }, "type": "array" }, "hostname": { "type": "string" }, "domain_name": { "type": "string" }, "state": { "type": "string" }, "name_servers": { "items": { "type": "string" }, "type": "array" }, "lookup_enabled": { "type": "string" } } }, "authorized_key": { "required": [ "user", "key" ], "type": "object", "description": "Adds or removes SSH authorized keys for particular user accounts", "properties": { "comment": { "type": "string" }, "exclusive": { "type": "string" }, "key_options": { "type": "string" }, "state": { "type": "string" }, "user": { "type": "string" }, "key": { "type": "string" }, "path": { "type": "string" }, "validate_certs": { "type": "string" }, "manage_dir": { "type": "string" } } }, "vmware_dns_config": { "required": [ "change_hostname_to", "dns_servers", "domainname" ], "type": "object", "description": "Manage VMware ESXi DNS Configuration", "properties": { "change_hostname_to": { "type": "string" }, "dns_servers": { "type": "string" }, "domainname": { "type": "string" } } }, "at": { "required": [ "count", "units" ], "type": "object", "description": "Use this module to schedule a command or script file to run once in the future.\nAll jobs are executed in the 'a' queue.", "properties": { "count": { "type": "string" }, "state": { "type": "string" }, "command": { "type": "string" }, "units": { "type": "string" }, "unique": { "type": "string" }, "script_file": { "type": "string" } } }, "bigip_routedomain": { "required": [ "id" ], "type": "object", "description": "Manage route domains on a BIG-IP", "properties": { "flow_eviction_policy": { "type": "string" }, "service_policy": { "type": "string" }, "description": { "type": "string" }, "parent": { "type": "string" }, "connection_limit": { "type": "string" }, "strict": { "type": "string" }, "state": { "type": "string" }, "routing_protocol": { "type": "string" }, "bwc_policy": { "type": "string" }, "vlans": { "type": "string" }, "id": { "type": "string" } } }, "win_msi": { "required": [ "path" ], "type": "object", "description": "Installs or uninstalls a Windows MSI file that is already located on the target server.", "properties": { "extra_args": { "type": "string" }, "removes": { "type": "string" }, "creates": { "type": "string" }, "state": { "type": "string" }, "path": { "type": "string" }, "wait": { "type": "string" } } }, "virt": { "required": [ "name" ], "type": "object", "description": "Manages virtual machines supported by I(libvirt).", "properties": { "xml": { "type": "string" }, "name": { "type": "string" }, "uri": { "type": "string" }, "state": { "type": "string" }, "command": { "type": "string" }, "autostart": { "type": "string" } } }, "win_msg": { "required": [], "type": "object", "description": "Wraps the msg.exe command in order to send messages to Windows hosts.", "properties": { "msg": { "type": "string" }, "to": { "type": "string" }, "wait": { "type": "string" }, "display_seconds": { "type": "integer" } } }, "aci_epg_monitoring_policy": { "required": [ "monitoring_policy", "tenant" ], "type": "object", "description": "Manage monitoring policies on Cisco ACI fabrics.\nMore information from the internal APIC class I(mon:EPGPol) at U(https://developer.cisco.com/media/mim-ref/MO-monEPGPol.html).", "properties": { "monitoring_policy": { "type": "string" }, "description": { "type": "string" }, "tenant": { "type": "string" }, "state": { "items": { "type": "string" }, "type": "array" } } }, "bigip_device_trust": { "required": [ "peer_server" ], "type": "object", "description": "Manage the trust relationships between BIG-IPs. Devices, once peered, cannot be updated. If updating is needed, the peer must first be removed before it can be re-added to the trust.", "properties": { "peer_server": { "type": "string" }, "peer_user": { "type": "string" }, "type": { "type": "string" }, "peer_hostname": { "type": "string" }, "peer_password": { "type": "string" } } }, "avi_seproperties": { "required": [], "type": "object", "description": "This module is used to configure SeProperties object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "se_agent_properties": { "type": "string" }, "uuid": { "type": "string" }, "url": { "type": "string" }, "se_runtime_properties": { "type": "string" }, "state": { "type": "string" }, "se_bootup_properties": { "type": "string" } } }, "cs_vpc": { "required": [ "name" ], "type": "object", "description": "Create, update and delete VPCs.", "properties": { "display_text": { "type": "string" }, "vpc_offering": { "type": "string" }, "poll_async": { "type": "boolean" }, "name": { "type": "string" }, "zone": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "clean_up": { "type": "string" }, "project": { "type": "string" }, "state": { "type": "string" }, "domain": { "type": "string" }, "account": { "type": "string" }, "cidr": { "type": "string" }, "network_domain": { "type": "string" } } }, "mongodb_parameter": { "required": [ "database", "param", "value" ], "type": "object", "description": "Change an administrative parameter on a MongoDB server.", "properties": { "login_port": { "type": "integer" }, "database": { "type": "string" }, "login_user": { "type": "string" }, "login_host": { "type": "string" }, "login_password": { "type": "string" }, "param": { "type": "string" }, "ssl": { "type": "boolean" }, "param_type": { "type": "string" }, "value": { "type": "string" }, "login_database": { "type": "string" }, "replica_set": { "type": "string" } } }, "rollbar_deployment": { "required": [ "environment", "token", "revision" ], "type": "object", "description": "Notify Rollbar about app deployments (see https://rollbar.com/docs/deploys_other/)", "properties": { "comment": { "type": "string" }, "rollbar_user": { "type": "string" }, "url": { "type": "string" }, "environment": { "type": "string" }, "token": { "type": "string" }, "user": { "type": "string" }, "validate_certs": { "type": "string" }, "revision": { "type": "string" } } }, "linode": { "required": [], "type": "object", "description": "Manage Linode Public Cloud instances and optionally wait for it to be 'running'.", "properties": { "alert_diskio_enabled": { "type": "string" }, "payment_term": { "type": "integer" }, "alert_bwquota_enabled": { "type": "string" }, "private_ip": { "type": "string" }, "watchdog": { "type": "string" }, "ssh_pub_key": { "type": "string" }, "backupweeklyday": { "type": "string" }, "displaygroup": { "type": "string" }, "alert_bwout_enabled": { "type": "string" }, "state": { "type": "string" }, "swap": { "type": "integer" }, "api_key": { "type": "string" }, "additional_disks": { "items": { "type": "string" }, "type": "array" }, "alert_bwin_enabled": { "type": "string" }, "kernel_id": { "type": "string" }, "alert_bwin_threshold": { "type": "string" }, "alert_cpu_enabled": { "type": "string" }, "linode_id": { "type": "string" }, "alert_diskio_threshold": { "type": "string" }, "wait_timeout": { "type": "integer" }, "plan": { "type": "string" }, "password": { "type": "string" }, "wait": { "type": "string" }, "datacenter": { "type": "string" }, "name": { "type": "string" }, "alert_cpu_threshold": { "type": "string" }, "distribution": { "type": "string" }, "alert_bwquota_threshold": { "type": "string" }, "alert_bwout_threshold": { "type": "string" } } }, "nxos_pim_interface": { "required": [ "jp_policy_out", "interface" ], "type": "object", "description": "Manages PIM interface configuration settings.", "properties": { "jp_policy_in": { "type": "string" }, "sparse": { "type": "boolean" }, "jp_type_in": { "type": "string" }, "jp_policy_out": { "type": "string" }, "neighbor_type": { "type": "string" }, "state": { "type": "string" }, "neighbor_policy": { "type": "string" }, "hello_interval": { "type": "string" }, "interface": { "type": "string" }, "hello_auth_key": { "type": "string" }, "border": { "type": "string" }, "jp_type_out": { "type": "string" } } }, "nclu": { "required": [], "type": "object", "description": "Interface to the Network Command Line Utility, developed to make it easier to configure operating systems running ifupdown2 and Quagga, such as Cumulus Linux. Command documentation is available at U(https://docs.cumulusnetworks.com/display/DOCS/Network+Command+Line+Utility)", "properties": { "commands": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" }, "abort": { "type": "boolean" }, "atomic": { "type": "boolean" }, "template": { "type": "string" }, "commit": { "type": "boolean" } } }, "os_keystone_endpoint": { "required": [ "interface", "service", "url" ], "type": "object", "description": "Create, update, or delete OpenStack Identity service endpoints. If a service with the same combination of I(service), I(interface) and I(region) exist, the I(url) and I(state) (C(present) or C(absent)) will be updated.", "properties": { "service": { "type": "string" }, "url": { "type": "string" }, "region": { "type": "string" }, "enabled": { "type": "boolean" }, "state": { "type": "string" }, "interface": { "type": "string" } } }, "clc_group": { "required": [ "name" ], "type": "object", "description": "Create or delete Server Groups at Centurylink Centurylink Cloud", "properties": { "description": { "type": "string" }, "parent": { "type": "string" }, "state": { "type": "string" }, "location": { "type": "string" }, "wait": { "type": "boolean" }, "name": { "type": "string" } } }, "infinity": { "required": [ "username", "server_ip", "action", "password" ], "type": "object", "description": "Manage Infinity IPAM using REST API", "properties": { "username": { "type": "string" }, "network_size": { "type": "string" }, "network_location": { "type": "integer" }, "network_family": { "type": "string" }, "network_id": { "type": "string" }, "network_name": { "type": "string" }, "network_address": { "type": "string" }, "server_ip": { "type": "string" }, "action": { "type": "string" }, "password": { "type": "string" }, "ip_address": { "type": "string" }, "network_type": { "type": "string" } } }, "na_cdot_svm": { "required": [ "state", "name" ], "type": "object", "description": "Create or destroy svm on NetApp cDOT", "properties": { "root_volume_security_style": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "root_volume_aggregate": { "type": "string" }, "name": { "type": "string" }, "root_volume": { "type": "string" } } }, "ce_bgp_neighbor": { "required": [ "remote_as", "vrf_name", "peer_addr" ], "type": "object", "description": "Manages BGP peer configurations on HUAWEI CloudEngine switches.", "properties": { "prepend_global_as": { "type": "string" }, "ebgp_max_hop": { "type": "string" }, "is_ignore": { "type": "string" }, "prepend_fake_as": { "type": "string" }, "fake_as": { "type": "string" }, "is_single_hop": { "type": "string" }, "conventional": { "type": "string" }, "remote_as": { "type": "string" }, "valid_ttl_hops": { "type": "string" }, "tx_interval": { "type": "string" }, "pswd_cipher_text": { "type": "string" }, "local_if_name": { "type": "string" }, "rx_interval": { "type": "string" }, "state": { "type": "string" }, "pswd_type": { "type": "string" }, "dual_as": { "type": "string" }, "connect_mode": { "items": { "type": "string" }, "type": "array" }, "description": { "type": "string" }, "is_log_change": { "type": "string" }, "keep_alive_time": { "type": "string" }, "key_chain_name": { "type": "string" }, "conn_retry_time": { "type": "string" }, "min_hold_time": { "type": "string" }, "multiplier": { "type": "string" }, "hold_time": { "type": "string" }, "is_bfd_block": { "type": "string" }, "tcp_MSS": { "type": "string" }, "is_bfd_enable": { "type": "string" }, "route_refresh": { "type": "string" }, "peer_addr": { "type": "string" }, "vrf_name": { "type": "string" }, "mpls_local_ifnet_disable": { "type": "string" } } }, "azure_rm_securitygroup_facts": { "required": [ "resource_group" ], "type": "object", "description": "Get facts for a specific security group or all security groups within a resource group.", "properties": { "name": { "type": "string" }, "resource_group": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } } }, "pkg5": { "required": [ "name" ], "type": "object", "description": "IPS packages are the native packages in Solaris 11 and higher.", "properties": { "accept_licenses": { "type": "boolean" }, "state": { "type": "string" }, "name": { "type": "string" } } }, "slackpkg": { "required": [ "name" ], "type": "object", "description": "Manage binary packages for Slackware using 'slackpkg' which is available in versions after 12.2.", "properties": { "state": { "type": "string" }, "update_cache": { "type": "boolean" }, "name": { "type": "string" } } }, "filesystem": { "required": [ "dev", "fstype" ], "type": "object", "description": "This module creates file system.", "properties": { "resizefs": { "type": "string" }, "force": { "type": "string" }, "opts": { "items": { "type": "string" }, "type": "array" }, "dev": { "type": "string" }, "fstype": { "type": "string" } } }, "django_manage": { "required": [ "app_path", "command" ], "type": "object", "description": "Manages a Django application using the I(manage.py) application frontend to I(django-admin). With the I(virtualenv) parameter, all management commands will be executed by the given I(virtualenv) installation.", "properties": { "virtualenv": { "type": "string" }, "app_path": { "type": "string" }, "database": { "type": "string" }, "pythonpath": { "type": "string" }, "settings": { "type": "string" }, "apps": { "items": { "type": "string" }, "type": "array" }, "cache_table": { "type": "string" }, "merge": { "type": "string" }, "command": { "type": "string" }, "skip": { "type": "string" }, "link": { "type": "string" }, "fixtures": { "items": { "type": "string" }, "type": "array" }, "failfast": { "type": "string" } } }, "pn_vrouter": { "required": [ "pn_name", "state" ], "type": "object", "description": "Execute vrouter-create, vrouter-delete, vrouter-modify command.\nEach fabric, cluster, standalone switch, or virtual network (VNET) can provide its tenants with a virtual router (vRouter) service that forwards traffic between networks and implements Layer 3 protocols.\nC(vrouter-create) creates a new vRouter service.\nC(vrouter-delete) deletes a vRouter service.\nC(vrouter-modify) modifies a vRouter service.", "properties": { "pn_ospf_redistribute": { "type": "string" }, "pn_name": { "type": "string" }, "state": { "type": "string" }, "pn_clipassword": { "type": "string" }, "pn_bgp_redistribute": { "type": "string" }, "pn_router_type": { "type": "string" }, "pn_hw_vrrp_id": { "type": "string" }, "pn_vnet": { "type": "string" }, "pn_cliusername": { "type": "string" }, "pn_rip_redistribute": { "type": "string" }, "pn_bgp_options": { "type": "string" }, "pn_router_id": { "type": "string" }, "pn_bgp_max_paths": { "type": "string" }, "pn_service_state": { "type": "string" }, "pn_service_type": { "type": "string" }, "pn_cliswitch": { "type": "string" }, "pn_ospf_options": { "type": "string" }, "pn_bgp_as": { "type": "string" } } }, "bigip_iapp_template": { "required": [], "type": "object", "description": "Manages TCL iApp templates on a BIG-IP. This module will allow you to deploy iApp templates to the BIG-IP and manage their lifecycle. The conventional way to use this module is to import new iApps as needed or by extracting the contents of the iApp archive that is provided at downloads.f5.com and then importing all the iApps with this module. This module can also update existing iApps provided that the source of the iApp changed while the name stayed the same. Note however that this module will not reconfigure any services that may have been created using the C(bigip_iapp_service) module. iApps are normally not updated in production. Instead, new versions are deployed and then existing services are changed to consume that new template. As such, the ability to update templates in-place requires the C(force) option to be used.", "properties": { "content": { "type": "string" }, "state": { "type": "string" }, "partition": { "type": "string" }, "force": { "type": "string" }, "name": { "type": "string" } } }, "route53": { "required": [ "zone", "record", "state", "type" ], "type": "object", "description": "Creates and deletes DNS records in Amazons Route53 service", "properties": { "health_check": { "type": "string" }, "alias_hosted_zone_id": { "type": "string" }, "weight": { "type": "string" }, "alias": { "type": "boolean" }, "region": { "type": "string" }, "retry_interval": { "type": "integer" }, "private_zone": { "type": "boolean" }, "value": { "items": { "type": "string" }, "type": "array" }, "hosted_zone_id": { "type": "string" }, "record": { "type": "string" }, "state": { "type": "string" }, "wait_timeout": { "type": "integer" }, "alias_evaluate_target_health": { "type": "boolean" }, "ttl": { "type": "string" }, "identifier": { "type": "string" }, "vpc_id": { "type": "string" }, "zone": { "type": "string" }, "type": { "type": "string" }, "failover": { "type": "string" }, "overwrite": { "type": "string" }, "wait": { "type": "boolean" } } }, "netapp_e_amg": { "required": [ "name", "secondaryArrayId", "state" ], "type": "object", "description": "Allows for the creation, removal and updating of Asynchronous Mirror Groups for NetApp E-series storage arrays", "properties": { "name": { "type": "string" }, "syncIntervalMinutes": { "type": "integer" }, "recoveryWarnThresholdMinutes": { "type": "integer" }, "secondaryArrayId": { "type": "string" }, "repoUtilizationWarnThreshold": { "type": "integer" }, "state": { "type": "string" }, "interfaceType": { "type": "string" }, "manualSync": { "type": "boolean" }, "syncWarnThresholdMinutes": { "type": "integer" } } }, "gconftool2": { "required": [ "state", "key" ], "type": "object", "description": "This module allows for the manipulation of GNOME 2 Configuration via gconftool-2. Please see the gconftool-2(1) man pages for more details.", "properties": { "direct": { "type": "string" }, "value": { "items": { "type": "string" }, "type": "array" }, "config_source": { "type": "string" }, "state": { "type": "string" }, "value_type": { "type": "string" }, "key": { "type": "string" } } }, "elb_target_group_facts": { "required": [], "type": "object", "description": "Gather facts about ELB target groups in AWS", "properties": { "target_group_arns": { "type": "string" }, "load_balancer_arn": { "type": "string" }, "names": { "type": "string" } } }, "capabilities": { "required": [ "capability", "path" ], "type": "object", "description": "This module manipulates files privileges using the Linux capabilities(7) system.", "properties": { "capability": { "type": "string" }, "path": { "type": "string" }, "state": { "type": "string" } } }, "hall": { "required": [ "msg", "room_token", "title" ], "type": "object", "description": "The C(hall) module connects to the U(https://hall.com) messaging API and allows you to deliver notication messages to rooms.", "properties": { "msg": { "type": "string" }, "room_token": { "type": "string" }, "picture": { "type": "string" }, "title": { "type": "string" } } }, "ec2_elb_facts": { "required": [], "type": "object", "description": "Gather facts about EC2 Elastic Load Balancers in AWS", "properties": { "names": { "items": { "type": "string" }, "type": "array" } } }, "win_environment": { "required": [ "name", "level" ], "type": "object", "description": "Uses .net Environment to set or remove environment variables and can set at User, Machine or Process level.\nUser level environment variables will be set, but not available until the user has logged off and on again.", "properties": { "state": { "type": "string" }, "name": { "type": "string" }, "value": { "type": "string" }, "level": { "type": "string" } } }, "mksysb": { "required": [ "name", "storage_path" ], "type": "object", "description": "This module manages a basic AIX mksysb (image) of rootvg.", "properties": { "storage_path": { "type": "string" }, "name": { "type": "string" }, "software_packing": { "items": { "type": "string" }, "type": "array" }, "use_snapshot": { "type": "string" }, "create_map_files": { "type": "string" }, "extended_attrs": { "type": "string" }, "backup_crypt_files": { "type": "string" }, "new_image_data": { "type": "string" }, "exclude_wpar_files": { "type": "string" }, "backup_dmapi_fs": { "type": "string" }, "exclude_files": { "type": "string" } } }, "ipa_subca": { "required": [ "subca_desc", "subca_name", "subca_subject" ], "type": "object", "description": "Add, modify, enable, disable and delete an IPA Lightweight Sub Certificate Authorities using IPA API.", "properties": { "subca_desc": { "type": "string" }, "subca_name": { "type": "string" }, "state": { "type": "string" }, "subca_subject": { "type": "string" } } }, "nxos_snmp_contact": { "required": [ "state", "contact" ], "type": "object", "description": "Manages SNMP contact information.", "properties": { "state": { "type": "string" }, "contact": { "type": "string" } } }, "honeybadger_deployment": { "required": [ "environment", "token" ], "type": "object", "description": "Notify Honeybadger.io about app deployments (see http://docs.honeybadger.io/article/188-deployment-tracking)", "properties": { "environment": { "type": "string" }, "url": { "type": "string" }, "repo": { "type": "string" }, "token": { "type": "string" }, "user": { "type": "string" }, "validate_certs": { "type": "string" }, "revision": { "type": "string" } } }, "iosxr_logging": { "required": [], "type": "object", "description": "This module provides declarative management of logging on Cisco IOS XR devices.", "properties": { "name": { "type": "string" }, "facility": { "type": "string" }, "dest": { "type": "string" }, "level": { "type": "string" }, "state": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" }, "size": { "type": "integer" } } }, "dynamodb_ttl": { "required": [ "table_name", "attribute_name" ], "type": "object", "description": "Uses boto3 to set TTL.\nrequires botocore version 1.5.24 or higher.", "properties": { "attribute_name": { "type": "string" }, "state": { "type": "string" }, "table_name": { "type": "string" } } }, "os_user_role": { "required": [ "role" ], "type": "object", "description": "Grant and revoke roles in either project or domain context for OpenStack Identity Users.", "properties": { "domain": { "type": "string" }, "group": { "type": "string" }, "availability_zone": { "type": "string" }, "project": { "type": "string" }, "state": { "type": "string" }, "role": { "type": "string" }, "user": { "type": "string" } } }, "bigip_irule": { "required": [ "src", "name", "module" ], "type": "object", "description": "Manage iRules across different modules on a BIG-IP.", "properties": { "src": { "type": "string" }, "name": { "type": "string" }, "partition": { "type": "string" }, "module": { "type": "string" }, "content": { "type": "string" }, "state": { "type": "string" } } }, "nso_config": { "required": [ "data" ], "type": "object", "description": "This module provides support for managing configuration in Cisco NSO and can also ensure services are in sync.", "properties": { "data": { "items": { "type": "string" }, "type": "array" } } }, "aos_logical_device": { "required": [ "session" ], "type": "object", "description": "Apstra AOS Logical Device module let you manage your Logical Devices easily. You can create create and delete Logical Device by Name, ID or by using a JSON File. This module is idempotent and support the I(check) mode. It's using the AOS REST API.", "properties": { "content": { "type": "string" }, "state": { "type": "string" }, "session": { "type": "string" }, "name": { "type": "string" }, "id": { "type": "string" } } }, "synchronize": { "required": [ "src", "dest" ], "type": "object", "description": "C(synchronize) is a wrapper around rsync to make common tasks in your playbooks quick and easy. It is run and originates on the local host where Ansible is being run. Of course, you could just use the C(command) action to call rsync yourself, but you also have to add a fair number of boilerplate options and host facts. C(synchronize) is not intended to provide access to the full power of rsync, but does make the most common invocations easier to implement. You `still` may need to call rsync directly via C(command) or C(shell) depending on your use case.", "properties": { "partial": { "type": "string" }, "links": { "type": "string" }, "copy_links": { "type": "string" }, "perms": { "type": "string" }, "link_dest": { "type": "string" }, "owner": { "type": "string" }, "archive": { "type": "string" }, "dest_port": { "type": "string" }, "group": { "type": "string" }, "existing_only": { "type": "string" }, "rsync_path": { "type": "string" }, "verify_host": { "type": "string" }, "use_ssh_args": { "type": "string" }, "dirs": { "type": "string" }, "private_key": { "type": "string" }, "dest": { "type": "string" }, "compress": { "type": "string" }, "rsync_timeout": { "type": "integer" }, "rsync_opts": { "type": "string" }, "set_remote_user": { "type": "boolean" }, "recursive": { "type": "string" }, "src": { "type": "string" }, "checksum": { "type": "string" }, "times": { "type": "string" }, "mode": { "type": "string" }, "delete": { "type": "string" } } }, "avi_backupconfiguration": { "required": [ "name" ], "type": "object", "description": "This module is used to configure BackupConfiguration object\nmore examples at U(https://github.com/avinetworks/devops)", "properties": { "ssh_user_ref": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "tenant_ref": { "type": "string" }, "remote_hostname": { "type": "string" }, "backup_passphrase": { "type": "string" }, "state": { "type": "string" }, "save_local": { "type": "string" }, "maximum_backups_stored": { "type": "string" }, "upload_to_remote_host": { "type": "string" }, "backup_file_prefix": { "type": "string" }, "remote_directory": { "type": "string" }, "uuid": { "type": "string" } } }, "aci_contract_subject": { "required": [], "type": "object", "description": "Manage initial Contract Subjects on Cisco ACI fabrics.\nMore information from the internal APIC class I(vz:Subj) at U(https://developer.cisco.com/media/mim-ref/MO-vzSubj.html).", "properties": { "description": { "type": "string" }, "consumer_match": { "type": "string" }, "contract": { "type": "string" }, "priority": { "type": "string" }, "state": { "items": { "type": "string" }, "type": "array" }, "dscp": { "type": "string" }, "reverse_filter": { "type": "boolean" }, "provider_match": { "type": "string" }, "tenant": { "type": "string" }, "subject": { "type": "string" } } }, "campfire": { "required": [ "msg", "token", "subscription", "room" ], "type": "object", "description": "Send a message to Campfire.\nMessages with newlines will result in a \"Paste\" message being sent.", "properties": { "msg": { "type": "string" }, "token": { "type": "string" }, "room": { "type": "string" }, "notify": { "type": "string" }, "subscription": { "type": "string" } } }, "ovirt_affinity_label": { "required": [ "name" ], "type": "object", "description": "This module manage affinity labels in oVirt/RHV. It can also manage assignments of those labels to hosts and VMs.", "properties": { "cluster": { "type": "string" }, "state": { "type": "string" }, "hosts": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "vms": { "items": { "type": "string" }, "type": "array" } } }, "nxos_file_copy": { "required": [ "local_file" ], "type": "object", "description": "Copy a file to the flash (or bootflash) remote network device on NXOS devices.", "properties": { "remote_file": { "type": "string" }, "local_file": { "type": "string" }, "file_system": { "type": "string" }, "connect_ssh_port": { "type": "integer" } } }, "os_flavor_facts": { "required": [], "type": "object", "description": "Retrieve facts about available OpenStack instance flavors. By default, facts about ALL flavors are retrieved. Filters can be applied to get facts for only matching flavors. For example, you can filter on the amount of RAM available to the flavor, or the number of virtual CPUs available to the flavor, or both. When specifying multiple filters, *ALL* filters must match on a flavor before that flavor is returned as a fact.", "properties": { "name": { "type": "string" }, "availability_zone": { "type": "string" }, "ram": { "type": "boolean" }, "ephemeral": { "type": "boolean" }, "vcpus": { "type": "boolean" }, "limit": { "type": "string" } } }, "azure_rm_storageaccount_facts": { "required": [], "type": "object", "description": "Get facts for one storage account or all storage accounts within a resource group.", "properties": { "name": { "type": "string" }, "resource_group": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" } } }, "haproxy": { "required": [ "state", "host" ], "type": "object", "description": "Enable, disable, drain and set weights for HAProxy backend servers using socket commands.", "properties": { "drain": { "type": "boolean" }, "socket": { "type": "string" }, "weight": { "type": "string" }, "wait_interval": { "type": "integer" }, "host": { "type": "string" }, "wait": { "type": "boolean" }, "wait_retries": { "type": "integer" }, "state": { "type": "string" }, "fail_on_not_found": { "type": "boolean" }, "shutdown_sessions": { "type": "boolean" }, "backend": { "type": "string" } } }, "nxos_rollback": { "required": [], "type": "object", "description": "This module offers the ability to set a configuration checkpoint file or rollback to a configuration checkpoint file on Cisco NXOS switches.", "properties": { "checkpoint_file": { "type": "string" }, "rollback_to": { "type": "string" } } }, "cs_facts": { "required": [], "type": "object", "description": "This module fetches data from the metadata API in CloudStack. The module must be called from within the instance itself.", "properties": { "filter": { "type": "string" }, "meta_data_host": { "type": "string" } } }, "ec2_metadata_facts": { "required": [], "type": "object", "description": "This module fetches data from the instance metadata endpoint in ec2 as per http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-instance-metadata.html. The module must be called from within the EC2 instance itself.", "properties": {} }, "elb_application_lb": { "required": [ "state", "name" ], "type": "object", "description": "Manage an AWS Application Elastic Load Balancer. See U(https://aws.amazon.com/blogs/aws/new-aws-application-load-balancer/) for details.", "properties": { "subnets": { "items": { "type": "string" }, "type": "array" }, "access_logs_enabled": { "type": "string" }, "tags": { "type": "string" }, "purge_tags": { "type": "boolean" }, "access_logs_s3_bucket": { "type": "string" }, "state": { "type": "string" }, "idle_timeout": { "type": "integer" }, "deletion_protection": { "type": "boolean" }, "purge_listeners": { "items": { "type": "boolean" }, "type": "array" }, "access_logs_s3_prefix": { "type": "string" }, "scheme": { "type": "string" }, "listeners": { "items": { "type": "string" }, "type": "array" }, "security_groups": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" } } }, "gcp_backend_service": { "required": [ "backends", "healthchecks", "backend_service_name" ], "type": "object", "description": "Create or Destroy a Backend Service. See U(https://cloud.google.com/compute/docs/load-balancing/http/backend-service) for an overview. Full install/configuration instructions for the Google Cloud modules can be found in the comments of ansible/test/gce_tests.py.", "properties": { "protocol": { "type": "string" }, "service_account_email": { "type": "string" }, "backends": { "items": { "type": "string" }, "type": "array" }, "state": { "type": "string" }, "enable_cdn": { "type": "string" }, "port_name": { "type": "string" }, "timeout": { "type": "string" }, "credentials_file": { "type": "string" }, "healthchecks": { "items": { "type": "string" }, "type": "array" }, "backend_service_name": { "type": "string" }, "project_id": { "type": "string" } } }, "win_eventlog_entry": { "required": [ "source", "log", "event_id", "message" ], "type": "object", "description": "Write log entries to a given event log from a specified source.", "properties": { "category": { "type": "string" }, "log": { "type": "string" }, "event_id": { "type": "string" }, "entry_type": { "type": "string" }, "source": { "type": "string" }, "raw_data": { "type": "string" }, "message": { "type": "string" } } }, "os_server_volume": { "required": [ "volume", "server" ], "type": "object", "description": "Attach or Detach volumes from OpenStack VM's", "properties": { "volume": { "type": "string" }, "device": { "type": "string" }, "state": { "type": "string" }, "availability_zone": { "type": "string" }, "server": { "type": "string" } } }, "ce_acl_advance": { "required": [ "acl_name" ], "type": "object", "description": "Manages advanced ACL configurations on HUAWEI CloudEngine switches.", "properties": { "acl_step": { "type": "string" }, "protocol": { "type": "string" }, "precedence": { "type": "string" }, "dest_port_end": { "type": "string" }, "log_flag": { "type": "boolean" }, "time_range": { "type": "string" }, "src_port_begin": { "type": "string" }, "frag_type": { "type": "string" }, "dest_port_op": { "type": "string" }, "dest_pool_name": { "type": "string" }, "acl_description": { "type": "string" }, "ttl_expired": { "type": "boolean" }, "icmp_type": { "type": "string" }, "src_mask": { "type": "string" }, "icmp_name": { "type": "string" }, "established": { "type": "boolean" }, "igmp_type": { "type": "string" }, "tos": { "type": "string" }, "state": { "type": "string" }, "rule_action": { "type": "string" }, "acl_num": { "type": "string" }, "tcp_flag_mask": { "type": "string" }, "src_port_end": { "type": "string" }, "dest_ip": { "type": "string" }, "icmp_code": { "type": "string" }, "src_port_op": { "type": "string" }, "acl_name": { "type": "string" }, "dscp": { "type": "string" }, "rule_name": { "type": "string" }, "rule_description": { "type": "string" }, "dest_mask": { "type": "string" }, "src_port_pool_name": { "type": "string" }, "source_ip": { "type": "string" }, "syn_flag": { "type": "string" }, "vrf_name": { "type": "string" }, "src_pool_name": { "type": "string" }, "dest_port_begin": { "type": "string" }, "dest_port_pool_name": { "type": "string" }, "rule_id": { "type": "string" } } }, "ecs_service": { "required": [ "name", "state" ], "type": "object", "description": "Creates or terminates ecs services.", "properties": { "repeat": { "type": "integer" }, "name": { "type": "string" }, "desired_count": { "type": "string" }, "placement_constraints": { "type": "string" }, "task_definition": { "type": "string" }, "delay": { "type": "integer" }, "cluster": { "type": "string" }, "state": { "type": "string" }, "role": { "type": "string" }, "deployment_configuration": { "type": "string" }, "load_balancers": { "items": { "type": "string" }, "type": "array" }, "client_token": { "type": "string" }, "placement_strategy": { "type": "string" } } }, "wait_for_connection": { "required": [], "type": "object", "description": "Waits for a total of C(timeout) seconds.\nRetries the transport connection after a timeout of C(connect_timeout).\nTests the transport connection every C(sleep) seconds.\nThis module makes use of internal ansible transport (and configuration) and the ping/win_ping module to guarantee correct end-to-end functioning.\nThis module is also supported for Windows targets.", "properties": { "delay": { "type": "integer" }, "sleep": { "type": "integer" }, "connect_timeout": { "type": "integer" }, "timeout": { "type": "integer" } } }, "win_find": { "required": [ "paths" ], "type": "object", "description": "Return a list of files based on specified criteria.\nMultiple criteria are AND'd together.\nFor non-Windows targets, use the M(find) module instead.", "properties": { "paths": { "items": { "type": "string" }, "type": "array" }, "file_type": { "type": "string" }, "checksum_algorithm": { "type": "string" }, "age": { "type": "string" }, "recurse": { "type": "string" }, "age_stamp": { "type": "string" }, "patterns": { "items": { "type": "string" }, "type": "array" }, "get_checksum": { "type": "string" }, "use_regex": { "type": "string" }, "follow": { "type": "string" }, "hidden": { "type": "string" }, "size": { "type": "string" } } }, "vcenter_license": { "required": [ "username", "hostname", "license", "password" ], "type": "object", "description": "Add and delete vCenter license keys.", "properties": { "username": { "type": "string" }, "labels": { "type": "string" }, "license": { "type": "string" }, "hostname": { "type": "string" }, "state": { "type": "string" }, "password": { "type": "string" } } }, "nxos_facts": { "required": [], "type": "object", "description": "Collects facts from Cisco Nexus devices running the NX-OS operating system. Fact collection is supported over both Cli and Nxapi transports. This module prepends all of the base network fact keys with C(ansible_net_). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.", "properties": { "gather_subset": { "items": { "type": "string" }, "type": "array" } } }, "xbps": { "required": [], "type": "object", "description": "Manage packages with the XBPS package manager.", "properties": { "update_cache": { "items": { "type": "boolean" }, "type": "array" }, "state": { "type": "string" }, "upgrade": { "type": "boolean" }, "recurse": { "type": "boolean" }, "name": { "type": "string" } } }, "win_unzip": { "required": [ "dest", "src" ], "type": "object", "description": "Unzips compressed files and archives.\nSupports .zip files natively\nSupports other formats supported by the Powershell Community Extensions (PSCX) module (basically everything 7zip supports)\nFor non-Windows targets, use the M(unarchive) module instead.", "properties": { "dest": { "type": "string" }, "src": { "type": "string" }, "delete_archive": { "type": "string" }, "recurse": { "type": "string" }, "creates": { "type": "string" } } }, "bigip_snmp_trap": { "required": [ "name" ], "type": "object", "description": "Manipulate SNMP trap information on a BIG-IP.", "properties": { "snmp_version": { "type": "string" }, "network": { "type": "string" }, "destination": { "type": "string" }, "community": { "type": "string" }, "state": { "type": "string" }, "port": { "type": "string" }, "name": { "type": "string" } } }, "getent": { "required": [ "database" ], "type": "object", "description": "Runs getent against one of it's various databases and returns information into the host's facts, in a getent_ prefixed variable.", "properties": { "fail_key": { "type": "string" }, "split": { "items": { "type": "string" }, "type": "array" }, "key": { "type": "string" }, "database": { "type": "string" } } }, "vca_vapp": { "required": [ "vapp_name" ], "type": "object", "description": "This module will actively managed vCloud Air vApp instances. Instances can be created and deleted as well as both deployed and undeployed.", "properties": { "vm_name": { "type": "string" }, "username": { "type": "string" }, "vm_memory": { "type": "string" }, "state": { "type": "string" }, "template_name": { "type": "string" }, "instance_id": { "type": "string" }, "host": { "type": "string" }, "network_mode": { "type": "string" }, "vapp_name": { "type": "string" }, "network_name": { "type": "string" }, "service_type": { "type": "string" }, "org": { "type": "string" }, "operation": { "type": "string" }, "password": { "type": "string" }, "vm_cpus": { "type": "string" }, "vdc_name": { "type": "string" }, "api_version": { "type": "string" } } }, "hg": { "required": [ "repo", "dest" ], "type": "object", "description": "Manages Mercurial (hg) repositories. Supports SSH, HTTP/S and local address.", "properties": { "purge": { "type": "string" }, "executable": { "type": "string" }, "force": { "type": "string" }, "dest": { "type": "string" }, "clone": { "type": "string" }, "update": { "type": "string" }, "repo": { "type": "string" }, "revision": { "type": "string" } } }, "win_package": { "required": [], "type": "object", "description": "Installs or uninstalls a package in either an MSI or EXE format.\nThese packages can be sources from the local file system, network file share or a url.\nPlease read the notes section around some caveats with this module.", "properties": { "username": { "type": "string" }, "expected_return_code": { "type": "string" }, "name": { "type": "string" }, "creates_service": { "type": "string" }, "creates_path": { "type": "string" }, "state": { "type": "string" }, "arguments": { "items": { "type": "string" }, "type": "array" }, "path": { "type": "string" }, "creates_version": { "type": "string" }, "password": { "type": "string" }, "validate_certs": { "type": "string" }, "product_id": { "type": "string" } } }, "snow_record": { "required": [ "username", "password", "instance", "state" ], "type": "object", "description": "Creates/Deletes/Updates a single record in ServiceNow", "properties": { "username": { "type": "string" }, "lookup_field": { "type": "string" }, "number": { "type": "string" }, "instance": { "type": "string" }, "state": { "type": "string" }, "attachment": { "type": "string" }, "table": { "type": "string" }, "password": { "type": "string" }, "data": { "type": "string" } } }, "lvg": { "required": [ "vg" ], "type": "object", "description": "This module creates, removes or resizes volume groups.", "properties": { "vg_options": { "type": "string" }, "pvs": { "items": { "type": "string" }, "type": "array" }, "force": { "type": "string" }, "vg": { "type": "string" }, "state": { "type": "string" }, "pesize": { "type": "integer" }, "pv_options": { "type": "string" } } }, "ios_user": { "required": [], "type": "object", "description": "This module provides declarative management of the local usernames configured on network devices. It allows playbooks to manage either individual usernames or the aggregate of usernames in the current running config. It also supports purging usernames from the configuration that are not explicitly defined.", "properties": { "update_password": { "type": "string" }, "configured_password": { "type": "string" }, "name": { "type": "string" }, "nopassword": { "type": "string" }, "purge": { "type": "boolean" }, "privilege": { "type": "string" }, "state": { "type": "string" }, "aggregate": { "items": { "type": "string" }, "type": "array" }, "view": { "type": "string" } } }, "elb_target_group": { "required": [ "name", "state" ], "type": "object", "description": "Manage an AWS Application Elastic Load Balancer target group. See U(http://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-target-groups.html) for details.", "properties": { "unhealthy_threshold_count": { "type": "string" }, "health_check_timeout": { "type": "string" }, "protocol": { "type": "string" }, "name": { "type": "string" }, "tags": { "type": "string" }, "purge_tags": { "type": "boolean" }, "health_check_port": { "type": "string" }, "successful_response_codes": { "type": "string" }, "port": { "type": "string" }, "stickiness_lb_cookie_duration": { "type": "string" }, "health_check_interval": { "type": "string" }, "state": { "type": "string" }, "stickiness_enabled": { "type": "string" }, "vpc_id": { "type": "string" }, "stickiness_type": { "type": "string" }, "deregistration_delay_timeout": { "type": "string" }, "modify_targets": { "type": "boolean" }, "healthy_threshold_count": { "type": "string" }, "targets": { "items": { "type": "string" }, "type": "array" }, "health_check_path": { "type": "string" }, "health_check_protocol": { "type": "string" } } }, "ovirt_nics_facts": { "required": [ "vm" ], "type": "object", "description": "Retrieve facts about one or more oVirt/RHV virtual machine network interfaces.", "properties": { "vm": { "type": "string" }, "name": { "type": "string" } } }, "ios_facts": { "required": [], "type": "object", "description": "Collects a base set of device facts from a remote device that is running IOS. This module prepends all of the base network fact keys with C(ansible_net_). The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.", "properties": { "gather_subset": { "items": { "type": "string" }, "type": "array" } } }, "pip": { "required": [], "type": "object", "description": "Manage Python library dependencies. To use this module, one of the following keys is required: C(name) or C(requirements).", "properties": { "virtualenv": { "type": "string" }, "extra_args": { "type": "string" }, "virtualenv_command": { "type": "string" }, "chdir": { "type": "string" }, "requirements": { "type": "string" }, "name": { "items": { "type": "string" }, "type": "array" }, "virtualenv_python": { "type": "string" }, "umask": { "type": "string" }, "editable": { "type": "string" }, "executable": { "type": "string" }, "virtualenv_site_packages": { "type": "string" }, "state": { "type": "string" }, "version": { "type": "string" } } }, "ovirt_users_facts": { "required": [], "type": "object", "description": "Retrieve facts about one or more oVirt/RHV users.", "properties": { "pattern": { "type": "string" } } }, "cl_ports": { "required": [], "type": "object", "description": "Set the initial port attribute defined in the Cumulus Linux ports.conf, file. This module does not do any error checking at the moment. Be careful to not include ports that do not exist on the switch. Carefully read the original ports.conf file for any exceptions or limitations. For more details go the Configure Switch Port Attribute Documentation at U(http://docs.cumulusnetworks.com).", "properties": { "speed_4_by_10g": { "items": { "type": "string" }, "type": "array" }, "speed_10g": { "items": { "type": "string" }, "type": "array" }, "speed_40g": { "items": { "type": "string" }, "type": "array" }, "speed_40g_div_4": { "items": { "type": "string" }, "type": "array" } } }, "ec2_vpc_nacl": { "required": [], "type": "object", "description": "Read the AWS documentation for Network ACLS U(http://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/VPC_ACLs.html)", "properties": { "subnets": { "items": { "type": "string" }, "type": "array" }, "ingress": { "items": { "type": "string" }, "type": "array" }, "name": { "type": "string" }, "tags": { "type": "string" }, "state": { "type": "string" }, "egress": { "items": { "type": "string" }, "type": "array" }, "vpc_id": { "type": "string" }, "nacl_id": { "type": "string" } } }, "junos_system": { "required": [], "type": "object", "description": "This module provides declarative management of node system attributes on Juniper JUNOS devices. It provides an option to configure host system parameters or remove those parameters from the device active configuration.", "properties": { "domain_search": { "items": { "type": "string" }, "type": "array" }, "hostname": { "type": "string" }, "domain_name": { "type": "string" }, "active": { "type": "boolean" }, "state": { "type": "string" }, "name_servers": { "items": { "type": "string" }, "type": "array" } } }, "docker_secret": { "required": [ "name" ], "type": "object", "description": "Create and remove Docker secrets in a Swarm environment. Similar to `docker secret create` and `docker secret rm`.\nAdds to the metadata of new secrets 'ansible_key', an encrypted hash representation of the data, which is then used\nin future runs to test if a secret has changed.\nIf 'ansible_key is not present, then a secret will not be updated unless the C(force) option is set.\nUpdates to secrets are performed by removing the secret and creating it again.", "properties": { "force": { "type": "boolean" }, "state": { "type": "string" }, "labels": { "type": "string" }, "data": { "type": "string" }, "name": { "type": "string" } } }, "crypttab": { "required": [ "state", "name" ], "type": "object", "description": "Control Linux encrypted block devices that are set up during system boot in C(/etc/crypttab).", "properties": { "name": { "type": "string" }, "backing_device": { "type": "string" }, "state": { "type": "string" }, "path": { "type": "string" }, "password": { "type": "string" }, "opts": { "items": { "type": "string" }, "type": "array" } } }, "riak": { "required": [], "type": "object", "description": "This module can be used to join nodes to a cluster, check the status of the cluster.", "properties": { "target_node": { "type": "string" }, "validate_certs": { "type": "string" }, "wait_for_service": { "type": "string" }, "http_conn": { "items": { "type": "string" }, "type": "array" }, "wait_for_ring": { "type": "string" }, "wait_for_handoffs": { "type": "string" }, "command": { "type": "string" }, "config_dir": { "type": "string" } } }, "stat": { "required": [ "path" ], "type": "object", "description": "Retrieves facts for a file similar to the linux/unix 'stat' command.\nFor Windows targets, use the M(win_stat) module instead.", "properties": { "checksum_algorithm": { "type": "string" }, "get_checksum": { "type": "string" }, "path": { "type": "string" }, "follow": { "type": "string" }, "get_md5": { "type": "string" }, "get_mime": { "type": "string" }, "get_attributes": { "type": "string" } } }, "vmware_local_user_manager": { "required": [ "local_user_name" ], "type": "object", "description": "Manage local users on an ESXi host", "properties": { "local_user_password": { "type": "string" }, "local_user_description": { "type": "string" }, "state": { "type": "string" }, "local_user_name": { "type": "string" } } }, "kubernetes": { "required": [ "inline_data", "api_endpoint", "state" ], "type": "object", "description": "This module can manage Kubernetes resources on an existing cluster using the Kubernetes server API. Users can specify in-line API data, or specify an existing Kubernetes YAML file.\nCurrently, this module (1) Only supports HTTP Basic Auth (2) Only supports 'strategic merge' for update, http://goo.gl/fCPYxT SSL certs are not working, use C(validate_certs=off) to disable.", "properties": { "url_password": { "type": "string" }, "certificate_authority_data": { "type": "string" }, "inline_data": { "type": "string" }, "insecure": { "type": "string" }, "file_reference": { "type": "string" }, "api_endpoint": { "type": "string" }, "state": { "type": "string" }, "url_username": { "type": "string" }, "validate_certs": { "type": "string" }, "patch_operation": { "type": "string" } } }, "bigip_monitor_tcp_echo": { "required": [ "name" ], "type": "object", "description": "Manages F5 BIG-IP LTM tcp monitors via iControl SOAP API.", "properties": { "name": { "type": "string" }, "parent": { "type": "string" }, "ip": { "type": "string" }, "interval": { "type": "string" }, "time_until_up": { "type": "string" }, "timeout": { "type": "string" } } }, "pn_trunk": { "required": [ "pn_name", "state" ], "type": "object", "description": "Execute trunk-create or trunk-delete command.\nTrunks can be used to aggregate network links at Layer 2 on the local switch. Use this command to create a new trunk.", "properties": { "pn_name": { "type": "string" }, "pn_lacp_fallback_timeout": { "type": "string" }, "pn_lacp_timeout": { "type": "string" }, "pn_host": { "type": "string" }, "pn_port_macaddr": { "type": "string" }, "pn_lacp_fallback": { "type": "string" }, "pn_routing": { "type": "string" }, "pn_mirror_receive": { "type": "string" }, "pn_egress_rate_limit": { "type": "string" }, "state": { "type": "string" }, "pn_broadcast_level": { "type": "string" }, "pn_cliswitch": { "type": "string" }, "pn_unknown_mcast_level": { "type": "string" }, "pn_unknown_ucast_level": { "type": "string" }, "pn_loopback": { "type": "string" }, "pn_speed": { "type": "string" }, "pn_edge_switch": { "type": "string" }, "pn_jumbo": { "type": "string" }, "pn_clipassword": { "type": "string" }, "pn_ports": { "type": "string" }, "pn_cliusername": { "type": "string" }, "pn_lacp_mode": { "type": "string" }, "pn_loopvlans": { "items": { "type": "string" }, "type": "array" }, "pn_lacp_priority": { "type": "string" }, "pn_pause": { "type": "string" }, "pn_description": { "type": "string" } } }, "ipadm_addrprop": { "required": [ "property", "addrobj" ], "type": "object", "description": "Modify IP address properties on Solaris/illumos systems.", "properties": { "state": { "type": "string" }, "property": { "type": "string" }, "temporary": { "type": "boolean" }, "value": { "type": "string" }, "addrobj": { "type": "string" } } }, "oneview_ethernet_network_facts": { "required": [], "type": "object", "description": "Retrieve the facts about one or more of the Ethernet Networks from OneView.", "properties": { "name": { "type": "string" }, "options": { "items": { "type": "string" }, "type": "array" } } }, "digital_ocean_sshkey": { "required": [ "oauth_token" ], "type": "object", "description": "Create/delete DigitalOcean SSH keys.", "properties": { "state": { "type": "string" }, "oauth_token": { "type": "string" }, "ssh_pub_key": { "type": "string" }, "name": { "type": "string" }, "fingerprint": { "type": "string" } } }, "netapp_e_lun_mapping": { "required": [ "state", "volume_name" ], "type": "object", "description": "Allows for the creation and removal of volume to host mappings for NetApp E-series storage arrays.", "properties": { "state": { "type": "string" }, "target": { "type": "string" }, "target_type": { "type": "string" }, "lun": { "type": "integer" }, "volume_name": { "type": "string" } } }, "datadog_monitor": { "required": [ "app_key", "name", "state", "api_key" ], "type": "object", "description": "Manages monitors within Datadog\nOptions like described on http://docs.datadoghq.com/api/", "properties": { "notify_audit": { "type": "boolean" }, "locked": { "type": "boolean" }, "timeout_h": { "type": "string" }, "tags": { "items": { "type": "string" }, "type": "array" }, "thresholds": { "type": "string" }, "silenced": { "type": "string" }, "new_host_delay": { "type": "string" }, "app_key": { "type": "string" }, "require_full_window": { "type": "string" }, "notify_no_data": { "type": "boolean" }, "renotify_interval": { "type": "string" }, "state": { "type": "string" }, "no_data_timeframe": { "type": "string" }, "escalation_message": { "type": "string" }, "query": { "type": "string" }, "message": { "type": "string" }, "api_key": { "type": "string" }, "type": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" } } } } } ] }, "$schema": "http://json-schema.org/draft-04/schema#", "type": "array" }