Ciena Waveserver Ai Collection

The Ansible Ciena Waveserver Ai collection includes a variety of Ansible content to help automate the management of Ciena Waveserver Ai platforms.

This collection has been tested against

Ansible version compatibility

Ansible version compatibility

This collection has been tested against following Ansible versions: >=2.15.0.

For collections that support Ansible 2.9, please ensure you update your network_os to use the fully qualified collection name (for example, cisco.ios.ios). Plugins and modules within a collection may be tested with only specific Ansible versions. A collection may contain metadata that identifies these versions. PEP440 is the schema used to describe the versions of Ansible.

Supported connections

Supports netconf and network_cli connections.

Included content

Netconf plugins

Name	Description
ciena.waveserverai.waveserverai	Use waveserverai netconf plugin to run netconf commands on Ciena waveserverai platform

Cliconf plugins

Name	Description
ciena.waveserverai.waveserverai	Low level CLI transport for running commands on Waveserver Ai

Terminal plugins

Name	Description
ciena.waveserverai.waveserverai	Prompt handling definitions for Waveserver Ai CLI sessions

Modules

Name	Description
ciena.waveserverai.waveserverai_command	Run commands on remote devices running Ciena Waveserver Ai
ciena.waveserverai.waveserverai_facts	Get facts about waveserverai devices.
ciena.waveserverai.waveserverai_ports	Waveserver port configuration and operational data.Manage the ports ports configuration of a Ciena waveserverai device
ciena.waveserverai.waveserverai_ptps	Waveserver Physical Termination Point (PTP) configuration and operational data.Manage the ptps ptps configuration of a Ciena waveserverai device
ciena.waveserverai.waveserverai_system	Waveserver System configuration data and operational data.Manage the system configuration of a Ciena waveserverai device
ciena.waveserverai.waveserverai_xcvrs	Waveserver transceivers (XCVR) configuration and operational data.Manage the xcvrs xcvrs configuration of a Ciena waveserverai device

Installing this collection

Install the collection with the Ansible Galaxy CLI:

ansible-galaxy collection install ciena.waverserverai

You can also include it in a requirements.yml file and install it with ansible-galaxy collection install -r requirements.yml, using the format:

---
collections:
  - name: ciena.waveserverai

Using this collection

This collection includes network resource modules.

Using modules from the collection in your playbooks

You can call modules by their Fully Qualified Collection Namespace (FQCN), such as ciena.waveserverai.waveserverai_xcvrs.

---
  - name: Set xcvr mode
    ciena.waveserverai.waveserverai_xcvrs:
      config:
        - xcvr-id: 1-1
          properties:
            mode: 56-400

Development

We welcome community contributions to this collection. If you find problems, please open an issue or create a PR against the collection repository.

Release is done automatically use Github Actions as part of merging to master.

Documentation generation

ansible-doc -M ./plugins/modules/ waveserverai_facts | sed -e 's/(\/home.*//g' | sed -e 's/> //g' > docs/waveserverai_facts.txt
ansible-doc -M ./plugins/modules/ waveserverai_xcvrs | sed -e 's/(\/home.*//g' | sed -e 's/> //g' > docs/waveserverai_xcvrs.txt

Resource Module Builder

The modules in this project were built using the resource module builder.

Usage:

PATH_TO_ANSIBLE_COLLECTIONS_DIR=/home/$USER/src/ansible_collections/ciena/waveserverai
ansible-playbook -e rm_dest=$PATH_TO_ANSIBLE_COLLECTIONS_DIR \
                 -e structure=collection \
                 -e collection_org=ciena \
                 -e collection_name=waveserverai \
                 -e model=$PATH_TO_ANSIBLE_COLLECTIONS_DIR/resource_module_models/xcvrs/waveserverai_xcvrs.yml \
                 -e transport=netconf \
                 site.yml

Changelogs

CHANGELOG

Licensing

See LICENSE to see the full text.