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

Note

This plugin is part of the abhinavg97.rr_io collection (version 1.1.1).

To install it use: ansible-galaxy collection install abhinavg97.rr_io.

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

New in version 1.0.0: of abhinavg97.rr_io

Synopsis

  • This is my longer description explaining my test module.

Parameters

Parameter Choices/Defaults Comments
name
string / required
Name of the network.
network_interface
string
added in 1.0.0 of abhinavg97.rr_io
Default:
"yes"
network_interface used by the runtim=device in type=routed_network.
Is case Insensitive.
present
boolean / required
added in 1.0.0 of abhinavg97.rr_io
    Choices:
  • no
  • yes
Whether the network should be present in rapyuta.io.
resource_type
string
added in 1.0.0 of abhinavg97.rr_io
    Choices:
  • x_small
  • small
  • medium
  • large
Resource type needed for the type=native_network and runtime=cloud of type=routed_network.
Required if type=native_network.
Is case Insensitive.
restart_policy
string
added in 1.0.0 of abhinavg97.rr_io
    Choices:
  • always ←
  • on_failure
  • never
Restart policy for runtime=device of type=routed_network.
Is case Insensitive.
ros_distro
string
added in 1.0.0 of abhinavg97.rr_io
    Choices:
  • melodic
  • kinetic
Ros Distro to be used for the native_network.
Required if type=native_network.
Is case Insensitive.
runtime
string
added in 1.0.0 of abhinavg97.rr_io
    Choices:
  • device
  • cloud ←
runtime for type=routed_network.
Is case Insensitive.
shared
boolean
added in 1.0.0 of abhinavg97.rr_io
    Choices:
  • no
  • yes ←
Whether the type=routed_network should be shared.
Is case Insensitive.
type
string / required
added in 1.0.0 of abhinavg97.rr_io
    Choices:
  • native_network
  • routed_network
  • static_route
Can be used to deploy either static routes, native_networks or routed_networks.

Examples

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

# Static Route example
-   name: GWM Static Route
    abhinavg97.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 Returned Description
message
string
always
The output message that the test module generates.

Sample:
goodbye
original_message
string
always
The original name param that was passed in.

Sample:
hello world


Authors

  • Dhananjay Sathe (@dsathe)

  • Abhinav Gupta (@abhinavg97)