Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,28 +16,28 @@ jobs:
steps:
- uses: actions/checkout@v2
with:
path: ansible_collections/ciena/saos10
path: ansible_collections/ciena/waveserverai
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
- name: Install collections
run: |
ansible-galaxy collection install ansible.netcommon
ansible-galaxy collection install ansible.netcommon
- name: Install dependencies
working-directory: ./ansible_collections/ciena/saos10
working-directory: ./ansible_collections/ciena/waveserverai
run: |
pip install -r requirements.txt
pip install -r requirements-test.txt
- name: test
working-directory: ./ansible_collections/ciena/saos10
working-directory: ./ansible_collections/ciena/waveserverai
run: |
ansible-test integration
- name: build
working-directory: ./ansible_collections/ciena/saos10
working-directory: ./ansible_collections/ciena/waveserverai
run: |
ansible-galaxy collection build
- name: release
working-directory: ./ansible_collections/ciena/saos10
working-directory: ./ansible_collections/ciena/waveserverai
run: |
ls *.tar.gz | xargs ansible-galaxy collection publish --api-key ${{ secrets.GALAXY_API_KEY }}
10 changes: 8 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
# Ciena WaveserverAi Collection Release Notes

## v1.0.3
## v1.1.0
### Added
- Added support for Waveserver Ai 2.5.0
- System Module
- Xcvrs Module
- Ports Module
- Ptps Module

## v1.0.3
### Fixed
- Moved config_is_diff method to utils

## v1.0.0

### Added
- Initial
32 changes: 27 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,17 @@ This collection has been tested against

## Ansible version compatibility

This collection has been tested against following Ansible versions: **>=2.9.10,<2.11**.
<!--start requires_ansible-->
## 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.
<!--end requires_ansible-->

### Supported connections

Expand All @@ -15,12 +25,19 @@ Supports ``netconf`` connections.
## Included content

<!--start collection content-->
### Netconf plugins
Name | Description
--- | ---
[ciena.waveserverai.waveserverai](https://github.com/ciena/ciena.waveserverai/blob/master/docs/ciena.waveserverai.waveserverai_netconf.rst)|Use waveserverai netconf plugin to run netconf commands on Ciena waveserverai platform

### Modules
| Name | Description |
| ------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------- |
| [ciena.waveserverai.waveserverai_facts](https://github.com/ciena/ciena.waveserverai/blob/master/docs/waveserverai_facts.txt) | Collect facts from remote devices |
| [ciena.waveserverai.waveserverai_xcvrs](https://github.com/ciena/ciena.waveserverai/blob/master/docs/waveserverai_command.txt) | Set xcvr settings on remote devices |
Name | Description
--- | ---
[ciena.waveserverai.waveserverai_facts](https://github.com/ciena/ciena.waveserverai/blob/master/docs/ciena.waveserverai.waveserverai_facts_module.rst)|Get facts about waveserverai devices.
[ciena.waveserverai.waveserverai_ports](https://github.com/ciena/ciena.waveserverai/blob/master/docs/ciena.waveserverai.waveserverai_ports_module.rst)|Waveserver port configuration and operational data.Manage the ports ports configuration of a Ciena waveserverai device
[ciena.waveserverai.waveserverai_ptps](https://github.com/ciena/ciena.waveserverai/blob/master/docs/ciena.waveserverai.waveserverai_ptps_module.rst)|Waveserver Physical Termination Point (PTP) configuration and operational data.Manage the ptps ptps configuration of a Ciena waveserverai device
[ciena.waveserverai.waveserverai_system](https://github.com/ciena/ciena.waveserverai/blob/master/docs/ciena.waveserverai.waveserverai_system_module.rst)|Waveserver System configuration data and operational data.Manage the system configuration of a Ciena waveserverai device
[ciena.waveserverai.waveserverai_xcvrs](https://github.com/ciena/ciena.waveserverai/blob/master/docs/ciena.waveserverai.waveserverai_xcvrs_module.rst)|Waveserver transceivers (XCVR) configuration and operational data.Manage the xcvrs xcvrs configuration of a Ciena waveserverai device

<!--end collection content-->
## Installing this collection
Expand Down Expand Up @@ -94,3 +111,8 @@ ansible-playbook -e rm_dest=$PATH_TO_ANSIBLE_COLLECTIONS_DIR \
## Licensing

See [LICENSE](LICENSE) to see the full text.





113 changes: 113 additions & 0 deletions docs/ciena.waveserverai.waveserverai_facts_module.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
.. _ciena.waveserverai.waveserverai_facts_module:


*************************************
ciena.waveserverai.waveserverai_facts
*************************************

**Get facts about waveserverai devices.**


Version added: 2.9

.. contents::
:local:
:depth: 1


Synopsis
--------
- Collects facts from network devices running the waveserverai operating system. This module places the facts gathered in the fact tree keyed by the respective resource name. The facts module will always collect a base set of facts from the device and can enable or disable collection of additional facts.




Parameters
----------

.. raw:: html

<table border=0 cellpadding=0 class="documentation-table">
<tr>
<th colspan="1">Parameter</th>
<th>Choices/<font color="blue">Defaults</font></th>
<th width="100%">Comments</th>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div>
<b>gather_network_resources</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">-</span>
</div>
<div style="font-style: italic; font-size: small; color: darkgreen">added in 2.9</div>
</td>
<td>
</td>
<td>
<div>When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all and the resources like interfaces, vlans etc. Can specify a list of values to include a larger subset. Values can also be used with an initial <code><span class='module'>!</span></code> to specify that a specific subset should not be collected.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div>
<b>gather_subset</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">-</span>
</div>
<div style="font-style: italic; font-size: small; color: darkgreen">added in 2.2</div>
</td>
<td>
<b>Default:</b><br/><div style="color: blue">"all"</div>
</td>
<td>
<div>When supplied, this argument will restrict the facts collected to a given subset. Possible values for this argument include all, min, hardware, config, legacy, and interfaces. Can specify a list of values to include a larger subset. Values can also be used with an initial <code><span class='module'>!</span></code> to specify that a specific subset should not be collected.</div>
</td>
</tr>
</table>
<br/>




Examples
--------

.. code-block:: yaml

# Gather all facts
- waveserverai_facts:
gather_subset: all
gather_network_resources: all

# Collect only the xcvrs facts
- waveserverai_facts:
gather_subset:
- !all
- !min
gather_network_resources:
- xcvrs

# Do not collect xcvrs facts
- waveserverai_facts:
gather_network_resources:
- "!xcvrs"

# Collect xcvrs and minimal default facts
- waveserverai_facts:
gather_subset: min
gather_network_resources: xcvrs




Status
------


Authors
~~~~~~~

- Ciena
76 changes: 76 additions & 0 deletions docs/ciena.waveserverai.waveserverai_netconf.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
.. _ciena.waveserverai.waveserverai_netconf:


*******************************
ciena.waveserverai.waveserverai
*******************************

**Use waveserverai netconf plugin to run netconf commands on Ciena waveserverai platform**


Version added: 1.0.0

.. contents::
:local:
:depth: 1


Synopsis
--------
- This waveserverai plugin provides low level abstraction apis for sending and receiving netconf commands from Ciena waveserverai network devices.




Parameters
----------

.. raw:: html

<table border=0 cellpadding=0 class="documentation-table">
<tr>
<th colspan="1">Parameter</th>
<th>Choices/<font color="blue">Defaults</font></th>
<th>Configuration</th>
<th width="100%">Comments</th>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-"></div>
<b>ncclient_device_handler</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
<b>Default:</b><br/><div style="color: blue">"default"</div>
</td>
<td>
</td>
<td>
<div>Specifies the ncclient device handler name for Ciena waveserverai network os. To identify the ncclient device handler name refer ncclient library documentation.</div>
</td>
</tr>
</table>
<br/>








Status
------


Authors
~~~~~~~

- Ciena


.. hint::
Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.
Loading