graphiant.naas.graphiant_static_routes module – Manage Graphiant static routes (edge.segments.*.staticRoutes)

Note

This module is part of the graphiant.naas collection (version 26.4.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install graphiant.naas. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: graphiant.naas.graphiant_static_routes.

New in graphiant.naas 26.2.0

Synopsis
Requirements
Parameters
Attributes
Notes
See Also
Examples
Return Values

Synopsis

Configure or delete static routes under edge segments (edge.segments.<segment>.staticRoutes).
Reads a structured YAML config file and builds the raw device-config payload in Python.
All operations are idempotent and safe to run multiple times.

Requirements

The below requirements are needed on the host that executes this module.

python >= 3.7
graphiant-sdk >= 26.4.0

Parameters

Parameter	Comments
access_token string	Bearer token for API authentication (for example, from `graphiant login`, which opens a browser for sign-in (SSO or non-SSO) and retrieves the token). If not passed as a module argument, the collection reads `GRAPHIANT_ACCESS_TOKEN` (set after `graphiant login` when you `source ~/.graphiant/env.sh`). When a bearer token is present (module argument or environment), it takes precedence over `username` and `password`. If no valid token is available, the module authenticates with `username` and `password` when both are supplied.
detailed_logs boolean	Enable detailed logging. Choices: `false` ← (default) `true`
host aliases: base_url string / required	Graphiant portal host URL for API connectivity. Example: “https://api.graphiant.com”
operation string	Specific operation to perform. `configure` builds full route objects. `deconfigure` deletes listed routes by setting route=null for each prefix. Choices: `"configure"` `"deconfigure"`
password string	Graphiant portal password for authentication. Required for password-based login when no valid bearer token is available from `access_token` or `GRAPHIANT_ACCESS_TOKEN`.
state string	Desired state for routes. `present` maps to `configure`; `absent` maps to `deconfigure` if operation not set. Choices: `"present"` ← (default) `"absent"`
static_routes_config_file aliases: static_route_config_file string / required	Path to the static routes YAML file. Can be an absolute path or relative to the configured config_path. Expected top-level key is `staticRoutes` (list of devices).
username string	Graphiant portal username for authentication. Required for password-based login when no valid bearer token is available from `access_token` or `GRAPHIANT_ACCESS_TOKEN`.

Attributes

Attribute	Support	Description
check_mode	Support: full In check mode, no configuration is pushed to devices, but the module still reads current device state to determine whether changes would be made. Payloads that would be pushed are logged with a `[check_mode]` prefix.	Supports check mode.

Notes

Note

Static Routes Operations:
- Configure: Create/update static routes listed in the config.
- Deconfigure: Delete static routes listed in the config.
Configuration files support Jinja2 templating syntax for dynamic configuration generation.
The module automatically resolves device names to IDs.
YAML schema uses camelCase keys (for example: staticRoutes, lanSegment, destinationPrefix, nextHops).
Configure idempotency: compares intended routes to existing device state per segment + prefix; skips push when already matched (changed=false).
Deconfigure deletes only the prefixes listed in the YAML (per segment).
Deconfigure payload uses route: null per prefix; this module preserves nulls in the final payload pushed to the API.

Examples

- name: Configure static routes
  graphiant.naas.graphiant_static_routes:
    operation: configure
    static_routes_config_file: "sample_static_route.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true
  register: static_routes_result
  no_log: true

- name: Display result message (includes detailed logs)
  ansible.builtin.debug:
    msg: "{{ static_routes_result.msg }}"

- name: Deconfigure static routes (deletes only prefixes listed in YAML)
  graphiant.naas.graphiant_static_routes:
    operation: deconfigure
    static_routes_config_file: "sample_static_route.yaml"
    host: "{{ graphiant_host }}"
    username: "{{ graphiant_username }}"
    password: "{{ graphiant_password }}"
    detailed_logs: true

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
changed boolean	Whether the operation made changes. `true` when config would be pushed to at least one device; `false` when intended state already matched. In check mode (`--check`), no configuration is pushed, but `changed` reflects whether changes would be made. Returned: always Sample: `false`
configured_devices list / elements=string	Device names where configuration was pushed (when changed=true). Returned: when supported Sample: `["edge-1-sdktest"]`
details dictionary	Raw manager result details (includes changed/configured_devices/skipped_devices). Returned: when supported
msg string	Result message from the operation, including detailed logs when `detailed_logs` is enabled. Returned: always Sample: `"Static routes already match desired state; no changes needed"`
operation string	The operation performed. Returned: always Sample: `"configure"`
skipped_devices list / elements=string	Device names that were skipped because desired state already matched. Returned: when supported Sample: `["edge-1-sdktest"]`
static_routes_config_file string	The static routes config file used for the operation. Returned: always Sample: `"sample_static_route.yaml"`

Authors

Graphiant Team (@graphiant)

Collection links

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/graphiant/naas/graphiant_static_routes_module.html