Skip to content

anramgop/cisco-network-puppet-module

BranchesTags
 
 

Repository files navigation

ciscopuppet

Documentation Workflow Map

This workflow map aids users, developers and maintainers of the ciscopuppet project in selecting the appropriate document(s) for their task.

Please see Learning Resources for additional references.

--

Table of Contents

  1. Overview
  2. Module Description
  3. Setup
  4. Usage
  5. Platform Support
  6. Resource Reference
  7. Limitations - OS compatibility, etc.
  8. Cisco OS Differences
  9. Learning Resources

Overview

The ciscopuppet module allows a network administrator to manage Cisco Network Elements using Puppet. This module bundles a set of Puppet Types, providers, Beaker Tests, Sample Manifests and Installation Tools for effective network management. The resources and capabilities provided by this Puppet Module will grow with contributions from Cisco, Puppet Labs and the open source community.

The Cisco Network Elements and Operating Systems managed by this Puppet Module are continuously expanding. Please refer to the Limitations section for details on currently supported hardware and software. The Limitations section also provides details on compatible Puppet Agent and Puppet Master versions.

This GitHub repository contains the latest version of the ciscopuppet module source code. Supported versions of the ciscopuppet module are available at Puppet Forge. Please refer to SUPPORT.md for additional details.

Contributions to this Puppet Module are welcome. Guidelines on contributions to the module are captured in CONTRIBUTING.md

Module Description

This module enables management of supported Cisco Network Elements using Puppet. This module enhances the Puppet DSL by introducing new Puppet Types and Providers capable of managing network elements.

The set of supported network element platforms is continuously expanding. Please refer to the Limitations section for a list of currently supported platforms.

Setup

Puppet Master

The ciscopuppet module must be installed on the Puppet Master server. Please see Puppet Labs: Installing Modules for general information on Puppet module installation.

Puppet Agent

The Puppet Agent requires installation and setup on each device. Agent setup can be performed as a manual process or it may be automated. For more information please see the README-agent-install.md document for detailed instructions on agent installation and configuration on Cisco Nexus and IOS XR devices.

Artifacts

As noted in the agent installation guide, these are the current RPM versions for use with ciscopuppet:

cisco_node_utils Ruby gem

This module has dependencies on the cisco_node_utils ruby gem. After installing the Puppet Agent software you will then need to install (and possibly configure) the gem on the agent device. See README-gem-install.md for detailed instructions.

Usage

The following example shows how to use ciscopuppet to configure ospf on a Cisco Nexus switch.

Three types are needed to add OSPF support on an interface: cisco_ospf, cisco_ospf_vrf, and cisco_interface_ospf.

First, to configure cisco_ospf to enable ospf on the device, add the following type in the manifest:

cisco_ospf {"Sample":
   ensure => present,
}

Then put the ospf router under a VRF, and add the corresponding OSPF configuration. If the configuration is global, use 'default' as the VRF name.

cisco_ospf_vrf {"Sample default":
   ensure => 'present',
   default_metric => '5',
   auto_cost => '46000',
}

Finally apply the ospf into an interface:

cisco_interface_ospf {"Ethernet1/2 Sample":
   ensure => present,
   area => 200,
   cost => "200",
}

Platform Support

Provider Support Across Platforms

The following table indicates which providers are supported on each platform. As platforms are added to the support list they may indicate Unsupported for some providers that have not completed the test validation process at the time of this release. Some providers will show caveats for a platform if there are limitations on usage, such as with unsupported properties or hardware limitations.

Cisco Providers
✅ = Supported
❌ = Unsupported		 N9k N30xx N31xx N56xx N6k N7k N8k IOS XR Caveats
cisco_aaa_authentication_login ✅ ✅ ✅ ❌ ❌ ❌ ✅ ❌
cisco_aaa_authorization_login_cfg_svc ✅ ✅ ✅ ❌ ❌ ❌ ✅ ❌
cisco_aaa_authorization_login_exec_svc ✅ ✅ ✅ ❌ ❌ ❌ ✅ ❌
cisco_aaa_group_tacacs ✅ ✅ ✅ ❌ ❌ ❌ ✅ ❌
cisco_acl ✅ ✅ ✅ ❌ ❌ ❌ ✅ ❌
cisco_ace ✅ ✅ ✅ ❌* ❌* ❌* ✅ ❌ * caveats
cisco_command_config ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
cisco_bgp ✅ ✅ ✅ ✅* ✅* ✅* ✅ ✅ * caveats
cisco_bgp_af ✅* ✅* ✅ ✅ ✅* ✅ ✅ ✅ * caveats
cisco_bgp_neighbor ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
cisco_bgp_neighbor_af ✅ ✅ ✅ ✅ ✅ ✅ ✅ ✅
cisco_bridge_domain ❌ ❌ ❌ ❌ ❌ ✅ ❌ ❌
cisco_bridge_domain_vni ❌ ❌ ❌ ❌ ❌ ✅ ❌ ❌
cisco_encapsulation ❌ ❌ ❌ ❌ ❌ ✅ ❌ ❌
cisco_interface ✅ ✅ ✅ ✅* ✅* ✅ ✅ ✅ * caveats
cisco_interface_channel_group ✅ ✅ ✅ ❌ ❌ ❌ ✅ ❌
cisco_interface_ospf ✅ ✅ ✅ ✅ ✅ ✅ ✅ ❌
cisco_interface_portchannel ❌* ✅* ✅* ❌* ❌* ❌* ✅ ❌ * caveats
cisco_interface_service_vni ❌ ❌ ❌ ❌ ❌ ✅ ❌ ❌
cisco_itd_device_group ✅ ❌ ❌ ❌ ❌ ✅ ❌ ❌
cisco_itd_device_group_node ✅ ❌ ❌ ❌ ❌ ✅ ❌ ❌
cisco_itd_service ✅ ❌ ❌ ❌ ❌ ✅ ❌ ❌ * caveats
cisco_ospf ✅ ✅ ✅ ✅ ✅ ✅ ✅ ❌
cisco_ospf_vrf ✅ ✅ ✅ ✅ ✅ ✅ ✅ ❌
✅ = Supported
❌ = Unsupported		 N9k N30xx N31xx N56xx N6k N7k N8k IOS XR Caveats
cisco_overlay_global ✅ ❌ ❌ ❌ ❌ ❌ ✅ ❌
cisco_pim ✅ ✅ ✅ ✅ ✅ ✅ ✅ ❌
cisco_pim_rp_address ✅ ✅ ✅ ✅ ✅ ✅ ✅ ❌
cisco_pim_grouplist ✅ ✅ ✅ ✅ ✅ ✅ ✅ ❌
cisco_portchannel_global ❌* ✅* ✅* ❌* ❌* ❌ ✅ ❌ * caveats
cisco_stp_global ✅* ✅* ✅* ✅* ✅* ✅ ✅ ❌ * caveats
cisco_snmp_community ✅ ✅ ✅ ✅ ✅ ✅ ✅ ❌
cisco_snmp_group ✅ ✅ ✅ ✅ ✅ ✅ ✅ ❌
cisco_snmp_server ✅ ✅ ✅ ✅ ✅ ✅ ✅ ❌
cisco_snmp_user ✅ ✅ ✅ ✅ ✅ ✅ ✅ ❌
cisco_tacacs_server ✅ ✅ ✅ ✅ ✅ ✅ ✅ ❌
cisco_tacacs_server_host ✅ ✅ ✅ ✅ ✅ ✅ ✅ ❌
cisco_vdc ❌ ❌ ❌ ❌ ❌ ✅ ❌ ❌
cisco_vlan ✅* ✅* ✅* ✅ ✅ ✅ ✅ ❌ * caveats
cisco_vpc_domain ✅* ✅* ✅* ✅* ✅* ✅* ✅* ❌ * caveats
cisco_vrf ✅ ✅* ✅* ❌ ❌ ❌ ✅ ✅* * caveats
cisco_vrf_af ✅ ✅ ✅ ✅* ✅* ✅* ✅ ✅* * caveats
cisco_vtp ✅ ✅ ✅ ❌ ❌ ❌ ✅ ❌
cisco_vxlan_vtep ✅ ❌ ❌ ❌ ❌ ❌ ✅ ❌
cisco_vxlan_vtep_vni ✅ ❌ ❌ ❌ ❌ ❌ ✅ ❌
NetDev Providers
✅ = Supported
❌ = Unsupported		 N9k N30xx N31xx N56xx N6k N7k N8k IOS XR
domain_name ✅ ✅ ✅ ❌ ❌ ❌ ✅ ✅
name_server ✅ ✅ ✅ ❌ ❌ ❌ ✅ ✅
network_dns ✅ ✅ ✅ ❌ ❌ ❌ ✅ ✅
network_interface ✅ ✅ ✅ ❌ ❌ ❌ ✅ ❌
network_snmp ✅ ✅ ✅ ❌ ❌ ❌ ✅ ❌
network_trunk ✅ ✅ ✅ ❌ ❌ ❌ ✅ ❌
ntp_config ✅ ✅ ✅ ❌ ❌ ❌ ✅ ✅
ntp_server ✅ ✅ ✅ ❌ ❌ ❌ ✅ ✅
network_snmp ✅ ✅ ✅ ❌ ❌ ❌ ✅ ❌
radius ✅ ✅ ✅ ❌ ❌ ❌ ✅ ❌
radius_global ✅ ✅ ✅ ❌ ❌ ❌ ✅ ✅
radius_server_group ✅ ✅ ✅ ❌ ❌ ❌ ✅ ✅
radius_server ✅ ✅ ✅ ❌ ❌ ❌ ✅ ✅*
search_domain ✅ ✅ ✅ ❌ ❌ ❌ ✅ ❌
snmp_community ✅ ✅ ✅ ❌ ❌ ❌ ✅ ❌
snmp_notification ✅ ✅ ✅ ❌ ❌ ❌ ✅ ❌
snmp_notification_receiver ✅ ✅ ✅ ❌ ❌ ❌ ✅ ❌
snmp_user ✅ ✅ ✅ ❌ ❌ ❌ ✅ ❌
syslog_server ✅ ✅ ✅ ❌ ❌ ❌ ✅ ✅
syslog_setting ✅ ✅ ✅ ❌ ❌ ❌ ✅ ❌
tacacs ✅ ✅ ✅ ❌ ❌ ❌ ✅ ❌
tacacs_global ✅ ✅ ✅ ❌ ❌ ❌ ✅ ❌
tacacs_server_group ✅ ✅ ✅ ❌ ❌ ❌ ✅ ✅
tacacs_server ✅ ✅ ✅ ❌ ❌ ❌ ✅ ✅

Resource Reference

The following resources include cisco types and providers along with cisco provider support for netdev stdlib types. Installing the ciscopuppet module will install both the ciscopuppet and netdev_stdlib modules.

Resource Type Catalog (by Technology)

--

Cisco Resource Type Catalog (by Name)

NetDev StdLib Resource Type Catalog (by Name)

--

Cisco Resource Type Details

The following resources are listed alphabetically.

--

Type: cisco_command_config

Allows execution of configuration commands.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.0.1
N30xx 7.0(3)I2(1) 1.0.1
N31xx 7.0(3)I2(1) 1.0.1
N56xx 7.3(0)N1(1) 1.2.0
N6k 7.3(0)N1(1) 1.2.0
N7k 7.3(0)D1(1) 1.2.0
N8k 7.0(3)F1(1) 1.3.0
IOS XR TODO TODO

Parameters

command

Configuration command(s) to be applied to the network element. Valid values are string.

This provider allows raw configurations to be managed by Puppet. It serves as a stopgap until specialized types are created. It has the following limitations:

  • The input message buffer is limited to 500KB. Large configurations are often easier to debug if broken up into multiple smaller resource blocks.
  • The cisco_command_config configuration block must use the same syntax as displayed by the show running-config command on the switch. In some cases, configuration commands that omit optional keywords when entered may actually appear with a different syntax when displayed by show running-config; for example, some access-list entries may be configured without a sequence number but yet an implicit sequence number is created regardless. This then creates an idempotency problem because there is a mismatch between show running-config and the manifest. The solution in this case is for the manifest to include explicit sequence numbers for the affected access-list entries.
  • Order is important. Some dependent commands may fail if their associated feature configuration is not enabled first. Use Puppet's before, after, or require keywords to establish dependencies between blocks.
  • Indentation counts! It implies sub-mode configuration. Use the switch's running-config as a guide and do not indent configurations that are not normally indented. Do not use tabs to indent.
  • Inline comments must be prefixed by '!' or '#'.
  • Negating a submode will also remove configuratons under that submode, without having to specify every submode config statement: no router ospf RED removes all configuration under router ospf RED.
  • Syntax does not auto-complete: use Ethernet1/1, not Eth1/1.
  • If a CLI command is rejected during configuration, the resource will abort at that point and will not issue any remaining CLI. For this reason, we recommend limiting the scope of each instance of this resource.

--

Type: cisco_aaa_authentication_login

Manages AAA Authentication Login configuration.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

name

The name of the AAA Authentication Login instance. Must be 'default'

ascii_authentication

Enable/disable ascii_authentication for AAA Authentication Login. Valid values are true, false, keyword 'default'

chap

Enable/disable chap for AAA Authentication Login.

error_display

Enable/disable error_display for AAA Authentication Login.

mschap

Enable/disable mschap for AAA Authentication Login.

mschapv2

Enable/disable mschapv2 for AAA Authentication Login.

--

Type: cisco_aaa_authorization_login_cfg_svc

Manages configuration for Authorization Login Config Service.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

ensure

Determines whether the config should be present or not on the device. Valid values are 'present' and 'absent'.

name

Name of the config login service. Valid values are 'console' or 'default'.

groups

Tacacs+ groups configured for this service. Valid values are an array of strings, keyword 'default'.

method

Authentication methods on this device. Valid values are 'local', 'unselected', 'default'.

--

Type: cisco_aaa_authorization_login_exec_svc

Manages configuration for Authorization Login Exec Service.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

ensure

Determines whether the config should be present or not on the device. Valid values are 'present' and 'absent'.

name

Name of the exec login service. Valid values are 'console' or 'default'.

groups

Tacacs+ groups configured for this service. Valid values are an array of strings, keyword 'default'.

method

Authentication methods on this device. Valid values are 'local', 'unselected', 'default'.

--

Type: cisco_aaa_group_tacacs

Manages configuration for a TACACS+ server group.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

ensure

Determines whether the config should be present or not on the device. Valid values are 'present' and 'absent'.

group

Name of the aaa group TACACS instance. Valid values are string.

deadtime

Deadtime interval for this TACACS+ server group. Valid values are integer, in minutes, keyword 'default'

server_hosts

An array of TACACS+ server hosts associated with this TACACS+ server group. Valid values are an array, or the keyword 'default'.

source_interface

Source interface for TACACS+ servers in this TACACS+ server group Valid values are string, keyword 'default'.

vrf_name

Specifies the virtual routing and forwarding instance (VRF) to use to contact this TACACS server group. Valid values are string, the keyword 'default'.

--

Type: cisco_acl

Manages configuration of a Access Control List (ACL) instance.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

ensure

Determines whether the config should be present or not on the device. Valid values are 'present' and 'absent'.

afi

Address Family Identifier (AFI). Required. Valid values are ipv4 and ipv6.

acl_name

Name of the acl instance. Valid values are string.

stats_per_entry

Enable/disable Statistics Per Entry for ACL. Valid values are true, false, keyword 'default'.

fragments

Permit or deny Fragments for ACL. Valid values are 'permit-all' and 'deny-all'

--

Type: cisco_ace

Manages configuration of an Access Control List (ACL) Access Control Entry (ACE) instance.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Caveats

Property Caveat Description
http_method ipv4 only
Not supported on N56xx, N6k, N7k
packet_length Not supported on N56xx, N6k
precedence ipv4 only
redirect ipv4 only
Not supported on N56xx, N6k, N7k
time_range Not supported on N56xx, N6k
ttl Not supported on N56xx, N6k, N7k
tcp_option_length ipv4 only
Not supported on N56xx, N6k, N7k

Example Usage

cisco_ace { 'ipv4 my_acl 42':
  ensure              => 'present',
  remark              => 'East Branch',
  action              => 'permit',
  proto               => 'tcp',
  src_addr            => '10.0.0.0/8',
  src_port            => 'eq 40',
  dst_addr            => 'any',
  dst_port            => 'neq 80',

  dscp                => 'af11',
  established         => 'true',
  log                 => 'true',
  packet_length       => 'range 512 1024'
  precedence          => 'flash',
  redirect            => 'Ethernet1/2,Port-Channel42',
  tcp_flags           => 'ack psh',
  time_range          => 'my_time_range',
  ttl                 => '128',
}

cisco_ace { 'ipv6 my_v6_acl 42':
  ensure              => 'present',
  remark              => 'East Branch',
  action              => 'permit',
  proto               => 'tcp',
  src_addr            => '1:1::1/128',
  dst_addr            => 'any',
}

Parameters

Example Parameter Usage
cisco_ace { '<afi> <acl_name> <seqno>':
cisco_ace { 'ipv4 my_acl 42':
afi

Address Family Identifier (AFI). Required. Valid values are ipv4 and ipv6.

acl_name

Access Control List (ACL) name. Required. Valid values are type String.

seqno

Access Control Entry (ACE) Sequence Number. Required. Valid values are type Integer.

ensure

Determines whether the config should be present or not on the device. Valid values are 'present' and 'absent'.

Properties

action

The action to perform with this ACE. Valid values are keywords permit or deny.

Example
action => 'permit'
dscp

Allows matching by Differentiated Services Code Point (DSCP) value. Valid values are type String, which must be one of the following forms:

  • A numeric dscp value
  • One of the dscp keyword names
    • af11 af12 af13 af21 af22 af23 af31 af32 af33 af41 af42 af43
    • cs1 cs2 cs3 cs4 cs5 cs6 cs7
    • ef
    • default
Example
dscp => 'af11'
dst_addr

The Destination Address to match against. This property shares the same syntax as src_addr. Valid values are type String, which must be one of the following forms:

  • An IPv4/IPv6 address or subnet
  • The keyword host and a host address
  • The keyword addrgroup and its object group name
  • The keyword any
Examples
dst_addr => '10.0.0.0/8'
dst_addr => 'host 10.0.0.1'
dst_addr => '128:1::/64'
dst_addr => 'addrgroup my_addrgroup'
dst_addr => 'any'

See src_addr.

dst_port

The TCP or UDP Destination Port to match against. This property shares the same syntax as src_port. Valid values are type String, which must be one of the following forms:

  • A comparison operator (eq, neq, lt, gt) and value
  • The keyword range and a range value
  • The keyword portgroup and its object group name
Examples
dst_port => 'neq 40'
dst_port => 'range 68 69'
dst_port => 'portgroup my_portgroup'

See src_port.

established

Allows matching against TCP Established connections. Valid values are true or false.

Example
established => true
http_method

(ipv4 only) Allows matching based on http-method. Valid values are String, which must be one of the following forms:

  • A numeric http-method value
  • One of the http-method keyword names
    • connect delete get head post put trace
Examples
http_method => 'post'
log

Enables logging for the ACE. Valid values are true or false.

Examples
'log' => true
packet_length

Allows matching based on Layer 3 Packet Length. Valid values are type String, which must be one of the following forms:

  • A comparison operator (eq, neq, lt, gt) and value
  • The keyword range and range values
Examples
packet_length => 'gt 512'
packet_length => 'range 512 1024'
precedence

(ipv4 only) Allows matching by precedence value. Valid values are String, which must be one of the following forms:

  • A numeric precedence value
  • One of the precedence keyword names
    • critical flash flash-override immediate internet network priority routine
Example
precedence => 'flash'
proto

The protocol to match against. Valid values are String or Integer. Examples are: tcp, udp, ip, 6.

Example
proto => 'tcp'
redirect

(ipv4 only) Allows for redirecting traffic to one or more interfaces. This property is only useful with VLAN ACL (VACL) applications. Valid values are a String containing a list of interface names.

Examples
redirect => 'Ethernet1/1'
redirect => 'Ethernet1/2,Port-Channel42'
remark

This is a Remark description for the ACL or ACE. Valid values are string.

Example
remark => 'East Branch'
src_addr

The Source Address to match against. Valid values are type String, which must be one of the following forms:

  • An IPv4/IPv6 address or subnet
  • The keyword host and a host address
  • The keyword addrgroup and its object group name
  • The keyword any
Examples
src_addr => '10.0.0.0/8'
src_addr => 'host 10.0.0.1'
src_addr => '128:1::/64'
src_addr => 'addrgroup my_addrgroup'
src_addr => 'any'

See dst_addr.

src_port

The TCP or UDP Source Port to match against. Valid values are type String, which must be one of the following forms:

  • A comparison operator (eq, neq, lt, gt) and value
  • The keyword range and range values
  • The keyword portgroup and its object group name
Examples
src_port => 'neq 40'
src_port => 'range 68 69'
src_port => 'portgroup my_portgroup'

See dst_port.

tcp_flags

The TCP flags or control bits. Valid values are a String of some or all of flags: urg, ack, psh, rst, syn, or fin.

Example
tcp_flags => 'ack psh'
tcp_option_length

(ipv4 only) Allows matching on TCP options length. Valid values are type Integer or String, which must be a multiple of 4 in the range 0-40.

Examples
tcp_option_length => '0'
tcp_option_length => '36'
time_range

Allows matching by Time Range. Valid values are String, which references a time-range name.

Example
time_range => 'my_time_range'
ttl

Allows matching based on Time-To-Live (TTL) value. Valid values are type Integer or String.

Example
ttl => '128'

--

Type: cisco_bgp

Manages configuration of a BGP instance.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.1.0
N30xx 7.0(3)I2(1) 1.1.0
N31xx 7.0(3)I2(1) 1.1.0
N56xx 7.3(0)N1(1) 1.2.0
N6k 7.3(0)N1(1) 1.2.0
N7k 7.3(0)D1(1) 1.2.0
N8k 7.0(3)F1(1) 1.3.0
IOS XR TODO TODO

Caveats

Property Caveat Description
bestpath_med_confed Only supported in global BGP context in IOS XR
bestpath_med_non_deterministic Not supported on IOS XR
cluster_id Only supported in global BGP context in IOS XR
confederation_id Only supported in global BGP context in IOS XR
confederation_peers Only supported in global BGP context in IOS XR
disable_policy_batching Not supported on IOS XR
disable_policy_batching_ipv4 Not supported on N56xx, N6k, N7k, IOS XR
disable_policy_batching_ipv6 Not supported on N56xx, N6k, N7k, IOS XR
enforce_first_as Only supported in global BGP context in NX-OS
event_history_cli Not supported on IOS XR
event_history_detail Not supported on IOS XR
event_history_events Not supported on IOS XR
event_history_periodic Not supported on IOS XR
fast_external_fallover Only supported in global BGP context in NX-OS
flush_routes Only supported in global BGP context in NX-OS. Not supported on IOS XR
graceful_restart Only supported in global BGP context in IOS XR
graceful_restart_helper Not supported on IOS XR
graceful_restart_timers_restart Only supported in global BGP context in IOS XR
graceful_restart_timers_stalepath_time Only supported in global BGP context in IOS XR
isolate Not supported on IOS XR
maxas_limit Not supported on IOS XR
neighbor_down_fib_accelerate Not supported on N56xx, N6k, N7k, IOS XR
nsr Only supported on IOS XR. Not supported on NX-OS
reconnect_interval Not supported on N56xx, N6k, N7k, IOS XR
shutdown Not supported on IOS XR
suppress_fib_pending Not supported on IOS XR
timer_bestpath_limit Not supported on IOS XR
timer_bestpath_limit_always Not supported on IOS XR

Parameters

ensure

Determines whether the config should be present or not on the device. Valid values are 'present' and 'absent'.

asn

BGP autonomous system number. Valid values are String, Integer in ASPLAIN or ASDOT notation.

vrf

Name of the resource instance. Valid values are string. The name 'default' is a valid VRF representing the global bgp.

route_distinguisher

VPN Route Distinguisher (RD). The RD is combined with the IPv4 or IPv6 prefix learned by the PE router to create a globally unique address. Valid values are a String in one of the route-distinguisher formats (ASN2:NN, ASN4:NN, or IPV4:NN); the keyword 'auto', or the keyword 'default'.

Please note: The route_distinguisher property is typically configured within the VRF context configuration on most platforms (including NXOS) but it is tightly coupled to bgp and therefore configured within the BGP configuration on some platforms (XR for example). For this reason the route_distinguisher property has support (with limitations) in both cisco_vrf and cisco_bgp providers:

  • cisco_bgp: The property is fully supported on both NXOS and XR.
  • cisco_vrf: The property is only supported on NXOS. See: cisco_vrf: route_distinguisher

IMPORTANT: Choose only one provider to configure the route_distinguisher property on a given device. Using both providers simultaneously on the same device may have unpredictable results.

router_id

Router Identifier (ID) of the BGP router VRF instance. Valid values are string, and keyword 'default'.

cluster_id

Route Reflector Cluster-ID. Valid values are String, keyword 'default'. On IOS XR, this property is only supported in the global BGP context.

confederation_id

Routing domain confederation AS. Valid values are String, keyword 'default'. On IOS XR, this property is only supported in the global BGP context.

confederation_peers

AS confederation parameters. Valid values are String, keyword 'default'. On IOS XR, this property is only supported in the global BGP context.

disable_policy_batching

Enable/Disable the batching evaluation of prefix advertisements to all peers. Valid values are 'true', 'false', and 'default'. This property is not supported on IOS XR.

disable_policy_batching_ipv4

Enable/Disable the batching evaluation of prefix advertisements to all peers with prefix list. Valid values are String, keyword 'default'. This property is not supported on IOS XR.

disable_policy_batching_ipv6

Enable/Disable the batching evaluation of prefix advertisements to all peers with prefix list. Valid values are String, keyword 'default'. This property is not supported on IOS XR.

enforce_first_as

Enable/Disable enforces the neighbor autonomous system to be the first AS number listed in the AS path attribute for eBGP. Valid values are 'true', 'false', and 'default'. On NX-OS, this property is only supported in the global BGP context.

event_history_cli

Enable/Disable cli event history buffer. Valid values are 'true', 'false', 'size_small', 'size_medium', 'size_large', 'size_disable' and 'default'. This property is not supported on IOS XR.

event_history_detail

Enable/Disable detail event history buffer. Valid values are 'true', 'false', 'size_small', 'size_medium', 'size_large', 'size_disable' and 'default'. This property is not supported on IOS XR.

event_history_events

Enable/Disable event history buffer. Valid values are 'true', 'false', 'size_small', 'size_medium', 'size_large', 'size_disable' and 'default'. This property is not supported on IOS XR.

event_history_periodic

Enable/Disable periodic event history buffer. Valid values are 'true', 'false', 'size_small', 'size_medium', 'size_large', 'size_disable' and 'default'. This property is not supported on IOS XR.

fast_external_fallover

Enable/Disable immediately reset the session if the link to a directly connected BGP peer goes down. Valid values are 'true', 'false', and 'default'. On NX-OS, this property is only supported in the global BGP context.

flush_routes

Enable/Disable flush routes in RIB upon controlled restart. Valid values are 'true', 'false', and 'default'. On NX-OS, this property is only supported in the global BGP context. This property is not supported on IOS XR.

isolate

Enable/Disable isolate this router from BGP perspective. Valid values are 'true', 'false', and 'default'. This property is not supported on IOS XR.

maxas_limit

Specify Maximum number of AS numbers allowed in the AS-path attribute. Valid values are integers between 1 and 512, or keyword 'default' to disable this property. This property is not supported on IOS XR.

neighbor_down_fib_accelerate

Enable/Disable handle BGP neighbor down event, due to various reasons. Valid values are 'true', 'false', and 'default'. This property is not supported on IOS XR.

nsr

Enable/Disable Non-Stop Routing (NSR). Valid values are 'true', 'false', and 'default'. This property is not supported on Nexus.

shutdown

Administratively shutdown the BGP protocol. Valid values are 'true', 'false', and 'default'. This property is not supported on IOS XR.

suppress_fib_pending

Enable/Disable advertise only routes programmed in hardware to peers. Valid values are 'true', 'false', and 'default'. This property is not supported on IOS XR.

log_neighbor_changes

Enable/Disable message logging for neighbor up/down event. Valid values are 'true', 'false', and 'default'

bestpath_always_compare_med

Enable/Disable MED comparison on paths from different autonomous systems. Valid values are 'true', 'false', and 'default'.

bestpath_aspath_multipath_relax

Enable/Disable load sharing across the providers with different (but equal-length) AS paths. Valid values are 'true', 'false', and 'default'

bestpath_compare_routerid

Enable/Disable comparison of router IDs for identical eBGP paths. Valid values are 'true', 'false', and 'default'

bestpath_cost_community_ignore

Enable/Disable Ignores the cost community for BGP best-path calculations. Valid values are 'true', 'false', and 'default'

bestpath_med_confed

Enable/Disable enforcement of bestpath to do a MED comparison only between paths originated within a confederation. Valid values are 'true', 'false', and 'default'. On IOS XR, this property is only supported in the global BGP context.

bestpath_med_missing_as_worst

Enable/Disable assigns the value of infinity to received routes that do not carry the MED attribute, making these routes the least desirable. Valid values are 'true', 'false', and 'default'.

bestpath_med_non_deterministic

Enable/Disable deterministic selection of the best MED path from among the paths from the same autonomous system. Valid values are 'true', 'false', and 'default'. This property is not supported on IOS XR.

timer_bestpath_limit

Specify timeout for the first best path after a restart, in seconds. Valid values are Integer, keyword 'default'. This property is not supported on IOS XR.

timer_bestpath_limit_always

Enable/Disable update-delay-always option. Valid values are 'true', 'false', and 'default'. This property is not supported on IOS XR.

graceful_restart

Enable/Disable graceful restart. Valid values are 'true', 'false', and 'default'. On IOS XR, this property is only supported in the global BGP context.

graceful_restart_helper

Enable/Disable graceful restart helper mode. Valid values are 'true', 'false', and 'default'. This property is not supported on IOS XR.

graceful_restart_timers_restart

Set maximum time for a restart sent to the BGP peer. Valid values are Integer, keyword 'default'. On IOS XR, this property is only supported in the global BGP context.

graceful_restart_timers_stalepath_time

Set maximum time that BGP keeps the stale routes from the restarting BGP peer. Valid values are Integer, keyword 'default'. On IOS XR, this property is only supported in the global BGP context.

timer_bgp_keepalive

Set bgp keepalive timer. Valid values are Integer, keyword 'default'.

timer_bgp_hold

Set bgp hold timer. Valid values are Integer, keyword 'default'.

--

Type: cisco_bgp_af

Manages configuration of a BGP Address-family instance.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.1.0
N30xx 7.0(3)I2(1) 1.1.0
N31xx 7.0(3)I2(1) 1.1.0
N56xx 7.3(0)N1(1) 1.2.0
N6k 7.3(0)N1(1) 1.2.0
N7k 7.3(0)D1(1) 1.2.0
N8k 7.0(3)F1(1) 1.3.0
IOS XR TODO TODO

Caveats

Property Caveat Description
additional_paths_install Not supported on IOS XR
advertise_l2vpn_evpn Not supported on N30xx, N31xx, N6k, IOS XR
client_to_client Only supported in global BGP context in IOS XR
dampen_igp_metric Not supported on IOS XR
dampening_state (and dependent properties dampening_half_time, dampening_max_suppress_time, dampening_reuse_time, dampening_routemap, dampening_suppress_time) Only supported in global BGP context in IOS XR
default_information_originate Not supported on IOS XR
default_metric Not supported on IOS XR
inject_map Not supported on IOS XR
next_hop_route_map Only supported in global BGP context in IOS XR
suppress_inactive Not supported on IOS XR
table_map_filter Not supported on IOS XR

Parameters

ensure

Determine whether the interface config should be present or not. Valid values are 'present' and 'absent'.

asn

BGP autonomous system number. Required. Valid values are String, Integer in ASPLAIN or ASDOT notation.

vrf

VRF name. Required. Valid values are string. The name 'default' is a valid VRF representing the global bgp.

afi

Address Family Identifier (AFI). Required. Valid values for Nexus and IOS XR are ipv4, ipv6, vpnv4, vpnv6 and l2vpn.

safi

Sub Address Family Identifier (SAFI). Required. Valid values are unicast, multicast and evpn.

additional_paths_install

Install a backup path into the forwarding table and provide prefix 'independent convergence (PIC) in case of a PE-CE link failure. Valid values are true, false, or 'default'. This property is not supported on IOS XR.

additional_paths_receive

Enables the receive capability of additional paths for all of the neighbors under this address family for which the capability has not been disabled. Valid values are true, false, or 'default'

additional_paths_selection

Configures the capability of selecting additional paths for a prefix. Valid values are a string defining the name of the route-map.

additional_paths_send

Enables the send capability of additional paths for all of the neighbors under this address family for which the capability has not been disabled. Valid values are true, false, or 'default'

advertise_l2vpn_evpn

Advertise evpn routes. Valid values are true and false. This property is not supported on IOS XR.

client_to_client

Configure client-to-client route reflection. Valid values are true and false. On IOS XR, this property is only supported in the global BGP context.

dampen_igp_metric

Specify dampen value for IGP metric-related changes, in seconds. Valid values are Integer, keyword 'default'. This property is not supported on IOS XR.

dampening_state

Enable/disable route-flap dampening. Valid values are true, false or 'default'. On IOS XR, this property is only supported in the global BGP context.

dampening_half_time

Specify decay half-life in minutes for route-flap dampening. Valid values are Integer, keyword 'default'. On IOS XR, this property is only supported in the global BGP context.

dampening_max_suppress_time

Specify max suppress time for route-flap dampening stable route. Valid values are Integer, keyword 'default'. On IOS XR, this property is only supported in the global BGP context.

dampening_reuse_time

Specify route reuse time for route-flap dampening. Valid values are Integer, keyword 'default'. On IOS XR, this property is only supported in the global BGP context.

dampening_routemap

Specify route-map for route-flap dampening. Valid values are a string defining the name of the route-map. On IOS XR, this property is only supported in the global BGP context.

dampening_suppress_time

Specify route suppress time for route-flap dampening. Valid values are Integer, keyword 'default'. On IOS XR, this property is only supported in the global BGP context.

Dampening Properties

Note: dampening_routemap is mutually exclusive with dampening_half_time, reuse_time, suppress_time and max_suppress_time.

default_information_originate

default-information originate. Valid values are true and false. This property is not supported on IOS XR.

default_metric

Sets default metrics for routes redistributed into BGP. Valid values are Integer or keyword 'default'. This property is not supported on IOS XR.

distance_ebgp

Sets the administrative distance for eBGP routes. Valid values are Integer or keyword 'default'.

distance_ibgp

Sets the administrative distance for iBGP routes. Valid values are Integer or keyword 'default'.

distance_local

Sets the administrative distance for local BGP routes. Valid values are Integer or keyword 'default'.

inject_map

An array of route-map names which will specify prefixes to inject. Each array entry must first specify the inject-map name, secondly an exist-map name, and optionally the copy-attributes keyword which indicates that attributes should be copied from the aggregate. This property is not supported on IOS XR.

For example, the following array will create three separate inject-maps for lax_inject_map, nyc_inject_map (with copy-attributes), and fsd_exist_map:

[
 ['lax_inject_map', 'lax_exist_map'],
 ['nyc_inject_map', 'nyc_exist_map', 'copy-attributes'],
 ['fsd_inject_map', 'fsd_exist_map']
]
maximum_paths

Configures the maximum number of equal-cost paths for load sharing. Valid value is an integer in the range 1-64. Default value is 1.

maximum_paths_ibgp

Configures the maximum number of ibgp equal-cost paths for load sharing. Valid value is an integer in the range 1-64. Default value is 1.

networks

Networks to configure. Valid value is a list of network prefixes to advertise. The list must be in the form of an array. Each entry in the array must include a prefix address and an optional route-map.

Example: IPv4 Networks Array

[
 ['10.0.0.0/16', 'routemap_LA'],
 ['192.168.1.1', 'Chicago'],
 ['192.168.2.0/24],
 ['192.168.3.0/24', 'routemap_NYC']
]

Example: IPv6 Networks Array

[
 ['10::0/64', 'routemap_LA'],
 ['192:168::1', 'Chicago'],
 ['192:168::/32]
]
next_hop_route_map

Configure a route-map for valid nexthops. Valid values are a string defining the name of the route-map. On IOS XR, this property is only supported in the global BGP context.

redistribute

A list of redistribute directives. Multiple redistribute entries are allowed. The list must be in the form of a nested array: the first entry of each array defines the source-protocol to redistribute from; the second entry defines a route-map name. A route-map is highly advised but may be optional on some platforms, in which case it may be omitted from the array list.

Example: Platform requiring route-maps

redistribute => [['direct',  'rm_direct'],
                 ['lisp',    'rm_lisp'],
                 ['static',  'rm_static'],
                 ['eigrp 1', 'rm_eigrp'],
                 ['isis 2',  'rm_isis'],
                 ['ospf 3',  'rm_ospf'],
                 ['rip 4',   'rm_rip']]

Example: Platform with optional route-maps

redistribute => [['direct'],
                 ['lisp',    'rm_lisp'],
                 ['static'],
                 ['eigrp 1', 'rm_eigrp'],
                 ['isis 2',  'rm_isis'],
                 ['ospf 3',  'rm_ospf'],
                 ['rip 4']]
suppress_inactive

Advertises only active routes to peers. Valid values are true, false, or 'default'. This property is not supported on IOS XR.

table_map

Apply table-map to filter routes downloaded into URIB. Valid values are a string.

table_map_filter

Filters routes rejected by the route-map and does not download them to the RIB. Valid values are true, false, or 'default'. This property is not supported on IOS XR.

--

Type: cisco_bgp_neighbor

Manages configuration of a BGP Neighbor.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.1.0
N30xx 7.0(3)I2(1) 1.1.0
N31xx 7.0(3)I2(1) 1.1.0
N56xx 7.3(0)N1(1) 1.2.0
N6k 7.3(0)N1(1) 1.2.0
N7k 7.3(0)D1(1) 1.2.0
N8k 7.0(3)F1(1) 1.3.0
IOS XR TODO TODO

Caveats

Property Caveat Description
capability_negotiation Not supported on IOS XR
dynamic_capability Not supported on IOS XR
log_neighbor_changes Not supported on N56xx, N6k, N7k, IOS XR
low_memory_exempt Not supported on IOS XR
maximum_peers Not supported on IOS XR
neighbor ip/prefix format is not supported on IOS XR
password_type Set of valid values differs between NX-OS and IOS XR
remove_private_as Not supported on IOS XR

Parameters

ensure

Determine whether the neighbor config should be present or not. Valid values are 'present' and 'absent'.

asn

BGP autonomous system number. Required. Valid values are String, Integer in ASPLAIN or ASDOT notation.

vrf

VRF name. Required. Valid values are string. The name 'default' is a valid VRF representing the global bgp.

neighbor

Neighbor Identifier. Required. Valid values are string. Neighbors may use IPv4 or IPv6 notation, with or without prefix length. Specifying ip/prefix format is not supported on IOS XR.

description

Description of the neighbor. Valid value is string.

connected_check

Configure whether or not to check for directly connected peer. Valid values are true and false.

capability_negotiation

Configure whether or not to negotiate capability with this neighbor. Valid values are true and false. This property is not supported on IOS XR.

dynamic_capability

Configure whether or not to enable dynamic capability. Valid values are true and false. This property is not supported on IOS XR.

ebgp_multihop

Specify multihop TTL for a remote peer. Valid values are integers between 2 and 255, or keyword 'default' to disable this property.

local_as

Specify the local-as number for the eBGP neighbor. Valid values are String or Integer in ASPLAIN or ASDOT notation, or 'default', which means not to configure it.

log_neighbor_changes

Specify whether or not to enable log messages for neighbor up/down event. Valid values are 'enable', to enable it, 'disable' to disable it, or 'inherit' to use the configuration in the cisco_bgp type. This property is not supported on IOS XR.

low_memory_exempt

Specify whether or not to shut down this neighbor under memory pressure. Valid values are 'true' to exempt the neighbor from being shutdown, 'false' to shut it down, or 'default' to perform the default shutdown behavior. This property is not supported on IOS XR.

maximum_peers

Specify Maximum number of peers for this neighbor prefix. Valid values are between 1 and 1000, or 'default', which does not impose the limit. This attribute can only be configured if neighbor is in 'ip/prefix' format, and is therefore not supported on IOS XR.

password

Specify the password for neighbor. Valid value is string.

password_type

Specify the encryption type the password will use. Valid values for Nexus are 'cleartext', '3des' or 'cisco_type_7' encryption, and 'default', which defaults to 'cleartext'. Valid values for IOS XR are 'cleartext', 'md5', and 'default', which also defaults to 'cleartext'.

remote_as

Specify Autonomous System Number of the neighbor. Valid values are String or Integer in ASPLAIN or ASDOT notation, or 'default', which means not to configure it. This property is required on IOS XR.

remove_private_as

Specify the config to remove private AS number from outbound updates. Valid values are 'enable' to enable this config, 'disable' to disable this config, 'all' to remove all private AS number, or 'replace-as', to replace the private AS number. This property is not supported on IOS XR.

shutdown

Configure to administratively shutdown this neighbor. Valid values are true and false.

suppress_4_byte_as

Configure to suppress 4-byte AS Capability. Valid values are 'true', 'false', and 'default', which sets to the default 'false' value.

timers_keepalive

Specify keepalive timer value. Valid values are integers between 0 and 3600 in terms of seconds, or 'default', which is 60.

timers_holdtime

Specify holdtime timer value. Valid values are integers between 0 and 3600 in terms of seconds, or 'default', which is 180.

transport_passive_mode

Specify whether BGP sessions can be established from incoming or outgoing TCP connection requests (or both). Valid values for IOS XR are 'active_only' (allow outgoing only), 'passive_only' (allow incoming only), 'both', 'clear' (clears this property) and 'default', which defaults to 'clear'. Valid values for Nexus are 'passive_only', 'both', 'clear' and 'default', which defaults to 'clear'. This property can only be configured when the neighbor is in 'ip' address format without prefix length. This property and the transport_passive_only property are mutually exclusive.

transport_passive_only

Specify whether or not to only allow passive connection setup. Valid values are 'true', 'false', and 'default', which defaults to 'false'. This property can only be configured when the neighbor is in 'ip' address format without prefix length. This property and the transport_passive_mode property are mutually exclusive.

update_source

Specify source interface of BGP session and updates. Valid value is a string of the interface name.

--

Type: cisco_bgp_neighbor_af

Manages configuration of a BGP Neighbor Address-family instance.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.1.0
N30xx 7.0(3)I2(1) 1.1.0
N31xx 7.0(3)I2(1) 1.1.0
N56xx 7.3(0)N1(1) 1.2.0
N6k 7.3(0)N1(1) 1.2.0
N7k 7.3(0)D1(1) 1.2.0
N8k 7.0(3)F1(1) 1.3.0
IOS XR TODO TODO

Caveats

Property Caveat Description
additional_paths_receive Not supported on IOS XR
additional_paths_send Not supported on IOS XR
advertise_map_exist Not supported on IOS XR
advertise_map_non_exist Not supported on IOS XR
default_originate_route_map Not supported on IOS XR
disable_peer_as_check Not supported on IOS XR
filter_list_in Not supported on IOS XR
filter_list_out Not supported on IOS XR
next_hop_third_party Not supported on IOS XR
prefix_list_in Not supported on IOS XR
prefix_list_out Not supported on IOS XR
soo Not supported on IOS XR
suppress_inactive Not supported on IOS XR
unsuppress_map Not supported on IOS XR

Parameters

ensure

Determine whether the neighbor address family config should be present or not. Valid values are 'present' and 'absent'.

asn

BGP autonomous system number. Required. Valid values are String, Integer in ASPLAIN or ASDOT notation.

vrf

VRF name. Required. Valid values are string. The name 'default' is a valid VRF representing the global bgp.

neighbor

Neighbor Identifier. Required. Valid values are string. Neighbors may use IPv4 or IPv6 notation, with or without a subnet mask.

afi

Neighbor Address Family Identifier (AFI). Required. Valid values are string. Valid neighbor AFIs are ipv4, ipv6, vpnv4, vpnv6 and l2vpn. Note that some AFI/SAFI address-families may not be supported with some neighbors; e.g. an ipv6 neighbor may not support an ipv4 multicast address-family.

safi

Neighbor Sub Address Family Identifier (SAFI). Required. Valid values are string. Valid neighbor SAFIs are unicast, multicast and evpn. Note that some AFI/SAFI address-families may not be supported with some neighbors; e.g. an ipv6 neighbor may not support an ipv4 multicast address-family.

additional_paths_receive

capability additional-paths receive. Valid values are enable for basic command enablement; disable for disabling the command at the neighbor_af level (it adds the disable keyword to the basic command); and inherit to remove the command at this level (the command value is inherited from a higher BGP layer). This property is not supported on IOS XR.

additional_paths_send

capability additional-paths send. Valid values are enable for basic command enablement; disable for disabling the command at the neighbor_af level (it adds the disable keyword to the basic command); and inherit to remove the command at this level (the command value is inherited from a higher BGP layer). This property is not supported on IOS XR.

advertise_map_exist

Conditional route advertisement. This property requires two route maps: an advertise-map and an exist-map. Valid values are an array specifying both the advertise-map name and the exist-map name, or simply 'default'; e.g. ['my_advertise_map', 'my_exist_map']. This command is mutually exclusive with the advertise_map_non_exist property. This property is not supported on IOS XR.

advertise_map_non_exist

Conditional route advertisement. This property requires two route maps: an advertise-map and a non-exist-map. Valid values are an array specifying both the advertise-map name and the non-exist-map name, or simply 'default'; e.g. ['my_advertise_map', 'my_non_exist_map']. This command is mutually exclusive with the advertise_map_exist property. This property is not supported on IOS XR.

allowas_in

allowas-in. Valid values are true, false, or an integer value, which enables the command with a specific max-occurrences value. Related: allowas_in_max.

allowas_in_max

Optional max-occurrences value for allowas_in. Valid values are an integer value or 'default'. Can be used independently or in conjunction with allowas_in.

as_override

as-override. Valid values are true, false, or 'default'.

default_originate

default-originate. Valid values are True, False, or 'default'. Related: default_originate_route_map.

default_originate_route_map

Optional route-map for the default_originate property. Can be used independently or in conjunction with default_originate. Valid values are a string defining a route-map name, or 'default'.

filter_list_in

Valid values are a string defining a filter-list name, or 'default'. This property is not supported on IOS XR.

filter_list_out

Valid values are a string defining a filter-list name, or 'default'. This property is not supported on IOS XR.

max_prefix_limit

maximum-prefix limit value. Valid values are an integer value or 'default'. Related: max_prefix_threshold, max_prefix_interval, and max_prefix_warning.

max_prefix_interval

Optional restart interval. Valid values are an integer value or 'default'. Requires max_prefix_limit.

max_prefix_threshold

Optional threshold percentage at which to generate a warning. Valid values are an integer value or 'default'. Requires max_prefix_limit.

max_prefix_warning

Optional warning-only keyword. Valid values are True, False, or 'default'. Requires max_prefix_limit.

next_hop_self

next-hop-self. Valid values are True, False, or 'default'.

next_hop_third_party

next-hop-third-party. Valid values are True, False, or 'default'. This property is not supported on IOS XR.

prefix_list_in

Valid values are a string defining a prefix-list name, or 'default'. This property is not supported on IOS XR.

prefix_list_out

Valid values are a string defining a prefix-list name, or 'default'. This property is not supported on IOS XR.

route_map_in

Valid values are a string defining a route-map name, or 'default'.

route_map_out

Valid values are a string defining a route-map name, or 'default'.

route_reflector_client

route-reflector-client. Valid values are True, False, or 'default'.

send_community

send-community attribute. Valid values are 'none', 'both', 'extended', 'standard', or 'default'.

soft_reconfiguration_in

soft-reconfiguration inbound. Valid values are enable for basic command enablement; always to add the always keyword to the basic command; and inherit to remove the command at this level (the command value is inherited from a higher BGP layer).

soo

Site-of-origin. Valid values are a string defining a VPN extcommunity or 'default'. This property is not supported on IOS XR.

suppress_inactive

suppress-inactive Valid values are True, False, or 'default'. This property is not supported on IOS XR.

unsuppress_map

unsuppress-map. Valid values are a string defining a route-map name or 'default'. This property is not supported on IOS XR.

weight

weight value. Valid values are an integer value or 'default'.

--

Type: cisco_bridge_domain

Managers a cisco Bridge-Domain

Platform OS Minimum Version Module Minimum Version
N9k unsupported unsupported
N30xx unsupported unsupported
N31xx unsupported unsupported
N56xx unsupported unsupported
N6k unsupported unsupported
N7k 7.3(0)D1(1) 1.3.0
N8k unsupported unsupported
IOS XR unsupported unsupported

Parameters

ensure

Determines whether or not the config should be present on the device. Valid values are 'present' and 'absent'.

bd

ID of the Bridge Domain. Valid values are integer.

bd_name

The bridge-domain name. Valid values are String or keyword 'default'.

shutdown

Specifies the shutdown state of the bridge-domain. Valid values are true, false, 'default'.

fabric_control

Specifies this bridge-domain as the fabric control bridge-domain. Only one bridge-domain or VLAN can be configured as fabric-control. Valid values are true, false.

--

Type: cisco_bridge_domain_vni

Creates a Virtual Network Identifier member (VNI) mapping for cisco Bridge-Domain.

Platform OS Minimum Version Module Minimum Version
N9k unsupported unsupported
N30xx unsupported unsupported
N31xx unsupported unsupported
N56xx unsupported unsupported
N6k unsupported unsupported
N7k 7.3(0)D1(1) 1.3.0
N8k unsupported unsupported
IOS XR unsupported unsupported

Parameters

ensure

Determines whether or not the config should be present on the device. Valid values are 'present' and 'absent'.

bd

The bridge-domain ID. Valid values are one or range of integers.

member_vni

The Virtual Network Identifier (VNI) id that is mapped to the VLAN. Valid values are one or range of integers

--

Type: cisco_encapsulation

Manages a Global VNI Encapsulation profile

Platform OS Minimum Version Module Minimum Version
N9k unsupported unsupported
N30xx unsupported unsupported
N31xx unsupported unsupported
N56xx unsupported unsupported
N6k unsupported unsupported
N7k 7.3(0)D1(1) 1.3.0
N8k unsupported unsupported
IOS XR unsupported unsupported

Parameters

ensure

Determines whether or not the config should be present on the device. Valid values are 'present' and 'absent'.

encap

Profile name of the Encapsulation. Valid values is string.

dot1q_map

The encapsulation profile dot1q vlan-to-vni mapping. Valid values are an array of [vlans, vnis] pairs.

--

Type: cisco_fabricpath_global

name

ID of the fabricpath global config. The only valid value is keyword 'default'.

aggregate_multicast_routes

Aggregate Multicast Routes on same tree in the topology. Valid values are true/false and keyword 'default'. Default value: false.

allocate_delay

Fabricpath Timers Allocate Delay in seconds. Valid values are integers from 1..1200 and keyword 'default'. Default value: 10.

graceful_merge

Graceful merge for conflicting switch-id or FTAG allocation. Valid values are enable/disable and keyword 'default'. Default value: true.

linkup_delay

Fabricpath Timers Link-up Delay in seconds. Valid values are integers from 1..1200 and keyword 'default'. Default value: 10.

loadbalance_algorithm

Fabricpath ECMP loadbalancing alogorithm. Valid values are 'destination', 'source', 'source-destination', 'symmetric' and the keyword 'default'. Default is symmetric for Nexus 7000 series and source-destination for others.

loadbalance_multicast_has_vlan

Multicast Loadbalance flow parameters - include vlan or not. Valid values are true or false and keyword 'default'. Default value: true. This parameter is valid only on Nexus 7000 series platform.

loadbalance_multicast_rotate

Multicast Loadbalance flow parameters - rotate amount in bytes. Valid values are integer in range 0..15 and keyword 'default'. Default value: 1. This parameter is valid only on Nexus 7000 series platform.

loadbalance_unicast_has_vlan

Unicast Loadbalance flow parameters - include vlan or not. Valid values are true/false and keyword 'default'. Default value: 1.

loadbalance_unicast_layer

Unicast Loadbalance flow parameters - layer. Valid values are : layer2, layer3, layer4, mixed, and keyword 'default'. Default value: mixed.

loadbalance_unicast_rotate

Unicast Loadbalance flow parameters - rotate amount in bytes. Valid values are Integers in range 0..15 and keyword 'default'. Default value: 1.

linkup_delay_always

Fabricpath Timers Link-up delay always. This configuration introduces a linkup delay always whether the link is administratively brought up or whether it is restored after events such as a module reload. Valid values are true/false. Default: true.

linkup_delay_enable

Fabricpath Timers Link-up delay enable. Valid values are true/false and keyword 'default'. Default value: true.

mode

Mode of operation of this switch w.r.t to segmentation. Valid values are normal/transit and keyword 'default'. Default: normal.

switch_id

The fabricpath switch_id. This parameter can be used to over-ride the automatically assigned switch-id for this switch. Valid values are integers from 1..4094.

transition_delay

Fabricpath Timers Transition Delay in seconds. Valid values are integers from 1..1200 and keyword 'default'. Default value: 10.

ttl_multicast

Fabricpath Multicast TTL value. Valid values are integers from 1..64 and keyword 'default'. Default value: 32. This parameter is valid only on Nexus 7000 series platform.

ttl_unicast

Fabricpath Unicast TTL value. Valid values are integers from 1..64 and keyword 'default'. Default value: 32. This parameter is valid only on Nexus 7000 series platform.

--

Type: cisco_fabricpath_topology

Manages a Cisco fabricpath Topology

topo_id

ID of the fabricpath topology. Valid values are integers in the range 1-63. Value of 0 is reserved for default topology.

member_vlans

ID of the VLAN(s) tha are members of this topology. Valid values are integer/integer ranges.

topo_name

Descriptive name of the topology. Valid values are string

--

Type: cisco_interface

Manages a Cisco Network Interface. Any resource dependency should be run before the interface resource.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.0.1
N30xx 7.0(3)I2(1) 1.0.1
N31xx 7.0(3)I2(1) 1.0.1
N56xx 7.3(0)N1(1) 1.2.0
N6k 7.3(0)N1(1) 1.2.0
N7k 7.3(0)D1(1) 1.2.0
N8k 7.0(3)F1(1) 1.3.0
IOS XR TODO TODO

Caveats

Property Caveat Description
access_vlan Not supported on IOS XR
duplex Not supported on IOS XR
fabric_forwarding_anycast_gateway Not supported on IOS XR
ipv4_arp_timeout Not supported on IOS XR
ipv4_forwarding Not supported on IOS XR
ipv4_pim_sparse_mode Not supported on IOS XR
negotiate_auto Not supported on IOS XR
speed Not supported on IOS XR
stp_bpdufilter Not supported on IOS XR
stp_bpduguard Not supported on IOS XR
stp_cost Not supported on IOS XR
stp_guard Not supported on IOS XR
stp_link_type Not supported on IOS XR
stp_port_priority Not supported on IOS XR
stp_port_type Not supported on IOS XR
stp_mst_cost Not supported on IOS XR
stp_mst_port_priority Not supported on IOS XR
stp_vlan_cost Not supported on IOS XR
stp_vlan_port_priority Not supported on IOS XR
svi_autostate Not supported on N56xx, N6k, IOS XR
svi_management Not supported on IOS XR
switchport Not supported on IOS XR
switchport_autostate_exclude Not supported on IOS XR
switchport_mode Not supported on IOS XR
switchport_trunk_allowed_vlan Not supported on IOS XR
switchport_trunk_native_vlan Not supported on IOS XR
switchport_vtp Not supported on IOS XR
vlan_mapping Not supported on N9k, N3k, N56xx, N6k, IOS XR
vlan_mapping_enable Not supported on IOS XR

Parameters

Basic interface config attributes
ensure

Determine whether the interface config should be present or not. Valid values are 'present' and 'absent'.

interface

Name of the interface on the network element. Valid value is a string.

description

Description of the interface. Valid values are a string or the keyword 'default'.

duplex

Duplex of the interface. Valid values are 'full', and 'auto'. This property is not supported on IOS XR.

speed

Speed of the interface. Valid values are 100, 1000, 10000, 40000, 1000000, and 'auto'. This property is not supported on IOS XR.

shutdown

Shutdown state of the interface. Valid values are 'true', 'false', and 'default'.

switchport_mode

Switchport mode of the interface. Interfaces that support switchport_mode may default to layer 2 or layer 3 depending on platform, interface type, or the system default switchport setting. An interface may be explicitly set to Layer 3 by setting switchport_mode to 'disabled'. Valid values are 'disabled', 'access', 'tunnel', 'fex_fabric', 'trunk', 'fabricpath' and 'default'. This property is not supported on IOS XR.

L2 interface config attributes
access_vlan

The VLAN ID assigned to the interface. Valid values are an integer or the keyword 'default'. This property is not supported on IOS XR.

encapsulation_dot1q

Enable IEEE 802.1Q encapsulation of traffic on a specified subinterface. Valid values are integer, keyword 'default'.

mtu

Maximum Trasnmission Unit size for frames received and sent on the specified interface. Valid value is an integer.

switchport_autostate_exclude

Exclude this port for the SVI link calculation. Valid values are 'true', 'false', and 'default'. This property is not supported on IOS XR.

switchport_trunk_allowed_vlan

The allowed VLANs for the specified Ethernet interface. Valid values are string, keyword 'default'. This property is not supported on IOS XR.

switchport_trunk_native_vlan

The Native VLAN assigned to the switch port. Valid values are integer, keyword 'default'. This property is not supported on IOS XR.

switchport_vtp

Enable or disable VTP on the interface. Valid values are 'true', 'false', and 'default'. This property is not supported on IOS XR.

negotiate_auto

Enable/Disable negotiate auto on the interface. Valid values are 'true', 'false', and 'default'. This property is not supported on IOS XR.

L3 interface config attributes
ipv4_acl_in

Applies an ipv4 access list on the interface in the ingress direction. An access-list should be present on the network device prior to this configuration. Valid values are string, keyword 'default'.

ipv4_acl_out

Applies an ipv4 access list on the interface in the egress direction. An access-list should be present on the network device prior to this configuration. Valid values are string, keyword 'default'.

ipv4_pim_sparse_mode

Enables or disables ipv4 pim sparse mode on the interface. Valid values are 'true', 'false', and 'default'. This property is not supported on IOS XR.

ipv4_proxy_arp

Enables or disables proxy arp on the interface. Valid values are 'true', 'false', and 'default'.

ipv4_address

IP address of the interface. Valid values are a string of ipv4 address or the keyword 'default'.

ipv4_netmask_length

Network mask length of the IP address on the interface. Valid values are integer and keyword 'default'.

ipv4_address_secondary

Secondary IP address of the interface. Valid values are a string of ipv4 address or the keyword 'default'.

ipv4_netmask_length_secondary

Network mask length of the secondary IP address on the interface. Valid values are integer and keyword 'default'.

ipv4_arp_timeout

Address Resolution Protocol (ARP) timeout value. Valid values are integer and keyword 'default'. Currently only supported on vlan interfaces. This property is not supported on IOS XR as IOS XR does not support vlan interfaces.

ipv4_forwarding

IP forwarding state. Valid values are string or keyword 'default'. This property is not supported on IOS XR.

ipv4_pim_sparse_mode

Enables or disables ipv4 pim sparse mode on the interface. Valid values are 'true', 'false', and 'default'.

ipv4_proxy_arp

Enables or disables proxy arp on the interface. Valid values are 'true', 'false', and 'default'.

ipv4_redirects

Enables or disables sending of IP redirect messages. Valid values are 'true', 'false', and 'default'.

ipv6_acl_in

Applies an ipv6 access list on the interface in the ingress direction. An access-list should be present on the network device prior to this configuration. Valid values are string, keyword 'default'.

ipv6_acl_out

Applies an ipv6 access list on the interface in the egress direction. An access-list should be present on the network device prior to this configuration. Valid values are string, keyword 'default'.

vlan_mapping

This property is a nested array of [original_vlan, translated_vlan] pairs. Valid values are an array specifying the mapped vlans or keyword 'default'; e.g.:

vlan_mapping => [[20, 21], [30, 31]]

This property is not supported on IOS XR.

vlan_mapping_enable

Allows disablement of vlan_mapping on a given interface. Valid values are 'true', 'false', and 'default'. This property is not supported on IOS XR.

vpc_id

Configure the vPC ID on this interface to make it a vPC link. The peer switch should configure a corresponding interface with the same vPC ID in order for the downstream device to add these links as part of the same port-channel. The vpc_id can generally be configured only on interfaces which are themselves port-channels (usually a single member port-channel). However, on the Nexus 7000 series a physical port can be configured as a vPC link. Valid values are integers in the range 1..4096. By default, interface is not configured with any vpc_id.

vpc_peer_link

Configure this port-channel interface to be a vPC peer-link. A vPC peer-link is essential to the working of the vPC complex, not only for establishing the peer connectivity for control message exchange, but also for providing redundancy when vPC links fail. Valid values are 'true' or 'false'. Default value: false.

vrf

VRF member of the interface. Valid values are a string or the keyword 'default'.

STP config attributes
stp_bpdufilter

Enable/Disable BPDU (Bridge Protocol Data Unit) filter for this interface. Valid values are enable, disable or 'default'.

stp_bpduguard

Enable/Disable BPDU (Bridge Protocol Data Unit) guard for this interface. Valid values are enable, disable or 'default'.

stp_cost

Path cost. Valid values are integer, 'auto' or 'default'.

stp_guard

Guard mode. Valid values are loop, none, root or 'default'.

stp_link_type

Link type. Valid values are auto, shared, point-to-point or 'default'.

stp_mst_cost

Mst cost. Valid values are an array of [mst_range, cost] pairs or 'default'.

stp_mst_port_priority

Mst port priority. Valid values are an array of [mst_range, port_priority] pairs or 'default'.

stp_port_priority

Port priority. Valid values are integer or 'default'.

stp_port_type

Port type. Valid values are edge, network, normal, edge_trunk or 'default'.

stp_vlan_cost

Vlan path cost. Valid values are an array of [vlan_range, cost] pairs or 'default'.

stp_vlan_port_priority

Vlan port priority. Valid values are an array of [vlan_range, port_priority] pairs or 'default'.

SVI interface config attributes
fabric_forwarding_anycast_gateway

Associate SVI with anycast gateway under VLAN configuration mode. The cisco_overlay_global anycast_gateway_mac must be set before setting this property. Valid values are 'true', 'false', and 'default'.

svi_autostate

Enable/Disable autostate on the SVI interface. Valid values are 'true', 'false', and 'default'. This property is not supported on IOS XR.

svi_management

Enable/Disable management on the SVI interface. Valid values are 'true', 'false', and 'default'. This property is not supported on IOS XR.

--

Type: cisco_interface_channel_group

Manages a Cisco Network Interface Channel-group.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR TODO TODO

Parameters

Basic interface channel-group config attributes
ensure

Determine whether the interface config should be present or not. Valid values are 'present' and 'absent'.

interface

Name of the interface where the service resides. Valid value is a string.

channel_group

channel_group is an aggregation of multiple physical interfaces that creates a logical interface. Valid values are 1 to 4096 and 'default'.

Note: On some platforms a normal side-effect of adding the channel-group property is that an independent port-channel interface will be created; however, removing the channel-group configuration by itself will not also remove the port-channel interface. Therefore, the port-channel interface itself may be explicitly removed by using the cisco_interface provider with ensure => absent.

description

Description of the interface. Valid values are a string or the keyword 'default'.

shutdown

Shutdown state of the interface. Valid values are 'true', 'false', and 'default'.

--

Type: cisco_interface_service_vni

Manages a Cisco Network Interface Service VNI.

Platform OS Minimum Version Module Minimum Version
N9k unsupported unsupported
N30xx unsupported unsupported
N31xx unsupported unsupported
N56xx unsupported unsupported
N6k unsupported unsupported
N7k 7.3(0)D1(1) 1.2.0
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

Basic interface service vni config attributes
ensure

Determine whether the interface config should be present or not. Valid values are 'present' and 'absent'.

interface

Name of the interface where the service resides. Valid value is a string.

sid

The Service ID number. Valid value is an Integer.

encapsulation_profile_vni

The VNI Encapsulation Profile Name. Valid values are String or the keyword 'default'

shutdown

Shutdown state of the interface service vni. Valid values are 'true', 'false', or 'default'.

--

Type: cisco_interface_ospf

Manages configuration of an OSPF interface instance.

Parameters

ensure

Determine whether the config should be present or not. Valid values are 'present' and 'absent'.

interface

Name of this cisco_interface resource. Valid value is a string.

ospf

Name of the cisco_ospf resource. Valid value is a string.

cost

The cost associated with this cisco_interface_ospf instance. Valid value is an integer.

hello_interval

The hello_interval associated with this cisco_interface_ospf instance. Time between sending successive hello packets. Valid values are an integer or the keyword 'default'.

dead_interval

The dead_interval associated with the cisco_interface_ospf instance. Time interval an ospf neighbor waits for a hello packet before tearing down adjacencies. Valid values are an integer or the keyword 'default'.

passive_interface

Passive interface associated with the cisco_interface_ospf instance. Setting to true will prevent this interface from receiving HELLO packets. Valid values are 'true' and 'false'.

message_digest

Enables or disables the usage of message digest authentication. Valid values are 'true' and 'false'.

message_digest_key_id

md5 authentication key-id associated with the cisco_interface_ospf instance. If this is present in the manifest, message_digest_encryption_type, message_digest_algorithm_type and message_digest_password are mandatory. Valid value is an integer.

message_digest_algorithm_type

Algorithm used for authentication among neighboring routers within an area. Valid values are 'md5' and keyword 'default'.

message_digest_encryption_type

Specifies the scheme used for encrypting message_digest_password. Valid values are 'cleartext', '3des' or 'cisco_type_7' encryption, and 'default', which defaults to 'cleartext'.

message_digest_password

Specifies the message_digest password. Valid value is a string.

area

Required. Ospf area associated with this cisco_interface_ospf instance. Valid values are a string, formatted as an IP address (i.e. "0.0.0.0") or as an integer.

--

Type: cisco_interface_portchannel

Manages configuration of a portchannel interface instance.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx 7.3(0)N1(1) 1.2.0
N6k 7.3(0)N1(1) 1.2.0
N7k 7.3(0)D1(1) 1.2.0
N8k 7.0(3)F1(1) 1.3.0
IOS XR TODO TODO

Caveats

Property Caveat Description
port_hash_distribution
port_load_defer 		Not supported on N56xx, N6k

Parameters

ensure

Determine whether the config should be present or not. Valid values are 'present' and 'absent'.

lacp_graceful_convergence

port-channel lacp graceful convergence. Valid values are true, false or 'default'.

lacp_max_bundle

port-channel max-bundle. Valid values are Integer, keyword 'default'.

lacp_min_links

port-channel min-links. Valid values are Integer, keyword 'default'.

lacp_suspend_individual

lacp port-channel state. Valid values are true and false or 'default'.

port_hash_distribution

port-channel per port hash-distribution. Valid values are 'adaptive', 'fixed' or the keyword 'default'. This property is not supported on (Nexus 5|6k)

port_load_defer

port-channel per port load-defer. Valid values are true, false or 'default'. This property is not supported on (Nexus 5|6k)

--

Type: cisco_itd_device_group

Manages configuration of ITD (Intelligent Traffic Director) device group

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I3(1) 1.3.0
N30xx unsupported unsupported
N31xx unsupported unsupported
N56xx unsupported unsupported
N6k unsupported unsupported
N7k 7.3(0)D1(1) 1.3.0
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

ensure

Determine whether the config should be present or not. Valid values are 'present' and 'absent'.

probe_control

Enable control protocol for probe. Valid values are true, false or 'default'. This is applicable only when the probe type is 'tcp' or 'udp'

probe_dns_host

Host name or target address when the probe type is 'dns'. Valid values are String.

probe_frequency

Probe frequency in seconds. Valid values are Integer, keyword 'default'.

probe_port

Probe port number when the type is 'tcp' or 'udp'. Valid values are Integer.

probe_retry_down

Probe retry count when the node goes down. Valid values are Integer, keyword 'default'.

probe_retry_up

Probe retry count when the node comes back up. Valid values are Integer, keyword 'default'.

probe_timeout

Probe timeout in seconds. Valid values are Integer, keyword 'default'.

probe_type

Probe type. Valid values are 'icmp', 'dns', 'tcp', 'udp' or keyword 'default'.

--

Type: cisco_itd_device_group_node

Manages configuration of ITD (Intelligent Traffic Director) device group node

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I3(1) 1.3.0
N30xx unsupported unsupported
N31xx unsupported unsupported
N56xx unsupported unsupported
N6k unsupported unsupported
N7k 7.3(0)D1(1) 1.3.0
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

ensure

Determine whether the config should be present or not. Valid values are 'present' and 'absent'.

hot_standby

Change mode of this node as hot-standby. Valid values are true, false or 'default'.

node_type

Type of the device group node. Valid values are ip and IPv6. It defaults to ip if not specified. IPv6 is not supported for N9k.

probe_control

Enable control protocol for probe. Valid values are true, false or 'default'. This is applicable only when the probe type is 'tcp' or 'udp'

probe_dns_host

Host name or target address when the probe type is 'dns'. Valid values are String.

probe_frequency

Probe frequency in seconds. Valid values are Integer, keyword 'default'.

probe_port

Probe port number when the type is 'tcp' or 'udp'. Valid values are Integer.

probe_retry_down

Probe retry count when the node goes down. Valid values are Integer, keyword 'default'.

probe_retry_up

Probe retry count when the node comes back up. Valid values are Integer, keyword 'default'.

probe_timeout

Probe timeout in seconds. Valid values are Integer, keyword 'default'.

probe_type

Probe type. Valid values are 'icmp', 'dns', 'tcp', 'udp' or keyword 'default'.

weight

Weight for traffic distribution. Valid values are Integer, keyword 'default'.

--

Type: cisco_itd_service

Manages configuration of ITD (Intelligent Traffic Director) service.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I3(1) 1.3.0
N30xx unsupported unsupported
N31xx unsupported unsupported
N56xx unsupported unsupported
N6k unsupported unsupported
N7k 7.3(0)D1(1) 1.3.0
N8k unsupported unsupported
IOS XR unsupported unsupported

Caveats

Property Caveat Description
nat_destination Supported only on N7k
peer_local Supported only on N9k
peer_vdc Supported only on N7k
vrf vrf cannot be removed as an attribute to the service so this is not going to be supported in this release

Parameters

ensure

Determine whether the config should be present or not. Valid values are 'present' and 'absent'.

access_list

ITD access-list name. Valid values are String or 'default'.

device_group

Device group name where this service belongs. Valid values are String or 'default'.

exclude_access_list

ITD exclude-access-list name. Valid values are String or 'default'.

fail_action

ITD failaction to reassign node. This enables traffic on failed nodes to be reassigned to the first available active node. Valid values are true, false or 'default'.

ingress_interface

Ingress interface. Valid values are an array of [interface, next-hop] pairs or 'default'.

load_bal_enable

Enable or disable load balance. Valid values are true, false or 'default'.

load_bal_buckets

Buckets for traffic distribution (in powers of 2). Valid values are Integer, or keyword 'default'.

load_bal_mask_pos

Loadbalance mask position. Valid values are Integer, keyword 'default'.

load_bal_method_bundle_select

Loadbalance bundle select. Valid values are 'src, 'dst' or keyword 'default'.

load_bal_method_bundle_hash

Loadbalance bundle hash. Valid values are 'ip, 'ip-l4port' or keyword 'default'.

load_bal_method_proto

Loadbalance protocol. This is valid only when the bundle hash is 'ip-l4port'. Valid values are 'tcp, 'udp' or keyword 'default'.

load_bal_method_start_port

Starting port in range (to match only packets in the range of port numbers). This is valid only when the bundle hash is 'ip-l4port'. Valid values are Integer, keyword 'default'.

load_bal_method_end_port

Ending port in range (to match only packets in the range of port numbers). This is valid only when the bundle hash is 'ip-l4port'. Valid values are Integer, keyword 'default'.

nat_destination

Destination NAT. Valid values are true, false or 'default'.

peer_local

Peer involved in sandwich mode. Valid values are String or 'default'.

peer_vdc

Peer involved in sandwich mode. Valid values are an array of [vdc, service] or 'default'.

shutdown

Whether or not the service is shutdown. Valid values are 'true', 'false' and keyword 'default'.

virtual_ip

Virtual ip configuration. Valid values are an array of Strings or 'default'.

--

Type: cisco_ospf

Manages configuration of an ospf instance.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.0.1
N30xx 7.0(3)I2(1) 1.0.1
N31xx 7.0(3)I2(1) 1.0.1
N56xx 7.3(0)N1(1) 1.2.0
N6k 7.3(0)N1(1) 1.2.0
N7k 7.3(0)D1(1) 1.2.0
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

ensure

Determine if the config should be present or not. Valid values are 'present', and 'absent'.

ospf

Name of the ospf router. Valid value is a string.

--

Type: cisco_ospf_vrf

Manages a VRF for an OSPF router.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.0.1
N30xx 7.0(3)I2(1) 1.0.1
N31xx 7.0(3)I2(1) 1.0.1
N56xx 7.3(0)N1(1) 1.2.0
N6k 7.3(0)N1(1) 1.2.0
N7k 7.3(0)D1(1) 1.2.0
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

ensure

Determines whether the config should be present or not on the device. Valid values are 'present' and 'absent'.

vrf

Name of the resource instance. Valid value is a string. The name 'default' is a valid VRF representing the global ospf.

ospf

Name of the ospf instance. Valid value is a string.

router_id

Router Identifier (ID) of the OSPF router VRF instance. Valid values are a string or the keyword 'default'.

default_metric

Specify the default Metric value. Valid values are an integer or the keyword 'default'.

log_adjacency

Controls the level of log messages generated whenever a neighbor changes state. Valid values are 'log', 'detail', 'none', and 'default'.

timer_throttle_lsa_start

Specify the start interval for rate-limiting Link-State Advertisement (LSA) generation. Valid values are an integer, in milliseconds, or the keyword 'default'.

timer_throttle_lsa_hold

Specifies the hold interval for rate-limiting Link-State Advertisement (LSA) generation. Valid values are an integer, in milliseconds, or the keyword 'default'.

timer_throttle_lsa_max

Specifies the max interval for rate-limiting Link-State Advertisement (LSA) generation. Valid values are an integer, in milliseconds, or the keyword 'default'.

timer_throttle_spf_start

Specify initial Shortest Path First (SPF) schedule delay. Valid values are an integer, in milliseconds, or the keyword 'default'.

timer_throttle_spf_hold

Specify minimum hold time between Shortest Path First (SPF) calculations. Valid values are an integer, in milliseconds, or the keyword 'default'.

timer_throttle_spf_max

Specify the maximum wait time between Shortest Path First (SPF) calculations. Valid values are an integer, in milliseconds, or the keyword 'default'.

auto_cost

Specifies the reference bandwidth used to assign OSPF cost. Valid values are an integer, in Mbps, or the keyword 'default'.

--

Type: cisco_overlay_global

Handles the detection of duplicate IP or MAC addresses based on the number of moves in a given time-interval (seconds). Also configures anycast gateway MAC of the switch.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx unsupported unsupported
N31xx unsupported unsupported
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

name

Instance of cisco_overlay_global, only allow the value 'default'

anycast_gateway_mac

Anycast gateway mac of the switch

dup_host_ip_addr_detection_host_moves

The number of host moves allowed in n seconds. The range is 1 to 1000 moves; default is 5 moves.

dup_host_ip_addr_detection_timeout

The duplicate detection timeout in seconds for the number of host moves. The range is 2 to 36000 seconds; default is 180 seconds.

dup_host_mac_detection_host_moves

The number of host moves allowed in n seconds. The range is 1 to 1000 moves; default is 5 moves.

dup_host_mac_detection_timeout

The duplicate detection timeout in seconds for the number of host moves. The range is 2 to 36000 seconds; default is 180 seconds.

--

Type: cisco_pim

Manages configuration of an Protocol Independent Multicast (PIM) instance.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx 7.3(0)N1(1) 1.2.0
N6k 7.3(0)N1(1) 1.2.0
N7k 7.3(0)D1(1) 1.2.0
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

afi

Address Family Identifier (AFI). Required. Valid value is ipv4.

vrf

Name of the resource instance. Required. Valid values are string. The name 'default' is a valid VRF representing the global vrf.

ssm_range

Configure group ranges for Source Specific Multicast (SSM). Valid values are multicast addresses or the keyword ‘none’.

--

Type: cisco_pim_grouplist

Manages configuration of an Protocol Independent Multicast (PIM) static route processor (RP) address for a multicast group range.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx 7.3(0)N1(1) 1.2.0
N6k 7.3(0)N1(1) 1.2.0
N7k 7.3(0)D1(1) 1.2.0
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

afi

Address Family Identifier (AFI). Required. Valid values are ipv4 and ipv6.

vrf

Name of the resource instance. Required. Valid values are string. The name 'default' is a valid VRF representing the global vrf.

rp_addr

IP address of a router which is the route processor (RP) for a group range.. Required. Valid values are unicast addresses.

group

Specifies a group range for a static route processor (RP) address. Required. Valid values are multicast addresses.

--

Type: cisco_pim_rp_address

Manages configuration of an Protocol Independent Multicast (PIM) static route processor (RP) address instance.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx 7.3(0)N1(1) 1.2.0
N6k 7.3(0)N1(1) 1.2.0
N7k 7.3(0)D1(1) 1.2.0
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

afi

Address Family Identifier (AFI). Required. Valid values are ipv4 and ipv6.

vrf

Name of the resource instance. Required. Valid values are string. The name 'default' is a valid VRF representing the global vrf.

rp_addr

Configures a Protocol Independent Multicast (PIM) static route processor (RP) address. Required. Valid values are unicast addresses.

--

Type: cisco_portchannel_global

Manages configuration of a portchannel global parameters

Platform OS Minimum Version Module Minimum Version
N9k unsupported unsupported
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Caveats

Property Caveat Description
hash_poly Supported only on N56xx, N6k
asymmetric
hash_distribution
load_defer		 Supported only on N7k
concatenation
resilient
symmetry		 Supported only on N9k, N30xx, N31xx
rotate Supported only on N9k, N30xx, N31xx and N7k

Parameters

asymmetric

port-channel asymmetric hash. Valid values are true, false or 'default'. This property is supported only on N7k.

bundle_hash

port-channel bundle hash. Valid values are 'ip', 'ip-l4port', 'ip-l4port-vlan', 'ip-vlan', 'l4port', 'mac', 'port', 'ip-only', 'port-only', 'ip-gre' or 'default'.

  • 'port', 'ip-only', 'port-only', 'ip-gre' are only supported on N9k, N30xx, N31xx, N56xx, N6k.
  • 'ip-l4port', 'ip-l4port-vlan', 'ip-vlan', 'l4port', 'ip-gre' are only supported on N9k, N30xx, N31xx, N7k.
  • 'port', 'ip-only', 'port-only' are only supported on N56xx, N6k, N7k.
bundle_select

port-channel bundle select. Valid values are 'src', 'dst', 'src-dst' or 'default'.

concatenation

port-channel concatenation enable or disable. Valid values are true, false or 'default'. This property is only supported on N9k, N30xx, N31xx.

hash_distribution

port-channel hash-distribution. Valid values are 'adaptive', 'fixed' or the keyword 'default'. This property is only supported on N7k.

hash_poly

port-channel hash-polynomial. Valid values are 'CRC10a', 'CRC10b', 'CRC10c' or 'CRC10d'. Note: This property does not support the keyword 'default' and it is only supported on N56xx and N6k.

load_defer

port-channel load-defer time interval. Valid values are integer or 'default'. This property is only supported on N7k.

resilient

port-channel resilient mode. Valid values are true, false or 'default'. This property is only supported on N9k, N30xx, N31xx.

rotate

port-channel hash input offset. Valid values are integer or 'default'. This property is only supported on N9k, N30xx, N31xx, N7k.

symmetry

port-channel symmetry hash. Valid values are true, false or 'default'. This property is only supported on N9k, N30xx, N31xx.

--

Type: cisco_stp_global

Manages spanning tree global parameters

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.3.0
N30xx 7.0(3)I2(1) 1.3.0
N31xx 7.0(3)I2(1) 1.3.0
N56xx 7.3(0)N1(1) 1.3.0
N6k 7.3(0)N1(1) 1.3.0
N7k 7.3(0)D1(1) 1.3.0
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Caveats

Property Caveat Description
bd_designated_priority Supported only on N7k
bd_forward_time Supported only on N7k
bd_hello_time Supported only on N7k
bd_max_age Supported only on N7k
bd_priority Supported only on N7k
bd_root_priority Supported only on N7k
domain Supported only on N56k, N6k, N7k
fcoe Supported only on N9k, N30xx, N31xx

Parameters

bd_designated_priority

Designated bridge priority. Valid values are an array of [bd_range, designated_priority] pairs or 'default'.

bd_forward_time

Forward delay. Valid values are an array of [bd_range, forward_time] pairs or 'default'.

bd_hello_time

Hello interval. Valid values are an array of [bd_range, hello_time] pairs or 'default'.

bd_max_age

Max age interval. Valid values are an array of [bd_range, max_age] pairs or 'default'.

bd_priority

Bridge priority. Valid values are an array of [bd_range, priority] pairs or 'default'.

bd_root_priority

Root bridge priority. Valid values are an array of [bd_range, root_priority] pairs or 'default'.

bpdufilter

Edge port (portfast) bpdu filter. Valid values are true, false or 'default'.

bpduguard

Edge port (portfast) bpdu guard. Valid values are true, false or 'default'.

bridge_assurance

Bridge Assurance on all network ports. Valid values are true, false or 'default'.

domain

Domain. Valid values are integer or 'default'.

fcoe

Spanning tree protocol for FCoE VLAN. Valid values are true, false or 'default'.

loopguard

Enable loopguard by default on all ports. Valid values are true, false or 'default'.

mode

Operating mode. Valid values are mst, rapid-pvst or 'default'.

mst_designated_priority

Designated priority for multiple spanning tree configuration. Valid values are an array of [mst_range, designated_priority] pairs or 'default'

mst_hello_time

Hello interval for multiple spanning tree configuration. Valid values are integer or 'default'.

mst_inst_vlan_map

Map vlans to an MST instance. Valid values are an array of [mst_instance, vlan_range] pairs or 'default'

mst_max_age

Max age interval for multiple spanning tree configuration. Valid values are integer or 'default'.

mst_max_hops

Max hops for multiple spanning tree configuration. Valid values are integer or 'default'

mst_name

Name for multiple spanning tree configuration. Valid values are String or 'default'

mst_priority

Priority for multiple spanning tree configuration. Valid values are an array of [mst_range, priority] pairs or 'default'

mst_revision

Configuration revision number for multiple spanning tree configuration. Valid values are String or 'default'

mst_root_priority

Root priority for multiple spanning tree configuration. Valid values are an array of [mst_range, root_priority] pairs or 'default'

pathcost

Pathcost option. Valid values are long, short or 'default'.

vlan_designated_priority

Designated priority for vlan. Valid values are an array of [vlan_range, designated_priority] pairs or 'default'

vlan_forward_time

Forward delay for vlan. Valid values are an array of [vlan_range, forward_time] pairs or 'default'

vlan_hello_time

Hello interval for vlan. Valid values are an array of [vlan_range, hello_time] pairs or 'default'

vlan_max_age

Max age interval for vlan. Valid values are an array of [vlan_range, max_age] pairs or 'default'

vlan_priority

Priority for vlan. Valid values are an array of [vlan_range, priority] pairs or 'default'

vlan_root_priority

Root priority for vlan. Valid values are an array of [vlan_range, root_priority] pairs or 'default'

--

Type: cisco_snmp_community

Manages an SNMP community on a Cisco SNMP server.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.0.1
N30xx 7.0(3)I2(1) 1.0.1
N31xx 7.0(3)I2(1) 1.0.1
N56xx 7.3(0)N1(1) 1.2.0
N6k 7.3(0)N1(1) 1.2.0
N7k 7.3(0)D1(1) 1.2.0
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

ensure

Determine whether the config should be present or not on the device. Valid values are 'present' and 'absent'.

community

Name of the SNMP community. Valid value is a string.

group

Group that the SNMP community belongs to. Valid values are a string or the keyword 'default'.

acl

Assigns an Access Control List (ACL) to an SNMP community to filter SNMP requests. Valid values are a string or the keyword 'default'.

--

Type: cisco_snmp_group

Manages a Cisco SNMP Group on a Cisco SNMP Server.

The term 'group' is a standard SNMP term, but in NXOS role it serves the purpose of group; thus this provider utility does not create snmp groups and only reports group (role) existence.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.0.1
N30xx 7.0(3)I2(1) 1.0.1
N31xx 7.0(3)I2(1) 1.0.1
N56xx 7.3(0)N1(1) 1.2.0
N6k 7.3(0)N1(1) 1.2.0
N7k 7.3(0)D1(1) 1.2.0
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

ensure

Determines whether the config should be present on the device or not. Valid values are 'present', and 'absent'.

group

Name of the snmp group. Valid value is a string.

--

Type: cisco_snmp_server

Manages a Cisco SNMP Server. There can only be one instance of the cisco_snmp_server.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.0.1
N30xx 7.0(3)I2(1) 1.0.1
N31xx 7.0(3)I2(1) 1.0.1
N56xx 7.3(0)N1(1) 1.2.0
N6k 7.3(0)N1(1) 1.2.0
N7k 7.3(0)D1(1) 1.2.0
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

name

The name of the SNMP Server instance. Only 'default' is accepted as a valid name.

location

SNMP location (sysLocation). Valid values are a string or the keyword 'default'.

contact

SNMP system contact (sysContact). Valid values are a string or the keyword 'default'.

aaa_user_cache_timeout

Configures how long the AAA synchronized user configuration stays in the local cache. Valid values are an integer or the keyword 'default'.

packet_size

Size of SNMP packet. Valid values are an integer, in bytes, or the keyword 'default'.

global_enforce_priv

Enable/disable SNMP message encryption for all users. Valid values are 'true', 'false', and 'default'.

protocol

Enable/disable SNMP protocol. Valid values are 'true', 'false', and 'default'.

tcp_session_auth

Enable/disable a one time authentication for SNMP over TCP session. Valid values are 'true', 'false', and 'default'.

--

Type: cisco_snmp_user

Manages an SNMP user on an cisco SNMP server.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.0.1
N30xx 7.0(3)I2(1) 1.0.1
N31xx 7.0(3)I2(1) 1.0.1
N56xx 7.3(0)N1(1) 1.2.0
N6k 7.3(0)N1(1) 1.2.0
N7k 7.3(0)D1(1) 1.2.0
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

ensure

Determines whether the config should be present or not on the device. Valid values are 'present', and 'absent'.

user

Name of the SNMP user. Valid value is a string.

engine_id

Engine ID of the SNMP user. Valid values are empty string or 5 to 32 octets seprated by colon.

groups

Groups that the SNMP user belongs to. Valid value is a string.

auth_protocol

Authentication protocol for the SNMP user. Valid values are 'md5', 'sha', and 'none'.

auth_password

Authentication password for the SNMP user. Valid value is string.

priv_protocol

Privacy protocol for the SNMP user. Valid values are 'aes128', 'des', and 'none'.

priv_password

Privacy password for SNMP user. Valid value is a string.

localized_key

Specifies whether the passwords specified in manifest are in localized key format (in case of true) or cleartext (in case of false). Valid values are 'true', and 'false'.

--

Type: cisco_tacacs_server

Manages a Cisco TACACS+ Server global configuration. There can only be one instance of the cisco_tacacs_server.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.0.1
N30xx 7.0(3)I2(1) 1.0.1
N31xx 7.0(3)I2(1) 1.0.1
N56xx 7.3(0)N1(1) 1.2.0
N6k 7.3(0)N1(1) 1.2.0
N7k 7.3(0)D1(1) 1.2.0
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

name

Instance of the tacacs_server, only allows the value 'default'.

timeout

Global timeout interval for TACACS+ servers. Valid value is an integer, in seconds, or the keyword 'default'.

directed_request

Allows users to specify a TACACS+ server to send the authentication request when logging in. Valid values are 'true', and 'false'.

deadtime

Specifies the global deadtime interval for TACACS+ servers. Valid values are Integer, in minutes, and keyword 'default'.

encryption_type

Specifies the global preshared key type for TACACS+ servers. Valid values are 'clear', 'encrypted', 'none', and 'default'.

encryption_password

Specifies the global TACACS+ servers preshared key password. Valid values are string, and keyword 'default'.

source_interface

Global source interface for all TACACS+ server groups configured on the device. Valid values are string, and keyword 'default'.

--

Type: cisco_tacacs_server_host

Configures Cisco TACACS+ server hosts.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.0.1
N30xx 7.0(3)I2(1) 1.0.1
N31xx 7.0(3)I2(1) 1.0.1
N56xx 7.3(0)N1(1) 1.2.0
N6k 7.3(0)N1(1) 1.2.0
N7k 7.3(0)D1(1) 1.2.0
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

ensure

Determines whether or not the config should be present on the device. Valid values are 'present' and 'absent'.

host

Name of the tacacs_server_host instance. Valid value is a string.

port

Server port for the host. Valid values are an integer or the keyword 'default'.

timeout

Timeout interval for the host. Valid values are an integer, in seconds, or the keyword 'default'.

encryption_type

Specifies a preshared key for the host. Valid values are 'clear', 'encrypted', 'none', and keyword 'default'.

encryption_password

"Specifies the preshared key password for the host. Valid value is a string.

--

Type: cisco_vdc

Manages a Cisco VDC (Virtual Device Context).

Platform OS Minimum Version Module Minimum Version
N9k unsupported unsupported
N30xx unsupported unsupported
N31xx unsupported unsupported
N56xx unsupported unsupported
N6k unsupported unsupported
N7k 7.3(0)D1(1) 1.2.0
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

name

Name of the VDC. Valid value is a String or optional keyword 'default' when referencing the default VDC. The current implementation restricts changes to the default VDC.

ensure

Determines whether the config should be present or not. Valid values are 'present' and 'absent'.

limit_resource_module_type

This command restricts the allowed module-types in a given VDC. Valid values are String or keyword 'default'.

--

Type: cisco_vlan

Manages a Cisco VLAN.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.0.1
N30xx 7.0(3)I2(1) 1.0.1
N31xx 7.0(3)I2(1) 1.0.1
N56xx 7.3(0)N1(1) 1.2.0
N6k 7.3(0)N1(1) 1.2.0
N7k 7.3(0)D1(1) 1.2.0
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Caveats

Property Caveat Description
mode Not supported on N9k, N30xx, N31xx

Parameters

vlan

ID of the Virtual LAN. Valid value is an integer.

ensure

Determines whether the config should be present or not. Valid values are 'present' and 'absent'.

mapped_vni

The Virtual Network Identifier (VNI) id that is mapped to the VLAN. Valid values are integer and keyword 'default'.

mode

Determines mode of the VLAN. Valid values are 'CE', 'fabricpath' and keyword 'default'.

vlan_name

The name of the VLAN. Valid values are a string or the keyword 'default'.

state

State of the VLAN. Valid values are 'active', 'suspend', and keyword 'default'.

shutdown

Whether or not the vlan is shutdown. Valid values are 'true', 'false' and keyword 'default'.

--

Type: cisco_vpc_domain

Manages the virtual Port Channel (vPC) domain configuration of a Cisco device.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx 7.3(0)N1(1) 1.2.0
N6k 7.3(0)N1(1) 1.2.0
N7k 7.3(0)D1(1) 1.2.0
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Caveats

Property Caveat Description
auto_recovery Not supported on N56xx, N6k
fabricpath_emulated_switch_id Not supported on N31xx, N9k, N56xx, N6k
fabricpath_multicast_load_balance Not supported on N31xx, N9k, N56xx, N6k
layer3_peer_routing Not supported on N9k, N30xx, N31xx, N56xx
peer_gateway_exclude_vlan Not supported on N9k, N30xx, N31xx
port_channel_limit Not supported on N31xx, N9k, N56xx, N6k
self_isolation Not supported on N9k, N56xx, N6k
shutdown Not supported on N9k, N30xx, N31xx

Parameters

ensure

Determines whether or not the config should be present on the device. Valid values are 'present' and 'absent'.

domain

vPC domain ID. Valid values are integer in the range 1-1000. There is no default value, this is a 'name' parameter.

auto_recovery

Auto Recovery enable or disable if peer is non-operational. Valid values are true, false or default. This parameter is available only on Nexus 7000 series. Default value: true.

auto_recovery_reload_delay

Delay (in secs) before peer is assumed dead before attempting to recover vPCs. Valid values are integers in the range 240..3600. Default value: 240.

delay_restore

Delay (in secs) after peer link is restored to bring up vPCs. Valid values are integers in the range 1..3600. Default vlaue: 30.

delay_restore_interface_vlan

Delay (in secs) after peer link is restored to bring up Interface VLANs or Interface BDs. Valid values are integers in the range 1..3600. Default value: 10.

dual_active_exclude_interface_vlan_bridge_domain

Interface VLANs or BDs to exclude from suspension when dual-active. Valid value is a string of integer ranges from 1..4095. There is no default value.

fabricpath_emulated_switch_id

Configure a fabricpath switch_Id to enable vPC+ mode. This is also known as the Emulated switch-id. Valid values are integers in the range 1..4095. There is no default value.

fabricpath_multicast_load_balance

In vPC+ mode, enable or disable the fabricpath multicast load balance. This loadbalances the Designated Forwarder selection for multicast traffic. Valid values are true, false or default

graceful_consistency_check

Graceful conistency check . Valid values are true, false or default. Default value: true.

layer3_peer_routing

Enable or Disable Layer3 peer routing. Valid values are true/false or default. Default value: false.

peer_keepalive_dest

Destination IPV4 address of the peer where Peer Keep-alives are terminated. Valid values are IPV4 unicast address. There is no default value.

peer_keepalive_hold_timeout

Peer keep-alive hold timeout in secs. Valid Values are integers in the range 3..10. Default value: 3.

peer_keepalive_interval

Peer keep-alive interval in millisecs. Valid Values are integers in the range 400..10000. Default value: 1000.

peer_keepalive_interval_timeout

Peer keep-alive interval timeout. Valid Values are integers in the range 3..20. Default value: 5.

peer_keepalive_precedence

Peer keep-alive precedence. Valid Values are integers in the range 0..7. Default value: 6.

peer_keepalive_src

Source IPV4 address of this switch where Peer Keep-alives are Sourced. Valid values are IPV4 unicast address. There is no default value.

peer_keepalive_udp_port

Peer keep-alive udp port used for hellos. Valid Values are integers in the range 1024..65000. Default value: 3200.

peer_keepalive_vrf

Peer keep-alive VRF. Valid Values are string. There is no default value.

peer_gateway

Enable or Disable Layer3 forwarding for packets with peer gateway-mac. Valid values are true/false or default. Default: false.

peer_gateway_exclude_vlan

Interface vlans to exclude from peer gateway functionality. Valid value is a string of integer ranges from 1..4095. This parameter is available only in Nexus 5000, Nexus 6000 and Nexus 7000 series. There is no default value.

port_channel_limit

In vPC+ mode, enable or disable the port channel scale limit of 244 vPCs. Valid values are true, false or default

role_priority

Priority to be used during vPC role selection of primary vs secondary. Valid values are integers in the range 1..65535. Default value: 32667.

self_isolation

Enable or Disable self-isolation function for vPC. Valid values are true, false or default. This parameter is available only in Nexus 7000 series. Default value: false.

shutdown

Whether or not the vPC domain is shutdown. This property is not avialable on Nexus 9000 and Nexus 3000 series. Default value: false.

system_mac

vPC system mac. Valid values are in mac addresses format. There is no default value.

system_priority

vPC system priority. Valid values are integers in the range 1..65535. Default value: 32667.

--

Type: cisco_vrf

Manages Cisco Virtual Routing and Forwarding (VRF) configuration of a Cisco device.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR TODO TODO

Caveats

Property Caveat Description
mhost_ipv4_default_interface Only supported on IOS XR
mhost_ipv6_default_interface Only supported on IOS XR
remote_route_filtering Only supported on IOS XR
route_distinguisher Only supported on N3k and N9k
shutdown Only supported on N3k and N9k
vni Only supported on N9k
vpn_id Only supported on IOS XR

Parameters

ensure

Determines whether or not the config should be present on the device. Valid values are 'present' and 'absent'. Default value is 'present'.

name

Name of the VRF. Valid value is a string of non-whitespace characters. It is not case-sensitive and overrides the title of the type.

description

Description of the VRF. Valid value is string.

mhost_ipv4_default_interface

Specify multicast ipv4 host default interface. Valid value will be a valid interface or the keyword 'default'.

mhost_ipv6_default_interface

Specify multicast ipv6 host default interface. Valid value will be a valid interface or the keyword 'default'.

remote_route_filtering

Enable/disable remote route filtering. Valid value will be true, false or the keyword 'default'.

route_distinguisher

VPN Route Distinguisher (RD). The RD is combined with the IPv4 or IPv6 prefix learned by the PE router to create a globally unique address. Valid values are a String in one of the route-distinguisher formats (ASN2:NN, ASN4:NN, or IPV4:NN); the keyword 'auto', or the keyword 'default'.

Please note: The route_distinguisher property is typically configured within the VRF context configuration on most platforms (including NXOS) but it is tightly coupled to bgp and therefore configured within the BGP configuration on some platforms (XR for example). For this reason the route_distinguisher property has support (with limitations) in both cisco_vrf and cisco_bgp providers:

  • cisco_bgp: The property is fully supported on both NXOS and XR. See: cisco_bgp: route_distinguisher
  • cisco_vrf: The property is only supported on NXOS.

IMPORTANT: Choose only one provider to configure the route_distinguisher property on a given device. Using both providers simultaneously on the same device may have unpredictable results.

shutdown

Shutdown state of the VRF. Valid values are 'true', 'false', and 'default'.

vni

Specify virtual network identifier. Valid values are Integer or keyword 'default'.

vpn_id

Specify vpn_id. Valid values are <0-ffffff>:<0-ffffffff> or keyword 'default'.

--

Type: cisco_vrf_af

Manages Cisco Virtual Routing and Forwarding (VRF) Address-Family configuration.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx 7.3(0)N1(1) 1.2.0
N6k 7.3(0)N1(1) 1.2.0
N7k 7.3(0)D1(1) 1.2.0
N8k 7.0(3)F1(1) 1.3.0
IOS XR TODO TODO

Caveats

Property Caveat Description
route_target_both_auto Only supported on nexus
route_target_both_auto_evpn Only supported on nexus
route_target_export_evpn Only supported on nexus
route_target_export_stitching Only supported on IOS XR
route_target_import_evpn Only supported on nexus
route_target_import_stitching Only supported on IOS XR

Parameters

ensure

Determines whether or not the config should be present on the device. Valid values are 'present' and 'absent'. Default value is 'present'.

name

Name of the VRF. Required. Valid value is a string of non-whitespace characters. It is not case-sensitive and overrides the title of the type.

afi

Address-Family Identifier (AFI). Required. Valid values are 'ipv4' or 'ipv6'.

safi

Sub Address-Family Identifier (SAFI). Required. Valid values are unicast or multicast. multicast is not supported on some platforms.

route policy export

Set route-policy(IOS XR) or map(nexus) export name. Valid value is string or keyword 'default'.

route policy import

Set route-policy(IOS XR) or map(nexus) import name. Valid value is string or keyword 'default'.

route target both auto

Enable/Disable the route-target 'auto' setting for both import and export target communities. Valid values are true, false, or 'default'.

route target both auto evpn

(EVPN only) Enable/Disable the EVPN route-target 'auto' setting for both import and export target communities. Valid values are true, false, or 'default'.

route_target_import

Sets the route-target import extended communities. Valid values are an Array or space-separated String of extended communities, or the keyword 'default'.

route_target Examples:

route_target_import => ['1.2.3.4:5', '33:55']
route_target_export => '4:4 66:66'
route_target_export_evpn => '5:5'
route_target_import_evpn

(EVPN only) Sets the route-target import extended communities for EVPN. Valid values are an Array or space-separated String of extended communities, or the keyword 'default'.

route_target_import_stitching

(Stitching only) Sets the route-target import extended communities for stitching. Valid values are an Array or space-separated String of extended communities, or the keyword 'default'.

route_target_export

Sets the route-target export extended communities. Valid values are an Array or space-separated String of extended communities, or the keyword 'default'.

route_target_export_evpn

(EVPN only) Sets the route-target export extended communities for EVPN. Valid values are an Array or space-separated String of extended communities, or the keyword 'default'.

route_target_export_stitching

(Stitching only) Sets the route-target export extended communities for stitching. Valid values are an Array or space-separated String of extended communities, or the keyword 'default'.

--

Type: cisco_vtp

Manages the VTP (VLAN Trunking Protocol) configuration of a Cisco device. There can only be one instance of the cisco_vtp.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.0.1
N30xx 7.0(3)I2(1) 1.0.1
N31xx 7.0(3)I2(1) 1.0.1
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

ensure

Determines whether or not the config should be present on the device. Valid values are 'present' and 'absent'.

name

Instance of vtp, only allow the value 'default'

domain

Required. VTP administrative domain. Valid value is a string.

version

Version for the VTP domain. Valid values are an integer or the keyword 'default'.

file_name

VTP file name. Valid values are a string or the keyword 'default'.

password

Password for the VTP domain. Valid values are a string or the keyword 'default'.

--

Type: cisco_vxlan_vtep

Creates a VXLAN Network Virtualization Endpoint (NVE) overlay interface that terminates VXLAN tunnels.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx unsupported unsupported
N31xx unsupported unsupported
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

ensure

Determines whether or not the config should be present on the device. Valid values are 'present' and 'absent'.

description

Description of the NVE interface. Valid values are string, or keyword 'default'.

host_reachability

Specify mechanism for host reachability advertisement. Valid values are 'evpn', 'flood' or keyword 'default'.

shutdown

Administratively shutdown the NVE interface. Valid values are true, false or keyword 'default'.

source_interface

Specify the loopback interface whose IP address should be used for the NVE interface. Valid values are string or keyword 'default'.

source_interface_hold_down_time

Suppresses advertisement of the NVE loopback address until the overlay has converged. Valid values are Integer or keyword 'default'.

--

Type: cisco_vxlan_vtep_vni

Creates a Virtual Network Identifier member (VNI) for an NVE overlay interface.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx unsupported unsupported
N31xx unsupported unsupported
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

ensure

Determines whether or not the config should be present on the device. Valid values are 'present' and 'absent'.

interface

Name of the nve interface on the network element. Valid values are string.

vni

ID of the Virtual Network Identifier. Valid values are integer.

assoc_vrf

This attribute is used to identify and separate processing VNIs that are associated with a VRF and used for routing. The VRF and VNI specified with this command must match the configuration of the VNI under the VRF. Valid values are true or false.

ingress_replication

Specifies mechanism for host reachability advertisement. Valid values are 'bgp', 'static', or 'default'.

multicast_group

The multicast group (range) of the VNI. Valid values are string and keyword 'default'.

peer_list

Set the ingress-replication static peer list. Valid values are an Array, a space-separated String of ip addresses, or the keyword 'default'.

suppress_arp

Suppress arp under layer 2 VNI. Valid values are true, false, or 'default'.

--

NetDev StdLib Resource Type Details

The following resources are listed alphabetically.

--

Type: domain_name

Configure the domain name of the device

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.1.0
N30xx 7.0(3)I2(1) 1.1.0
N31xx 7.0(3)I2(1) 1.1.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR TODO TODO

Parameters

ensure

Determines whether or not the config should be present on the device. Valid values are 'present' and 'absent'.

name

Domain name of the device. Valid value is a string.

--

Type: name_server

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR TODO TODO

Parameters

ensure

Determines whether or not the config should be present on the device. Valid values are 'present' and 'absent'.

name

Hostname or address of the DNS server. Valid value is a string.

--

Type: network_dns

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.1.0
N30xx 7.0(3)I2(1) 1.1.0
N31xx 7.0(3)I2(1) 1.1.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR TODO TODO

Parameters

ensure

Determines whether or not the config should be present on the device. Valid values are 'present' and 'absent'.

name

Name, generally "settings", not used to manage the resource. Valid value is a string.

domain

Default domain name to append to the device hostname. Valid value is a string.

search

Array of DNS suffixes to search for FQDN entries. Valid value is an array of strings.

servers

Array of DNS servers to use for name resolution. Valid value is an array of strings.

--

Type: network_interface

Manages a puppet netdev_stdlib Network Interface. Any resource dependency should be run before the interface resource.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

name

Name of the interface on the network element. Valid value is a string.

description

Description of the interface. Valid values are a string or the keyword 'default'.

duplex

Duplex of the interface. Valid values are 'full', and 'auto'.

speed

Speed of the interface. Valid values are 100m, 1g, 10g, 40g, 100g, and 'auto'.

mtu

Maximum Trasnmission Unit size for frames received and sent on the specified interface. Valid value is an integer.

--

Type: network_snmp

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.1.0
N30xx 7.0(3)I2(1) 1.1.0
N31xx 7.0(3)I2(1) 1.1.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

name

Name of the Puppet resource, not used to manage the device. Valid value is a string.

enable

Enable or disable SNMP functionality. Valid values are 'true' or 'false'.

contact

Contact name for this device. Valid value is a string.

location

Location of this device. Valid value is a string.

--

Type: network_trunk

Manages a puppet netdev_stdlib Network Trunk. It should be noted that while the NetDev stdlib has certain specified accepted parameters these may not be applicable to different network devices. For example, certain Cisco devices only use dot1q encapsulation, and therefore other values will cause errors.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

name

The switch interface name. Valid value is a string.

encapsulation

The vlan-tagging encapsulation protocol, usually dot1q. Valid values are 'dot1q', 'isl', 'negotiate' and 'none'. Cisco devices use dot1q encapsulation.

mode

The L2 interface mode, enables or disables trunking. Valid values are 'access', 'trunk', 'dynamic_auto', and 'dynamic_desirable'. The mode on a Cisco device will always be 'trunk'.

untagged_vlan

VLAN used for untagged VLAN traffic. a.k.a Native VLAN. Values must be in range of 1 to 4095.

tagged_vlans

Array of VLAN names used for tagged packets. Values must be in range of 1 to 4095.

pruned_vlans

Array of VLAN ID numbers used for VLAN pruning. Values must be in range of 1 to 4095. Cisco do not implement the concept of pruned vlans.

--

Type: ntp_config

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.1.0
N30xx 7.0(3)I2(1) 1.1.0
N31xx 7.0(3)I2(1) 1.1.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR TODO TODO

Parameters

name

Resource name, not used to configure the device. Valid value is a string.

source_interface

Source interface for the NTP server. Valid value is a string.

--

Type: ntp_server

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.1.0
N30xx 7.0(3)I2(1) 1.1.0
N31xx 7.0(3)I2(1) 1.1.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR TODO TODO

Parameters

ensure

Determines whether or not the config should be present on the device. Valid values are 'present' and 'absent'.

name

Hostname or IPv4/IPv6 address of the NTP server. Valid value is a string.

--

Type: port_channel

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

ensure

Determines whether or not the config should be present on the device. Valid values are 'present' and 'absent'.

id

Channel group ID. eg 100. Valid value is an integer.

interfaces

Array of Physical Interfaces that are part of the port channel. An array of valid interface names.

minimum_links

Number of active links required for port channel to be up. Valid value is an integer.

name

Name of the port channel. eg port-channel100. Valid value is a string.

--

Type: radius

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.1.0
N30xx 7.0(3)I2(1) 1.1.0
N31xx 7.0(3)I2(1) 1.1.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

name

Resource name, not used to manage the device. Valid value is a string.

enable

Enable or disable radius functionality. Valid values are 'true' or 'false'.

--

Type: radius_global

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.1.0
N30xx 7.0(3)I2(1) 1.1.0
N31xx 7.0(3)I2(1) 1.1.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR TODO TODO

Parameters

name

Resource identifier, not used to manage the device. Valid value is a string.

timeout

Number of seconds before the timeout period ends. Valid value is an integer.

retransmit_count

Number of times to retransmit. Valid value is an integer.

key

Encryption key (plaintext or in hash form depending on key_format). Valid value is a string.

key_format

Encryption key format [0-7]. Valid value is an integer.

--

Type: radius_server

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.1.0
N30xx 7.0(3)I2(1) 1.1.0
N31xx 7.0(3)I2(1) 1.1.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR TODO TODO

Caveats

Property Caveat Description
accouting_only Not supported in Cisco IOS XR
authentication_only Not supported in Cisco IOS XR

Parameters

ensure

Determines whether or not the config should be present on the device. Valid values are 'present' and 'absent'.

name

IPv4/IPv6 address of the radius server. Valid value is a string.

auth_port

Port number to use for authentication. Valid value is an integer.

acct_port

Port number to use for accounting. Valid value is an integer.

timeout

Number of seconds before the timeout period ends. Valid value is an integer.

retransmit_count

Number of times to retransmit. Valid value is an integer.

accouting_only

Enable this server for accounting only. Valid values are 'true' or 'false'. Not supported on IOS XR.

authentication_only

Enable this server for authentication only. Valid values are 'true' or 'false'. Not supported on IOS XR.

key

Encryption key (plaintext or in hash form depending on key_format). Valid value is a string.

key_format

Encryption key format [0-7]. Valid value is an integer.

--

Type: radius_server_group

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR TODO TODO

Parameters

servers

Array of servers associated with this group.

--

Type: search_domain

Configure the search domain of the device. Note that this type is functionally equivalent to the netdev_stdlib domain_name type.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

ensure

Determines whether or not the config should be present on the device. Valid values are 'present' and 'absent'.

name

Search domain of the device. Valid value is a string.

Type: snmp_community

Manages an SNMP community on a Cisco SNMP server.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

ensure

Determine whether the config should be present or not on the device. Valid values are 'present' and 'absent'.

group

Group that the SNMP community belongs to. Valid values are a string or the keyword 'default'.

acl

Assigns an Access Control List (ACL) to an SNMP community to filter SNMP requests. Valid values are a string or the keyword 'default'.

--

Type: snmp_notification

Manages an SNMP notification on a Cisco SNMP server.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

enable

Determine whether the trap should be on or off. Valid values are true and false.

--

Type: snmp_notification_receiver

Manages an SNMP user on an cisco SNMP server.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

ensure

Determines whether the config should be present or not on the device. Valid values are 'present', and 'absent'.

name

IP address of the SNMP user. Valid value is a string.

port

SNMP UDP port number

username

Username to use for SNMPv3 privacy and authentication. This is the community string for SNMPv1 and v2.

version

SNMP version [v1|v2|v3]

type

The type of receiver [traps|informs].

security

SNMPv3 security mode [auto|noauth|priv].

vrf

Interface to send SNMP data from, e.g. "management"

source_interface

Source interface to send SNMP data from, e.g. "ethernet 2/1".

--

Type: snmp_user

Manages an SNMP user on an cisco SNMP server.

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

ensure

Determines whether the config should be present or not on the device. Valid values are 'present', and 'absent'.

name

Name of the SNMP user. Valid value is a string.

engine_id

Engine ID of the SNMP user. Valid values are empty string or 5 to 32 octets seprated by colon.

roles

Groups that the SNMP user belongs to. Valid value is a string.

auth

Authentication protocol for the SNMP user. Valid values are 'md5' and 'sha'.

password

Authentication password for the SNMP user. Valid value is string.

privacy

Privacy protocol for the SNMP user. Valid values are 'aes128' and 'des'.

private_key

Privacy password for SNMP user. Valid value is a string.

localized_key

Specifies whether the passwords specified in manifest are in localized key format (in case of true) or cleartext (in case of false). Valid values are 'true', and 'false'.

--

Type: syslog_server

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.1.0
N30xx 7.0(3)I2(1) 1.1.0
N31xx 7.0(3)I2(1) 1.1.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR TODO TODO

Parameters

ensure

Determines whether or not the config should be present on the device. Valid values are 'present' and 'absent'.

name

Hostname or IPv4/IPv6 address of the Syslog server. Valid value is a string.

serverity_level

Syslog severity level to log. Valid value is an integer.

vrf

Interface to send syslog data from, e.g. "management". Valid value is a string.

--

Type: syslog_setting

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.1.0
N30xx 7.0(3)I2(1) 1.1.0
N31xx 7.0(3)I2(1) 1.1.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

name

Hostname or address of the Syslog server. Valid value is a string.

time_stamp_units

The unit of measurement for log time values. Valid values are 'seconds' and 'milliseconds'.

--

Type: tacacs

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

enable

Enable or disable radius functionality [true|false]

--

Type: tacacs_global

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR unsupported unsupported

Parameters

enable

Enable or disable radius functionality [true|false]

key

Encryption key (plaintext or in hash form depending on key_format)

key_format

Encryption key format [0-7]

timeout

Number of seconds before the timeout period ends

--

Type: tacacs_server

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR TODO TODO
ensure

Determines whether or not the config should be present on the device. Valid values are 'present' and 'absent'.

key

Encryption key (plaintext or in hash form depending on key_format)

key_format

Encryption key format [0-7]

name

Hostname or IPv4/IPv6 address of the Syslog server. Valid value is a string.

port

The port of the tacacs server.

timeout

Number of seconds before the timeout period ends

--

Type: tacacs_server_group

Platform OS Minimum Version Module Minimum Version
N9k 7.0(3)I2(1) 1.2.0
N30xx 7.0(3)I2(1) 1.2.0
N31xx 7.0(3)I2(1) 1.2.0
N56xx unsupported unsupported
N6k unsupported unsupported
N7k unsupported unsupported
N8k 7.0(3)F1(1) 1.3.0
IOS XR TODO TODO

Parameters

servers

Array of servers associated with this group.

Limitations

Minimum Requirements:

  • Cisco NX-OS:
    • Open source Puppet version 4.0+ or Puppet Enterprise 2015.2+
    • Cisco Nexus 31xx, OS Version 7.0(3)I2(1), Environments: Bash-shell, Guestshell
    • Cisco Nexus 30xx, OS Version 7.0(3)I2(1), Environments: Bash-shell, Guestshell
    • Cisco Nexus 85xx, OS Version 7.0(3)F1(1), Environments: Bash-shell, Guestshell
    • Cisco Nexus 95xx, OS Version 7.0(3)I2(1), Environments: Bash-shell, Guestshell
    • Cisco Nexus 93xx, OS Version 7.0(3)I2(1), Environments: Bash-shell, Guestshell
    • Cisco Nexus 56xx, OS Version 7.3(0)N1(1), Environments: Open Agent Container (OAC)
    • Cisco Nexus 60xx, OS Version 7.3(0)N1(1), Environments: Open Agent Container (OAC)
    • Cisco Nexus 7xxx, OS Version 7.3(0)D1(1), Environments: Open Agent Container (OAC)
  • Cisco IOS XR:
    • Open source Puppet version 4.3.2+ or Puppet Enterprise 2015.3.2+
    • Cisco IOS XRv 9000, OS Version TODO, Environments: native (Bash-shell)
    • Cisco Network Convergence System (NCS) 55xx, OS Version TODO, Environments: native (Bash-shell)

Cisco OS Differences

There are some differences between NX-OS and IOS-XR as described below:

  • Route-Map vs Route-Policy
    • Nexus uses route-maps in some commands, this is a string reference to a route-map defined elsewhere in the configuration.
    • XR uses route-policies instead. Similar to Nexus, this is a string reference to a route-policy defined elsewhere. Under XR, a policy must be defined before it is referenced.

Learning Resources

License

Copyright (c) 2014-2016 Cisco and/or its affiliates.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

About

No description, website, or topics provided.

Resources

Readme

License

Apache-2.0 license
Activity

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

10 tags

Packages

No packages published

Languages

  • Ruby 98.9%
  • Other 1.1%