abhinavg97.rr_io.networks (1.1.19) — module

Install collection

Install with ansible-galaxy collection install abhinavg97.rr_io:==1.1.19

Add to requirements.yml

  collections:
    - name: abhinavg97.rr_io
      version: 1.1.19

Description

This is my longer description explaining my test module.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Inputs

    
name:
    description: Name of the network.
    required: true
    type: str

type:
    choices:
    - native_network
    - routed_network
    - static_route
    description:
    - Can be used to deploy either static routes, native_networks or routed_networks.
    required: true
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

shared:
    choices:
    - true
    - false
    default: true
    description:
    - Whether the I(type=routed_network) should be shared.
    - Is case Insensitive.
    required: false
    type: bool
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

present:
    choices:
    - true
    - false
    description:
    - Whether the network should be present in rapyuta.io.
    required: true
    type: bool
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

runtime:
    choices:
    - device
    - cloud
    default: cloud
    description:
    - runtime for I(type=routed_network).
    - Is case Insensitive.
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

ros_distro:
    choices:
    - melodic
    - kinetic
    description:
    - Ros Distro to be used for the native_network.
    - Required if I(type=native_network).
    - Is case Insensitive.
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

resource_type:
    choices:
    - x_small
    - small
    - medium
    - large
    description:
    - Resource type needed for the I(type=native_network) and I(runtime=cloud) of I(type=routed_network).
    - Required if I(type=native_network).
    - Is case Insensitive.
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

restart_policy:
    choices:
    - always
    - on_failure
    - never
    default: always
    description:
    - Restart policy for I(runtime=device) of I(type=routed_network).
    - Is case Insensitive.
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

network_interface:
    default: true
    description:
    - network_interface used by the I(runtim=device) in I(type=routed_network).
    - Is case Insensitive.
    required: false
    type: str
    version_added: 1.0.0
    version_added_collection: abhinavg97.rr_io

Outputs

changed:
  description: Whether the network was changed during executing the playbook.
  returned: always
  sample: true
  type: bool
exists:
  description: Whether the network exists after executing the playbook.
  returned: always
  sample: true
  type: bool
id:
  description: Whether the network exists after executing the playbook.
  returned: always
  sample: true
  type: bool
name:
  description: Whether the network exists after executing the playbook.
  returned: always
  sample: true
  type: bool
status:
  description: Whether the network exists after executing the playbook.
  returned: always
  sample: true
  type: bool
type:
  description: Whether the network exists after executing the playbook.
  returned: always
  sample: true
  type: bool