Documentation

pn_vrouter - CLI command to create/delete/modify a vrouter.

New in version 2.2.

Synopsis

  • Execute vrouter-create, vrouter-delete, vrouter-modify command.
  • Each fabric, cluster, standalone switch, or virtual network (VNET) can provide its tenants with a virtual router (vRouter) service that forwards traffic between networks and implements Layer 3 protocols.
  • vrouter-create creates a new vRouter service.
  • vrouter-delete deletes a vRouter service.
  • vrouter-modify modifies a vRouter service.

Options

parameter required default choices comments
pn_bgp_as
 no
Specify the Autonomous System Number(ASN) if the vRouter runs Border Gateway Protocol(BGP).
pn_bgp_max_paths
 no
Specify the maximum number of paths for BGP. This is a number between 1 and 255 or 0 to unset.
pn_bgp_options
 no
Specify other BGP options as a whitespaces separated string within single quotes ''.
pn_bgp_redistribute
 no
  • static
  • connected
  • rip
  • ospf
Specify how BGP routes are redistributed.
pn_clipassword
 no
Provide login password if user is not root.
pn_cliswitch
 no
Target switch(es) to run the CLI on.
pn_cliusername
 no
Provide login username if user is not root.
pn_hw_vrrp_id
 no
Specifies the VRRP ID for a hardware vrouter.
pn_name
 yes
Specify the name of the vRouter.
pn_ospf_options
 no
Specify other OSPF options as a whitespaces separated string within single quotes ''.
pn_ospf_redistribute
 no
  • static
  • connected
  • bgp
  • rip
Specify how OSPF routes are redistributed.
pn_rip_redistribute
 no
  • static
  • connected
  • ospf
  • bgp
Specify how RIP routes are redistributed.
pn_router_id
 no
Specify the vRouter IP address.
pn_router_type
 no
  • hardware
  • software
Specify if the vRouter uses software or hardware.
Note that if you specify hardware as router type, you cannot assign IP addresses using DHCP. You must specify a static IP address.
pn_service_state
 no
  • enable
  • disable
Specify to enable or disable vRouter service.
pn_service_type
 no
  • dedicated
  • shared
Specify if the vRouter is a dedicated or shared VNET service.
pn_vnet
 no
Specify the name of the VNET.
Required for vrouter-create.
state
 yes
  • present
  • absent
  • update
State the action to perform. Use 'present' to create vrouter, 'absent' to delete vrouter and 'update' to modify vrouter.

Examples

- name: create vrouter
  pn_vrouter:
    state: 'present'
    pn_name: 'ansible-vrouter'
    pn_vnet: 'ansible-fab-global'
    pn_router_id: 208.74.182.1

- name: delete vrouter
  pn_vrouter:
    state: 'absent'
    pn_name: 'ansible-vrouter'

Return Values

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

name description returned type sample
changed
Indicates whether the CLI caused changes on the target.
 always bool
command
The CLI command run on the target node(s).
 always str
stderr
The set of error responses from the vrouter command.
 on error list
stdout
The set of responses from the vrouter command.
 always list


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

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