rapyutarobotics.rr_io.networks – Module to interact with rapyuta_io networks

Note

This plugin is part of the rapyutarobotics.rr_io collection (version 2.0.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 rapyutarobotics.rr_io.

To use it in a playbook, specify: rapyutarobotics.rr_io.networks.

New in version 1.0.0: of rapyutarobotics.rr_io

Synopsis

  • This is my longer description explaining my test module.

Parameters

Parameter

Comments

name

string / required

Name of the network.

network_interface

string

added in 1.0.0 of rapyutarobotics.rr_io

network_interface used by the runtim=device in type=routed_network or type=native_network.

Is case Insensitive.

Default: “yes”

present

boolean / required

added in 1.0.0 of rapyutarobotics.rr_io

Whether the network should be present in rapyuta.io.

Choices:

  • no

  • yes

resource_type

string

added in 1.0.0 of rapyutarobotics.rr_io

Resource type needed for the type=native_network and runtime=cloud of type=routed_network.

Required if type=native_network.

Is case Insensitive.

Choices:

  • x_small

  • small

  • medium

  • large

restart_policy

string

added in 1.0.0 of rapyutarobotics.rr_io

Restart policy for runtime=device of type=routed_network.

Is case Insensitive.

Choices:

  • always ← (default)

  • on_failure

  • never

ros_distro

string

added in 1.0.0 of rapyutarobotics.rr_io

Ros Distro to be used for the native_network.

Required if type=native_network.

Is case Insensitive.

Choices:

  • melodic

  • kinetic

  • noetic

runtime

string

added in 1.0.0 of rapyutarobotics.rr_io

runtime for type=routed_network.

Is case Insensitive.

Choices:

  • device

  • cloud ← (default)

shared

boolean

added in 1.0.0 of rapyutarobotics.rr_io

Whether the type=routed_network should be shared.

Is case Insensitive.

Choices:

  • no

  • yes ← (default)

type

string / required

added in 1.0.0 of rapyutarobotics.rr_io

Can be used to deploy either static routes, native_networks or routed_networks.

Choices:

  • native_network

  • routed_network

  • static_route

Examples

# Native network example
-   name: Network Deployment
    rapyutarobotics.rr_io.networks:
    name: native_network
    present: false
    type: native_network
    ros_distro: noetic
    resource_type: small

# Static Route example
-   name: GWM Static Route
    rapyutarobotics.rr_io.networks:
    name: rr-gwm
    present: false
    type: static_route

Return Values

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

Key

Description

changed

boolean

Whether the network was changed during executing the playbook.

Returned: always

Sample: true

exists

boolean

Whether the network exists after executing the playbook.

Returned: always

Sample: true

id

boolean

Whether the network exists after executing the playbook.

Returned: always

Sample: true

name

boolean

Whether the network exists after executing the playbook.

Returned: always

Sample: true

status

boolean

Whether the network exists after executing the playbook.

Returned: always

Sample: true

type

boolean

Whether the network exists after executing the playbook.

Returned: always

Sample: true

Authors

  • Dhananjay Sathe (@dsathe)

  • Abhinav Gupta (@abhinavg97)