Validate EXAMPLES as YAML

pull/21497/head
Matt Martz 8 years ago committed by Toshio Kuratomi
parent 499d3a1b53
commit 7c00346714

@ -105,14 +105,14 @@ EXAMPLES = '''
# It is assumed that their matching environment variables are set. # It is assumed that their matching environment variables are set.
# Basic creation example: # Basic creation example:
ec2_vpc: - ec2_vpc:
state: present state: present
cidr_block: 172.23.0.0/16 cidr_block: 172.23.0.0/16
resource_tags: { "Environment":"Development" } resource_tags: { "Environment":"Development" }
region: us-west-2 region: us-west-2
# Full creation example with subnets and optional availability zones. # Full creation example with subnets and optional availability zones.
# The absence or presence of subnets deletes or creates them respectively. # The absence or presence of subnets deletes or creates them respectively.
ec2_vpc: - ec2_vpc:
state: present state: present
cidr_block: 172.22.0.0/16 cidr_block: 172.22.0.0/16
resource_tags: { "Environment":"Development" } resource_tags: { "Environment":"Development" }
@ -143,12 +143,12 @@ EXAMPLES = '''
register: vpc register: vpc
# Removal of a VPC by id # Removal of a VPC by id
ec2_vpc: - ec2_vpc:
state: absent state: absent
vpc_id: vpc-aaaaaaa vpc_id: vpc-aaaaaaa
region: us-west-2 region: us-west-2
If you have added elements not managed by this module, e.g. instances, NATs, etc then # If you have added elements not managed by this module, e.g. instances, NATs, etc then
the delete will fail until those dependencies are removed. # the delete will fail until those dependencies are removed.
''' '''

@ -73,7 +73,7 @@ EXAMPLES = '''
# Facts are published in ansible_facts['cloudformation'][<stack_name>] # Facts are published in ansible_facts['cloudformation'][<stack_name>]
- debug: - debug:
msg: '{{ ansible_facts['cloudformation']['my-cloudformation-stack'] }}' msg: "{{ ansible_facts['cloudformation']['my-cloudformation-stack'] }}"
# Get all stack information about a stack # Get all stack information about a stack
- cloudformation_facts: - cloudformation_facts:

@ -145,10 +145,10 @@ EXAMPLES = '''
# Facts are published in ansible_facts['cloudfront'][<distribution_name>] # Facts are published in ansible_facts['cloudfront'][<distribution_name>]
- debug: - debug:
msg: '{{ ansible_facts['cloudfront']['my-cloudfront-distribution-id'] }}' msg: "{{ ansible_facts['cloudfront']['my-cloudfront-distribution-id'] }}"
- debug: - debug:
msg: '{{ ansible_facts['cloudfront']['www.my-website.com'] }}' msg: "{{ ansible_facts['cloudfront']['www.my-website.com'] }}"
# Get all information about an invalidation for a distribution. # Get all information about an invalidation for a distribution.
- cloudfront_facts: - cloudfront_facts:

@ -83,7 +83,8 @@ extends_documentation_fragment: aws
EXAMPLES = """ EXAMPLES = """
- name: enable cloudtrail - name: enable cloudtrail
local_action: cloudtrail local_action:
module: cloudtrail
state: enabled state: enabled
name: main name: main
s3_bucket_name: ourbucket s3_bucket_name: ourbucket
@ -91,7 +92,8 @@ EXAMPLES = """
region: us-east-1 region: us-east-1
- name: enable cloudtrail with different configuration - name: enable cloudtrail with different configuration
local_action: cloudtrail local_action:
module: cloudtrail
state: enabled state: enabled
name: main name: main
s3_bucket_name: ourbucket2 s3_bucket_name: ourbucket2
@ -99,7 +101,8 @@ EXAMPLES = """
region: us-east-1 region: us-east-1
- name: remove cloudtrail - name: remove cloudtrail
local_action: cloudtrail local_action:
module: cloudtrail
state: disabled state: disabled
name: main name: main
region: us-east-1 region: us-east-1

@ -182,15 +182,15 @@ EXAMPLES = '''
# Rolling ASG Updates # Rolling ASG Updates
Below is an example of how to assign a new launch config to an ASG and terminate old instances. # Below is an example of how to assign a new launch config to an ASG and terminate old instances.
#
All instances in "myasg" that do not have the launch configuration named "my_new_lc" will be terminated in # All instances in "myasg" that do not have the launch configuration named "my_new_lc" will be terminated in
a rolling fashion with instances using the current launch configuration, "my_new_lc". # a rolling fashion with instances using the current launch configuration, "my_new_lc".
#
This could also be considered a rolling deploy of a pre-baked AMI. # This could also be considered a rolling deploy of a pre-baked AMI.
#
If this is a newly created group, the instances will not be replaced since all instances # If this is a newly created group, the instances will not be replaced since all instances
will have the current launch configuration. # will have the current launch configuration.
- name: create launch config - name: create launch config
ec2_lc: ec2_lc:
@ -213,8 +213,8 @@ will have the current launch configuration.
desired_capacity: 5 desired_capacity: 5
region: us-east-1 region: us-east-1
To only replace a couple of instances instead of all of them, supply a list # To only replace a couple of instances instead of all of them, supply a list
to "replace_instances": # to "replace_instances":
- ec2_asg: - ec2_asg:
name: myasg name: myasg

@ -175,7 +175,7 @@ EXAMPLES = '''
# Modify the interface to enable the delete_on_terminaton flag # Modify the interface to enable the delete_on_terminaton flag
- ec2_eni: - ec2_eni:
eni_id: {{ "eni.interface.id" }} eni_id: "{{ eni.interface.id }}"
delete_on_termination: true delete_on_termination: true
''' '''

@ -90,7 +90,7 @@ EXAMPLES = '''
hostPort: 80 hostPort: 80
- name: busybox - name: busybox
command: command:
- "/bin/sh -c \"while true; do echo '<html> <head> <title>Amazon ECS Sample App</title> <style>body {margin-top: 40px; background-color: #333;} </style> </head><body> <div style=color:white;text-align:center> <h1>Amazon ECS Sample App</h1> <h2>Congratulations!</h2> <p>Your application is now running on a container in Amazon ECS.</p>' > top; /bin/date > date ; echo '</div></body></html>' > bottom; cat top date bottom > /usr/local/apache2/htdocs/index.html ; sleep 1; done\"" - /bin/sh -c "while true; do echo '<html><head><title>Amazon ECS Sample App</title></head><body><div><h1>Amazon ECS Sample App</h1><h2>Congratulations!</h2><p>Your application is now running on a container in Amazon ECS.</p>' > top; /bin/date > date ; echo '</div></body></html>' > bottom; cat top date bottom > /usr/local/apache2/htdocs/index.html ; sleep 1; done"
cpu: 10 cpu: 10
entryPoint: entryPoint:
- sh - sh

@ -54,7 +54,7 @@ extends_documentation_fragment:
EXAMPLES = ''' EXAMPLES = '''
# Add or change a subnet group # Add or change a subnet group
- elasticache_subnet_group - elasticache_subnet_group:
state: present state: present
name: norwegian-blue name: norwegian-blue
description: My Fancy Ex Parrot Subnet Group description: My Fancy Ex Parrot Subnet Group

@ -276,7 +276,7 @@ EXAMPLES = '''
wait: yes wait: yes
# Reboot an instance and wait for it to become available again # Reboot an instance and wait for it to become available again
- rds - rds:
command: reboot command: reboot
instance_name: database instance_name: database
wait: yes wait: yes

@ -67,7 +67,7 @@ EXAMPLES = '''
- 'subnet-bbbbb' - 'subnet-bbbbb'
# Remove subnet group # Remove subnet group
redshift_subnet_group: > - redshift_subnet_group:
state: absent state: absent
group_name: redshift-subnet group_name: redshift-subnet
''' '''

@ -163,7 +163,7 @@ EXAMPLES = '''
- name: Add new instance to host group - name: Add new instance to host group
add_host: add_host:
hostname: '{{ item['ips'][0].public_ip }}' hostname: "{{ item['ips'][0].public_ip }}"
groupname: azure_vms groupname: azure_vms
with_items: "{{ azure.deployment.instances }}" with_items: "{{ azure.deployment.instances }}"

@ -151,14 +151,14 @@ author:
EXAMPLES = ''' EXAMPLES = '''
- name: Create a network interface with minimal parameters - name: Create a network interface with minimal parameters
azure_rm_networkinterface: azure_rm_networkinterface:
name: nic001 name: nic001
resource_group: Testing resource_group: Testing
virtual_network_name: vnet001 virtual_network_name: vnet001
subnet_name: subnet001 subnet_name: subnet001
- name: Create a network interface with private IP address only (no Public IP) - name: Create a network interface with private IP address only (no Public IP)
azure_rm_networkinterface: azure_rm_networkinterface:
name: nic001 name: nic001
resource_group: Testing resource_group: Testing
virtual_network_name: vnet001 virtual_network_name: vnet001
@ -166,7 +166,7 @@ EXAMPLES = '''
public_ip: no public_ip: no
- name: Create a network interface for use in a Windows host (opens RDP port) with custom RDP port - name: Create a network interface for use in a Windows host (opens RDP port) with custom RDP port
azure_rm_networkinterface: azure_rm_networkinterface:
name: nic002 name: nic002
resource_group: Testing resource_group: Testing
virtual_network_name: vnet001 virtual_network_name: vnet001
@ -175,7 +175,7 @@ EXAMPLES = '''
rdp_port: 3399 rdp_port: 3399
- name: Create a network interface using existing security group and public IP - name: Create a network interface using existing security group and public IP
azure_rm_networkinterface: azure_rm_networkinterface:
name: nic003 name: nic003
resource_group: Testing resource_group: Testing
virtual_network_name: vnet001 virtual_network_name: vnet001
@ -184,7 +184,7 @@ EXAMPLES = '''
public_ip_address_name: publicip001 public_ip_address_name: publicip001
- name: Delete network interface - name: Delete network interface
azure_rm_networkinterface: azure_rm_networkinterface:
resource_group: Testing resource_group: Testing
name: nic003 name: nic003
state: absent state: absent

@ -76,7 +76,7 @@ EXAMPLES = '''
# Note - You must set the CLC_V2_API_USERNAME And CLC_V2_API_PASSWD Environment variables before running these examples # Note - You must set the CLC_V2_API_USERNAME And CLC_V2_API_PASSWD Environment variables before running these examples
- name: Deploy package - name: Deploy package
clc_blueprint_package: clc_blueprint_package:
server_ids: server_ids:
- UC1TEST-SERVER1 - UC1TEST-SERVER1
- UC1TEST-SERVER2 - UC1TEST-SERVER2

@ -91,7 +91,7 @@ EXAMPLES = '''
# Ensure account configuration # Ensure account configuration
- local_action: - local_action:
module: cs_configuration: module: cs_configuration
name: allow.public.user.templates name: allow.public.user.templates
value: false value: false
account: acme inc account: acme inc

@ -84,7 +84,7 @@ EXAMPLES = '''
# register your existing local public key: # register your existing local public key:
- cs_sshkeypair: - cs_sshkeypair:
name: linus@example.com name: linus@example.com
public_key: '{{ lookup('file', '~/.ssh/id_rsa.pub') }}' public_key: "{{ lookup('file', '~/.ssh/id_rsa.pub') }}"
delegate_to: localhost delegate_to: localhost
''' '''

@ -231,7 +231,7 @@ EXAMPLES = '''
load_path: my_sinatra.tar load_path: my_sinatra.tar
- name: Build image and with buildargs - name: Build image and with buildargs
docker_image: docker_image:
path: /path/to/build/dir path: /path/to/build/dir
name: myimage name: myimage
buildargs: buildargs:

@ -236,6 +236,7 @@ EXAMPLES = '''
credentials_file: "/path/to/your-key.json" credentials_file: "/path/to/your-key.json"
project_id: "your-project-name" project_id: "your-project-name"
---
# Example Playbook # Example Playbook
- name: Compute Engine Instance Examples - name: Compute Engine Instance Examples
hosts: localhost hosts: localhost

@ -91,10 +91,10 @@ gcpubsub:
mykey2: myvalu2 mykey2: myvalu2
mykey3: myvalue3 mykey3: myvalue3
- message: "this is message 2" - message: "this is message 2"
attributes: attributes:
server: prod server: prod
sla: "99.9999" sla: "99.9999"
owner: fred owner: fred
# Subscriptions # Subscriptions
## Create Subscription (pull) ## Create Subscription (pull)

@ -286,7 +286,7 @@ EXAMPLES = '''
- proxmox: - proxmox:
vmid: 100 vmid: 100
api_user: root@pam api_user: root@pam
api_passwordL 1q2w3e api_password: 1q2w3e
api_host: node1 api_host: node1
force: yes force: yes
state: stopped state: stopped

@ -217,8 +217,7 @@ vm:
EXAMPLES = ''' EXAMPLES = '''
# basic get info from VM # basic get info from VM
action: rhevm - rhevm:
args:
name: "demo" name: "demo"
user: "{{ rhev.admin.name }}" user: "{{ rhev.admin.name }}"
password: "{{ rhev.admin.pass }}" password: "{{ rhev.admin.pass }}"
@ -226,8 +225,7 @@ EXAMPLES = '''
state: "info" state: "info"
# basic create example from image # basic create example from image
action: rhevm - rhevm:
args:
name: "demo" name: "demo"
user: "{{ rhev.admin.name }}" user: "{{ rhev.admin.name }}"
password: "{{ rhev.admin.pass }}" password: "{{ rhev.admin.pass }}"
@ -237,8 +235,7 @@ EXAMPLES = '''
cluster: "centos" cluster: "centos"
# power management # power management
action: rhevm - rhevm:
args:
name: "uptime_server" name: "uptime_server"
user: "{{ rhev.admin.name }}" user: "{{ rhev.admin.name }}"
password: "{{ rhev.admin.pass }}" password: "{{ rhev.admin.pass }}"
@ -246,11 +243,10 @@ EXAMPLES = '''
cluster: "RH" cluster: "RH"
state: "down" state: "down"
image: "centos7_x64" image: "centos7_x64"
cluster: "centos cluster: "centos"
# multi disk, multi nic create example # multi disk, multi nic create example
action: rhevm - rhevm:
args:
name: "server007" name: "server007"
user: "{{ rhev.admin.name }}" user: "{{ rhev.admin.name }}"
password: "{{ rhev.admin.pass }}" password: "{{ rhev.admin.pass }}"
@ -290,23 +286,21 @@ EXAMPLES = '''
- "hd" - "hd"
# add a CD to the disk cd_drive # add a CD to the disk cd_drive
action: rhevm - rhevm:
args: name: 'server007'
name: 'server007' user: "{{ rhev.admin.name }}"
user: "{{ rhev.admin.name }}" password: "{{ rhev.admin.pass }}"
password: "{{ rhev.admin.pass }}" state: 'cd'
state: 'cd' cd_drive: 'rhev-tools-setup.iso'
cd_drive: 'rhev-tools-setup.iso'
# new host deployment + host network configuration # new host deployment + host network configuration
action: rhevm - rhevm:
args: name: "ovirt_node007"
name: "ovirt_node007" password: "{{ rhevm.admin.pass }}"
password: "{{ rhevm.admin.pass }}" type: "host"
type: "host" state: present
state: present cluster: "rhevm01"
cluster: "rhevm01" ifaces:
ifaces:
- name: em1 - name: em1
- name: em2 - name: em2
- name: p3p1 - name: p3p1

@ -75,17 +75,18 @@ EXAMPLES = '''
state: running state: running
# /usr/bin/ansible invocations # /usr/bin/ansible invocations
ansible host -m virt -a "name=alpha command=status" # ansible host -m virt -a "name=alpha command=status"
ansible host -m virt -a "name=alpha command=get_xml" # ansible host -m virt -a "name=alpha command=get_xml"
ansible host -m virt -a "name=alpha command=create uri=lxc:///" # ansible host -m virt -a "name=alpha command=create uri=lxc:///"
---
# a playbook example of defining and launching an LXC guest # a playbook example of defining and launching an LXC guest
tasks: tasks:
- name: define vm - name: define vm
virt: virt:
name: foo name: foo
command: define command: define
xml: '{{ lookup('template', 'container-template.xml.j2') }}' xml: "{{ lookup('template', 'container-template.xml.j2') }}"
uri: 'lxc:///' uri: 'lxc:///'
- name: start vm - name: start vm
virt: virt:

@ -34,10 +34,11 @@ options: {}
EXAMPLES = ''' EXAMPLES = '''
- name: Gather facts from xenserver - name: Gather facts from xenserver
xenserver: xenserver:
- name: Print running VMs - name: Print running VMs
debug: msg="{{ item }}" debug:
msg: "{{ item }}"
with_items: "{{ xs_vms.keys() }}" with_items: "{{ xs_vms.keys() }}"
when: xs_vms[item]['power_state'] == "Running" when: xs_vms[item]['power_state'] == "Running"

@ -58,7 +58,7 @@ EXAMPLES = '''
var: openstack_domains var: openstack_domains
# Gather facts about a previously created domain with filter # Gather facts about a previously created domain with filter
- os_keystone_domain_facts - os_keystone_domain_facts:
cloud: awesomecloud cloud: awesomecloud
name: demodomain name: demodomain
filters: filters:

@ -63,16 +63,15 @@ EXAMPLES = '''
var: openstack_projects var: openstack_projects
# Gather facts about a previously created project in a specific domain # Gather facts about a previously created project in a specific domain
- os_project_facts - os_project_facts:
cloud: awesomecloud cloud: awesomecloud
name: demoproject name: demoproject
domain: admindomain domain: admindomain
- debug: - debug:
var: openstack_projects var: openstack_projects
# Gather facts about a previously created project in a specific domain # Gather facts about a previously created project in a specific domain with filter
with filter - os_project_facts:
- os_project_facts
cloud: awesomecloud cloud: awesomecloud
name: demoproject name: demoproject
domain: admindomain domain: admindomain

@ -298,12 +298,12 @@ EXAMPLES = '''
username: admin username: admin
password: admin password: admin
project_name: admin project_name: admin
name: vm1 name: vm1
image: 4f905f38-e52a-43d2-b6ec-754a13ffb529 image: 4f905f38-e52a-43d2-b6ec-754a13ffb529
key_name: ansible_key key_name: ansible_key
timeout: 200 timeout: 200
flavor: 4 flavor: 4
nics: "net-id=4cb08b20-62fe-11e5-9d70-feff819cdc9f,net-id=542f0430-62fe-11e5-9d70-feff819cdc9f..." nics: "net-id=4cb08b20-62fe-11e5-9d70-feff819cdc9f,net-id=542f0430-62fe-11e5-9d70-feff819cdc9f..."
- name: Creates a new instance and attaches to a network and passes metadata to the instance - name: Creates a new instance and attaches to a network and passes metadata to the instance
os_server: os_server:
@ -336,7 +336,7 @@ EXAMPLES = '''
key_name: ansible_key key_name: ansible_key
timeout: 200 timeout: 200
flavor: 4 flavor: 4
network: another_network network: another_network
# Create a new instance with 4G of RAM on a 75G Ubuntu Trusty volume # Create a new instance with 4G of RAM on a 75G Ubuntu Trusty volume
- name: launch a compute instance - name: launch a compute instance

@ -86,12 +86,12 @@ EXAMPLES = '''
bmc_flavor: m1.medium bmc_flavor: m1.medium
bmc_image: CentOS bmc_image: CentOS
key_name: default key_name: default
private_net: {{ private_net_param }} private_net: "{{ private_net_param }}"
node_count: 2 node_count: 2
name: undercloud name: undercloud
image: CentOS image: CentOS
my_flavor: m1.large my_flavor: m1.large
external_net: {{ external_net_param }} external_net: "{{ external_net_param }}"
''' '''
RETURN = ''' RETURN = '''

@ -63,16 +63,15 @@ EXAMPLES = '''
var: openstack_users var: openstack_users
# Gather facts about a previously created user in a specific domain # Gather facts about a previously created user in a specific domain
- os_user_facts - os_user_facts:
cloud: awesomecloud cloud: awesomecloud
name: demouser name: demouser
domain: admindomain domain: admindomain
- debug: - debug:
var: openstack_users var: openstack_users
# Gather facts about a previously created user in a specific domain # Gather facts about a previously created user in a specific domain with filter
with filter - os_user_facts:
- os_user_facts
cloud: awesomecloud cloud: awesomecloud
name: demouser name: demouser
domain: admindomain domain: admindomain

@ -102,7 +102,7 @@ tasks:
# oVirt user's password, and include that yaml file with variable: # oVirt user's password, and include that yaml file with variable:
- include_vars: ovirt_password.yml - include_vars: ovirt_password.yml
- name: Obtain SSO token with using username/password credentials: - name: Obtain SSO token with using username/password credentials
ovirt_auth: ovirt_auth:
url: https://ovirt.example.com/ovirt-engine/api url: https://ovirt.example.com/ovirt-engine/api
username: admin@internal username: admin@internal
@ -116,11 +116,11 @@ tasks:
state: absent state: absent
name: myvm name: myvm
always: always:
- name: Always revoke the SSO token - name: Always revoke the SSO token
ovirt_auth: ovirt_auth:
state: absent state: absent
ovirt_auth: "{{ ovirt_auth }}" ovirt_auth: "{{ ovirt_auth }}"
''' '''
RETURN = ''' RETURN = '''

@ -73,14 +73,14 @@ EXAMPLES = '''
- ovirt_snapshots: - ovirt_snapshots:
vm_name: rhel7 vm_name: rhel7
description: MySnapshot description: MySnapshot
register: snapshot register: snapshot
# Create snapshot and save memory: # Create snapshot and save memory:
- ovirt_snapshots: - ovirt_snapshots:
vm_name: rhel7 vm_name: rhel7
description: SnapWithMem description: SnapWithMem
use_memory: true use_memory: true
register: snapshot register: snapshot
# Restore snapshot: # Restore snapshot:
- ovirt_snapshots: - ovirt_snapshots:

@ -137,12 +137,12 @@ EXAMPLES = '''
- name: Creates a new vApp in a VCA instance - name: Creates a new vApp in a VCA instance
vca_vapp: vca_vapp:
vapp_name: tower vapp_name: tower
state=present state: present
template_name='Ubuntu Server 12.04 LTS (amd64 20150127)' template_name: 'Ubuntu Server 12.04 LTS (amd64 20150127)'
vdc_name=VDC1 vdc_name: VDC1
instance_id=<your instance id here> instance_id: '<your instance id here>'
username=<your username here> username: '<your username here>'
password=<your password here> password: '<your password here>'
''' '''

@ -64,14 +64,16 @@ extends_documentation_fragment: vmware.documentation
EXAMPLES = ''' EXAMPLES = '''
# Example vmware_cluster command from Ansible Playbooks # Example vmware_cluster command from Ansible Playbooks
- name: Create Cluster - name: Create Cluster
local_action: > local_action:
vmware_cluster module: vmware_cluster
hostname="{{ ansible_ssh_host }}" username=root password=vmware hostname: "{{ ansible_ssh_host }}"
datacenter_name="datacenter" username: root
cluster_name="cluster" password: vmware
enable_ha=True datacenter_name: "datacenter"
enable_drs=True cluster_name: "cluster"
enable_vsan=True enable_ha: True
enable_drs: True
enable_vsan: True
''' '''
try: try:

@ -65,10 +65,13 @@ extends_documentation_fragment: vmware.documentation
EXAMPLES = ''' EXAMPLES = '''
# Example vmware_datacenter command from Ansible Playbooks # Example vmware_datacenter command from Ansible Playbooks
- name: Create Datacenter - name: Create Datacenter
local_action: > local_action:
vmware_datacenter module: vmware_datacenter
hostname="{{ ansible_ssh_host }}" username=root password=vmware hostname: "{{ ansible_ssh_host }}"
datacenter_name="datacenter" state=present username: root
password: vmware
datacenter_name: "datacenter"
state: present
''' '''
try: try:

@ -65,7 +65,7 @@ extends_documentation_fragment: vmware.documentation
EXAMPLES = ''' EXAMPLES = '''
- name: Create Management portgroup - name: Create Management portgroup
local_action: local_action:
module: vmware_dvs_portgroup module: vmware_dvs_portgroup
hostname: vcenter_ip_or_hostname hostname: vcenter_ip_or_hostname
username: vcenter_username username: vcenter_username

@ -68,7 +68,7 @@ extends_documentation_fragment: vmware.documentation
''' '''
EXAMPLES = ''' EXAMPLES = '''
Example from Ansible playbook # Example from Ansible playbook
- name: Add ESXi Host to VCSA - name: Add ESXi Host to VCSA
local_action: local_action:

@ -64,7 +64,7 @@ extends_documentation_fragment: vmware.documentation
''' '''
EXAMPLES = ''' EXAMPLES = '''
Example from Ansible playbook # Example from Ansible playbook
- name: Migrate Management vmk - name: Migrate Management vmk
local_action: local_action:

@ -60,7 +60,7 @@ extends_documentation_fragment: vmware.documentation
''' '''
EXAMPLES = ''' EXAMPLES = '''
Example from Ansible playbook # Example from Ansible playbook
- name: Add Management Network VM Portgroup - name: Add Management Network VM Portgroup
local_action: local_action:

@ -45,10 +45,12 @@ extends_documentation_fragment: vmware.documentation
EXAMPLES = ''' EXAMPLES = '''
# Example vmware_target_canonical_facts command from Ansible Playbooks # Example vmware_target_canonical_facts command from Ansible Playbooks
- name: Get Canonical name - name: Get Canonical name
local_action: > local_action:
vmware_target_canonical_facts module: vmware_target_canonical_facts
hostname="{{ ansible_ssh_host }}" username=root password=vmware hostname: "{{ ansible_ssh_host }}"
target_id=7 username: root
password: vmware
target_id: 7
''' '''
try: try:

@ -51,7 +51,7 @@ extends_documentation_fragment: vmware.documentation
''' '''
EXAMPLES = ''' EXAMPLES = '''
Example from Ansible playbook # Example from Ansible playbook
- name: Perform vMotion of VM - name: Perform vMotion of VM
local_action: local_action:

@ -65,7 +65,7 @@ extends_documentation_fragment: vmware.documentation
''' '''
EXAMPLES = ''' EXAMPLES = '''
Example from Ansible playbook # Example from Ansible playbook
- name: Add a VMware vSwitch - name: Add a VMware vSwitch
local_action: local_action:

@ -153,6 +153,7 @@ requirements:
EXAMPLES = ''' EXAMPLES = '''
---
# Create a new VM on an ESX server # Create a new VM on an ESX server
# Returns changed = False when the VM already exists # Returns changed = False when the VM already exists
# Returns changed = True and a adds ansible_facts from the new VM # Returns changed = True and a adds ansible_facts from the new VM
@ -258,7 +259,7 @@ EXAMPLES = '''
guest: newvm001 guest: newvm001
vmware_guest_facts: yes vmware_guest_facts: yes
---
# Typical output of a vsphere_facts run on a guest # Typical output of a vsphere_facts run on a guest
# If vmware tools is not installed, ipadresses with return None # If vmware tools is not installed, ipadresses with return None
@ -277,22 +278,22 @@ EXAMPLES = '''
hw_processor_count: 2 hw_processor_count: 2
hw_product_uuid: "ef50bac8-2845-40ff-81d9-675315501dac" hw_product_uuid: "ef50bac8-2845-40ff-81d9-675315501dac"
hw_power_status will be one of the following values: # hw_power_status will be one of the following values:
- POWERED ON # - POWERED ON
- POWERED OFF # - POWERED OFF
- SUSPENDED # - SUSPENDED
- POWERING ON # - POWERING ON
- POWERING OFF # - POWERING OFF
- SUSPENDING # - SUSPENDING
- RESETTING # - RESETTING
- BLOCKED ON MSG # - BLOCKED ON MSG
- REVERTING TO SNAPSHOT # - REVERTING TO SNAPSHOT
- UNKNOWN # - UNKNOWN
as seen in the VMPowerState-Class of PySphere: http://git.io/vlwOq # as seen in the VMPowerState-Class of PySphere: http://git.io/vlwOq
---
# Remove a vm from vSphere # Remove a vm from vSphere
# The VM must be powered_off or you need to use force to force a shutdown # The VM must be powered_off or you need to use force to force a shutdown
- vsphere_guest: - vsphere_guest:
vcenter_hostname: vcenter.mydomain.local vcenter_hostname: vcenter.mydomain.local
username: myuser username: myuser

@ -76,5 +76,5 @@ EXAMPLES = '''
executable: /bin/bash executable: /bin/bash
- name: safely use templated variables. Always use quote filter to avoid injection issues. - name: safely use templated variables. Always use quote filter to avoid injection issues.
raw: {{package_mgr|quote}} {{pkg_flags|quote}} install {{python_simplejson|quote}} raw: "{{package_mgr|quote}} {{pkg_flags|quote}} install {{python_simplejson|quote}}"
''' '''

@ -67,19 +67,19 @@ options:
EXAMPLES = ''' EXAMPLES = '''
# Example influxdb_database command from Ansible Playbooks # Example influxdb_database command from Ansible Playbooks
- name: Create database - name: Create database
influxdb_database: influxdb_database:
hostname: "{{influxdb_ip_address}}" hostname: "{{influxdb_ip_address}}"
database_name: "{{influxdb_database_name}}" database_name: "{{influxdb_database_name}}"
state: present state: present
- name: Destroy database - name: Destroy database
influxdb_database: influxdb_database:
hostname: "{{influxdb_ip_address}}" hostname: "{{influxdb_ip_address}}"
database_name: "{{influxdb_database_name}}" database_name: "{{influxdb_database_name}}"
state: absent state: absent
- name: Create database using custom credentials - name: Create database using custom credentials
influxdb_database: influxdb_database:
hostname: "{{influxdb_ip_address}}" hostname: "{{influxdb_ip_address}}"
username: "{{influxdb_username}}" username: "{{influxdb_username}}"
password: "{{influxdb_password}}" password: "{{influxdb_password}}"

@ -77,7 +77,7 @@ options:
EXAMPLES = ''' EXAMPLES = '''
# Example influxdb_retention_policy command from Ansible Playbooks # Example influxdb_retention_policy command from Ansible Playbooks
- name: create 1 hour retention policy - name: create 1 hour retention policy
influxdb_retention_policy: influxdb_retention_policy:
hostname: "{{influxdb_ip_address}}" hostname: "{{influxdb_ip_address}}"
database_name: "{{influxdb_database_name}}" database_name: "{{influxdb_database_name}}"
policy_name: test policy_name: test
@ -85,7 +85,7 @@ EXAMPLES = '''
replication: 1 replication: 1
- name: create 1 day retention policy - name: create 1 day retention policy
influxdb_retention_policy: influxdb_retention_policy:
hostname: "{{influxdb_ip_address}}" hostname: "{{influxdb_ip_address}}"
database_name: "{{influxdb_database_name}}" database_name: "{{influxdb_database_name}}"
policy_name: test policy_name: test
@ -93,7 +93,7 @@ EXAMPLES = '''
replication: 1 replication: 1
- name: create 1 week retention policy - name: create 1 week retention policy
influxdb_retention_policy: influxdb_retention_policy:
hostname: "{{influxdb_ip_address}}" hostname: "{{influxdb_ip_address}}"
database_name: "{{influxdb_database_name}}" database_name: "{{influxdb_database_name}}"
policy_name: test policy_name: test
@ -101,7 +101,7 @@ EXAMPLES = '''
replication: 1 replication: 1
- name: create infinite retention policy - name: create infinite retention policy
influxdb_retention_policy: influxdb_retention_policy:
hostname: "{{influxdb_ip_address}}" hostname: "{{influxdb_ip_address}}"
database_name: "{{influxdb_database_name}}" database_name: "{{influxdb_database_name}}"
policy_name: test policy_name: test

@ -183,7 +183,7 @@ EXAMPLES = """
state: present state: present
# Example privileges string format # Example privileges string format
mydb.*:INSERT,UPDATE/anotherdb.*:SELECT/yetanotherdb.*:ALL # mydb.*:INSERT,UPDATE/anotherdb.*:SELECT/yetanotherdb.*:ALL
# Example using login_unix_socket to connect to server # Example using login_unix_socket to connect to server
- mysql_user: - mysql_user:
@ -200,10 +200,9 @@ mydb.*:INSERT,UPDATE/anotherdb.*:SELECT/yetanotherdb.*:ALL
sql_log_bin: no sql_log_bin: no
# Example .my.cnf file for setting the root password # Example .my.cnf file for setting the root password
# [client]
[client] # user=root
user=root # password=n<_665{vS43y
password=n<_665{vS43y
""" """
import getpass import getpass

@ -189,7 +189,7 @@ EXAMPLES = '''
state: absent state: absent
# Example privileges string format # Example privileges string format
INSERT,UPDATE/table:SELECT/anothertable:ALL # INSERT,UPDATE/table:SELECT/anothertable:ALL
# Remove an existing user's password # Remove an existing user's password
- postgresql_user: - postgresql_user:

@ -244,7 +244,7 @@ EXAMPLES = '''
links: yes links: yes
# Synchronization of two paths both on the control machine # Synchronization of two paths both on the control machine
- synchronize - synchronize:
src: some/relative/path src: some/relative/path
dest: /some/absolute/path dest: /some/absolute/path
delegate_to: localhost delegate_to: localhost
@ -282,9 +282,9 @@ EXAMPLES = '''
rsync_path: "su -c rsync" rsync_path: "su -c rsync"
# Example .rsync-filter file in the source directory # Example .rsync-filter file in the source directory
- var # exclude any path whose last part is 'var' # - var # exclude any path whose last part is 'var'
- /var # exclude any path starting with 'var' starting at the source directory # - /var # exclude any path starting with 'var' starting at the source directory
+ /var/conf # include /var/conf even though it was previously excluded # + /var/conf # include /var/conf even though it was previously excluded
# Synchronize passing in extra rsync options # Synchronize passing in extra rsync options
- synchronize: - synchronize:

@ -88,7 +88,7 @@ EXAMPLES = '''
version: '1.3' version: '1.3'
token: '{{ bigpanda_token }}' token: '{{ bigpanda_token }}'
state: started state: started
...
- bigpanda: - bigpanda:
component: myapp component: myapp
version: '1.3' version: '1.3'
@ -104,7 +104,7 @@ EXAMPLES = '''
state: started state: started
delegate_to: localhost delegate_to: localhost
register: deployment register: deployment
...
- bigpanda: - bigpanda:
component: '{{ deployment.component }}' component: '{{ deployment.component }}'
version: '{{ deployment.version }}' version: '{{ deployment.version }}'

@ -122,7 +122,7 @@ datadog_monitor:
type: "metric alert" type: "metric alert"
name: "Test monitor" name: "Test monitor"
state: "present" state: "present"
query: "datadog.agent.up".over("host:host1").last(2).count_by_status()" query: "datadog.agent.up.over('host:host1').last(2).count_by_status()"
message: "Host [[host.name]] with IP [[host.ip]] is failing to report to datadog." message: "Host [[host.name]] with IP [[host.ip]] is failing to report to datadog."
api_key: "9775a026f1ca7d1c6c5af9d94d9595a4" api_key: "9775a026f1ca7d1c6c5af9d94d9595a4"
app_key: "87ce4a24b5553d2e482ea8a8500e71b8ad4554ff" app_key: "87ce4a24b5553d2e482ea8a8500e71b8ad4554ff"

@ -230,7 +230,7 @@ EXAMPLES = '''
tasks: tasks:
- name: Create a host group - name: Create a host group
# All tasks except for target=collector should use delegate_to: localhost # All tasks except for target=collector should use delegate_to: localhost
logicmonitor logicmonitor:
target: hostgroup target: hostgroup
action: add action: add
fullpath: /servers/development fullpath: /servers/development

@ -102,6 +102,7 @@ options:
EXAMPLES = """ EXAMPLES = """
# Note: examples below use the following provider dict to handle # Note: examples below use the following provider dict to handle
# transport and authentication to the node. # transport and authentication to the node.
---
vars: vars:
cli: cli:
host: "{{ inventory_hostname }}" host: "{{ inventory_hostname }}"
@ -111,6 +112,7 @@ vars:
authorize: yes authorize: yes
auth_pass: cisco auth_pass: cisco
---
- asa_acl: - asa_acl:
lines: lines:
- access-list ACL-ANSIBLE extended permit tcp any any eq 82 - access-list ACL-ANSIBLE extended permit tcp any any eq 82
@ -127,7 +129,7 @@ vars:
lines: lines:
- access-list ACL-OUTSIDE extended permit tcp any any eq www - access-list ACL-OUTSIDE extended permit tcp any any eq www
- access-list ACL-OUTSIDE extended permit tcp any any eq https - access-list ACL-OUTSIDE extended permit tcp any any eq https
context: customer_a context: customer_a
provider: "{{ cli }}" provider: "{{ cli }}"
""" """

@ -84,6 +84,7 @@ options:
EXAMPLES = """ EXAMPLES = """
# Note: examples below use the following provider dict to handle # Note: examples below use the following provider dict to handle
# transport and authentication to the node. # transport and authentication to the node.
---
vars: vars:
cli: cli:
host: "{{ inventory_hostname }}" host: "{{ inventory_hostname }}"
@ -93,7 +94,7 @@ vars:
auth_pass: cisco auth_pass: cisco
transport: cli transport: cli
---
- asa_command: - asa_command:
commands: commands:
- show version - show version

@ -172,6 +172,7 @@ options:
EXAMPLES = """ EXAMPLES = """
# Note: examples below use the following provider dict to handle # Note: examples below use the following provider dict to handle
# transport and authentication to the node. # transport and authentication to the node.
---
vars: vars:
cli: cli:
host: "{{ inventory_hostname }}" host: "{{ inventory_hostname }}"
@ -181,6 +182,7 @@ vars:
auth_pass: cisco auth_pass: cisco
transport: cli transport: cli
---
- asa_config: - asa_config:
lines: lines:
- network-object host 10.80.30.18 - network-object host 10.80.30.18

@ -2,7 +2,7 @@
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
# Ansible module to manage Big Monitoring Fabric service chains # Ansible module to manage Big Monitoring Fabric service chains
# (c) 2016, Ted Elhourani <ted@bigswitch.com> # (c) 2016, Ted Elhourani <ted@bigswitch.com>,
# #
# This file is part of Ansible # This file is part of Ansible
# #
@ -59,11 +59,11 @@ options:
EXAMPLES = ''' EXAMPLES = '''
- name: bigmon inline service chain - name: bigmon inline service chain
bigmon_chain: bigmon_chain:
name: MyChain name: MyChain
controller: '{{ inventory_hostname }}' controller: '{{ inventory_hostname }}'
state: present state: present
validate_certs: false validate_certs: false
''' '''

@ -84,13 +84,13 @@ options:
EXAMPLES = ''' EXAMPLES = '''
- name: policy to aggregate filter and deliver data center (DC) 1 traffic - name: policy to aggregate filter and deliver data center (DC) 1 traffic
bigmon_policy: bigmon_policy:
name: policy1 name: policy1
policy_description: DC 1 traffic policy policy_description: DC 1 traffic policy
action: drop action: drop
controller: '{{ inventory_hostname }}' controller: '{{ inventory_hostname }}'
state: present state: present
validate_certs: false validate_certs: false
''' '''
RETURN = ''' RETURN = '''

@ -84,6 +84,7 @@ options:
EXAMPLES = """ EXAMPLES = """
# Note: examples below use the following provider dict to handle # Note: examples below use the following provider dict to handle
# transport and authentication to the node. # transport and authentication to the node.
---
vars: vars:
cli: cli:
host: "{{ inventory_hostname }}" host: "{{ inventory_hostname }}"
@ -91,6 +92,7 @@ vars:
password: admin password: admin
transport: cli transport: cli
---
- name: run display version on remote devices - name: run display version on remote devices
ce_command: ce_command:
commands: display version commands: display version

@ -186,6 +186,7 @@ EXAMPLES = '''
# In vars file # In vars file
# ============ # ============
---
cl_bonds: cl_bonds:
bond0: bond0:
alias_name: uplink to isp alias_name: uplink to isp

@ -140,6 +140,7 @@ EXAMPLES = '''
# In vars file # In vars file
# ============ # ============
---
cl_bridge: cl_bridge:
br0: br0:
alias_name: 'vlan aware bridge' alias_name: 'vlan aware bridge'

@ -146,8 +146,8 @@ EXAMPLES = '''
# define cl_interfaces once in tasks # define cl_interfaces once in tasks
# then write interfaces in variables file # then write interfaces in variables file
# with just the options you want. # with just the options you want.
- name: Create interfaces - name: Create interfaces
cl_interface: cl_interface:
name: '{{ item.key }}' name: '{{ item.key }}'
ipv4: '{{ item.value.ipv4 | default(omit) }}' ipv4: '{{ item.value.ipv4 | default(omit) }}'
ipv6: '{{ item.value.ipv6 | default(omit) }}' ipv6: '{{ item.value.ipv6 | default(omit) }}'
@ -165,11 +165,12 @@ EXAMPLES = '''
mstpctl_portnetwork: "{{ item.value.mstpctl_portnetwork | default('no') }}" mstpctl_portnetwork: "{{ item.value.mstpctl_portnetwork | default('no') }}"
mstpctl_portadminedge: "{{ item.value.mstpctl_portadminedge | default('no') }}" mstpctl_portadminedge: "{{ item.value.mstpctl_portadminedge | default('no') }}"
mstpctl_bpduguard: "{{ item.value.mstpctl_bpduguard | default('no') }}" mstpctl_bpduguard: "{{ item.value.mstpctl_bpduguard | default('no') }}"
with_dict: '{{ cl_interfaces }}' with_dict: '{{ cl_interfaces }}'
notify: reload networking notify: reload networking
# In vars file # In vars file
# ============ # ============
---
cl_interfaces: cl_interfaces:
swp1: swp1:
alias_name: uplink to isp alias_name: uplink to isp

@ -49,7 +49,7 @@ options:
''' '''
EXAMPLES = ''' EXAMPLES = '''
Example playbook entries using the cl_interface_policy module. # Example playbook entries using the cl_interface_policy module.
- name: shows types of interface ranges supported - name: shows types of interface ranges supported
cl_interface_policy: cl_interface_policy:

@ -78,7 +78,7 @@ EXAMPLES = '''
dest: /etc/network/interfaces dest: /etc/network/interfaces
notify: restart networking notify: restart networking
handlers: handlers:
- name: restart switchd - name: restart switchd
service: service:
name: switchd name: switchd
@ -89,10 +89,7 @@ EXAMPLES = '''
state: reloaded state: reloaded
# Force all switches to accept a new license. Typically not needed # Force all switches to accept a new license. Typically not needed
ansible -m cl_license -a "src='http://10.1.1.1/new_lic' force=yes" -u root all # ansible -m cl_license -a "src='http://10.1.1.1/new_lic' force=yes" -u root all
----
''' '''
RETURN = ''' RETURN = '''

@ -97,7 +97,7 @@ tasks:
provider: "{{ cli }}" provider: "{{ cli }}"
- name: run multiple commands on remote nodes - name: run multiple commands on remote nodes
dellos10_command: dellos10_command:
commands: commands:
- show version - show version
- show interface - show interface

@ -87,20 +87,20 @@ tasks:
- name: run show version on remote devices - name: run show version on remote devices
dellos6_command: dellos6_command:
commands: show version commands: show version
provider "{{ cli }}" provider: "{{ cli }}"
- name: run show version and check to see if output contains Dell - name: run show version and check to see if output contains Dell
dellos6_command: dellos6_command:
commands: show version commands: show version
wait_for: result[0] contains Dell wait_for: result[0] contains Dell
provider "{{ cli }}" provider: "{{ cli }}"
- name: run multiple commands on remote nodes - name: run multiple commands on remote nodes
dellos6_command: dellos6_command:
commands: commands:
- show version - show version
- show interfaces - show interfaces
provider "{{ cli }}" provider: "{{ cli }}"
- name: run multiple commands and evaluate the output - name: run multiple commands and evaluate the output
dellos6_command: dellos6_command:
@ -110,7 +110,7 @@ tasks:
wait_for: wait_for:
- result[0] contains Dell - result[0] contains Dell
- result[1] contains Access - result[1] contains Access
provider "{{ cli }}" provider: "{{ cli }}"
""" """
RETURN = """ RETURN = """

@ -136,7 +136,7 @@ EXAMPLES = '''
delegate_to: localhost delegate_to: localhost
# create a my.com CNAME record to example.com # create a my.com CNAME record to example.com
- dnsimple - dnsimple:
domain: my.com domain: my.com
record: '' record: ''
type: CNAME type: CNAME

@ -94,7 +94,7 @@ EXAMPLES = """
wait_for: result[0] contains Arista wait_for: result[0] contains Arista
- name: run multiple commands on remote nodes - name: run multiple commands on remote nodes
eos_command: eos_command:
commands: commands:
- show version - show version
- show interfaces - show interfaces

@ -104,7 +104,7 @@ EXAMPLES = """
lookup_source: Management1 lookup_source: Management1
- name: configure DNS lookup sources with VRF support - name: configure DNS lookup sources with VRF support
eos_system: eos_system:
lookup_source: lookup_source:
- interface: Management1 - interface: Management1
vrf: mgmt vrf: mgmt

@ -199,7 +199,7 @@ EXAMPLES = '''
state: "present" state: "present"
name: "my-pool" name: "my-pool"
partition: "Common" partition: "Common"
host: "{{ ansible_default_ipv4["address"] }}" host: "{{ ansible_default_ipv4['address'] }}"
port: 80 port: 80
- name: Remove pool member from pool - name: Remove pool member from pool
@ -210,7 +210,7 @@ EXAMPLES = '''
state: "absent" state: "absent"
name: "my-pool" name: "my-pool"
partition: "Common" partition: "Common"
host: "{{ ansible_default_ipv4["address"] }}" host: "{{ ansible_default_ipv4['address'] }}"
port: 80 port: 80
- name: Delete pool - name: Delete pool

@ -132,7 +132,7 @@ EXAMPLES = '''
state: "present" state: "present"
pool: "my-pool" pool: "my-pool"
partition: "Common" partition: "Common"
host: "{{ ansible_default_ipv4["address"] }}" host: "{{ ansible_default_ipv4['address'] }}"
port: 80 port: 80
description: "web server" description: "web server"
connection_limit: 100 connection_limit: 100
@ -148,7 +148,7 @@ EXAMPLES = '''
state: "present" state: "present"
pool: "my-pool" pool: "my-pool"
partition: "Common" partition: "Common"
host: "{{ ansible_default_ipv4["address"] }}" host: "{{ ansible_default_ipv4['address'] }}"
port: 80 port: 80
ratio: 1 ratio: 1
description: "nginx server" description: "nginx server"
@ -162,7 +162,7 @@ EXAMPLES = '''
state: "absent" state: "absent"
pool: "my-pool" pool: "my-pool"
partition: "Common" partition: "Common"
host: "{{ ansible_default_ipv4["address"] }}" host: "{{ ansible_default_ipv4['address'] }}"
port: 80 port: 80
delegate_to: localhost delegate_to: localhost
@ -190,7 +190,7 @@ EXAMPLES = '''
monitor_state: "disabled" monitor_state: "disabled"
pool: "my-pool" pool: "my-pool"
partition: "Common" partition: "Common"
host: "{{ ansible_default_ipv4["address"] }}" host: "{{ ansible_default_ipv4['address'] }}"
port: 80 port: 80
delegate_to: localhost delegate_to: localhost
''' '''

@ -49,6 +49,7 @@ options:
EXAMPLES = """ EXAMPLES = """
# Note: examples below use the following provider dict to handle # Note: examples below use the following provider dict to handle
# transport and authentication to the node. # transport and authentication to the node.
---
vars: vars:
cli: cli:
host: "{{ inventory_hostname }}" host: "{{ inventory_hostname }}"
@ -56,6 +57,7 @@ vars:
password: cisco password: cisco
transport: cli transport: cli
---
# Collect all facts from the device # Collect all facts from the device
- ios_facts: - ios_facts:
gather_subset: all gather_subset: all

@ -95,7 +95,7 @@ tasks:
wait_for: result[0] contains IOS-XR wait_for: result[0] contains IOS-XR
- name: run multiple commands on remote nodes - name: run multiple commands on remote nodes
iosxr_command: iosxr_command:
commands: commands:
- show version - show version
- show interfaces - show interfaces

@ -99,10 +99,12 @@ EXAMPLES = """
comment: update system config comment: update system config
- name: replace config hierarchy - name: replace config hierarchy
junos_template:
src: config.j2 src: config.j2
action: replace action: replace
- name: overwrite the config - name: overwrite the config
junos_template:
src: config.j2 src: config.j2
action: overwrite action: overwrite
""" """

@ -110,12 +110,14 @@ notes:
EXAMPLES = """ EXAMPLES = """
# Note: examples below use the following provider dict to handle # Note: examples below use the following provider dict to handle
# transport and authentication to the node. # transport and authentication to the node.
---
vars: vars:
netconf: netconf:
host: "{{ inventory_hostname }}" host: "{{ inventory_hostname }}"
username: ansible username: ansible
password: Ansible password: Ansible
---
- name: run a set of commands - name: run a set of commands
junos_command: junos_command:
commands: ['show version', 'show ip route'] commands: ['show version', 'show ip route']

@ -146,12 +146,14 @@ notes:
EXAMPLES = """ EXAMPLES = """
# Note: examples below use the following provider dict to handle # Note: examples below use the following provider dict to handle
# transport and authentication to the node. # transport and authentication to the node.
---
vars: vars:
netconf: netconf:
host: "{{ inventory_hostname }}" host: "{{ inventory_hostname }}"
username: ansible username: ansible
password: Ansible password: Ansible
---
- name: load configure file into device - name: load configure file into device
junos_config: junos_config:
src: srx.cfg src: srx.cfg

@ -58,6 +58,7 @@ options:
EXAMPLES = """ EXAMPLES = """
# Note: examples below use the following provider dict to handle # Note: examples below use the following provider dict to handle
# transport and authentication to the node. # transport and authentication to the node.
---
vars: vars:
cli: cli:
host: "{{ inventory_hostname }}" host: "{{ inventory_hostname }}"
@ -65,6 +66,7 @@ vars:
password: Ansible password: Ansible
transport: cli transport: cli
---
- name: enable netconf service on port 830 - name: enable netconf service on port 830
junos_netconf: junos_netconf:
listens_on: 830 listens_on: 830

@ -361,26 +361,26 @@ EXAMPLES='''
- '{{ nmcli_team_slave }}' - '{{ nmcli_team_slave }}'
###### Working with all cloud nodes - Bonding ###### Working with all cloud nodes - Bonding
- name: try nmcli add bond - conn_name only & ip4 gw4 mode - name: try nmcli add bond - conn_name only & ip4 gw4 mode
nmcli: nmcli:
type: bond type: bond
conn_name: '{{ item.conn_name }}' conn_name: '{{ item.conn_name }}'
ip4: '{{ item.ip4 }}' ip4: '{{ item.ip4 }}'
gw4: '{{ item.gw4 }}' gw4: '{{ item.gw4 }}'
mode: '{{ item.mode }}' mode: '{{ item.mode }}'
state: present state: present
with_items: with_items:
- '{{ nmcli_bond }}' - '{{ nmcli_bond }}'
- name: try nmcli add bond-slave - name: try nmcli add bond-slave
nmcli: nmcli:
type: bond-slave type: bond-slave
conn_name: '{{ item.conn_name }}' conn_name: '{{ item.conn_name }}'
ifname: '{{ item.ifname }}' ifname: '{{ item.ifname }}'
master: '{{ item.master }}' master: '{{ item.master }}'
state: present state: present
with_items: with_items:
- '{{ nmcli_bond_slave }}' - '{{ nmcli_bond_slave }}'
##### Working with all cloud nodes - Ethernet ##### Working with all cloud nodes - Ethernet
- name: nmcli add Ethernet - conn_name only & ip4 gw4 - name: nmcli add Ethernet - conn_name only & ip4 gw4
@ -394,8 +394,6 @@ EXAMPLES='''
- '{{ nmcli_ethernet }}' - '{{ nmcli_ethernet }}'
## playbook-del.yml example ## playbook-del.yml example
---
- hosts: openstack-stage - hosts: openstack-stage
remote_user: root remote_user: root
tasks: tasks:

@ -259,8 +259,8 @@ options:
choices: ['present','absent'] choices: ['present','absent']
''' '''
EXAMPLES = ''' EXAMPLES = '''
configure RR client - name: configure RR client
- nxos_bgp_neighbor_af: nxos_bgp_neighbor_af:
asn: 65535 asn: 65535
neighbor: '3.3.3.3' neighbor: '3.3.3.3'
afi: ipv4 afi: ipv4

@ -91,6 +91,7 @@ options:
EXAMPLES = """ EXAMPLES = """
# Note: examples below use the following provider dict to handle # Note: examples below use the following provider dict to handle
# transport and authentication to the node. # transport and authentication to the node.
---
vars: vars:
cli: cli:
host: "{{ inventory_hostname }}" host: "{{ inventory_hostname }}"
@ -98,6 +99,7 @@ vars:
password: admin password: admin
transport: cli transport: cli
---
- name: run show version on remote devices - name: run show version on remote devices
nxos_command: nxos_command:
commands: show version commands: show version
@ -110,7 +112,7 @@ vars:
provider: "{{ cli }}" provider: "{{ cli }}"
- name: run multiple commands on remote nodes - name: run multiple commands on remote nodes
nxos_command: nxos_command:
commands: commands:
- show version - show version
- show interfaces - show interfaces

@ -164,6 +164,7 @@ options:
EXAMPLES = """ EXAMPLES = """
# Note: examples below use the following provider dict to handle # Note: examples below use the following provider dict to handle
# transport and authentication to the node. # transport and authentication to the node.
---
vars: vars:
cli: cli:
host: "{{ inventory_hostname }}" host: "{{ inventory_hostname }}"
@ -171,6 +172,7 @@ vars:
password: admin password: admin
transport: cli transport: cli
---
- name: configure top level configuration and save it - name: configure top level configuration and save it
nxos_config: nxos_config:
lines: hostname {{ inventory_hostname }} lines: hostname {{ inventory_hostname }}

@ -53,6 +53,7 @@ options:
EXAMPLES = """ EXAMPLES = """
# Note: examples below use the following provider dict to handle # Note: examples below use the following provider dict to handle
# transport and authentication to the node. # transport and authentication to the node.
---
vars: vars:
cli: cli:
host: "{{ inventory_hostname }}" host: "{{ inventory_hostname }}"
@ -60,6 +61,7 @@ vars:
password: admin password: admin
transport: cli transport: cli
---
- nxos_facts: - nxos_facts:
gather_subset: all gather_subset: all

@ -68,33 +68,33 @@ EXAMPLES = '''
username: "{{ un }}" username: "{{ un }}"
password: "{{ pwd }}" password: "{{ pwd }}"
transport: nxapi transport: nxapi
rescue: rescue:
- name: Wait for device to perform checks - name: Wait for device to perform checks
wait_for: wait_for:
port: 22 port: 22
state: stopped state: stopped
timeout: 300 timeout: 300
delay: 60 delay: 60
host: "{{ inventory_hostname }}" host: "{{ inventory_hostname }}"
- name: Wait for device to come back up - name: Wait for device to come back up
wait_for: wait_for:
port: 22 port: 22
state: started state: started
timeout: 300 timeout: 300
delay: 60 delay: 60
host: "{{ inventory_hostname }}" host: "{{ inventory_hostname }}"
- name: Check installed OS - name: Check installed OS
nxos_command: nxos_command:
commands: commands:
- show version - show version
username: "{{ un }}" username: "{{ un }}"
password: "{{ pwd }}" password: "{{ pwd }}"
host: "{{ inventory_hostname }}" host: "{{ inventory_hostname }}"
transport: nxapi transport: nxapi
register: output register: output
- assert: - assert:
that: that:
- output['stdout'][0]['kickstart_ver_str'] == '7.0(3)I4(1)' - output['stdout'][0]['kickstart_ver_str'] == '7.0(3)I4(1)'
''' '''
RETURN = ''' RETURN = '''

@ -89,48 +89,49 @@ options:
''' '''
EXAMPLES = ''' EXAMPLES = '''
- name Ensure an interface is a Layer 3 port and that it has the proper description - name: Ensure an interface is a Layer 3 port and that it has the proper description
nxos_interface: nxos_interface:
interface: Ethernet1/1 interface: Ethernet1/1
description: 'Configured by Ansible' description: 'Configured by Ansible'
mode: layer3 mode: layer3
host: 68.170.147.165 host: 68.170.147.165
- name Admin down an interface - name: Admin down an interface
nxos_interface: nxos_interface:
interface: Ethernet2/1 interface: Ethernet2/1
host: 68.170.147.165 host: 68.170.147.165
admin_state: down admin_state: down
- name Remove all loopback interfaces - name: Remove all loopback interfaces
nxos_interface: nxos_interface:
interface: loopback interface: loopback
state: absent state: absent
host: 68.170.147.165 host: 68.170.147.165
- name Remove all logical interfaces - name: Remove all logical interfaces
nxos_interface: nxos_interface:
interface_type: "{{ item }} " interface_type: "{{ item }} "
state: absent state: absent
host: "{{ inventory_hostname }}" host: "{{ inventory_hostname }}"
with_items: with_items:
- loopback - loopback
- portchannel - portchannel
- svi - svi
- nve - nve
- name Admin up all ethernet interfaces
- name: Admin up all ethernet interfaces
nxos_interface: nxos_interface:
interface: ethernet interface: ethernet
host: 68.170.147.165 host: 68.170.147.165
admin_state: up admin_state: up
- name Admin down ALL interfaces (physical and logical) - name: Admin down ALL interfaces (physical and logical)
nxos_interface: nxos_interface:
interface: all interface: all
host: 68.170.147.165 host: 68.170.147.165
admin_state: down admin_state: down
''' '''
RETURN = ''' RETURN = '''
proposed: proposed:
description: k/v pairs of parameters passed into module description: k/v pairs of parameters passed into module

@ -76,14 +76,14 @@ options:
EXAMPLES = """ EXAMPLES = """
- name: set hostname with file lookup - name: set hostname with file lookup
ops_template: ops_template:
src: ./hostname.json src: ./hostname.json
backup: yes backup: yes
remote_user: admin remote_user: admin
become: yes become: yes
- name: set hostname with var - name: set hostname with var
ops_template: ops_template:
src: "{{ config }}" src: "{{ config }}"
remote_user: admin remote_user: admin
become: yes become: yes

@ -85,6 +85,7 @@ options:
EXAMPLES = """ EXAMPLES = """
# Note: examples below use the following provider dict to handle # Note: examples below use the following provider dict to handle
# transport and authentication to the node. # transport and authentication to the node.
---
vars: vars:
cli: cli:
host: "{{ inventory_hostname }}" host: "{{ inventory_hostname }}"
@ -92,6 +93,7 @@ vars:
password: netop password: netop
transport: cli transport: cli
---
- ops_command: - ops_command:
commands: commands:
- show version - show version

@ -139,12 +139,14 @@ options:
EXAMPLES = """ EXAMPLES = """
# Note: examples below use the following provider dict to handle # Note: examples below use the following provider dict to handle
# transport and authentication to the node. # transport and authentication to the node.
---
vars: vars:
cli: cli:
host: "{{ inventory_hostname }}" host: "{{ inventory_hostname }}"
username: netop username: netop
password: netop password: netop
---
- name: configure hostname over cli - name: configure hostname over cli
ops_config: ops_config:
lines: lines:

@ -73,6 +73,7 @@ options:
EXAMPLES = """ EXAMPLES = """
# Note: examples below use the following provider dict to handle # Note: examples below use the following provider dict to handle
# transport and authentication to the node. # transport and authentication to the node.
---
vars: vars:
cli: cli:
host: "{{ inventory_hostname }}" host: "{{ inventory_hostname }}"
@ -85,6 +86,7 @@ vars:
password: netop password: netop
transport: rest transport: rest
---
- ops_facts: - ops_facts:
gather_subset: all gather_subset: all
provider: "{{ rest }}" provider: "{{ rest }}"

@ -85,6 +85,7 @@ options:
EXAMPLES = """ EXAMPLES = """
# Note: examples below use the following provider dict to handle # Note: examples below use the following provider dict to handle
# transport and authentication to the node. # transport and authentication to the node.
---
vars: vars:
cli: cli:
host: "{{ inventory_hostname }}" host: "{{ inventory_hostname }}"
@ -92,6 +93,7 @@ vars:
password: admin password: admin
transport: cli transport: cli
---
tasks: tasks:
- name: run show version on remote devices - name: run show version on remote devices
sros_command: sros_command:
@ -105,7 +107,7 @@ tasks:
provider: "{{ cli }}" provider: "{{ cli }}"
- name: run multiple commands on remote nodes - name: run multiple commands on remote nodes
sros_command: sros_command:
commands: commands:
- show version - show version
- show port detail - show port detail

@ -160,6 +160,7 @@ options:
EXAMPLES = """ EXAMPLES = """
# Note: examples below use the following provider dict to handle # Note: examples below use the following provider dict to handle
# transport and authentication to the node. # transport and authentication to the node.
---
vars: vars:
cli: cli:
host: "{{ inventory_hostname }}" host: "{{ inventory_hostname }}"
@ -167,19 +168,20 @@ vars:
password: admin password: admin
transport: cli transport: cli
---
- name: enable rollback location - name: enable rollback location
sros_config: sros_config:
lines: configure system rollback rollback-location "cf3:/ansible" lines: configure system rollback rollback-location "cf3:/ansible"
provider: "{{ cli }}" provider: "{{ cli }}"
- name: set system name to {{ inventory_hostname }} using one line - name: set system name to {{ inventory_hostname }} using one line
sros_config: sros_config:
lines: lines:
- configure system name "{{ inventory_hostname }}" - configure system name "{{ inventory_hostname }}"
provider: "{{ cli }}" provider: "{{ cli }}"
- name: set system name to {{ inventory_hostname }} using parents - name: set system name to {{ inventory_hostname }} using parents
sros_config: sros_config:
lines: lines:
- 'name "{{ inventory_hostname }}"' - 'name "{{ inventory_hostname }}"'
parents: parents:
@ -189,7 +191,7 @@ vars:
backup: yes backup: yes
- name: load config from file - name: load config from file
sros_config: sros_config:
src: "{{ inventory_hostname }}.cfg" src: "{{ inventory_hostname }}.cfg"
provider: "{{ cli }}" provider: "{{ cli }}"
save: yes save: yes

@ -79,6 +79,7 @@ options:
EXAMPLES = """ EXAMPLES = """
# Note: examples below use the following provider dict to handle # Note: examples below use the following provider dict to handle
# transport and authentication to the node. # transport and authentication to the node.
---
vars: vars:
cli: cli:
host: "{{ inventory_hostname }}" host: "{{ inventory_hostname }}"
@ -86,6 +87,7 @@ vars:
password: admin password: admin
transport: cli transport: cli
---
- name: configure rollback location - name: configure rollback location
sros_rollback: sros_rollback:
rollback_location: "cb3:/ansible" rollback_location: "cb3:/ansible"

@ -84,7 +84,7 @@ EXAMPLES = '''
msg: Ansible task finished msg: Ansible task finished
# send a message, specifying the host and port # send a message, specifying the host and port
- jabber - jabber:
user: mybot@example.net user: mybot@example.net
host: talk.example.net host: talk.example.net
port: 5223 port: 5223

@ -119,7 +119,7 @@ author: "Jan-Piet Mens (@jpmens)"
''' '''
EXAMPLES = ''' EXAMPLES = '''
- mqtt: - mqtt:
topic: 'service/ansible/{{ ansible_hostname }}' topic: 'service/ansible/{{ ansible_hostname }}'
payload: 'Hello at {{ ansible_date_time.iso8601 }}' payload: 'Hello at {{ ansible_date_time.iso8601 }}'
qos: 0 qos: 0

@ -124,7 +124,7 @@ EXAMPLES = '''
delegate_to: localhost delegate_to: localhost
# send an email to more than one recipient that the build failed # send an email to more than one recipient that the build failed
- sendgrid - sendgrid:
username: "{{ sendgrid_username }}" username: "{{ sendgrid_username }}"
password: "{{ sendgrid_password }}" password: "{{ sendgrid_password }}"
from_address: "build@mycompany.com" from_address: "build@mycompany.com"

@ -162,7 +162,7 @@ EXAMPLES = """
title: System load title: System load
fields: fields:
- title: System A - title: System A
value: load average: 0,74, 0,66, 0,63" value: "load average: 0,74, 0,66, 0,63"
short: True short: True
- title: System B - title: System B
value: 'load average: 5,16, 4,64, 2,43' value: 'load average: 5,16, 4,64, 2,43'

@ -54,8 +54,8 @@ options:
EXAMPLES = """ EXAMPLES = """
send a message to chat in playbook - name: send a message to chat in playbook
- telegram: telegram:
token: 'bot9999999:XXXXXXXXXXXXXXXXXXXXXXX' token: 'bot9999999:XXXXXXXXXXXXXXXXXXXXXXX'
chat_id: 000000 chat_id: 000000
msg: Ansible task finished msg: Ansible task finished

@ -76,7 +76,7 @@ EXAMPLES = '''
name: bootstrap name: bootstrap
- name: Install "bootstrap" bower package on version 3.1.1. - name: Install "bootstrap" bower package on version 3.1.1.
bower: bower:
name: bootstrap name: bootstrap
version: '3.1.1' version: '3.1.1'

@ -81,44 +81,44 @@ options:
''' '''
EXAMPLES = ''' EXAMPLES = '''
description: Install "coffee-script" node.js package. - name: Install "coffee-script" node.js package.
- npm: npm:
name: coffee-script name: coffee-script
path: /app/location path: /app/location
description: Install "coffee-script" node.js package on version 1.6.1. - name: Install "coffee-script" node.js package on version 1.6.1.
- npm: npm:
name: coffee-script name: coffee-script
version: '1.6.1' version: '1.6.1'
path: /app/location path: /app/location
description: Install "coffee-script" node.js package globally. - name: Install "coffee-script" node.js package globally.
- npm: npm:
name: coffee-script name: coffee-script
global: yes global: yes
description: Remove the globally package "coffee-script". - name: Remove the globally package "coffee-script".
- npm: npm:
name: coffee-script name: coffee-script
global: yes global: yes
state: absent state: absent
description: Install "coffee-script" node.js package from custom registry. - name: Install "coffee-script" node.js package from custom registry.
- npm: npm:
name: coffee-script name: coffee-script
registry: 'http://registry.mysite.com' registry: 'http://registry.mysite.com'
description: Install packages based on package.json. - name: Install packages based on package.json.
- npm: npm:
path: /app/location path: /app/location
description: Update packages based on package.json to their latest version. - name: Update packages based on package.json to their latest version.
- npm: npm:
path: /app/location path: /app/location
state: latest state: latest
description: Install packages based on package.json using the npm installed with nvm v0.10.1. - name: Install packages based on package.json using the npm installed with nvm v0.10.1.
- npm: npm:
path: /app/location path: /app/location
executable: /opt/nvm/v0.10.1/bin/npm executable: /opt/nvm/v0.10.1/bin/npm
state: present state: present

@ -128,8 +128,8 @@ EXAMPLES = '''
# Playbook: make sure spells with/without required dependencies (if any) are installed # Playbook: make sure spells with/without required dependencies (if any) are installed
- sorcery: - sorcery:
name: {{ item.spell }} name: "{{ item.spell }}"
depends: {{ item.depends | default(None) }} depends: "{{ item.depends | default(None) }}"
state: present state: present
with_items: with_items:
- { spell: 'vifm', depends: '+file,-gtk+2' } - { spell: 'vifm', depends: '+file,-gtk+2' }

@ -145,7 +145,7 @@ EXAMPLES = '''
# Force refresh of a repository # Force refresh of a repository
- zypper_repository: - zypper_repository:
repo: 'http://my_internal_ci_repo/repo repo: 'http://my_internal_ci_repo/repo'
name: my_ci_repo name: my_ci_repo
state: present state: present
runrefresh: yes runrefresh: yes

@ -57,7 +57,8 @@ options:
''' '''
EXAMPLES = ''' EXAMPLES = '''
Simple Example: ---
# Simple Example:
- name: "Create Product" - name: "Create Product"
local_action: local_action:
@ -69,9 +70,8 @@ Simple Example:
params: params:
name: "Centos 7" name: "Centos 7"
Abstraction Example: # Abstraction Example:
# katello.yml
katello.yml
--- ---
- name: "{{ name }}" - name: "{{ name }}"
local_action: local_action:
@ -82,7 +82,7 @@ katello.yml
entity: "{{ entity }}" entity: "{{ entity }}"
params: "{{ params }}" params: "{{ params }}"
tasks.yml # tasks.yml
--- ---
- include: katello.yml - include: katello.yml
vars: vars:

@ -96,7 +96,7 @@ EXAMPLES = """
- name: Snapshot volume - name: Snapshot volume
netapp_e_snapshot_volume: netapp_e_snapshot_volume:
ssid: "{{ ssid }}" ssid: "{{ ssid }}"
api_url: "{{ netapp_api_url }}"/ api_url: "{{ netapp_api_url }}/"
api_username: "{{ netapp_api_username }}" api_username: "{{ netapp_api_username }}"
api_password: "{{ netapp_api_password }}" api_password: "{{ netapp_api_password }}"
state: present state: present

@ -78,13 +78,19 @@ options:
''' '''
EXAMPLES = ''' EXAMPLES = '''
name: Gather facts about ZFS dataset rpool/export/home - name: Gather facts about ZFS dataset rpool/export/home
zfs_facts: dataset=rpool/export/home zfs_facts:
dataset: rpool/export/home
name: Report space usage on ZFS filesystems under data/home
zfs_facts: name=data/home recurse=yes type=filesystem - name: Report space usage on ZFS filesystems under data/home
debug: msg='ZFS dataset {{ item.name }} consumes {{ item.used }} of disk space.' zfs_facts:
with_items: '{{ ansible_zfs_datasets }} name: data/home
recurse: yes
type: filesystem
- debug:
msg: 'ZFS dataset {{ item.name }} consumes {{ item.used }} of disk space.'
with_items: '{{ ansible_zfs_datasets }}'
''' '''
RETURN = ''' RETURN = '''

@ -91,7 +91,7 @@ EXAMPLES = '''
state: opts_present state: opts_present
opts: discard opts: discard
with_items: '{{ ansible_mounts }}' with_items: '{{ ansible_mounts }}'
when: '/dev/mapper/luks-' in {{ item.device }} when: "'/dev/mapper/luks-' in {{ item.device }}"
''' '''
from ansible.module_utils.basic import * from ansible.module_utils.basic import *

Some files were not shown because too many files have changed in this diff Show More

Loading…
Cancel
Save