Ciena SAOS 8 Collection

The Ansible Ciena SAOS collection includes a variety of Ansible content to help automate the management of Ciena SAOS 8.x network appliances.

This collection has been tested against Ciena rel_saos5170_8.6.5_ga076

Requirements

• Python 3.6+

Ansible version compatibility

This collection has been tested against following Ansible versions: >=2.9.10,<2.11.

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 SAOS 8 collection supports network_cli connections.

Included content

Modules

Name	Description
ciena.saos8.saos8_command	Run commands on remote devices running Ciena SAOS 8
ciena.saos8.saos8_facts	Collect facts from remote devices running Ciena SAOS 8

Installing this collection

You can install the Ciena SAOS 8 collection with the Ansible Galaxy CLI:

ansible-galaxy collection install ciena.saos8

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

Using this collection

This collection includes network resource modules.

Using modules from the Ciena SAOS 8 collection in your playbooks

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

---
  - name: Execute SAOS 8 commands
    ciena.saos8.saos8_command:
      commands:
      - port set port 2 description foo
      - port set port 3 description bar
      - config save

NOTE: For Ansible 2.9, you may not see deprecation warnings when you run your playbooks with this collection. Use this documentation to track when a module is deprecated.

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 8 collection repository.

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

Documentation generation

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

Changelogs

CHANGELOG

Roadmap

More information

• Ansible network resources
• Ansible Collection overview
• Ansible User guide
• Ansible Developer guide
• Ansible Community code of conduct

Licensing

See LICENSE to see the full text.