This module implements the type specification for the network device support program. The goal of this module is to provide the Puppet types for writing provider implementations of these types for a specific network device model.
The modules supports legacy Puppet and Resource API versions of the types.
Both versions of the types perform the same in the catalog, but stricter type checking is enabled with RSAPI versions.
Only one version can be loaded into an environment at a time. On the master, RSAPI version of the types will always be loaded when Resource API gem is present. This will be the default behavior in future versions of Puppet.
On the agent, legacy types will be loaded if the operatingsystem is aristaeos or ios_xr, otherwise RSAPI version is loaded.
The following reference material is useful when developing providers for the types implemented in this module.
- Resource API
- Puppet Types and Providers by Dan Bode & Nan Liu
- Custom Types Documentation
- Seriously, What is this Provider Doing? Useful for an in-depth explanation of the instances class method for each provider.
banner: Configure banners for network devicesnetwork_dns: Configure DNS settings for network devicesnetwork_interface: Manage physical network interfaces, e.g. Ethernet1network_snmp: Manage snmp location, contact and enable SNMP on the devicenetwork_trunk: Ethernet logical (switch-port) interface. Configures VLAN trunking.network_vlan: Manage VLAN's. Layer-2 VLAN's are managed by this resource type.ntp_auth_key: NTP Authentication keysntp_config: Global configuration for the NTP systemntp_server: Specify an NTP serverport_channel: Network Device Link Aggregation Groupradius: Enable or disable radius functionalityradius_global: Configure global radius settingsradius_server: Configure a radius serverradius_server_group: Configure a radius server groupsnmp_community: Manage the SNMP communitysnmp_notification: Enable or disable notification groups and eventssnmp_notification_receiver: Manage an SNMP notification receiversnmp_user: Set the SNMP contact namesyslog_facility: Configure severity levels for global syslog facilitiessyslog_server: Configure a remote syslog server for loggingsyslog_settings: Configure global syslog settingstacacs: Enable or disable tacacs functionalitytacacs_global: Configure global tacacs settingstacacs_server: Configure a tacacs servertacacs_server_group: Configure a tacacs server groupvrf: Configure a VRF
The following types have been replaced by network_dns
domain_name: Default domain name to append to the device hostnamename_server: Configure the resolver to use the specified DNS serversearch_domain: DNS suffix to search for FQDN entries
Set various banners on the device, for example motd.
The following attributes are available in the banner type.
namevar
The friendly name for banner settings, it is set to default.
Default value: default.
The MOTD banner.
The Login banner.
The EXEC banner.
Deprecated - Default domain name to append to the device hostname.
The following properties are available in the domain_name type.
Valid values: present, absent.
The basic property that the resource should be in.
Default value: present.
The following parameters are available in the domain_name type.
namevar
The domain name of the device.
Deprecated - Configure the resolver to use the specified DNS server.
The following properties are available in the name_server type.
Valid values: present, absent.
The basic property that the resource should be in.
Default value: present.
The following parameters are available in the name_server type.
namevar
The hostname or address of the DNS server.
Configure DNS settings for network devices.
The following properties are available in the network_dns type.
Valid values: present, absent.
The basic property that the resource should be in.
Default value: present.
The default domain name to add to the device hostname.
The hostname of the device
Array of DNS suffixes to search for FQDN entries.
Array of DNS servers to use for name resolution.
The following parameters are available in the network_dns type.
namevar
Name, generally "settings". Not used to manage the resource.
Manage physical network interfaces, for example, Ethernet1.
The following properties are available in the network_interface type.
Valid values: true, false
Enable the interface, true or false.
Interface physical port description.
Interface Maximum Transmission Unit in bytes.
Valid values: auto, 1g, 10g, 40g, 56g, 100g, 100m, 10m.
Link speed [auto*|10m|100m|1g|10g|40g|56g|100g].
Valid values: auto, full, half.
Duplex mode [auto*|full|half].
The following parameters are available in the network_interface type.
namevar
Interface Name, for example, Ethernet1.
Manage snmp location. Contact and enable SNMP on the device.
The following properties are available in the network_snmp type.
Valid values: true, false
Enable or disable SNMP functionality [true|false].
The contact name for this device.
The location of this device.
The following parameters are available in the network_snmp type.
namevar
The name of the Puppet resource — not used to manage the device.
Ethernet logical (switch-port) interface. Configures VLAN trunking.
The following properties are available in the network_trunk type.
Valid values: present, absent.
The basic property that the resource should be in.
Default value: present.
Valid values: dot1q, isl, negotiate, none.
The vlan-tagging encapsulation protocol, usually dot1q.
Valid values: access, trunk, dynamic_auto, dynamic_desirable.
The L2 interface mode, enables or disables trunking.
VLAN used for untagged VLAN traffic. a.k.a Native VLAN.
Array of VLAN names used for tagged packets.
Array of VLAN ID numbers used for VLAN pruning.
The following parameters are available in the network_trunk type.
namevar
The switch interface name, for example, Ethernet1.
Manage VLAN's. Layer-2 VLAN's are managed by this resource type.
The following properties are available in the network_vlan type.
Valid values: present, absent.
The basic property that the resource should be in.
Default value: present.
The VLAN name, for example, VLAN100.
Valid values: true, false
VLAN shutdown if true, not shutdown if false.
The VLAN Description, for example, 'Engineering'.
The following parameters are available in the network_vlan type.
The VLAN ID, for example, 100.
NTP Authentication keys.
The following properties are available in the ntp_auth_key type.
Valid values: present, absent.
The basic property that the resource should be in.
Default value: present.
Valid values: md5, sha1, sha256.
Hash algorithm [md5|sha1|sha256].
Password mode [0 (plain) | 7 (encrypted)].
Password text
The following parameters are available in the ntp_auth_key type.
namevar
Authentication key ID.
Global configuration for the NTP system.
The following properties are available in the ntp_config type.
Valid values: true, false.
NTP authentication enabled [true|false].
The source interface for the NTP system.
Array of global trusted-keys. Contents can be a String or Integers.
The following parameters are available in the ntp_config type.
namevar
Resource name — not used to configure the device.
Specify an NTP server.
The following properties are available in the ntp_server type.
Valid values: present, absent.
The basic property that the resource should be in.
Default value: present.
Authentication key ID.
The maximul poll interval.
The minimum poll interval.
Valid values: true, false.
Prefer this NTP server [true|false].
The source interface used to reach the NTP server.
The VRF instance this server is bound to.
The following parameters are available in the ntp_server type.
namevar
The hostname or address of the NTP server.
Network Device Link Aggregation Group.
The following properties are available in the port_channel type.
Valid values: present, absent.
The basic property that the resource should be in.
Default value: present.
Valid values: present, absent.
The basic property that the resource should be in.
Default value: present.
Channel Group ID, for example, 10.
Port Channel description.
Valid values: active, passive, disabled.
LACP mode [ passive | active | disabled* ]
Array of Physical Interfaces.
Number of active links required for LAG to be up.
Valid values: auto, 1g, 10g, 40g, 56g, 100g, 100m, 10m.
Link speed [auto*|10m|100m|1g|10g|40g|56g|100g].
Valid values: auto, full, half.
Duplex mode [auto*|full|half].
Valid values: desired, on, off.
Flow control (send) [desired|on|off].
Valid values: desired, on, off.
Flow control (receive) [desired|on|off].
The following parameters are available in the port_channel type.
namevar
LAG Name.
Valid values: true, false
Force configuration (true / false).
Enable or disable radius functionality.
The following properties are available in the radius type.
Valid values: true, false
Enable or disable radius functionality [true|false].
The following parameters are available in the radius type.
namevar
Resource name — not used to manage the device.
Configure global radius settings.
The following properties are available in the radius_global type.
Valid values: true, false.
Enable or disable radius functionality [true|false].
Encryption key (plaintext or in hash form depending on key_format).
Encryption key format [0-7].
How many times to retransmit or 'unset' (Cisco Nexus only)
The source interface used for RADIUS packets (array of strings for multiple).
Number of seconds before the timeout period ends or 'unset' (Cisco Nexus only)f
The VRF associated with source_interface (array of strings for multiple).
The following parameters are available in the radius_global type.
namevar
Resource identifier — not used to manage the device.
Configure a radius server.
The following properties are available in the radius_server type.
Valid values: present, absent.
The basic property that the resource should be in.
Default value: present.
The hostname or address of the radius server.
Port number to use for authentication.
Port number to use for accounting.
Encryption key (plaintext or in hash form depending on key_format).
Encryption key format [0-7].
Server group associated with this server.
Number of minutes to ignore an unresponsive server.
Number of seconds before the timeout period ends.
Interface to send syslog data from, for example, "management".
Source interface to send syslog data from, for example, "ethernet 2/1".
How many times to retransmit.
Valid values: true, false.
Enable this server for accounting only.
Valid values: true, false.
Enable this server for authentication only.
The following parameters are available in the radius_server type.
namevar
The name of the radius server.
Configure a radius server group.
The following properties are available in the radius_server_group type.
Valid values: present, absent.
The basic property that the resource should be in.
Default value: present.
Array of servers associated with this group.
The following parameters are available in the radius_server_group type.
namevar
The name of the radius server group.
Deprecated - DNS suffix to search for FQDN entries.
The following properties are available in the search_domain type.
Valid values: present, absent.
The basic property that the resource should be in.
Default value: present.
The following parameters are available in the search_domain type.
namevar
The search domain to configure in the resolver.
Manage the SNMP community.
The following properties are available in the snmp_community type.
Valid values: present, absent.
The basic property that the resource should be in.
Default value: present.
The SNMP group for this community.
The ACL name to associate with this community string.
The following parameters are available in the snmp_community type.
namevar
The name of the community, for example, "public" or "private".
Enable or disable notification groups and events.
The following properties are available in the snmp_notification type.
Valid values: true, false.
Enable or disable the notification [true|false].
The following parameters are available in the snmp_notification type.
namevar
The notification name or "all" for all notifications.
Manage an SNMP notification receiver.
The following properties are available in the snmp_notification_receiver type.
Valid values: present, absent.
The basic property that the resource should be in.
Default value: present.
SNMP UDP port number.
Valid values: v1, v2, v3.
SNMP version [v1|v2|v3].
Valid values: traps, informs.
The type of receiver [traps|informs].
Valid values: auth, noauth, priv.
SNMPv3 security mode.
Interface to send SNMP data from, for example, "management".
Source interface to send SNMP data from, for example, "ethernet 2/1".
The following parameters are available in the snmp_notification_receiver type.
namevar
Hostname or IP address of the receiver.
Set the SNMP contact name.
The following properties are available in the snmp_user type.
Valid values: present, absent.
The basic property that the resource should be in.
Default value: present.
Valid values: v1, v2, v2c, v3.
SNMP version [v1|v2|v2c|v3].
A list of roles associated with this SNMP user.
Valid values: md5, sha.
Authentication mode [md5|sha].
Cleartext password for the user.
Valid values: aes128, des
Privacy encryption method [aes128|des].
Private key in hexadecimal string.
Necessary if the SNMP engine is encrypting data.
The following parameters are available in the snmp_user type.
namevar
The name of the SNMP user.
Valid values: true, false
If true, password needs to be a hexadecimal value.
Valid values: true, false
If true, message encryption is enforced.
Configure severity levels for global syslog facilities.
The following properties are available in the syslog_facility type.
Syslog severity level to log.
The following parameters are available in the syslog_facility type.
namevar
Global facility to manage
Configure a remote syslog server for logging.
The following properties are available in the syslog_server type.
Valid values: present, absent.
The basic property that the resource should be in.
Default value: present.
Port number of remote syslog server.
Syslog severity level to log.
Interface to send syslog data from, for example, "management".
Source interface to send syslog data from, for example, "ethernet 2/1".
The following parameters are available in the syslog_server type.
namevar
The hostname or address of the remote syslog server.
Configure global syslog settings.
The following properties are available in the syslog_settings type.
Valid values: true, false.
Enable or disable syslog logging [true|false].
Console logging severity level [0-7] or 'unset'.
Monitor (terminal) logging severity level [0-7] or 'unset'.
Source interface to send syslog data from, for example, "ethernet 2/1" (array of strings for multiple).
Valid values: seconds, milliseconds.
The unit to log time values in.
The VRF associated with source_interface (array of strings for multiple).
Logfile severity level [0-7] or 'unset'
Logfile file name to use or 'unset'
Logging file maximum size or 'unset'
Buffered log severity level [0-7] or 'unset'
Logging buffer size or 'unset'
The following parameters are available in the syslog_settings type.
namevar
Resource name — not used to configure the device.
Enable or disable tacacs functionality.
The following properties are available in the tacacs type.
Valid values: true, false.
Enable or disable tacacs functionality [true|false].
The following parameters are available in the tacacs type.
namevar
Resource name — not used to manage the device.
Configure global tacacs settings.
The following properties are available in the tacacs_global type.
Valid values: true, false.
Enable or disable radius functionality [true|false].
Encryption key (plaintext or in hash form depending on key_format).
Encryption key format [0-7].
How many times to retransmit or 'unset' (Cisco Nexus only)
The source interface used for TACACS packets (array of strings for multiple).
Number of seconds before the timeout period ends or 'unset' (Cisco Nexus only)
The VRF associated with source_interface (array of strings for multiple).
Valid values: true, false.
Whether to allow users to specify tacacs server to use with `@server'.
The following parameters are available in the tacacs_global type.
namevar
Resource identifier — not used to manage the device.
Configure a tacacs server.
The following properties are available in the tacacs_server type.
Valid values: present, absent.
The basic property that the resource should be in.
Default value: present.
The hostname or address of the tacacs server.
Valid values: true, false
Enable or disable session multiplexing [true|false].
Specifies the VRF instance used to communicate with the server.
The port of the tacacs server.
Encryption key (plaintext or in hash form depending on key_format).
Encryption key format [0-7].
Number of seconds before the timeout period ends.
Server group associated with this server.
The following parameters are available in the tacacs_server type.
namevar
The name of the tacacs server group.
Configure a tacacs server group.
The following properties are available in the tacacs_server_group type.
Valid values: present, absent.
The basic property that the resource should be in.
Default value: present
Array of servers associated with this group.
The source interface used for TACACS packets.
The VRF associated with source_interface.
The following parameters are available in the tacacs_server_group type.
namevar
The name of the tacacs server group.
Configure a VRF.
The following parameters are available in the vrf type.
namevar
The name of the VRF.
Optional[String]
Address qualifier for the VRF, used to amintain uniqueness among identical routes.
Optional[Array[Tuple[Enum["export", "import", "both"], String]]]
Address qualifier for the VRF, used to share routes between multiple VRFs.
Optional[String]
Associates a route map with the VRF.
This section describes how to get started developing providers for the types implemented in this module.
First, configure a Ruby development environment. There are multiple ways to accomplish this task including rvm, rbenv, and crossfader. This module has been developed using crossfader, a pre-packaged build of multiple Ruby versions specifically designed for developing and extending Puppet.
Please follow the Crossfader Quick Start instructions to get started with crossfader on Mac OS X.
Once crossfader is installed, select the version of Ruby currently shipping with Puppet Enterprise. At the time of writing this is currently Ruby 1.9.3-p484. Information on the current version of Ruby shipping with Puppet Enterprise is available at Puppet Enterprise Software Components.
$ eval "$(crossfader --ruby 1.9.3-p484 --gemset netdev shellinit)"
Once initialized, verify the environment is using the specified version of ruby
with the gem env command.
$ gem env
RubyGems Environment:
- RUBYGEMS VERSION: 1.8.23
- RUBY VERSION: 1.9.3 (2013-11-22 patchlevel 484) [x86_64-darwin13.0.0]
- INSTALLATION DIRECTORY: /opt/crossfader/versions/ruby/1.9.3-p484/gemsets/netdev/ruby/1.9.1
- RUBY EXECUTABLE: /opt/crossfader/versions/ruby/1.9.3-p484/bin/ruby
- EXECUTABLE DIRECTORY: /opt/crossfader/versions/ruby/1.9.3-p484/gemsets/netdev/ruby/1.9.1/bin
- RUBYGEMS PLATFORMS:
- ruby
- x86_64-darwin-13
- GEM PATHS:
- /opt/crossfader/versions/ruby/1.9.3-p484/gemsets/netdev/ruby/1.9.1
- /opt/crossfader/versions/ruby/1.9.3-p484/gemsets/global/ruby/1.9.1
- /opt/crossfader/versions/ruby/1.9.3-p484/lib/ruby/gems/1.9.1
- /Users/jeff/.gem/ruby/1.9.1
- GEM CONFIGURATION:
- :update_sources => true
- :verbose => true
- :benchmark => false
- :backtrace => false
- :bulk_threshold => 1000
- REMOTE SOURCES:
- http://rubygems.org/
Clone this repository into your local development workspace.
$ git clone https://github.com/puppetlabs/netdev_stdlib
Cloning into 'netdev_stdlib'...
remote: Counting objects: 595, done.
remote: Compressing objects: 100% (172/172), done.
remote: Total 595 (delta 264), reused 587 (delta 261)
Receiving objects: 100% (595/595), 76.83 KiB | 0 bytes/s, done.
Resolving deltas: 100% (264/264), done.
Checking connectivity... done.
The types depend primarily on Puppet which itself has a set of dependencies. All of these additional software components should be installed using bundler when developing the types and providers.
$ cd netdev_stdlib/
$ bundle install --path .bundle/gems/
Fetching gem metadata from https://rubygems.org/.........
Resolving dependencies...
Installing rake (10.1.1)
Installing CFPropertyList (2.2.8)
Installing ast (2.0.0)
Installing slop (3.6.0)
Installing parser (2.2.0.pre.4)
Installing astrolabe (1.3.0)
Installing timers (1.1.0)
Installing celluloid (0.15.2)
Installing coderay (1.1.0)
Installing diff-lcs (1.2.5)
Installing docile (1.1.5)
Installing facter (2.2.0)
Installing ffi (1.9.3)
Installing formatador (0.2.5)
Installing rb-fsevent (0.9.4)
Installing rb-inotify (0.9.5)
Installing listen (2.7.9)
Installing lumberjack (1.0.9)
Installing method_source (0.8.2)
Installing pry (0.10.1)
Installing thor (0.19.1)
Installing guard (2.6.1)
Installing rspec-core (2.13.1)
Installing rspec-expectations (2.13.0)
Installing rspec-mocks (2.13.1)
Installing rspec (2.13.0)
Installing guard-rspec (3.1.0)
Installing powerpack (0.0.9)
Installing rainbow (2.0.0)
Installing ruby-progressbar (1.5.1)
Installing rubocop (0.26.0)
Installing guard-rubocop (1.1.0)
Installing json_pure (1.8.1)
Installing hiera (1.3.4)
Installing metaclass (0.0.4)
Installing mocha (1.1.0)
Installing multi_json (1.10.1)
Installing yard (0.8.7.4)
Installing pry-doc (0.6.0)
Installing rgen (0.6.6)
Installing puppet (3.6.2)
Installing puppet-lint (1.0.1)
Installing puppet-syntax (1.3.0)
Installing rspec-puppet (1.0.1)
Installing puppetlabs_spec_helper (0.8.1)
Installing simplecov-html (0.8.0)
Installing simplecov (0.9.0)
Using bundler (1.3.6)
Your bundle is complete!
It was installed into ./.bundle/gems
bundle install --path .bundle/gems/ 7.74s user 1.99s system 45% cpu 21.569 total
Before starting development of the types or providers, make sure the current branch is known-good by automatically validating expected behavior against actual behavior.
$ bundle exec rspec spec/
.........................................
Finished in 2.43 seconds
1213 examples, 0 failures
Coverage report generated for Unit Tests to /netdev_stdlib/coverage/. 512 / 519 LOC (98.65%) covered.
bundle exec rspec spec 3.59s user 0.27s system 99% cpu 3.896 total
If the types are being changed, the spec tests may be automatically run in response to file system change events using guard.
$ bundle exec guard
16:52:13 - INFO - Guard is using Tmux to send notifications.
16:52:13 - INFO - Guard is using TerminalTitle to send notifications.
16:52:13 - INFO - Guard::RSpec is running
16:52:13 - INFO - Inspecting Ruby code style of all files
16:52:16 - INFO - Guard is now watching at '/netdev_stdlib'
[1] guard(main)>
For a platform named foo, the following section describes how to implement a
module containing providers for the netdev_stdlib types.
The basic process for implementing providers for these types are as follows.
First, create a parent directory for use as the module directory. This parent
directory will contain the netdev_stdlib module and the netdev_stdlib_foo
module. For example, /workspace/netdev/.
Clone the netdev_stdlib into the module directory, for example
/workspace/netdev/netdev_stdlib and install dependencies using bundler as
described in Getting Started for Development.
With a current working directory of the type module, generate the provider
module using puppet module generate:
$ cd /workspace/netdev/netdev_stdlib/
$ bundle exec puppet module generate acme-netdev_stdlib_foo
We need to create a metadata.json file for this module. Please answer the
following questions; if the question is not applicable to this module, feel free
to leave it blank.
Puppet uses Semantic Versioning (semver.org) to version modules.
What version is this module? [0.1.0]
--> 0.1.0
Who wrote this module? [acme]
--> acme
What license does this module code fall under? [Apache 2.0]
-->
How would you describe this module in a single sentence?
--> Acme Foo platform providers for the Network Device Standard Library types
Where is this module's source code repository?
--> https://github.com/acme/netdev_stdlib_foo
Where can others go to learn more about this module? [https://github.com/acme/netdev_stdlib_foo]
-->
Where can others go to file issues about this module? [https://github.com/acme/netdev_stdlib_foo/issues]
-->
----------------------------------------
{
"name": "acme-netdev_stdlib_foo",
"version": "0.1.0",
"author": "acme",
"summary": "Acme Foo platform providers for the Network Device Standard Library types",
"license": "Apache 2.0",
"source": "https://github.com/acme/netdev_stdlib_foo",
"project_page": "https://github.com/acme/netdev_stdlib_foo",
"issues_url": "https://github.com/acme/netdev_stdlib_foo/issues",
"dependencies": [
{
"name": "puppetlabs-stdlib",
"version_range": ">= 1.0.0"
}
]
}
----------------------------------------
About to generate this metadata; continue? [n/Y]
Notice: Generating module at /workspace/serious/src/modules/netdev/test/netdev_stdlib/acme-netdev_stdlib_foo...
Notice: Populating ERB templates...
Finished; module generated in acme-netdev_stdlib_foo.
acme-netdev_stdlib_foo/manifests
acme-netdev_stdlib_foo/manifests/init.pp
acme-netdev_stdlib_foo/metadata.json
acme-netdev_stdlib_foo/Rakefile
acme-netdev_stdlib_foo/README.md
acme-netdev_stdlib_foo/spec
acme-netdev_stdlib_foo/spec/classes
acme-netdev_stdlib_foo/spec/classes/init_spec.rb
acme-netdev_stdlib_foo/spec/spec_helper.rb
acme-netdev_stdlib_foo/tests
acme-netdev_stdlib_foo/tests/init.pp
Move the skeleton into the module directory:
$ mv acme-netdev_stdlib_foo ../netdev_stdlib_foo
$ cd ../netdev_stdlib_foo
The provider module has the same dependencies as the type module and so it is
easiest to simply copy the dependency information from the netdev_stdlib
type.
$ cp ../netdev_stdlib/{Gem,Guard}file .
Install the dependencies:
$ bundle install --path .bundle/gems/
Puppet Providers are generally tested with RSpec. Copy the spec helper, which initializes RSpec for module testing.
$ cp ../netdev_stdlib/spec/spec_helper.rb spec/
Remove the rspec-puppet generated example for a puppet class.
$ rm ./spec/classes/init_spec.rb
Test that rspec runs:
$ bundle exec rspec spec/
No examples found.
Finished in 0.00004 seconds
0 examples, 0 failures
The device API used by the provider should be modeled as a utility class in
PuppetX::NetDev::FooApi class, located at lib/puppet_x/net_dev/foo_api.rb.
Instance methods of this API class are suitable for mocking network based API
calls in the spec tests. For REST API's the response data from the resource
request should be serialized into a fixtures directory. These fixtures are
therefore able to be updated as API responses are changed or added over time.
For more information on rspec, please see https://github.com/rspec/rspec
Copyright 2014-2018 Puppet, Inc.
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.