Ciena SAOS 10 Collection

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

This collection has been tested against saos-10-10-01-0182-GA

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 SAOS 10 collection supports network_cli and netconf connections.

Included content

Cliconf plugins

Name	Description
ciena.saos10.saos10	Use saos10 cliconf to run command on Ciena saos10 platform

Netconf plugins

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

Modules

Name	Description
ciena.saos10.saos10_bgp	Top level bgp container for bgp configurationManage the bgp instance configuration of a Ciena saos10 device
ciena.saos10.saos10_classifiers	List of classifier templates. Classifiers can be referenced by various entities (flow-point/access-flow/qos-flow etc.), to define their incoming classification.Manage the classifiers classifier configuration of a Ciena saos10 device
ciena.saos10.saos10_command	Run commands on remote devices running Ciena SAOS 10
ciena.saos10.saos10_facts	Get facts about saos10 devices.
ciena.saos10.saos10_fds	List of forwarding-domains. Forwarding domains are layer 2 forwarding domains to which various entities attach (flow-points, MPLS-PWs etc).Manage the fds fd configuration of a Ciena saos10 device
ciena.saos10.saos10_fps	A List of flow-points.Manage the fps fp configuration of a Ciena saos10 device
ciena.saos10.saos10_isis	List of IS-IS structures.Manage the isis instance configuration of a Ciena saos10 device
ciena.saos10.saos10_ldp	Ldp config container.Manage the ldp instance configuration of a Ciena saos10 device
ciena.saos10.saos10_logical_ports	List of logical-ports.Manage the logical_ports logical_port configuration of a Ciena saos10 device
ciena.saos10.saos10_mpls	MPLS config container.Manage the mpls configuration of a Ciena saos10 device
ciena.saos10.saos10_ptps	Physical Termination Point (PTP) configuration and operational data.Manage the ptps ptp configuration of a Ciena saos10 device

Installing this collection

Install the Ciena SAOS 10 collection with the Ansible Galaxy CLI:

ansible-galaxy collection install ciena.saos10

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

Using this collection

This collection includes network resource modules.

Using modules from the Ciena SAOS 10 collection in your playbooks

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

---
- hosts: all
  collections:
    - ciena.saos10
  gather_facts: false
  name: Gather facts for ciena device Saos 10
  tasks:
    - name: get device facts for Saos 10
      ciena.saos10.saos10_facts:
        gather_subset:
          - all
        gather_network_resources:
          - classifiers
      connection: netconf
    - name: saos10_command with diag shell
      ciena.saos10.saos10_command:
        commands:
        - software show
        - diag shell host
        - ls /
      connection: network_cli
  - name: Set port config
    ciena.saos10.saos10_command:
      commands:
      - config
      - oc-if:interfaces interface 2 config name 2 description myport
      - exit

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.