Installation¶

Requirements¶

One authoritative statement, mirrored by the CI matrix (the floor and the current release are both tested on every merge):

Component	Requirement	Notes
netautomate.netorca	2.x	this documentation; 1.x is frozen and unmaintained
ansible-core	≥ 2.15	tested against 2.15 (floor) and 2.18 (current)
Python (controller)	≥ 3.9	CI tests 3.11 and 3.12
netorca-sdk	≥ 1.0.9, < 2.0.0	the v2 SDK architecture; installed separately via pip
NetOrca platform	current SaaS/on-prem API (`/v1`)	API-key authentication

The modules run on the controller (hosts: localhost), so netorca-sdk must be installed into the Python environment Ansible uses there - nothing is needed on managed nodes.

Install¶

ansible-galaxy collection install netautomate.netorca
pip install "netorca-sdk>=1.0.9,<2.0.0"

Or via a requirements.yml, pinned to the major version (recommended for CI):

collections:
  - name: netautomate.netorca
    version: ">=2.0.0,<3.0.0"

ansible-galaxy collection install -r requirements.yml

Staying on v1

v1 playbooks do not run on 2.x (see the migration guide). To stay on the frozen v1 line: version: "<2.0.0" - and note v1 needs netorca_sdk==0.2.4.

Verify¶

$ ansible-doc -l netautomate.netorca
netautomate.netorca.netorca_change_instance       Transition change instances in NetOrca
netautomate.netorca.netorca_change_instance_info  Query change instances in NetOrca
netautomate.netorca.netorca_deployed_item         Manage deployed items in NetOrca
netautomate.netorca.netorca_service_item_info     Query service items in NetOrca
$ python -c "import netorca_sdk; print('sdk ok')"
sdk ok

Then run your first playbook.

Upgrade¶

ansible-galaxy collection install netautomate.netorca --upgrade

Within 2.x, upgrades are additive (new modules and options); check the release notes per release.

Offline / air-gapped install¶

Download the release tarball (from Galaxy or the build job artifact of any pipeline), transfer it, then:

ansible-galaxy collection install netautomate-netorca-2.0.0.tar.gz
pip download "netorca-sdk>=1.0.9,<2.0.0" -d ./wheels   # on a connected host
pip install --no-index --find-links ./wheels netorca-sdk

Execution environments¶

The collection ships meta/execution-environment.yml, so ansible-builder picks up the Python dependency automatically:

# execution-environment.yml
dependencies:
  galaxy:
    collections:
      - netautomate.netorca

The resulting image contains both the collection and netorca-sdk.