community.network.opx_cps module – CPS operations on networking device running Openswitch (OPX)
Note
This module is part of the community.network collection (version 5.0.3).
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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.network.opx_cps
.
Synopsis
Executes the given operation on the YANG object, using CPS API in the networking device running OpenSwitch (OPX). It uses the YANG models provided in https://github.com/open-switch/opx-base-model.
Aliases: network.opx.opx_cps
Requirements
The below requirements are needed on the host that executes this module.
cps
cps_object
cps_utils
Parameters
Parameter |
Comments |
---|---|
Attribute Yang path and their corresponding data. |
|
Attribute Yang type. |
|
Attempts to force the auto-commit event to the specified yang object. Choices:
|
|
Queries/Writes the specified yang path from/to the db. Choices:
|
|
Yang path to be configured. |
|
Operation to be performed on the object. Choices:
|
|
A qualifier provides the type of object data to retrieve or act on. Choices:
|
Examples
- name: Create VLAN
community.network.opx_cps:
module_name: "dell-base-if-cmn/if/interfaces/interface"
attr_data: {
"base-if-vlan/if/interfaces/interface/id": 230,
"if/interfaces/interface/name": "br230",
"if/interfaces/interface/type": "ianaift:l2vlan"
}
operation: "create"
- name: Get VLAN
community.network.opx_cps:
module_name: "dell-base-if-cmn/if/interfaces/interface"
attr_data: {
"if/interfaces/interface/name": "br230",
}
operation: "get"
- name: Modify some attributes in VLAN
community.network.opx_cps:
module_name: "dell-base-if-cmn/if/interfaces/interface"
attr_data: {
"cps/key_data":
{ "if/interfaces/interface/name": "br230" },
"dell-if/if/interfaces/interface/untagged-ports": ["e101-008-0"],
}
operation: "set"
- name: Delete VLAN
community.network.opx_cps:
module_name: "dell-base-if-cmn/if/interfaces/interface"
attr_data: {
"if/interfaces/interface/name": "br230",
}
operation: "delete"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Denotes if auto-commit event is set Returned: when commit_event is set to True in module options Sample: |
|
Returns the CPS Get output i.e. the running configuration before CPS operation of set/delete is performed Returned: when CPS operations set, delete Sample: |
|
Denotes if CPS DB transaction was performed Returned: when db is set to True in module options Sample: |
|
The actual configuration that will be pushed comparing the running configuration and input attributes Returned: when CPS operations set, delete Sample: |
|
Output from the CPS transaction. Output of CPS Get operation if CPS set/create/delete not done. Returned: when a CPS transaction is successfully performed. Sample: |