Ciena Waveserver5 Collection for Ansible

The Ansible Ciena Waveserver 5 collection includes a variety of Ansible content to help automate the management of Ciena Waveserver 5 network appliances.

Ansible version compatibility

This collection has been tested against following Ansible versions: >=2.12.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

The Ciena Waveserver5 collection supports netconf connections.

Included content

Netconf plugins

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

Modules

Name	Description
ciena.waveserver5.waveserver5_aaa	Waveserver AAA configuration data and operational data.
ciena.waveserver5.waveserver5_facts	Get facts about waveserver5 devices.
ciena.waveserver5.waveserver5_pm	Waveserver System configuration data and operational data.
ciena.waveserver5.waveserver5_ports	Waveserver Port configuration data and operational data.
ciena.waveserver5.waveserver5_ptps	Waveserver PTP configuration data and operational data.
ciena.waveserver5.waveserver5_system	Waveserver System configuration data and operational data.
ciena.waveserver5.waveserver5_xcvrs	Waveserver Transceiver configuration data and operational data.

Installing this collection

Install the Ciena Waveserver 5 collection with the Ansible Galaxy CLI:

ansible-galaxy collection install ciena.waveserver5

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.waveserver5

Using this collection

This collection includes network resource modules.

Using modules from the Ciena Waveserver 5 collection in your playbooks

You can call modules by their Fully Qualified Collection Namespace (FQCN), such as ciena.waveserver5.waveserver5_system. The following example task replaces configuration changes in the existing configuration on a Ciena Waveserver 5 network device, using the FQCN:

---
- hosts: all
  collections:
    - ciena.waveserver5
  gather_facts: false
  name: Gather facts for ciena device Saos 10
  tasks:
    - name: get device facts for Saos 10
      ciena.waveserver5.waveserver5_facts:
        gather_subset:
          - all
    - name: Set hostname
      ciena.waveserver5.waveserver5_system:
        config:
          host_name:
            config_host_name: hostname_test
        state: merged

Contributing to this collection

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

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

Resource Module Builder

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

Changelogs

CHANGELOG

Licensing

See LICENSE to see the full text.