ciscopuppet

Cisco Puppet providers and types for NX-OS devices

Module Stats

72,778 downloads

24,129 latest version

4.1 quality score

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

released Jul 24th 2015

This version is compatible with:

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'puppetlabs-ciscopuppet', '0.9.0'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppetlabs-ciscopuppet

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppetlabs-ciscopuppet --version 0.9.0

Tags: network, cisco, nxos, nx-os

Documentation

puppetlabs/ciscopuppet — version 0.9.0 Jul 24th 2015

ciscopuppet

EARLY FIELD TRIAL: This is a Puppet agent EFT for use with Cisco NX-OS release 7.0(3)I2(1). Please see the Limitations section for more information.

Overview
Module Description
Setup
- Setup requirements
- Beginning with ciscopuppet
Usage
Reference - An under-the-hood peek at what the module is doing and how
Limitations - OS compatibility, etc.
Development - Guide for contributing to the module

Overview

This ciscopuppet module enables Puppet to config Cisco Nexus Switches that support NXAPI through types and NXAPI based providers.

Module Description

This module enables users to manage Cisco Nexus switches using Puppet.

This module uses Cisco NXAPI to manage various Cisco NX-OS functions on certain Cisco Nexus Switches models such as N9k series and N31xx series. These functions include, but are not limited to, tacacs server and host, snmp server and users, and OSPF.

Setup

Beginning with ciscopuppet

Before the module can be run properly on the agent, enable pluginsync in the puppet.conf file on the agent.

You must also install the following gems on the agent: net_http_unix, cisco_nxapi, and cisco_node_utils. Since these have dependencies on each other, when you install cisco_node_utils, the other two gems will be automatically installed. You can include the package provider in the manifest to automate installing these gems as shown in the following example.

package { 'cisco_node_utils' :
  provider => 'gem',
  ensure => present,
}

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",
}

Reference

Type: cisco_command_config

Allows execution of configuration commands.

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.
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_interface

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

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'.

`shutdown`

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

`switchport_mode`

Switchport mode of the interface. To make an interface Layer 3, set switchport_mode to 'disabled'. Valid values are 'disabled', 'access', 'tunnel', 'fex_fabric', 'trunk', and 'default'.

L2 interface config attributes

`access_vlan`

The VLAN ID assigned to the interface. Valid values are an integer or the keyword 'default'.

`switchport_autostate_exclude`

Exclude this port for the SVI link calculation. Valid values are 'true', 'false', and 'default'.

`switchport_vtp`

Enable or disable VTP on the interface. Valid values are 'true', 'false', and 'default'.

`negotiate_auto`

Enable/Disable negotiate auto on the interface. Valid values are 'true', 'false', and 'default'.

L3 interface config attributes

`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'.

`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'.

SVI interface config attributes

`svi_autostate`

Enable/Disable autostate on the SVI interface. Valid values are 'true', 'false', and 'default'.

`svi_management`

Enable/Disable management on the SVI interface. Valid values are 'true', 'false', and '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 thecisco_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_ospf

Manages configuration of an ospf instance.

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.

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_snmp_community

Manages an SNMP community on a Cisco SNMP server.

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.

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.

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.

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.

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.

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_vlan

Manages a Cisco VLAN.

Parameters

`vlan`

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

`ensure`

Determined wether the config should be present or not. Valid values are 'present' and 'absent'.

`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_vtp

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

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'.

Limitations

This module can only be supported from NX-OS software release 7.0(3)I2(1) on Cisco Nexus switch N95xx, N93xx, N30xx and N31xx platforms. Please ensure that the switch is running a supported version of NX-OS software.

On the supported platforms, it can work with both the native NX-OS Puppet agent or with the CentOS Puppet agent installed into the Guestshell. It does not (yet) address other Cisco operating systems such as IOS, IOS-XE, or IOS XR.

Development

Fork the repository on Github.
Create a named feature branch (like add_component_x).
Write your change.
Write tests for your change (if applicable).
Run the tests, ensuring they all pass.
Submit a Pull Request using Github.

License

Copyright (c) 2014-2015 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.

Types in this module release

cisco_snmp_user

Manages an SNMP user on an cisco SNMP server. Autorequires: cisco_snmp_group

cisco_snmp_user {" <engine_id>": ..attributes.. }

is the name of the SNMP user resource. <engine_id> is the engine id the user belongs to. If it is local user, the <engine_id> is empty. Otherwise, it is 5 to 32 octets separated by colon.

Example: cisco_snmp_user {"v3test": ensure => present, groups => ['network-admin'], auth_protocol => 'md5', auth_password => 'xxxxx', localized_key => false, } or cisco_snmp_user {"v3test 128:128:127:127:124:2": ensure => present, groups => ['network-admin'], auth_protocol => 'md5', auth_password => 'xxxxx', localized_key => false, }

Parameters
engine_id	Engine ID of the SNMP user. Valid values are empty string or 5 to 32 octets seprated by colon.
ensure
localized_key	Specifies whether the passwords specified in manifest are in localized key format (in case of true) or cleartext (in case of false).
name	Name of cisco_snmp_user, not used, just to make puppet happy
provider
user	Name of the SNMP user. Valid values are string.

Properties
auth_password	Authentication password for the SNMP user. Valid values are string.
auth_protocol	Authentication protocol for the SNMP user.
groups	Groups that the SNMP user belongs to. Valid values are string.
priv_password	Privacy password for SNMP user. Valid values are string
priv_protocol	Privacy protocol for the SNMP user.

Providers
nxapi	The NXAPI provider.

cisco_snmp_server

Manages a Cisco SNMP Server.

cisco_snmp_server {"<instance_name>": ..attributes.. }

There can only be one instance of the cisco_snmp_server.

Example: cisco_snmp_server {"<instance_name>": contact => "user1", location => "rtp", packet_size => 2500, aaa_user_cache_timeout => 1000, tcp_session_auth => false, protocol => false, global_enforce_priv => false, }

Parameters
name	The name of the SNMP Server instance. Valid values are string.
provider

Properties
aaa_user_cache_timeout	Configures how long the AAA synchronized user configuration stays in the local cache. Valid values are integer, keyword 'default'.
contact	SNMP system contact (sysContact). Valid values are string, keyword 'default'.
global_enforce_priv	Enable/disable SNMP message encryption for all users.
location	SNMP location (sysLocation). Valid values are string, keyword 'default'.
packet_size	Size of SNMP packet. Valid values are integer, in bytes, keyword 'default'.
protocol	Enable/disable SNMP protocol.
tcp_session_auth	Enable/disable a one time authentication for SNMP over TCP session.

Providers
nxapi	The nxapi provider.

cisco_tacacs_server

Manages a Cisco TACACS+ Server global configuration.

cisco_tacacs_server {"": ..attributes.. }

The is the name of the tacacs server instance.

There can only be one instance of the cisco_tacacs_server.

Example: cisco_tacacs_server {"default": ensure => present, timeout => 10, directed_request => true, deadtime => 20, encryption_type => clear, encryption_password => 'test123', source_interface => 'Ethernet1/2', }

Parameters
encryption_type	Specifies the global preshared key type for TACACS+ servers.
ensure
name	Instance of the tacacs_server, only allow the value 'default'
provider

Properties
deadtime	Specifies the global deadtime interval for TACACS+ servers. Valid values are Integer, in minutes, keyword 'default'.
directed_request	Allows users to specify a TACACS+ server to send the authentication request when logging in.
encryption_password	Specifies the global TACACS+ servers preshared key password. Valid values are string, keyword 'default'.
source_interface	Global source interface for all TACACS+ server groups configured on the device. Valid values are string, keyword 'default'.
timeout	Global timeout interval for TACACS+ servers. Valid values are Integer, in seconds, keyword 'default'.

Providers
nxapi	The nxapi provider.

cisco_ospf_vrf

Manages a VRF for an OSPF router.

cisco_ospf_vrf {" ": ..attributes.. }

is the name of the ospf router instance. is the name of the ospf vrf.

Example: cisco_ospf_vrf {"green test": ensure => present, router_id => "192.168.1.1", default_metric => 2, log_adjancency => log, timer_throttle_lsa_start => 0, timer_throttle_lsa_hold => 5000, timer_throttle_lsa_max => 5000, timer_throttle_spf_start => 200, timer_throttle_spf_hold => 1000, timer_throttle_spf_max => 5000, auto_cost => 40000, }

Parameters
ensure
name	Name of cisco_ospf_vrf, not used, but needed for puppet
ospf	Name of the ospf instance. Valid values are string.
provider
vrf	Name of the resource instance. Valid values are string. The name 'default' is a valid VRF.

Properties
auto_cost	Specifies the reference bandwidth used to assign OSPF cost. Valid values are integer, in Mbps, keyword 'default'.
default_metric	Specify the default Metric value. Valid values are integer, keyword 'default'.
log_adjacency	Controls the level of log messages generated whenever a neighbor changes state.
router_id	Router Identifier (ID) of the OSPF router VRF instance. Valid values are string, keyword 'default'.
timer_throttle_lsa_hold	Specifies the hold interval for rate-limiting Link-State Advertisement (LSA) generation. Valid values are integer, in milliseconds, keyword 'default'.
timer_throttle_lsa_max	Specifies the max interval for rate-limiting Link-State Advertisement (LSA) generation. Valid values are integer, in milliseconds, keyword 'default'.
timer_throttle_lsa_start	Specify the start interval for rate-limiting Link-State Advertisement (LSA) generation. Valid values are integer, in milliseconds, keyword 'default'.
timer_throttle_spf_hold	Specify minimum hold time between Shortest Path First (SPF) calculations. Valid values are integer, in milliseconds, keyword 'default'.
timer_throttle_spf_max	Specify the maximum wait time between Shortest Path First (SPF) calculations. Valid values are integer, in milliseconds, keyword 'default'.
timer_throttle_spf_start	Specify initial Shortest Path First (SPF) schedule delay. Valid values are integer, in milliseconds, keyword 'default'.

Providers
nxapi	The NXAPI provider.

cisco_command_config

Allows execution of configuration commands.

cisco_command_config {"": ..attributes.. }

is the name of the cisco_command_config instance.

Example cisco_command_config {"feature-config": command => " feature interface-vlan" }

cisco_command_config {"feature-intf-portchannel2":
  command => "
              interface Vlan20
                no ip redirects
                ip address 17.159.249.1/24
                ip dhcp relay address 17.158.158.16
                ip dhcp relay address 17.158.156.10
                ip dhcp relay address 17.158.4.32
                no shutdown"
  require => cisco_command_config ["feature-config"],
}

is optional.

Parameters
name
provider

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

Providers
nxapi

cisco_ospf

Manages configuration of an ospf instance

cisco_ospf {"": ..attributes.. }

is the name of the ospf router instance.

Example: cisco_ospf {"green" : ensure => present, }

Parameters
ensure
ospf	Name of the ospf router. Valid values are string.
provider

Providers
nxapi	The NXAPI provider.

cisco_vtp

Manages the VTP (VLAN Trunking Protocol) configuration of a Cisco device.

cisco_vtp { : ..attributes.. }

There can only be one instance of the cisco_vtp. Example: cisco_vtp { default: ensure => present, domain => 'mydomain', password => 'xxxxx', version => 2, filename => 'bootflash:/vlan.dat', }

Parameters
ensure
name	Instance of vtp, only allow the value 'default'
provider

Properties
domain	VTP administrative domain. Valid values are string. Mandatory parameter.
filename	VTP file name. Valid values are string, keyword 'default'.
password	Password for the VTP domain. Valid values are string, keyword 'default'.
version	Version for the VTP domain. Valid values are integer, keyword 'default'.

Providers
nxapi	The nxapi provider.

cisco_interface

Manages a Cisco Network Interface.

Any resource dependency should be run before the interface resource.

cisco_interface {"": ..attributes.. }

is the complete name of the interface.

Example: cisco_interface {"Ethernet1/15": shutdown => false, description => "switched port", switchport_mode => access, access_vlan => 2, switchport_autostate_exclude => true, switchport_vtp => true, } cisco_interface { "Ethernet1/16" : shutdown => true, description => "routed port", ipv4_address => "192.168.1.1", ipv4_netmask_length => 24, ipv4_redirects => true, ipv4_proxy_arp => true, negotiate_auto => true, } cisco_interface { "loopback42" : description => "logical interface", shutdown => true, } cisco_interface { "loopback43" : ensure => absent,

 # ensure will create or destroy a logical interface. If not specified
 # then the default behavior is to attempt to create the interface.
}
cisco_interface {"Vlan98":
 shutdown                     => true,
 description                  => "svi interface",
 svi_autostate                => true,
 svi_management               => true,
}

Parameters
ensure
interface	Name of the interface on the network element. Valid values are string.
provider

Properties
access_vlan	The VLAN ID assigned to the interface. Valid values are integer, keyword 'default'.
description	Description of the interface. Valid values are string, keyword 'default'.
ipv4_address	IP address of the interface. Valid values are string, keyword 'default'.
ipv4_netmask_length	Network mask length of the IP address on the interface. Valid values are integer, keyword 'default'.
ipv4_proxy_arp	Enables or disables proxy arp on the interface.
ipv4_redirects	Enables or disables sending of IP redirect messages.
negotiate_auto	Enable/Disable negotiate auto on the interface.
shutdown	Shutdown state of the interface.
svi_autostate	Enable/Disable autostate on the SVI interface.
svi_management	Enable/Disable management on the SVI interface.
switchport_autostate_exclude	Exclude this port for the SVI link calculation.
switchport_mode	Switchport mode of the interface. To make an interface L3, set switchport_mode to 'disabled'.
switchport_vtp	Enable or disable VTP on the interface.

Providers
nxapi	The NXAPI provider for cisco_interface.

cisco_snmp_group

Manages a Cisco SNMP Group on a Cisco SNMP Server.

group is a standard SNMP term but in NXOS role is used to serve the purpose of group; thus this provider utility does not create snmp groups and is limited to reporting group (role) existence only.

cisco_snmp_group {"": ..attributes.. }

is the name of the snmp group.

Example: cisco_snmp_group {"network-admin": ensure => present, }

Parameters
ensure
group	Name of the snmp group. Valid values are string.
provider

Providers
nxapi	The NXAPI provider for snmp group.

cisco_interface_ospf

Manages configuration of an OSPF interface instance Autorequires: cisco_interface, cisco_ospf

cisco_interface_ospf {" ": ..attributes.. }

is the name of the interface where the ospf interface config is to be applied. is the name of the ospf router instance.

Example: cisco_interface_ospf {"Ethernet1/8 green": ensure => present, area => "0.0.0.0", cost => 10, hello_interval => 10, dead_interval => 40, passive_interface => true, message_digest => true, message_digest_key_id => 5, message_digest_algorithm_type => md5, message_digest_encryption_type => "clear", message_digest_password => "xxxxx", }

Parameters
area	Ospf area associated with this cisco_interface_ospf instance. Valid values are string, formatted as an IP address i.e. "0.0.0.0" or as an integer. Mandatory parameter.
ensure
interface	Name of this cisco_interface resource. Valid values are string.
message_digest_algorithm_type	Algorithm used for authentication among neighboring routers within an area. 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'.
name	dummy paramenter to support puppet resource command
ospf	Name of the cisco_ospf resource. Valid values are string.
provider

Properties
cost	The cost associated with this cisco_interface_ospf instance. Valid values are integer.
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 integer, keyword 'default'.
hello_interval	The hello_interval associated with this cisco_interface_ospf instance. Time between sending successive hello packets. Valid values are integer, keyword 'default'.
message_digest	Enables or disables the usage of message digest authentication.
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 values are integer.
message_digest_password	Specifies the message_digest password. Valid values are string.
passive_interface	Passive interface associated with the cisco_interface_ospf instance. Setting to true will prevent this interface from receiving HELLO packets.

Providers
nxapi	The nxapi provider.

cisco_snmp_community

Manages an SNMP community on a Cisco SNMP server.

cisco_snmp_community {"": ..attributes.. }

is the name of the SNMP community resource.

Example: cisco_snmp_community {"setcom": ensure => present, group => "network-admin", acl => "testcomacl", }

Parameters
community	Name of the SNMP community. Valid values are string.
ensure
provider

Properties
acl	Assigns an Access Control List (ACL) to an SNMP community to filter SNMP requests. Valid values are string, 'default'.
group	Group that the SNMP community belongs to. Valid values are string, keyword 'default'.

Providers
nxapi	The NXAPI provider for cisco_snmp_community

cisco_tacacs_server_host

Configures Cisco TACACS+ server hosts.

cisco_tacacs_server_host {"": ..attributes.. }

is the name of the tacacs server host.

Example: cisco_tacacs_server_host {"accounting" : ensure => present, port => 50, timeout => 10, encryption_type => 'encrypted', encryption_password => 'xxxxx', }

Parameters
encryption_type	Specifies a preshared key for the host. keyword 'default'.
ensure
host	Name of the tacacs_server_host instance. Valid values are string.
provider

Properties
encryption_password	Specifies the preshared key password for the host. Valid values are string.
port	Server port for the host. Valid values are Integer, keyword 'default'.
timeout	Timeout interval for the host. Valid values are Integer, in seconds.

Providers
nxapi	The NXAPI provider.

cisco_vlan

Manages a Cisco VLAN.

cisco_vlan {"": ..attributes.. }

is the id of the vlan.

Example: cisco_vlan {"200": ensure => present, vlan_name => 'red', state => 'active', shutdown => 'true', }

Parameters
ensure
provider
vlan	ID of the Virtual LAN. Valid values are integer.

Properties
shutdown	whether or not the vlan is shutdown
state	State of the VLAN.
vlan_name	The name of the VLAN. Valid values are string, keyword 'default'.

Providers
nxapi	The new NXAPI provider.

                                 Apache License
                           Version 2.0, January 2004
                        http://www.apache.org/licenses/

   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

   1. Definitions.

      "License" shall mean the terms and conditions for use, reproduction,
      and distribution as defined by Sections 1 through 9 of this document.

      "Licensor" shall mean the copyright owner or entity authorized by
      the copyright owner that is granting the License.

      "Legal Entity" shall mean the union of the acting entity and all
      other entities that control, are controlled by, or are under common
      control with that entity. For the purposes of this definition,
      "control" means (i) the power, direct or indirect, to cause the
      direction or management of such entity, whether by contract or
      otherwise, or (ii) ownership of fifty percent (50%) or more of the
      outstanding shares, or (iii) beneficial ownership of such entity.

      "You" (or "Your") shall mean an individual or Legal Entity
      exercising permissions granted by this License.

      "Source" form shall mean the preferred form for making modifications,
      including but not limited to software source code, documentation
      source, and configuration files.

      "Object" form shall mean any form resulting from mechanical
      transformation or translation of a Source form, including but
      not limited to compiled object code, generated documentation,
      and conversions to other media types.

      "Work" shall mean the work of authorship, whether in Source or
      Object form, made available under the License, as indicated by a
      copyright notice that is included in or attached to the work
      (an example is provided in the Appendix below).

      "Derivative Works" shall mean any work, whether in Source or Object
      form, that is based on (or derived from) the Work and for which the
      editorial revisions, annotations, elaborations, or other modifications
      represent, as a whole, an original work of authorship. For the purposes
      of this License, Derivative Works shall not include works that remain
      separable from, or merely link (or bind by name) to the interfaces of,
      the Work and Derivative Works thereof.

      "Contribution" shall mean any work of authorship, including
      the original version of the Work and any modifications or additions
      to that Work or Derivative Works thereof, that is intentionally
      submitted to Licensor for inclusion in the Work by the copyright owner
      or by an individual or Legal Entity authorized to submit on behalf of
      the copyright owner. For the purposes of this definition, "submitted"
      means any form of electronic, verbal, or written communication sent
      to the Licensor or its representatives, including but not limited to
      communication on electronic mailing lists, source code control systems,
      and issue tracking systems that are managed by, or on behalf of, the
      Licensor for the purpose of discussing and improving the Work, but
      excluding communication that is conspicuously marked or otherwise
      designated in writing by the copyright owner as "Not a Contribution."

      "Contributor" shall mean Licensor and any individual or Legal Entity
      on behalf of whom a Contribution has been received by Licensor and
      subsequently incorporated within the Work.

   2. Grant of Copyright License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      copyright license to reproduce, prepare Derivative Works of,
      publicly display, publicly perform, sublicense, and distribute the
      Work and such Derivative Works in Source or Object form.

   3. Grant of Patent License. Subject to the terms and conditions of
      this License, each Contributor hereby grants to You a perpetual,
      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
      (except as stated in this section) patent license to make, have made,
      use, offer to sell, sell, import, and otherwise transfer the Work,
      where such license applies only to those patent claims licensable
      by such Contributor that are necessarily infringed by their
      Contribution(s) alone or by combination of their Contribution(s)
      with the Work to which such Contribution(s) was submitted. If You
      institute patent litigation against any entity (including a
      cross-claim or counterclaim in a lawsuit) alleging that the Work
      or a Contribution incorporated within the Work constitutes direct
      or contributory patent infringement, then any patent licenses
      granted to You under this License for that Work shall terminate
      as of the date such litigation is filed.

   4. Redistribution. You may reproduce and distribute copies of the
      Work or Derivative Works thereof in any medium, with or without
      modifications, and in Source or Object form, provided that You
      meet the following conditions:

      (a) You must give any other recipients of the Work or
          Derivative Works a copy of this License; and

      (b) You must cause any modified files to carry prominent notices
          stating that You changed the files; and

      (c) You must retain, in the Source form of any Derivative Works
          that You distribute, all copyright, patent, trademark, and
          attribution notices from the Source form of the Work,
          excluding those notices that do not pertain to any part of
          the Derivative Works; and

      (d) If the Work includes a "NOTICE" text file as part of its
          distribution, then any Derivative Works that You distribute must
          include a readable copy of the attribution notices contained
          within such NOTICE file, excluding those notices that do not
          pertain to any part of the Derivative Works, in at least one
          of the following places: within a NOTICE text file distributed
          as part of the Derivative Works; within the Source form or
          documentation, if provided along with the Derivative Works; or,
          within a display generated by the Derivative Works, if and
          wherever such third-party notices normally appear. The contents
          of the NOTICE file are for informational purposes only and
          do not modify the License. You may add Your own attribution
          notices within Derivative Works that You distribute, alongside
          or as an addendum to the NOTICE text from the Work, provided
          that such additional attribution notices cannot be construed
          as modifying the License.

      You may add Your own copyright statement to Your modifications and
      may provide additional or different license terms and conditions
      for use, reproduction, or distribution of Your modifications, or
      for any such Derivative Works as a whole, provided Your use,
      reproduction, and distribution of the Work otherwise complies with
      the conditions stated in this License.

   5. Submission of Contributions. Unless You explicitly state otherwise,
      any Contribution intentionally submitted for inclusion in the Work
      by You to the Licensor shall be under the terms and conditions of
      this License, without any additional terms or conditions.
      Notwithstanding the above, nothing herein shall supersede or modify
      the terms of any separate license agreement you may have executed
      with Licensor regarding such Contributions.

   6. Trademarks. This License does not grant permission to use the trade
      names, trademarks, service marks, or product names of the Licensor,
      except as required for reasonable and customary use in describing the
      origin of the Work and reproducing the content of the NOTICE file.

   7. Disclaimer of Warranty. Unless required by applicable law or
      agreed to in writing, Licensor provides the Work (and each
      Contributor provides its Contributions) on an "AS IS" BASIS,
      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
      implied, including, without limitation, any warranties or conditions
      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
      PARTICULAR PURPOSE. You are solely responsible for determining the
      appropriateness of using or redistributing the Work and assume any
      risks associated with Your exercise of permissions under this License.

   8. Limitation of Liability. In no event and under no legal theory,
      whether in tort (including negligence), contract, or otherwise,
      unless required by applicable law (such as deliberate and grossly
      negligent acts) or agreed to in writing, shall any Contributor be
      liable to You for damages, including any direct, indirect, special,
      incidental, or consequential damages of any character arising as a
      result of this License or out of the use or inability to use the
      Work (including but not limited to damages for loss of goodwill,
      work stoppage, computer failure or malfunction, or any and all
      other commercial damages or losses), even if such Contributor
      has been advised of the possibility of such damages.

   9. Accepting Warranty or Additional Liability. While redistributing
      the Work or Derivative Works thereof, You may choose to offer,
      and charge a fee for, acceptance of support, warranty, indemnity,
      or other liability obligations and/or rights consistent with this
      License. However, in accepting such obligations, You may act only
      on Your own behalf and on Your sole responsibility, not on behalf
      of any other Contributor, and only if You agree to indemnify,
      defend, and hold each Contributor harmless for any liability
      incurred by, or claims asserted against, such Contributor by reason
      of your accepting any such warranty or additional liability.

   END OF TERMS AND CONDITIONS

   APPENDIX: How to apply the Apache License to your work.

      To apply the Apache License to your work, attach the following
      boilerplate notice, with the fields enclosed by brackets "[]"
      replaced with your own identifying information. (Don't include
      the brackets!) The text should be enclosed in the appropriate
      comment syntax for the file format. We also recommend that a
      file or class name and description of purpose be included on the
      same "printed page" as the copyright notice for easier
      identification within third-party archives.

   Copyright (c) 2014-2015 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.

ciscopuppet

Support the Puppet Community by contributing to this module

Version information

This version is compatible with:

Start using this module

Documentation

ciscopuppet

EARLY FIELD TRIAL: This is a Puppet agent EFT for use with Cisco NX-OS release 7.0(3)I2(1). Please see the Limitations section for more information.

Table of Contents

Overview

Module Description

Setup

Beginning with ciscopuppet

Usage

Reference

Public Types

Type: cisco_command_config

Parameters

command

Type: cisco_interface

Parameters

Basic interface config attributes

ensure

interface

description

shutdown

switchport_mode

L2 interface config attributes

access_vlan

switchport_autostate_exclude

switchport_vtp

negotiate_auto

L3 interface config attributes

ipv4_proxy_arp

ipv4_redirects

ipv4_address

ipv4_netmask_length

SVI interface config attributes

svi_autostate

svi_management

Type: cisco_interface_ospf

Parameters

ensure

interface

ospf

cost

hello_interval

dead_interval

passive_interface

message_digest

message_digest_key_id

message_digest_algorithm_type

message_digest_encryption_type

message_digest_password

area

Type: cisco_ospf

Parameters

ensure

ospf

Type: cisco_ospf_vrf

Parameters

ensure

vrf

ospf

router_id

default_metric

log_adjacency

timer_throttle_lsa_start

timer_throttle_lsa_hold

timer_throttle_lsa_max

timer_throttle_spf_start

timer_throttle_spf_hold

timer_throttle_spf_max

auto_cost

Type: cisco_snmp_community

Parameters

ensure

community

group

acl

`command`

`ensure`

`interface`

`description`

`shutdown`

`switchport_mode`

`access_vlan`

`switchport_autostate_exclude`

`switchport_vtp`

`negotiate_auto`

`ipv4_proxy_arp`

`ipv4_redirects`

`ipv4_address`

`ipv4_netmask_length`

`svi_autostate`

`svi_management`

`ensure`

`interface`

`ospf`

`cost`

`hello_interval`

`dead_interval`

`passive_interface`

`message_digest`

`message_digest_key_id`

`message_digest_algorithm_type`

`message_digest_encryption_type`

`message_digest_password`

`area`

`ensure`

`ospf`

`ensure`

`vrf`

`ospf`

`router_id`

`default_metric`

`log_adjacency`

`timer_throttle_lsa_start`

`timer_throttle_lsa_hold`

`timer_throttle_lsa_max`

`timer_throttle_spf_start`

`timer_throttle_spf_hold`

`timer_throttle_spf_max`

`auto_cost`

`ensure`

`community`

`group`

`acl`

`ensure`

`group`

`name`

`location`

`contact`

`aaa_user_cache_timeout`

`packet_size`

`global_enforce_priv`

`protocol`

`tcp_session_auth`

`ensure`

`user`

`engine_id`

`groups`

`auth_protocol`

`auth_password`

`priv_protocol`

`priv_password`

`localized_key`

`name`

`timeout`

`directed_request`

`deadtime`

`encryption_type`

`encryption_password`

`source_interface`

`ensure`

`host`

`port`

`timeout`

`encryption_type`

`encryption_password`