This workflow map aids users, developers and maintainers of the cisco-cookbook project in selecting the appropriate document(s) for their task.
- User Guides
- README-agent-install : Agent Installation and Configuration Guide
- README-chef-provisioning : Automated Agent Installation and Configuration
- README-package-provider : Cisco Nexus Package Management using the Package Provider
- The remainder of this document is aimed at end users
- Developer Guides
- CONTRIBUTING : Contribution guidelines
- README-develop-resources-providers : Developing New cisco-cookbook Resources and Providers
- Maintainers Guides
- README-maintainers : Guidelines for core maintainers of the cisco-cookbook project
- All developer guides apply to maintainers as well
Please see Learning Resources for additional references.
--
The cisco-cookbook
allows a network administrator to manage Cisco Network Elements using Chef. This cookbook bundles a set of Chef Resources, providers, Sample Recipes and installation Tools for effective network management. The resources and capabilities provided by this cookbook will grow with contributions from Cisco, Chef Software Inc., and the open source community.
The Cisco Network Elements and Operating Systems managed by this cookbook are continuously expanding. Please refer to the Provider Support Across Platforms section for details on currently supported hardware and software. The Chef and Ruby Requirements section also provides details on compatible Chef client and Ruby versions.
This GitHub repository contains the latest version of the cisco-cookbook source code. Supported versions of the cisco-cookbook are available at Chef Supermarket. Please refer to SUPPORT for additional details.
Contributions to this cookbook are welcome. Guidelines on contributions to the cookbook are captured in CONTRIBUTING
This cookbook enables management of supported Cisco Network Elements using Chef. This cookbook enhances the Chef DSL by introducing new Chef Resources and Providers capable of managing network elements.
The set of supported network element platforms is continuously expanding. Please refer to the Provider Support Across Platforms section for an overview of currently supported platforms.
The cisco-cookbook
is installed on the Chef server. Please see The Chef Server for information on Chef server setup. See Chef's knife cookbook site for general information on Chef cookbook installation.
The Chef Client (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 document for detailed instructions on agent installation and configuration on Cisco Nexus devices.
The cisco-cookbook has dependencies on a few ruby gems. These gems are already installed in the cookbook as vendored gems so there are no additional steps required for installing these gems. The gems are shown here for reference only:
Place a dependency on cisco-cookbook in your cookbook's metadata.rb
depends 'cisco-cookbook', '~> 1.0'
See the recipes directory for example usage of cisco providers and resources.
- Cisco NX-OS Chef implementation requires Chef version 12.6.0
- Ruby 2.0 or higher (preferably from the Chef full-stack installer)
A note about support for specific platform models:
Platform Models
Platform | Description | Environments |
---|---|---|
N9k | Support includes all N9xxx models | bash-shell, guestshell |
N3k | Support includes N30xx and N31xx models only. The N35xx model is not supported. |
bash-shell, guestshell |
N5k | Support includes N56xx models only. The N50xx and N55xx models are not supported at this time. |
Open Agent Container (OAC) |
N6k | Support includes all N6xxx models | Open Agent Container (OAC) |
N7k | Support includes all N7xxx models | Open Agent Container (OAC) |
N9k-F | Support includes all N95xx models running os version 7.0(3)Fx(x) | bash-shell, guestshell |
âś… = Supported
N9k | N3k | N5k | N6k | N7k | N9k-F | Caveats | |
---|---|---|---|---|---|---|---|
cisco_command_config | âś… | âś… | âś… | âś… | âś… | âś… | |
cisco_interface | âś… | âś… | âś…* | âś…* | âś… | âś… | Caveat |
cisco_interface_ospf | âś… | âś… | âś… | âś… | âś… | âś… | |
cisco_ospf | âś… | âś… | âś… | âś… | âś… | âś… | |
cisco_ospf_vrf | âś… | âś… | âś… | âś… | âś… | âś… | |
cisco_snmp_community | âś… | âś… | âś… | âś… | âś… | âś… | |
cisco_snmp_group | âś… | âś… | âś… | âś… | âś… | âś… | |
cisco_snmp_server | âś… | âś… | âś… | âś… | âś… | âś… | |
cisco_snmp_user | âś… | âś… | âś… | âś… | âś… | âś… | |
cisco_tacacs_server | âś… | âś… | âś… | âś… | âś… | âś… | |
cisco_tacacs_server_host | âś… | âś… | âś… | âś… | âś… | âś… | |
cisco_vlan | âś… | âś… | âś… | âś… | âś… | âś… | |
cisco_vtp | âś… | âś… | âś… | âś… | âś… | âś… |
-
Miscellaneous Types
-
Interface Types
-
OSPF Types
-
SNMP Types
-
TACACS Types
-
VLAN Types
--
cisco_command_config
cisco_interface
cisco_interface_ospf
cisco_ospf
cisco_ospf_vrf
cisco_snmp_community
cisco_snmp_group
cisco_snmp_server
cisco_snmp_user
cisco_tacacs_server
cisco_tacacs_server_host
cisco_vlan
cisco_vtp
--
The following resources are listed alphabetically.
Minimum Requirements | N9k | N3k | N5k | N6k | N7k | N9k-F |
---|---|---|---|---|---|---|
OS Image | 7.0(3)I2(1) | 7.0(3)I2(1) | 7.3(0)N1(1) | 7.3(0)N1(1) | 7.3(0)D1(1) | 7.0(3)F1(1) |
Cisco Cookbook Version | 1.0.1 | 1.0.1 | 1.1.0 | 1.1.0 | 1.1.0 | 1.2.0 |
The cisco_command_config
resource allows raw configurations to be managed by chef. It serves as a stopgap until specialized resources 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 - 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 configurations 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
, notEth1/1
- If a CLI command is rejected during configuration, the resource will abort at that point and will not continue to issue any remaining CLI. For this reason it is recommended to limit the scope of each instance of this resource.
cisco_command_config 'loop42' do
command '
interface loopback42
description Peering for AS 42
ip address 192.168.1.42/24
'
end
cisco_command_config 'route42' do
command ' ip route 192.168.42.42/32 Null0 '
end
command
- The sequence of configuration commands to apply.
The cisco_interface
resource is used to manage general configuration of all
interface types, including ethernet, port-channel, loopback, and SVI (vlan).
Minimum Requirements | N9k | N3k | N5k | N6k | N7k | N9k-F |
---|---|---|---|---|---|---|
OS Image | 7.0(3)I2(1) | 7.0(3)I2(1) | 7.3(0)N1(1) | 7.3(0)N1(1) | 7.3(0)D1(1) | 7.0(3)F1(1) |
Cisco Cookbook Version | 1.0.1 | 1.0.1 | 1.1.0 | 1.1.0 | 1.1.0 | 1.2.0 |
Property | Caveat Description |
---|---|
svi_autostate | Not supported on N56xx and N6k |
cisco_interface 'Ethernet1/1' do
action :create
ipv4_address '10.1.1.1'
ipv4_netmask_length 24
ipv4_proxy_arp true
ipv4_redirects true
shutdown true
switchport_mode 'disabled'
end
cisco_interface 'Ethernet1/2' do
action :create
access_vlan 100
shutdown false
switchport_mode 'access'
switchport_vtp true
end
Note that the setting of the switchport_mode
parameter influences which of the
other parameters are permitted. Not all interface types support all of the below
parameters.
-
interface_name
- The interface name, in lower case. Defaults to the resource name. -
access_vlan
- The access VLAN ID. Only valid withswitchport_mode
set toaccess
ortrunk
. -
description
- Descriptive label for this interface. -
encapsulation_dot1q
- Enable IEEE 802.1Q encapsulation of traffic on a specified subinterface. Valid values are integer, keyword 'default'. -
shutdown
- Set totrue
to administratively shut down this interface,false
to administratively enable this interface. -
ipv4_address
- IPv4 address to apply to this interface. Requiresipv4_netmask_length
. -
ipv4_netmask_length
- Netmask length of this interface's IPv4 address. Must be a value between0
and32
. Requiresipv4_address
. -
ipv4_proxy_arp
- Set totrue
to enable Proxy ARP on this interface,false
to disable Proxy ARP. -
ipv4_redirects
- Set tofalse
to disable ICMP redirects on this interface,true
to enable them. -
mtu
- Maximum Trasnmission Unit size for frames received and sent on the specified interface. Valid value is an integer. -
negotiate_auto
- Set totrue
orfalse
to enable or disable autonegotiation of interface speed. -
switchport_autostate_exclude
- Set totrue
orfalse
to exclude or include this interface from SVI calculations. Default value:false
. -
switchport_mode
- Interface switchport mode. Available options (depending on interface type) are 'disabled', 'access', 'tunnel', 'fex_fabric', 'trunk', 'default'. If set to 'default', the default mode for the interface type is used. -
switchport_trunk_allowed_vlan
- The allowed VLANs for the specified Ethernet interface. Valid values are string, keyword 'default'. -
switchport_trunk_native_vlan
- The Native VLAN assigned to the switch port. Valid values are integer, keyword 'default' -
switchport_vtp
- Set totrue
orfalse
to enable or disable VTP on this interface. Default value:false
. -
svi_autostate
- Enable/disable SVI autostate. Default value:true
. Only applicable to SVI (vlan
) interfaces. -
svi_management
- Enable/disable SVI management. Default value:false
. Only applicable to SVI (vlan
) interfaces. -
vrf
- Specify the vrf membership of this interface. Value must be a string.
-
:create
- Creates and/or updates the interface configuration. -
:destroy
- Unconfigures and/or deletes the interface.
Note that logical interfaces (loopback, SVI, etc.) can be created/destroyed, while physical interfaces (Ethernet, etc.) can only be configured/unconfigured. The same actions apply regardless.
Minimum Requirements | N9k | N3k | N5k | N6k | N7k | N9k-F |
---|---|---|---|---|---|---|
OS Image | 7.0(3)I2(1) | 7.0(3)I2(1) | 7.3(0)N1(1) | 7.3(0)N1(1) | 7.3(0)D1(1) | 7.0(3)F1(1) |
Cisco Cookbook Version | 1.0.1 | 1.0.1 | 1.1.0 | 1.1.0 | 1.1.0 | 1.2.0 |
The cisco_interface_ospf
resource is used to manage per-interface OSPF
configuration properties. More broadly applicable OSPF configuration is
managed by the cisco_ospf
and cisco_ospf_vrf
resources.
cisco_interface_ospf 'Ethernet1/2' do
action :create
ospf 'Sample'
area 200
cost 200
dead_interval 200
hello_interval 200
message_digest true
message_digest_encryption_type 'cisco_type_7'
message_digest_algorithm_type 'md5'
message_digest_key_id 7
message_digest_password '088199c89d4a5ee'
passive_interface true
end
-
interface_name
- The interface name, in lower case. Defaults to the resource name. -
ospf
- The OSPF process name. Required. -
area
- The OSPF area. Required. -
cost
- The OSPF link cost for this interface. Default is0
, meaning to calculate cost automatically. -
dead_interval
- The OSPF dead interval on this interface, in seconds. Default value:40
. -
hello_interval
- The OSPF hello interval on this interface, in seconds. Default value:10
. -
message_digest
- Enable or disable message-digest authentication on on the interface. Available options aretrue
andfalse
. Default value:false
. -
message_digest_algorithm_type
- OSPF message digest algorithm. Default value:md5
, which is currently the only supported value. -
message_digest_encryption_type
- Encryption type for the message digest password. Available options are'cleartext'
,'3des'
, and'cisco_type_7'
. Default value:'cleartext'
. -
message_digest_key_id
- The key ID to use for message digest authentication. Valid values are numbers from0
to255
, with0
(the default value) indicating message digest authentication is disabled. -
message_digest_password
- The message digest key (password), in the format specified bymessage_digest_encryption
. -
passive_interface
- Set totrue
orfalse
to suppress or permit OSPF routing updates on this interface.
-
:create
- Creates and/or updates the OSPF configuration on the interface. -
:destroy
- Removes all OSPF configuration on the interface.
Minimum Requirements | N9k | N3k | N5k | N6k | N7k | N9k-F |
---|---|---|---|---|---|---|
OS Image | 7.0(3)I2(1) | 7.0(3)I2(1) | 7.3(0)N1(1) | 7.3(0)N1(1) | 7.3(0)D1(1) | 7.0(3)F1(1) |
Cisco Cookbook Version | 1.0.1 | 1.0.1 | 1.1.0 | 1.1.0 | 1.1.0 | 1.2.0 |
The cisco_ospf
resource is used to enable/disable OSPF on the switch.
More detailed OSPF configuration is managed by the cisco_ospf_vrf
and
cisco_interface_ospf
resources.
cisco_ospf 'Sample' do
action :create
end
name
- The name of the OSPF process. Defaults to the resource name.
-
:create
- Enables the given OSPF process, first configuringfeature ospf
if necessary. -
:destroy
- Destroys the given OSPF process. If no OSPF configuration remains, will also disablefeature ospf
.
Minimum Requirements | N9k | N3k | N5k | N6k | N7k | N9k-F |
---|---|---|---|---|---|---|
OS Image | 7.0(3)I2(1) | 7.0(3)I2(1) | 7.3(0)N1(1) | 7.3(0)N1(1) | 7.3(0)D1(1) | 7.0(3)F1(1) |
Cisco Cookbook Version | 1.0.1 | 1.0.1 | 1.1.0 | 1.1.0 | 1.1.0 | 1.2.0 |
The cisco_ospf_vrf
resource is used to manage per-VRF OSPF configuration,
including the default
VRF.
cisco_ospf_vrf 'dark_blue default' do
auto_cost 45000
default_metric 5
log_adjacency 'detail'
timer_throttle_lsa_start 5
timer_throttle_lsa_hold 5500
timer_throttle_lsa_max 5600
timer_throttle_spf_start 250
timer_throttle_spf_hold 1500
timer_throttle_spf_max 5500
end
cisco_ospf_vrf 'dark_blue vrf1' do
auto_cost 46000
default_metric 10
log_adjacency 'log'
timer_throttle_lsa_start 8
timer_throttle_lsa_hold 5600
timer_throttle_lsa_max 5800
timer_throttle_spf_start 277
timer_throttle_spf_hold 1700
timer_throttle_spf_max 5700
end
-
ospf
- Name of the parent OSPF process. Defaults to the first word of the resource name. -
vrf
- Name of the VRF to apply OSPF configuration to. Defaults to the second word of the resource name. A value ofdefault
refers to the default VRF. -
auto_cost
- The reference bandwidth, in Mbps, used to calculate interface default metrics. Default value:40000
. -
default_metric
- The default cost metric for redistributed routes. -
log_adjacency
- Whether to generate system log messages whenever a neighbor changes state. Available options are'none'
,'log'
, or'detail'
. Default value:'none'
. -
router_id
- IPv4 address to use as a router-id for OSPF. -
timer_throttle_lsa_start
- LSA generation start interval, in milliseconds. Default value:0
. -
timer_throttle_lsa_hold
- LSA generation hold interval, in milliseconds. Default value:5000
. -
timer_throttle_lsa_max
- LSA generation maximum interval, in milliseconds. Default value:5000
. -
timer_throttle_spf_start
- Initial SPF schedule delay, in milliseconds. Default value:200
. -
timer_throttle_spf_hold
- Minimum hold time between SPF calculations, in milliseconds. Default value:1000
. -
timer_throttle_spf_max
- Maximum wait time between SPF calculations, in milliseconds. Default value:5000
.
-
:create
- Enables the given OSPF process for the given VRF. -
:destroy
- Removes the given VRF from the given OSPF process.
Minimum Requirements | N9k | N3k | N5k | N6k | N7k | N9k-F |
---|---|---|---|---|---|---|
OS Image | 7.0(3)I2(1) | 7.0(3)I2(1) | 7.3(0)N1(1) | 7.3(0)N1(1) | 7.3(0)D1(1) | 7.0(3)F1(1) |
Cisco Cookbook Version | 1.0.1 | 1.0.1 | 1.1.0 | 1.1.0 | 1.1.0 | 1.2.0 |
The cisco_package
resource is a subclass of the Chef yum_package
resource.
Unlike yum_package
, it will always install packages into the NX-OS native
environment, even if the Chef agent is running within guestshell
.
cookbook_file '/bootflash/demo-one-1.0-1.x86_64.rpm' do
owner 'root'
group 'root'
mode '0775'
source 'rpm-store/demo-one-1.0-1.x86_64.rpm'
end
cisco_package 'demo-one' do
action :install
source '/bootflash/demo-one-1.0-1.x86_64.rpm'
end
See https://docs.chef.io/resource_package.html
See https://docs.chef.io/resource_package.html
Minimum Requirements | N9k | N3k | N5k | N6k | N7k | N9k-F |
---|---|---|---|---|---|---|
OS Image | 7.0(3)I2(1) | 7.0(3)I2(1) | 7.3(0)N1(1) | 7.3(0)N1(1) | 7.3(0)D1(1) | 7.0(3)F1(1) |
Cisco Cookbook Version | 1.0.1 | 1.0.1 | 1.1.0 | 1.1.0 | 1.1.0 | 1.2.0 |
The cisco_snmp_community
resource is used to manage SNMP communities.
cisco_snmp_community 'setcom' do
action :create
acl 'testcomacl'
group 'network-admin'
end
-
community
- Name of the SNMP community to manage. Defaults to the resource name. -
acl
- Access control list (ACL) to filter SNMP requests. Default value: '', indicating no ACL. -
group
- SNMP group name. Default value:network-operator
.
-
:create
- Create or update the given SNMP community. -
:destroy
- Destroy the given SNMP community.
Minimum Requirements | N9k | N3k | N5k | N6k | N7k | N9k-F |
---|---|---|---|---|---|---|
OS Image | 7.0(3)I2(1) | 7.0(3)I2(1) | 7.3(0)N1(1) | 7.3(0)N1(1) | 7.3(0)D1(1) | 7.0(3)F1(1) |
Cisco Cookbook Version | 1.0.1 | 1.0.1 | 1.1.0 | 1.1.0 | 1.1.0 | 1.2.0 |
The cisco_snmp_group
resource is used to manage SNMP groups. Cisco NX-OS
defines SNMP groups based on user roles, so this resource is unable to create
or delete groups but can only be used to validate that the group exists or not.
cisco_snmp_group 'network-admin' do
action :create
end
group
- SNMP group name. Defaults to the resource name.
-
:create
- Ensure that the given group exists, or raise an error if not. -
:destroy
- Ensure that the given group does not exist, or raise an error.
Minimum Requirements | N9k | N3k | N5k | N6k | N7k | N9k-F |
---|---|---|---|---|---|---|
OS Image | 7.0(3)I2(1) | 7.0(3)I2(1) | 7.3(0)N1(1) | 7.3(0)N1(1) | 7.3(0)D1(1) | 7.0(3)F1(1) |
Cisco Cookbook Version | 1.0.1 | 1.0.1 | 1.1.0 | 1.1.0 | 1.1.0 | 1.2.0 |
The cisco_snmp_server
resource is used to manage the SNMP server configuration
on a node. There can only be one instance of this resource per node.
cisco_snmp_server 'default' do
aaa_user_cache_timeout 1000
contact 'user1'
global_enforce_priv true
location 'rtp'
packet_size 2500
protocol false
tcp_session_auth false
end
-
name
- Must bedefault
. -
aaa_user_cache_timeout
- Time in seconds before entries in the AAA user cache time out. Default value:3600
. -
contact
- SNMP system contact (sysContact). -
global_enforce_priv
- Used to enable/disable SNMP message encryption for all users. Default value:true
. -
location
- SNMP location (sysLocation). -
packet_size
- Maximum SNMP packet size. Default value:1500
. -
protocol
- Used to enable/disable the SNMP protocol. Default value:true
. -
tcp_session_auth
- Used to enable/disable one-time authentication for SNMP over a TCP session. Default value:true
.
:update
- Apply changes to the SNMP server configuration as necessary.
Minimum Requirements | N9k | N3k | N5k | N6k | N7k | N9k-F |
---|---|---|---|---|---|---|
OS Image | 7.0(3)I2(1) | 7.0(3)I2(1) | 7.3(0)N1(1) | 7.3(0)N1(1) | 7.3(0)D1(1) | 7.0(3)F1(1) |
Cisco Cookbook Version | 1.0.1 | 1.0.1 | 1.1.0 | 1.1.0 | 1.1.0 | 1.2.0 |
The cisco_snmp_user
resource is used to manage SNMP user configuration.
cisco_snmp_user 'v3test' do
groups ['network-admin']
end
cisco_snmp_user 'withengine 128:128:127:127:124:2' do
auth_password 'Plus+Minus-'
auth_protocol 'md5'
groups ['network-admin']
localized_key false
priv_password 'Minus-Plus+'
priv_protocol 'des'
end
-
user
- The username to manage. Defaults to the first word of the resource name. -
engine_id
- SNMP user engineID. Defaults to the second word of the resource name, if any, else ''. Valid values are '' or a string consisting of 5 to 32 colon-separated decimal octets. -
auth_password
- User authentication password. -
auth_protocol
- Authentication protocol to use. Available options are'md5'
,'sha
', or'none'
. Default value:md5
. -
groups
- Array of strings representing the SNMP group(s) that the user belongs to. -
localized_key
- Set totrue
if theauth_password
andpriv_password
are in localized key format,false
if they are in cleartext format. -
priv_protocol
- Privacy protocol to use. Available options are'des'
and'aes128'
. Default value:des
. -
priv_password
- User privacy password.
-
:create
- Create or update the given SNMP user. -
:destroy
- Destroy the given SNMP user.
Minimum Requirements | N9k | N3k | N5k | N6k | N7k | N9k-F |
---|---|---|---|---|---|---|
OS Image | 7.0(3)I2(1) | 7.0(3)I2(1) | 7.3(0)N1(1) | 7.3(0)N1(1) | 7.3(0)D1(1) | 7.0(3)F1(1) |
Cisco Cookbook Version | 1.0.1 | 1.0.1 | 1.1.0 | 1.1.0 | 1.1.0 | 1.2.0 |
The cisco_tacacs_server
resource is used to manage global TACACS+ server
configuration. There can only be one instance of this resource per node.
cisco_tacacs_server 'default' do
action :create
deadtime 20
directed_request true
encryption_password 'test123'
encryption_type 'clear'
source_interface 'Ethernet1/2'
timeout 10
end
-
deadtime
- TACACS+ server deadtime interval, in minutes. -
directed_request
- Set to true to permit users to specify which server to query. Default value:false
. -
encryption_password
- Specifies the global TACACS+ server preshared key. -
encryption_type
- The encryption type for theencryption_password
. Available values are'clear'
,'encrypted'
, or'default'
. -
source_interface
- Global source interface for all TACACS+ server groups. -
timeout
- Global timeout interval for TACACS+ servers, in seconds. Default value:5
.
-
:create
- Enablefeature tacacs+
and apply any specified configuration. -
:update
- Update existing TACACS+ configuration. -
:destroy
- Disable TACACS+.
Minimum Requirements | N9k | N3k | N5k | N6k | N7k | N9k-F |
---|---|---|---|---|---|---|
OS Image | 7.0(3)I2(1) | 7.0(3)I2(1) | 7.3(0)N1(1) | 7.3(0)N1(1) | 7.3(0)D1(1) | 7.0(3)F1(1) |
Cisco Cookbook Version | 1.0.1 | 1.0.1 | 1.1.0 | 1.1.0 | 1.1.0 | 1.2.0 |
The cisco_tacacs_server_host
resource is used to manage per-host TACACS+
configuration.
cisco_tacacs_server_host 'testhost' do
action :create
encryption_password 'foobarpassword'
encryption_type 'clear'
port 66
timeout 33
end
-
name
- The hostname to manage. -
encryption_password
- The preshared key for this host. -
encryption_type
- The encryption type for theencryption_password
. Available values are'clear'
,'encrypted'
, or'default'
. -
port
- Server port for the host. Default value:49
. -
timeout
- Timeout interval for this host, in seconds. Default value:'0'
, indicating to inherit the global TACACS+ server timeout.
-
:create
- Create/update configuration for this TACACS+ server host. -
:destroy
- Remove all configuration for this host.
Minimum Requirements | N9k | N3k | N5k | N6k | N7k | N9k-F |
---|---|---|---|---|---|---|
OS Image | 7.0(3)I2(1) | 7.0(3)I2(1) | 7.3(0)N1(1) | 7.3(0)N1(1) | 7.3(0)D1(1) | 7.0(3)F1(1) |
Cisco Cookbook Version | 1.0.1 | 1.0.1 | 1.1.0 | 1.1.0 | 1.1.0 | 1.2.0 |
The cisco_vlan
resource is used to manage VLAN configuration.
cisco_vlan '220' do
action :create
shutdown true
state 'active'
vlan_name 'newtest'
end
-
name
- The VLAN ID, in the range 1-4096. Some values are reserved and may not be managed by Chef. -
shutdown
- Whether the VLAN is shut down. Default value:false
. -
state
- State of the VLAN. Accepted values are'active'
and'suspend'
. Default value:active
. -
vlan_name
- Descriptive name for the VLAN.
-
:create
- Create/update the specified VLAN. -
:destroy
- Delete the specified VLAN.
Minimum Requirements | N9k | N3k | N5k | N6k | N7k | N9k-F |
---|---|---|---|---|---|---|
OS Image | 7.0(3)I2(1) | 7.0(3)I2(1) | 7.3(0)N1(1) | 7.3(0)N1(1) | 7.3(0)D1(1) | 7.0(3)F1(1) |
Cisco Cookbook Version | 1.0.1 | 1.0.1 | 1.2.0 | 1.2.0 | 1.1.0 | 1.2.0 |
The cisco_vtp
resource is used to manage VLAN Trunking Protocol (VTP)
configuration. There can only be one instance of this resource per node.
cisco_vtp 'default' do
action :create
domain 'cisco1234'
filename 'bootflash:/vlan.dat'
password 'test1234'
version 2
end
-
domain
- VTP administrative domain. Required. -
filename
- VTP file name. Default value:bootflash:/vlan.dat
-
password
- VTP domain password. -
version
- VTP version number. Default value:1
.
-
:create
- Enablefeature vtp
and apply VTP configuration as requested. -
:destroy
- Disable VTP.
--
- Chef
- Markdown (for editing documentation)
- Ruby
- Ruby Gems
- YAML
- Yum
Copyright (c) 2014-2017 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.