Documentation

cs_router - Manages routers on Apache CloudStack based clouds.

New in version 2.2.

Synopsis

  • Start, restart, stop and destroy routers.
  • state=present is not able to create routers, use cs_network instead.

Options

parameter required default choices comments
account
no
Account the router is related to.
api_http_method
no get
  • get
  • post
HTTP method used.
api_key
no
API key of the CloudStack API.
api_region
no cloudstack
Name of the ini section in the cloustack.ini file.
api_secret
no
Secret key of the CloudStack API.
api_timeout
no 10
HTTP timeout.
api_url
no
URL of the CloudStack API e.g. https://cloud.example.com/client/api.
domain
no
Domain the router is related to.
name
yes
Name of the router.
project
no
Name of the project the router is related to.
service_offering
no
Name or id of the service offering of the router.
state
no present
  • present
  • absent
  • started
  • stopped
  • restarted
State of the router.

Examples

# Ensure the router has the desired service offering, no matter if
# the router is running or not.
- local_action:
    module: cs_router
    name: r-40-VM
    service_offering: System Offering for Software Router

# Ensure started
- local_action:
    module: cs_router
    name: r-40-VM
    state: started

# Ensure started with desired service offering.
# If the service offerings changes, router will be rebooted.
- local_action:
    module: cs_router
    name: r-40-VM
    service_offering: System Offering for Software Router
    state: started

# Ensure stopped
- local_action:
    module: cs_router
    name: r-40-VM
    state: stopped

# Remove a router
- local_action:
    module: cs_router
    name: r-40-VM
    state: absent

Return Values

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

name description returned type sample
domain Domain the router is related to. success string ROOT
name Name of the router. success string r-40-VM
zone Name of zone the router is in. success string ch-gva-2
created Date of the router was created. success string 2014-12-01T14:57:57+0100
template_version Version of the system VM template. success string 4.5.1
account Account the router is related to. success string admin
requires_upgrade Whether the router needs to be upgraded to the new template. success bool False
state State of the router. success string Active
role Role of the router. success string VIRTUAL_ROUTER
service_offering Name of the service offering the router has. success string System Offering For Software Router
id UUID of the router. success string 04589590-ac63-4ffc-93f5-b698b8ac38b6
redundant_state Redundant state of the router. success string UNKNOWN


Notes

Note

  • Ansible uses the cs library’s configuration method if credentials are not provided by the arguments api_url, api_key, api_secret. Configuration is read from several locations, in the following order. - The CLOUDSTACK_ENDPOINT, CLOUDSTACK_KEY, CLOUDSTACK_SECRET and CLOUDSTACK_METHOD. CLOUDSTACK_TIMEOUT environment variables. - A CLOUDSTACK_CONFIG environment variable pointing to an .ini file, - A cloudstack.ini file in the current working directory. - A .cloudstack.ini file in the users home directory. Optionally multiple credentials and endpoints can be specified using ini sections in cloudstack.ini. Use the argument api_region to select the section name, default section is cloudstack. See https://github.com/exoscale/cs for more information.
  • A detailed guide about cloudstack modules can be found on http://docs.ansible.com/ansible/guide_cloudstack.html
  • This module supports check mode.

Status

This module is flagged as stableinterface which means that the maintainers for this module guarantee that no backward incompatible interface changes will be made.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.