Note
This plugin is part of the community.network collection (version 3.0.0).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.network.
To use it in a playbook, specify: community.network.cv_server_provision.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| action string |
| The action for the module to take. The actions are add, which applies the specified template config to port, remove, which defaults the specified interface configuration, and show, which will return the current port configuration with no changes. |
| auto_run boolean |
| Flag that determines whether or not the module will execute the CVP task spawned as a result of changes to a switch configlet. When an add or remove action is taken which results in a change to a switch configlet, CVP will spawn a task that needs to be executed for the configuration to be applied to the switch. If this option is True then the module will determined the task number created by the configuration change, execute it and wait for the task to complete. If the option is False then the task will remain in the Pending state in CVP for a network administrator to review and execute. |
| host string / required | The hostname or IP address of the CVP node being connected to. | |
| password string / required | The password of the user that will be used to connect to CVP for API calls. | |
| port string | The port number to use when making API calls to the CVP node. This will default to the default port for the specified protocol. Port 80 for http and port 443 for https. | |
| port_vlan string | The vlan that should be applied to the port for this server. This parameter is dependent on a proper template that supports single vlan provisioning with it. If a port vlan is specified by the template specified does not support this the module will exit out with no changes. If a template is specified that requires a port vlan but no port vlan is specified the module will exit out with no changes. | |
| protocol string |
| The protocol to use when making API calls to CVP. CVP defaults to https and newer versions of CVP no longer support http. |
| server_name string / required | The hostname or identifier for the server that is having it's switch port provisioned. | |
| switch_name string / required | The hostname of the switch is being configured for the server being provisioned. | |
| switch_port string / required | The physical port number on the switch that the new server is connected to. | |
| template string / required | A path to a Jinja formatted template file that contains the configuration block that will be applied to the specified switch port. This template will have variable fields replaced by the module before being applied to the switch configuration. | |
| username string / required | The user that will be used to connect to CVP for making API calls. |
- name: Get current configuration for interface Ethernet2
community.network.cv_server_provision:
host: cvp_node
username: cvp_user
password: cvp_pass
protocol: https
server_name: new_server
switch_name: eos_switch_1
switch_port: 2
template: template_file.j2
action: show
- name: Remove existing configuration from interface Ethernet2. Run task.
community.network.cv_server_provision:
host: cvp_node
username: cvp_user
password: cvp_pass
protocol: https
server_name: new_server
switch_name: eos_switch_1
switch_port: 2
template: template_file.j2
action: remove
auto_run: True
- name: Add template configuration to interface Ethernet2. No VLAN. Run task.
community.network.cv_server_provision:
host: cvp_node
username: cvp_user
password: cvp_pass
protocol: https
server_name: new_server
switch_name: eos_switch_1
switch_port: 2
template: single_attached_trunk.j2
action: add
auto_run: True
- name: Add template with VLAN configuration to interface Ethernet2. Run task.
community.network.cv_server_provision:
host: cvp_node
username: cvp_user
password: cvp_pass
protocol: https
server_name: new_server
switch_name: eos_switch_1
switch_port: 2
port_vlan: 22
template: single_attached_vlan.j2
action: add
auto_run: True
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| changed boolean | success | Signifies if a change was made to the configlet Sample: True |
| currentConfigBlock string | when action = show | The current config block for the user specified interface Sample: interface Ethernet4 ! |
| fullConfig string | when action = add or remove | The full config of the configlet after being updated Sample: ! interface Ethernet3 ! interface Ethernet4 ! |
| newConfigBlock string | when action = add or remove | The new config block for the user specified interface Sample: interface Ethernet3 description example no switchport ! |
| oldConfigBlock string | when action = add or remove | The current config block for the user specified interface before any changes are made Sample: interface Ethernet3 ! |
| portConfigurable boolean | success | Signifies if the user specified port has an entry in the configlet that Ansible has access to Sample: True |
| switchConfigurable boolean | success | Signifies if the user specified switch has a configlet applied to it that CVP is allowed to edit Sample: True |
| switchInfo dictionary | success | Information from CVP describing the switch being configured Sample: {'architecture': 'i386', 'bootupTimeStamp': 1491264298.21, 'complianceCode': '0000', 'complianceIndication': 'NONE', 'deviceInfo': 'Registered', 'deviceStatus': 'Registered', 'fqdn': 'veos1', 'hardwareRevision': '', 'internalBuildId': '12-12', 'internalVersion': '4.17.1F-11111.4171F', 'ipAddress': '192.168.1.20', 'isDANZEnabled': 'no', 'isMLAGEnabled': 'no', 'key': '00:50:56:5d:e5:e0', 'lastSyncUp': 1496432895799, 'memFree': 472976, 'memTotal': 1893460, 'modelName': 'vEOS', 'parentContainerId': 'container_13_5776759195930', 'serialNumber': '', 'systemMacAddress': '00:50:56:5d:e5:e0', 'taskIdList': [], 'tempAction': None, 'type': 'netelement', 'unAuthorized': False, 'version': '4.17.1F', 'ztpMode': 'false'} |
| taskCompleted boolean | when action = add or remove, and auto_run = true, and configuration changes | Signifies if the task created and executed has completed successfully Sample: True |
| taskCreated boolean | when action = add or remove, and auto_run = true or false, and configuration changes | Signifies if a task was created due to configlet changes Sample: True |
| taskExecuted boolean | when action = add or remove, and auto_run = true, and configuration changes | Signifies if the automation executed the spawned task Sample: True |
| taskId string | when action = add or remove, and auto_run = true or false, and configuration changes | The task ID created by CVP because of changes to configlet Sample: 500 |
| updateConfigletResponse string | when action = add or remove and configuration changes | Response returned from CVP when configlet update is triggered Sample: Configlet veos1-server successfully updated and task initiated. |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/cv_server_provision_module.html