cisco_node_utils 1.1.0 → 1.2.0

data/lib/cisco_node_utils/README_YAML.md

@@ -1,325 +0,0 @@
-# Command Reference YAML
-
-The `command_reference_*.yaml` files in this directory are used with the
-`CommandReference` module as a way to abstract away platform CLI differences.
-
-This document describes the structure and semantics of these files.
-
-## Structure
-
-```yaml
-FEATURE_1:
-  _template:
-    # base parameters for all attributes of this feature go here
-
-  ATTRIBUTE_1:
-    config_get: 'string'
-    config_get_token: 'string'
-    config_get_token_append: 'string'
-    config_set: 'string'
-    config_set_append: 'string'
-    default_value: string, boolean, integer, or constant
-    test_config_get: 'string'
-    test_config_get_regexp: '/regexp/'
-    test_config_result:
-      input_1: output_1
-      input_2: output_2
-
-  ATTRIBUTE_2:
-    ...
-
-  ATTRIBUTE_3:
-    ...
-
-FEATURE_2:
-  ...
-```
-
-All parameters are optional and may be omitted if not needed.
-
-### Wildcard substitution
-
-The `config_get_token` and `config_set` (and their associated `_append`
-variants) all support two forms of wildcarding - printf-style and key-value.
-
-#### Printf-style wildcards
-
-```yaml
-tacacs_server_host:
-  encryption:
-    config_set: '%s tacacs-server host %s key %s %s'
-```
-
-This permits parameter values to be passed as a simple sequence:
-
-```ruby
-config_set('tacacs_server_host', 'encryption', 'no', 'user', 'md5', 'password')
-
-# this becomes 'no tacacs-server host user key md5 password'
-#               ^^                    ^^^^     ^^^ ^^^^^^^^
-```
-
-This approach is quick to implement and concise, but less flexible - in
-particular it cannot handle a case where different platforms take parameters
-in a different order - and less readable in the ruby code.
-
-#### Key-value wildcards
-
-```yaml
-ospf:
-  auto_cost:
-    config_set: ['router ospf <name>', 'auto-cost reference-bandwidth <cost> <type>']
-```
-
-This requires parameter values to be passed as a hash:
-
-```ruby
-config_set('ospf', 'auto_cost', {:name => 'red',
-                                 :cost => '40',
-                                 :type => 'Gbps'})
-
-# this becomes the config sequence:
-#   router ospf red
-#    auto-cost reference-bandwidth 40 Gbps
-```
-
-This approach is moderately more complex to implement but is more readable in
-the ruby code and is flexible enough to handle significant platform
-differences in CLI. It is therefore the recommended approach for new
-development.
-
-### `_template`
-
-The optional `_template` section can be used to define base parameters for all
-attributes of a given feature. For example, all interface attributes might be
-checked with the `show running-config interface all` command, and all
-attributes might be set by first entering the interface configuration submode
-with the `interface <name>` configuration command. Thus, you might have:
-
-```yaml
-interface:
-  _template:
-    config_get: 'show running-config interface all'
-    config_get_token: '/^interface <name>$/'
-    config_set: 'interface <name>'
-
-  access_vlan:
-    config_get_token_append: '/^switchport access vlan (.*)$/'
-    config_set_append: 'switchport access vlan <number>'
-
-  description:
-    config_get_token_append: '/^description (.*)$/'
-    config_set_append: 'description <desc>'
-
-  ...
-```
-
-instead of the more repetitive (but equally valid):
-
-```yaml
-interface:
-  access_vlan:
-    config_get: 'show running interface all'
-    config_get_token: ['/^interface %s$/i', '/^switchport access vlan (.*)$/']
-    config_set: ['interface %s', 'switchport access vlan %s']
-
-  description:
-    config_get: 'show running-config interface all'
-    config_get_token: ['/^interface <name>$/i', '/^description (.*)$/']
-    config_set: ['interface <name>', 'description <desc>']
-
-  ...
-```
-
-### `config_get`
-
-`config_get` must be a single string representing the CLI command (usually a
-`show` command) to be used to display the information needed to get the
-current value of this attribute.
-
-```yaml
-    config_get: 'show running-config interface <name> all'
-```
-
-### `config_get_token`
-
-`config_get_token` can be a single string, a single regex, an array of strings,
-or an array of regexs.
-
-If this value is a string or array of strings, then the `config_get` command
-will be executed to produce _structured_ output and the string(s) will be
-used as lookup keys.
-
-```yaml
-show_version
-  cpu:
-    config_get: 'show version'
-    config_get_token: 'cpu_name'
-    # config_get('show_version', 'cpu') returns structured_output['cpu_name']
-```
-
-```yaml
-inventory:
-  productid:
-    config_get: 'show inventory'
-    config_get_token: ['TABLE_inv', 'ROW_inv', 0, 'productid']
-    # config_get('inventory', 'productid') returns
-    # structured_output['TABLE_inv']['ROW_inv'][0]['productid']
-```
-
-If this value is a regex or array or regexs, then the `config_get` command
-will be executed to produce _plaintext_ output.
-
-For a single regex, it will be used to match against the plaintext.
-
-```yaml
-memory:
-  total:
-    config_get: 'show system resources'
-    config_get_token: '/Memory.* (\S+) total/'
-    # config_get('memory', 'total') returns
-    # plaintext_output.scan(/Memory.* (\S+) total/)
-```
-
-For an array of regex, then the plaintext is assumed to be hierarchical in
-nature (like `show running-config`) and the regexs are used to filter down
-through the hierarchy.
-
-```yaml
-interface:
-  description:
-    config_get: 'show running interface all'
-    config_get_token: ['/^interface %s$/i', '/^description (.*)/']
-    # config_get('interface', 'description', 'Ethernet1/1') gets the plaintext
-    # output, finds the subsection under /^interface Ethernet1/1$/i, then finds
-    # the line matching /^description (.*)$/ in that subsection
-```
-
-### `config_get_token_append`
-
-When using a `_template` section, an attribute can use
-`config_get_token_append` to extend the `config_get_token` value provided by
-the template instead of replacing it:
-
-```yaml
-interface:
-  _template:
-    config_get: 'show running-config interface all'
-    config_get_token: '/^interface <name>$/'
-
-  description:
-    config_get_token_append: '/^description (.*)$/'
-    # config_get_token value for 'description' is now:
-    # ['/^interface %s$/i', '/^description (.*)$/']
-```
-
-This can also be used to specify conditional tokens which may or may not be
-used depending on the set of parameters passed into `config_get()`:
-
-```yaml
-bgp:
-  _template:
-    config_get: 'show running bgp all'
-    config_get_token: '/^router bgp <asnum>$/'
-    config_get_token_append:
-      - '/^vrf <vrf>$/'
-
-  router_id:
-    config_get_token_append: '/^router-id (\S+)$/'
-```
-
-In this example, both `config_get('bgp', 'router_id', {:asnum => '1'})` and
-`config_get('bgp', 'router_id', {:asnum => '1', :vrf => 'red'})` are valid -
-the former will match 'router bgp 1' followed by 'router-id', while the latter
-will match 'router bgp 1' followed by 'vrf red' followed by 'router-id'.
-
-### `config_set`
-
-The `config_set` parameter is a string or array of strings representing the
-configuration CLI command(s) used to set the value of the attribute.
-
-```yaml
-interface:
-  create:
-    config_set: 'interface <name>'
-
-  description:
-    config_set: ['interface <name>', 'description <desc>']
-```
-
-### `config_set_append`
-
-When using a `_template` section, an attribute can use `config_set_append` to
-extend the `config_set` value provided by the template instead of replacing it:
-
-```yaml
-interface:
-  _template:
-    config_set: 'interface <name>'
-
-  access_vlan:
-    config_set_append: 'switchport access vlan <number>'
-    # config_set value for 'access_vlan' is now:
-    # ['interface <name>', 'switchport access vlan <number>']
-```
-
-Much like `config_get_token_append`, this can also be used to specify optional
-commands that can be included or omitted as needed:
-
-```yaml
-bgp:
-  _template:
-    config_set: 'router bgp <asnum>'
-    config_set_append:
-      - 'vrf <vrf>'
-```
-
-### `default_value`
-
-If there is a default value for this attribute when not otherwise specified by
-the user, the `default_value` parameter describes it. This can be a string,
-boolean, integer, or array.
-
-```yaml
-interface:
-  description:
-    default_value: ''
-
-interface_ospf:
-  hello_interval:
-    default_value: 10
-
-ospf:
-  auto_cost:
-    default_value: [40, 'Gbps']
-```
-
-### `test_config_get` and `test_config_get_regex`
-
-Test-only equivalents to `config_get` and `config_get_token` - a show command
-to be executed over telnet by the minitest unit test scripts, and a regex
-(or array thereof) to match in the resulting plaintext output.
-Should only be referenced by test scripts, never by a feature provider itself.
-
-```yaml
-show_version:
-  boot_image:
-    test_config_get: 'show version | no-more'
-    test_config_get_regex: '/NXOS image file is: (.*)$/'
-```
-
-### `test_config_result`
-
-Test-only container for input-result pairs that might differ by platform.
-Should only be referenced by test scripts, never by a feature provider itself.
-
-```yaml
-vtp:
-  version:
-    test_config_result:
-      3: 'Cisco::CliError'
-```
-
-## Style Guide
-
-Please see [YAML Best Practices](../../docs/README-develop-best-practices.md#ydbp).

data/lib/cisco_node_utils/command_reference_common.yaml

@@ -1,1051 +0,0 @@
-# Command Reference Common 
-#
-# For documentation please see:
-#   - README_YAML.md
-#
----
-aaa_authentication_login:
-  ascii_authentication:
-    config_get: "show run aaa all"
-    config_get_token: '/^aaa authentication login ascii-authentication/'
-    config_set: "%s aaa authentication login ascii-authentication"
-    default_value: false
-
-  chap:
-    config_get: "show run aaa all"
-    config_get_token: '/^aaa authentication login chap enable/'
-    config_set: "%s aaa authentication login chap enable"
-    default_value: false
-
-  error_display:
-    config_get: "show run aaa all"
-    config_get_token: '/^aaa authentication login error-enable/'
-    config_set: "%s aaa authentication login error-enable"
-    default_value: false
-
-  mschap:
-    config_get: "show run aaa all"
-    config_get_token: '/^aaa authentication login mschap enable/'
-    config_set: "%s aaa authentication login mschap enable"
-    default_value: false
-
-  mschapv2:
-    config_get: "show run aaa all"
-    config_get_token: '/^aaa authentication login mschapv2 enable/'
-    config_set: "%s aaa authentication login mschapv2 enable"
-    default_value: false
-
-aaa_auth_login_service:
-  groups:
-    config_get: "show aaa authentication"
-    config_get_token: ["TABLE_AuthenMethods", "ROW_AuthenMethods"]
-    # this set is only used when there are groups to configure
-    config_set: "%s aaa authentication login %s group %s %s"
-    default_value: []
-
-  method:
-    config_get: "show aaa authentication"
-    #config_get_token: '/aaa authentication login %s (?:group (?:\S+ )+)?(local|none)$/'
-    config_get_token: '/^\s*%s:.*(local|none)\s*$/'
-    # this set is only used when there are no groups to configure
-    config_set: "%s aaa authentication login %s %s"
-    default_value: :local
-
-  services:
-    config_get: "show run aaa all"
-    #config_get_token: '/^\s*(\S+):/'
-    config_get_token: '/^aaa authentication login (\S+) (?:none|group|local)/'
-
-aaa_server_group:
-  deadtime:
-    default_value: 0
-
-  servers:
-    default_value: []
-
-  source_interface:
-    default_value: ""
-
-  tacacs_deadtime:
-    config_get: "show run tacacs all"
-    config_get_token: ['/^aaa group server tacacs\+ %s/', '/^deadtime (\d+)/']
-    config_set: ["aaa group server tacacs %s", "%s deadtime %s"]
-
-  tacacs_group:
-    config_set: "%s aaa group server tacacs %s"
-
-  tacacs_groups:
-    config_get: "show run tacacs all"
-    config_get_token: '/^aaa group server tacacs\+ (\S+)/'
-
-  tacacs_server:
-    config_set: ["aaa group server tacacs %s", "%s server %s"]
-
-  tacacs_servers:
-    config_get: "show run tacacs all"
-    config_get_token: ['/^aaa group server tacacs\+ %s/', '/^server (\S+)/']
-
-  tacacs_source_interface:
-    config_get: "show run tacacs all"
-    config_get_token: ['/^aaa group server tacacs\+ %s/', '/^source-interface (\S+)/']
-    config_set: ["aaa group server tacacs %s", "%s source-interface %s"]
-
-  tacacs_vrf:
-    config_get: "show run tacacs all"
-    config_get_token: ['/^aaa group server tacacs\+ %s/', '/^use-vrf (\S+)/']
-    config_set: ["aaa group server tacacs %s", "%s use-vrf %s"]
-
-  vrf:
-    default_value: "default"
-
-dnsclient:
-  domain_list:
-    config_get: "show running-config all"
-    config_get_token: '/^ip domain-list (\S+)$/'
-    config_set: '<state> ip domain-list <name>'
-    default_value: ''
-
-  domain_list_vrf:
-    config_get: "show running-config all"
-    config_get_token: ['/vrf context <vrf>/', '/ip domain-list (\S+)/']
-    config_set: ['vrf context <vrf>', '<state> ip domain-list <name>']
-    default_value: ''
-
-  domain_name:
-    config_get: 'show running-config all'
-    config_get_token: '/^ip domain-name (\S+)$/'
-    config_set: '<state> ip domain-name <name>'
-    default_value: ''
-
-  domain_name_vrf:
-    config_get: 'show running-config all'
-    config_get_token: ['/vrf context <vrf>/', '/ip domain-name (\S+)/']
-    config_set: ['vrf context <vrf>', '<state> ip domain-name <name>']
-    default_value: ''
-
-  name_server:
-    config_get: "show running-config all | include 'ip name-server' | exclude 'use-vrf'"
-    config_get_token: '/^ip name-server ([\s\d\.:]+)$/'
-    config_set: '<state> ip name-server <ip>'
-    default_value: ''
-
-fex:
-  feature:
-    config_get: "show feature-set"
-    config_get_token: '/^fex[\s\d]+(\w+)/'
-    config_set: "%s feature-set fex"
-
-  feature_install:
-    config_set: "%s install feature-set fex"
-
-images:
-  packages:
-    config_get: 'show install patches'
-    # Package state should always be some variant of Active or Inactive
-    config_get_token: '/^(\S+)\s+(\S*[aA]ctive.*)\s*$/'
-
-interface:
-  access_vlan:
-    config_get: "show running interface all"
-    config_get_token: ['/^interface %s$/i', '/^switchport access vlan (.*)$/']
-    config_set: ["interface %s", "switchport access vlan %s"]
-    default_value: 1
-
-  all_interfaces:
-    config_get: "show running interface all"
-    config_get_token: '/^interface (.*)/'
-
-  create:
-    config_set: "interface %s"
-
-  description:
-    config_get: "show running interface all"
-    config_get_token: ['/^interface %s$/i', '/^description (.*)/']
-    config_set: ["interface %s", "%s description %s"]
-    default_value: ""
-
-  destroy:
-    config_set: "no interface %s"
-
-  encapsulation_dot1q:
-    config_get: "show running interface all"
-    config_get_token: ['/^interface %s$/i', '/^encapsulation dot1q (.*)/']
-    config_set: ["interface %s", "%s encapsulation dot1q %s"]
-    default_value: ""
-
-  feature_lacp:
-    config_get: "show running | i ^feature"
-    config_get_token: '/^feature lacp$/'
-    config_set: "%s feature lacp"
-
-  feature_vlan:
-    config_get: "show running | i ^feature"
-    config_get_token: '/^feature interface-vlan$/'
-    config_set: "%s feature interface-vlan"
-
-  ipv4_addr_mask:
-    config_get: "show running interface all"
-    config_get_token: [
-    '/^interface %s$/i',
-    '/^ip address ([0-9\.]+)[\s\/](.*)/'
-    ]
-    config_set: ["interface %s", "%s ip address %s"]
-
-  ipv4_address:
-    default_value: ~
-
-  ipv4_netmask_length:
-    default_value: ~
-
-  ipv4_proxy_arp:
-    config_get: "show running interface all"
-    config_get_token: [
-    '/^interface %s$/i',
-    '/^ip proxy-arp$/'
-    ]
-    config_set: ["interface %s", "%s ip proxy-arp"]
-    default_value: false
-
-  ipv4_redirects_loopback:
-    config_get: "show running interface all"
-    config_get_token: [
-    '/^interface %s$/i',
-    '/^((?:no )?ip redirects)$/'
-    ]
-    config_set: ["interface %s", "%s ip redirects"]
-    default_value: true
-    test_config_get_regex: [!ruby/regexp '/^\s+no ip redirects/']
-    test_config_result:
-      false: RuntimeError
-      true: RuntimeError
-
-  ipv4_redirects_other_interfaces:
-    config_get: "show running interface all"
-    config_get_token: [
-    '/^interface %s$/i',
-    '/^((?:no )?ip redirects)$/'
-    ]
-    config_set: ["interface %s", "%s ip redirects"]
-    default_value: true
-    test_config_get_regex: [!ruby/regexp '/^\s+no ip redirects/']
-    test_config_result:
-      false: false
-      true: true
-
-  mtu:
-    config_get: "show running interface all"
-    config_get_token: ['/^interface %s$/i', '/^mtu (.*)$/']
-    config_set: ["interface %s", "%s mtu %s"]
-    default_value: 1500
-
-  negotiate_auto_ethernet:
-    config_get: "show running interface all"
-    config_get_token: [
-    '/^interface %s$/i',
-    '/^negotiate auto$/'
-    ]
-    config_set: ["interface %s", "%s negotiate auto"]
-    default_value: true
-    test_config_get_regex: [
-    !ruby/regexp '/^\s+no negotiate auto/',
-    !ruby/regexp '/^\s+negotiate auto/'
-    ]
-
-  negotiate_auto_portchannel:
-    config_get: "show running interface all"
-    config_get_token: [
-    '/^interface %s$/i',
-    '/^negotiate auto$/'
-    ]
-    config_set: ["interface %s", "%s negotiate auto"]
-    default_value: true
-    test_config_get_regex: [
-    !ruby/regexp '/^\s+no negotiate auto/',
-    !ruby/regexp '/^\s+negotiate auto/'
-    ]
-
-  negotiate_auto_other_interfaces:
-    default_value: false
-    test_config_result:
-      false: RuntimeError
-      true: RuntimeError
-
-  shutdown:
-    config_get: "show running interface all"
-    config_get_token: ['/^interface %s$/i', '/^shutdown$/']
-    config_set: ["interface %s", "%s shutdown"]
-
-  shutdown_ether_channel:
-    default_value: false
-
-  shutdown_ethernet_noswitchport_noshutdown:
-    default_value: false
-
-  shutdown_ethernet_noswitchport_shutdown:
-    default_value: false
-
-  shutdown_ethernet_switchport_noshutdown:
-    default_value: false
-
-  shutdown_ethernet_switchport_shutdown:
-    default_value: true
-
-  shutdown_loopback:
-    default_value: false
-
-  shutdown_vlan:
-    default_value: true
-
-  shutdown_unknown:
-    default_value: true
-
-  system_default_switchport:
-    config_get: "show running all | include 'system default'"
-    config_get_token: ['/^system default switchport$/']
-    # default_value: n/a. This is a user-configurable system default.
-
-  system_default_switchport_shutdown:
-    config_get: "show running all | include 'system default'"
-    config_get_token: ['/^system default switchport shutdown$/']
-    # default_value: n/a. This is a user-configurable system default.
-
-  system_default_svi_autostate:
-    config_get: "show running all | include 'system default'"
-    config_get_token: ['/^system default interface-vlan autostate$/']
-    # default_value: n/a. This is a user-configurable system default.
-
-  switchport:
-    config_get: "show running interface all"
-    config_get_token: ['/^interface %s$/i', '/^switchport$/']
-    config_set: ["interface %s", "%s switchport"]
-    # default_value: n/a. This is derived from system_default_switchport
-
-  switchport_autostate_exclude:
-    config_get: "show running interface all"
-    config_get_token: ['/^interface %s$/i', '/(^switchport autostate exclude)/']
-    config_set: ["interface %s", "%s switchport autostate exclude"]
-    default_value: false
-
-  switchport_mode_ethernet:
-    config_get: "show running interface all"
-    config_get_token: ['/^interface %s$/i', '/^switchport mode (.*)$/']
-    config_set: ["interface %s", "%s switchport mode %s"]
-    default_value: "access"
-
-  switchport_mode_port_channel:
-    config_get: "show running interface all"
-    config_get_token: ['/^interface %s$/i', '/^switchport mode (.*)$/']
-    config_set: ["interface %s", "%s switchport mode %s"]
-    default_value: ""
-
-  switchport_mode_other_interfaces:
-    default_value: ""
-
-  switchport_mode_dot1q_tunnel:
-    test_config_result:
-      false: RuntimeError
-
-  switchport_trunk_allowed_vlan:
-    config_get: "show running interface all"
-    config_get_token: [
-      '/^interface %s$/i',
-      '/^switchport trunk allowed vlan (.*)$/'
-    ]
-    config_set: ["interface %s", "%s switchport trunk allowed vlan %s"]
-    default_value: "all"
-
-  switchport_trunk_native_vlan:
-    config_get: "show running interface all"
-    config_get_token: [
-      '/^interface %s$/i',
-      '/^switchport trunk native vlan (.*)$/'
-    ]
-    config_set: ["interface %s", "%s switchport trunk native vlan %s"]
-    default_value: 1
-
-  svi_autostate:
-    config_get: "show running interface all"
-    config_get_token: ['/^interface %s$/i', '/^autostate$/']
-    config_set: ["interface %s", "%s autostate"]
-    default_value: true
-    test_config_result:
-      false: false
-      true: true
-
-  svi_management:
-    config_get: "show running interface all"
-    config_get_token: ['/^interface %s$/i', '/^management$/']
-    config_set: ["interface %s", "%s management"]
-    default_value: false
-
-  vrf:
-    config_get: "show running interface all"
-    config_get_token: ['/^interface %s$/i', '/^vrf member (.*)/']
-    config_set: ["interface %s", "%s vrf member %s"]
-    default_value: ""
-
-  vtp:
-    config_get: "show running interface all"
-    config_get_token: ['/^interface %s$/i', '/^vtp *$/']
-    config_set: ["interface %s", "%s vtp"]
-    default_value: false
-
-interface_ospf:
-  area:
-    config_get: 'show running interface all'
-    config_get_token: ['/^interface %s$/i', '/^\s*ip router ospf (\S+) area (\S+)/']
-    config_set: ["interface %s", "%s ip router ospf %s area %s"]
-
-  cost:
-    config_get: 'show running interface all'
-    config_get_token: ['/^interface %s$/i', '/^\s*ip ospf cost (\d+)/']
-    config_set: ["interface %s", "%s ip ospf cost %s"]
-    default_value: 0
-
-  dead_interval:
-    config_get: 'show running interface all'
-    config_get_token: ['/^interface %s$/i', '/^\s*ip ospf dead-interval (\d+)/']
-    config_set: ["interface %s", "%s ip ospf dead-interval %s"]
-    default_value: 40
-    test_config_result: [262141]
-
-  hello_interval:
-    config_get: 'show running interface all'
-    config_get_token: ['/^interface %s$/i', '/^\s*ip ospf hello-interval (\d+)/']
-    config_set: ["interface %s", "%s ip ospf hello-interval %s"]
-    default_value: 10
-
-  message_digest:
-    config_get: 'show running interface all'
-    config_get_token: ['/^interface %s$/i', '/^\s*ip ospf authentication message-digest/']
-    config_set: ["interface %s", "%s ip ospf authentication message-digest"]
-    default_value: false
-
-  message_digest_alg_type:
-    config_get: 'show running interface all'
-    config_get_token: ['/^interface %s$/i', '/^\s*ip ospf message-digest-key \d+ (\S+)/']
-    default_value: 'md5'
-
-  message_digest_enc_type:
-    config_get: 'show running interface all'
-    config_get_token: ['/^interface %s$/i', '/^\s*ip ospf message-digest-key \d+ \S+ (\d+)/']
-    default_value: '0'
-
-  message_digest_password:
-    config_get: 'show running interface all'
-    config_get_token: ['/^interface %s$/i', '/^\s*ip ospf message-digest-key \d+ \S+ \d+ (\S+)/']
-
-  message_digest_key_id:
-    config_get: 'show running interface all'
-    config_get_token: ['/^interface %s$/i', '/^\s*ip ospf message-digest-key (\d+)/']
-    default_value: 0
-
-  message_digest_key_set:
-    config_set: ["interface %s", "%s ip ospf message-digest-key %s %s %s %s"]
-
-  passive_interface:
-    config_get: 'show running interface all'
-    config_get_token: ['/^interface %s$/i', '/^\s*ip ospf passive-interface/']
-    config_set: ["interface %s", "%s ip ospf passive-interface"]
-    default_value: false
-
-
-inventory:
-  all:
-    config_get: 'show inventory'
-    config_get_token: ["TABLE_inv", "ROW_inv"]
-
-  chassis:
-    config_get: 'show inventory'
-    config_get_token: ["TABLE_inv", "ROW_inv", {'name': '"Chassis"'}]
-
-  inventory:
-    test_config_get_regex: [
-    !ruby/regexp '/.*\nNAME: "(.+)",\s+DESCR: "(.+)"\nPID: (\S+)\s+, VID: (.+) , SN: (.+)\n/',
-    !ruby/regexp '/.*\nNAME: "(.+)",\s+DESCR: "(.+)"\nPID: (\S+)\s+, VID: (.+) , SN: (.+)\n/'
-    ]
-
-  productid:
-    config_get: "show inventory"
-    config_get_token: ["TABLE_inv", "ROW_inv", 0, "productid"]
-
-  serialnum:
-    config_get: "show inventory"
-    config_get_token: ["TABLE_inv", "ROW_inv", 0, "serialnum"]
-
-  versionid:
-    config_get: "show inventory"
-    config_get_token: ["TABLE_inv", "ROW_inv", 0, "vendorid"]
-
-ntp_config:
-  source_interface:
-    config_get: "show running-config ntp"
-    config_get_token: '/^ntp source-interface\s+(.*)$/'
-    config_set: '<state> ntp source-interface <source_interface>'
-    default_value: ''
-
-ntp_server:
-  server:
-    config_get: "show running-config all | include 'ntp server'"
-    config_get_token: '/ntp server ((?:[0-9]{1,3}\.){3}[0-9]{1,3})/'
-    config_set: '<state> ntp server <ip> <prefer>'
-    default_value: ''
-
-  prefer:
-    config_get: "show running-config all | include 'ntp server(.*)(prefer)'"
-    config_get_token: '/ntp server ((?:[0-9]{1,3}\.){3}[0-9]{1,3})/'
-    default_value: ''
-
-memory:
-  total:
-    config_get: 'show system resources'
-    config_get_token: '/Memory.* (\S+) total/'
-
-  used:
-    config_get: 'show system resources'
-    config_get_token: '/Memory.* (\S+) used/'
-
-  free:
-    config_get: 'show system resources'
-    config_get_token: '/Memory.* (\S+) free/'
-
-ospf:
-  _template:
-    config_get: "show running ospf all"
-    config_get_token: '/^router ospf <name>$/'
-    config_get_token_append:
-      - '/^vrf <vrf>$/'
-    config_set: "router ospf <name>"
-    config_set_append:
-      - "vrf <vrf>"
-
-  auto_cost:
-    config_get_token_append: '/^auto-cost reference-bandwidth (\d+)\s*(\S+)?$/'
-    config_set_append: "auto-cost reference-bandwidth <cost> <type>"
-    default_value: [40, "Gbps"]
-
-  default_metric:
-    config_get_token_append: '/^default-metric (\d+)?$/'
-    config_set_append: "<state> default-metric <metric>"
-    default_value: 0
-
-  feature:
-    config_get: "show running ospf"
-    config_get_token: '/^feature ospf$/'
-    config_set: "%s feature ospf"
-
-  log_adjacency:
-    config_get_token_append: '/^(log-adjacency-changes)\s*(detail)?$/'
-    config_set_append: "<state> log-adjacency-changes <type>"
-    default_value: :none
-
-  router:
-    config_get: "show running ospf"
-    config_get_token: '/^router ospf (\S+)$/'
-    config_set: "%s router ospf %s"
-
-  router_id:
-    config_get_token_append: '/^router-id (\S+)?$/'
-    config_set_append: "<state> router-id <router_id>"
-    default_value: ""
-
-  timer_throttle_lsa:
-    config_get_token_append: '/^timers throttle lsa (\d+) (\d+) (\d+)$/'
-    config_set_append: "timers throttle lsa <start> <hold> <max>"
-
-  timer_throttle_lsa_start:
-    default_value: 0
-
-  timer_throttle_lsa_hold:
-    default_value: 5000
-
-  timer_throttle_lsa_max:
-    default_value: 5000
-
-  timer_throttle_spf:
-    config_get_token_append: '/^timers throttle spf (\d+) (\d+) (\d+)$/'
-    config_set_append: "timers throttle spf <start> <hold> <max>"
-
-  timer_throttle_spf_start:
-    default_value: 200
-
-  timer_throttle_spf_hold:
-    default_value: 1000
-
-  timer_throttle_spf_max:
-    default_value: 5000
-
-  vrf:
-    config_get_token: ['/^router ospf <name>$/i', '/^vrf\s+(\S+)$/']
-    config_set: ["router ospf <name>", "<state> vrf <vrf>", "end"]
-
-radius_server:
-  hosts:
-    config_get: "show running-config radius"
-    config_get_token: '/^radius-server host ((?:[0-9]{1,3}\.){3}[0-9]{1,3})/'
-    config_set: '<state> radius-server host <ip>'
-    default_value: ''
-
-  auth-port:
-    config_get: "show running-config radius all"
-    config_get_token: '/^radius-server host %s.* auth-port (\d+).*$/'
-    config_set: '<state> radius-server host <ip> auth-port <port>'
-    default_value: 1812
-
-  acct-port:
-    config_get: "show running-config radius all"
-    config_get_token: '/^radius-server host %s.* acct-port (\d+).*$/'
-    config_set: '<state> radius-server host <ip> acct-port <port>'
-    default_value: 1813
-
-  timeout:
-    config_get: "show running-config radius all"
-    config_get_token: '/^radius-server host %s.* timeout (\d+).*$/'
-    config_set: '<state> radius-server host <ip> timeout <timeout>'
-    default_value: null
-
-  retransmit:
-    config_get: "show running-config radius all"
-    config_get_token: '/^radius-server host %s.* retransmit (\d+).*$/'
-    config_set: '<state> radius-server host <ip> retransmit <count>'
-    default_value: null
-
-  accounting:
-    config_get: "show running-config radius"
-    config_get_token: '/^radius-server host %s.* (accounting) .*$/'
-    config_set: '<state> radius-server host <ip> accounting'
-    default_value: true
-
-  authentication:
-    config_get: "show running-config radius"
-    config_get_token: '/^radius-server host %s.* (authentication) .*$/'
-    config_set: '<state> radius-server host <ip> authentication'
-    default_value: true
-
-  key_format:
-    config_get: "show running-config radius all"
-    config_get_token: '/^radius-server host %s.* key (\d).*$/'
-    default_value: null
-
-  key:
-    config_get: "show running-config radius all"
-    config_get_token: '/^radius-server host %s.* key \d+\s+(\S+)/'
-    config_set: '<state> radius-server host <ip> key <key>'
-    default_value: null
-
-radius_global:
-  timeout:
-    config_get: "show running-config radius all"
-    config_get_token: '/^radius-server timeout (\d+).*/'
-    config_set: '<state> radius-server timeout <timeout>'
-    default_value: '5'
-
-  retransmit:
-    config_get: "show running-config radius all"
-    config_get_token: '/^radius-server retransmit (\d+).*/'
-    config_set: '<state> radius-server retransmit <count>'
-    default_value: '1'
-
-  key_format:
-    config_get: "show running-config radius all"
-    config_get_token: '/^radius-server key (\d).*/'
-
-  key:
-    config_get: "show running-config radius all"
-    config_get_token: '/^radius-server key \d+\s+(\S+)/'
-    config_set: '<state> radius-server key <key>'
-
-show_system:
-  uptime:
-    config_get: 'show system uptime'
-    config_get_token: '/.*System uptime:\s+(\d+) days, (\d+) hours, (\d+) minutes, (\d+) seconds/'
-
-show_version:
-  board:
-    config_get: 'sh version'
-    config_get_token: 'proc_board_id'
-
-  boot_image:
-    config_get: "sh version"
-    config_get_token: "kick_file_name"
-    test_config_get: "sh version | no-more"
-    test_config_get_regex: !ruby/regexp '/.*NXOS image file is: (.*)$.*/'
-
-  cpu:
-    config_get: 'sh version'
-    config_get_token: 'cpu_name'
-
-  description:
-    config_get: "sh version"
-    config_get_token: "chassis_id"
-    test_config_get: "sh version | no-more"
-    # Hardware
-    #   cisco Nexus9000 C9396PX Chassis
-    #
-    # Other variants for the line of interest:
-    #   cisco Nexus9000 C9504 (4 Slot) Chassis ("Supervisor Module")
-    #                                          ^-module_id-ignore!-^
-    #   cisco Nexus3000 C3132Q Chassis
-    #   cisco N3K-C3048TP-1GE
-    test_config_get_regex: !ruby/regexp '/Hardware\n  cisco (([^(\n]+|\(\d+ Slot\))+\w+)/'
-
-  full:
-    config_get: "sh version"
-
-  header:
-    config_get: "sh version"
-    config_get_token: "header_str"
-
-  host_name:
-    config_get: "sh version"
-    config_get_token: "host_name"
-
-  last_reset_reason:
-    config_get: "sh version"
-    config_get_token: "rr_reason"
-    test_config_get: "sh version | no-more"
-    test_config_get_regex: !ruby/regexp '/.*\nLast reset.*\n\n?  Reason: (.*)\n/'
-
-  last_reset_time:
-    config_get: "sh version"
-    config_get_token: "rr_ctime"
-    test_config_get: "sh version | no-more"
-    test_config_get_regex: !ruby/regexp '/.*\nLast reset at \d+ usecs after  (.*)\n/'
-
-  system_image:
-    config_get: "sh version"
-    config_get_token: "kick_file_name"
-    test_config_get: "sh version | no-more"
-    test_config_get_regex: !ruby/regexp '/.*NXOS image file is: (.*)$.*/'
-
-  uptime:
-    config_get: 'show version'
-    config_get_token: '/uptime is (.*)/'
-
-  version:
-    config_get: "sh version"
-    test_config_get: "sh version | no-more"
-    config_get_token: "kickstart_ver_str"
-    test_config_get_regex: [
-    !ruby/regexp /\nkickstart_ver_str\s+(.+)\n/,
-    !ruby/regexp '/.*NXOS:\s+version (.*)\n/'
-    ]
-
-snmp_community:
-  acl:
-    config_get: "show running snmp all"
-    config_get_token: '/^snmp-server community %s use-acl (.*)$/'
-    config_set: "%s snmp-server community %s use-acl %s"
-    default_value: ""
-
-  all_communities:
-    config_get: "show running snmp all"
-    config_get_token: '/^snmp-server community (\S+) /'
-
-  community:
-    config_get: "show running snmp all"
-    config_get_token: '/^snmp-server community (%s) group .*$/'
-    config_set: "%s snmp-server community %s group %s"
-
-  group:
-    config_get: "show running snmp all"
-    config_get_token: '/^snmp-server community %s group (.*)$/'
-    config_set: "snmp-server community %s group %s"
-    default_value: "network-operator"
-
-snmp_group:
-  group:
-    config_get: "show snmp group"
-    config_get_token: "/^Role: (.*)$/"
-    default_value: ""
-
-snmp_server:
-  aaa_user_cache_timeout:
-    config_get: "show snmp internal globals"
-    config_get_token: '/AAA Cache Timeout :(\d+)/'
-    config_set: "%s snmp-server aaa-user cache-timeout %d"
-    default_value: 3600
-
-  contact:
-    config_get: "show snmp"
-    config_get_token: "sys_contact"
-    config_set: "%s snmp-server contact %s"
-    default_value: ""
-
-  global_enforce_priv:
-    config_get: "show run snmp"
-    config_get_token: '/snmp-server globalEnforcePriv/'
-    config_set: "%s snmp-server globalEnforcePriv"
-    default_value: false
-
-  location:
-    config_get: "show snmp"
-    config_get_token: "sys_location"
-    config_set: "%s snmp-server location %s"
-    default_value: ""
-
-  packet_size:
-    config_get: "show snmp internal globals"
-    config_get_token: '/SNMP Max packet size :(\d+)/'
-    config_set: "%s snmp-server packetsize %d"
-    default_value: 1500
-
-  protocol:
-    config_get: "show snmp"
-    config_get_token: "protocol_status"
-    config_set: "%s snmp-server protocol enable"
-    default_value: true
-
-  tcp_session_auth:
-    config_get: "show snmp"
-    config_get_token: "tcp_auth_status"
-    config_set: "%s snmp-server tcp-session %s"
-    default_value: true
-
-
-snmp_user:
-  auth_password:
-    config_get: "show run snmp all"
-    config_get_token: '/snmp-server user (\S+) \S+ auth \S+ (\S+)/'
-    default_value: ""
-
-  # The getter format will not have group info if engine id is configured.
-  auth_password_with_engine_id:
-    config_get: "show run snmp all"
-    config_get_token: '/snmp-server user (\S+) auth \S+ (\S+) .*engineID (\S+)/'
-    default_value: ""
-
-  auth_protocol:
-    default_value: "md5"
-
-  engine_id:
-    default_value: ""
-
-  group:
-    default_value: "network-operator"
-
-  priv_password:
-    config_get: "show run snmp all"
-    config_get_token: '/snmp-server user (\S+) \S+ auth \S+ \S+ priv.*(0x\S+)/'
-    default_value: ""
-
-  # The getter format will not have group info if engine id is configured.
-  priv_password_with_engine_id:
-    config_get: "show run snmp all"
-    config_get_token: '/snmp-server user (\S+) auth \S+ \S+ priv .*(0x\S+) .*engineID (\S+)/'
-    default_value: ""
-
-  priv_protocol:
-    default_value: "des"
-
-  # Config string syntax:
-  # [no] snmp-server user <user> [group] [auth {md5|sha} <passwd1> \
-  #       [priv [aes-128] <passwd2>] [localizedkey] [engineID <id>]]
-  user:
-    config_get: "show snmp user"
-    config_get_token: ["TABLE_snmp_users", "ROW_snmp_users"]
-    config_set: "%s snmp-server user %s %s %s %s %s %s"
-
-syslog_settings:
-  timestamp:
-    config_get: "show running-config all | include '^logging timestamp'"
-    config_get_token: '/^logging timestamp (.*)$/'
-    config_set: '<state> logging timestamp <units>'
-    default_value: 'seconds'
-
-syslog_server:
-  server:
-    config_get: "show running-config all | include '^logging server'"
-    config_get_token: '/^logging server ((?:[0-9]{1,3}\.){3}[0-9]{1,3}).*/'
-    config_set: '<state> logging server <ip> <level> <vrf>'
-    default_value: ''
-
-  level:
-    config_get: "show running-config all | include '^logging server'"
-    config_get_token: '/^logging server %s (\d).*/'
-    default_value: ''
-
-  vrf:
-    config_get: "show running-config all | include '^logging server(.*)(use-vrf)'"
-    config_get_token: '/^logging server %s.* use-vrf (.*)$/'
-    default_value: ''
-
-system:
-  resources:
-    config_get: "show system resources"
-    test_config_get: "show system resources | no-more"
-    test_config_get_regex: !ruby/regexp '/.*CPU states  :   (\d+\.\d+)% user,   (\d+\.\d+)% kernel/'
-      
-tacacs_server:
-  deadtime:
-    config_get: "show run tacacs all"
-    config_get_token: '/^tacacs-server deadtime\s+(\d+)/'
-    config_set: "%s tacacs-server deadtime %d"
-    default_value: 0
-
-  directed_request:
-    # oddly, directed request must be retrieved from aaa output
-    config_get: "show running aaa all"
-    config_get_token: '/(?:no)?\s*tacacs-server directed-request/'
-    config_set: "%s tacacs-server directed-request"
-    default_value: false
-
-  encryption_type:
-    config_get: "show run tacacs all"
-    config_get_token: '/^tacacs-server key (\d+)\s+(\S+)/'
-    default_value: 0
-
-  encryption_password:
-    config_get: "show run tacacs all"
-    config_get_token: '/^tacacs-server key (\d+)\s+(\S+)/'
-    default_value: ""
-
-  encryption:
-    config_set: "%s tacacs-server key %d %s"
-
-  feature:
-    config_get: "show run tacacs all"
-    config_get_token: '/^feature tacacs/'
-    config_set: "%s feature tacacs+"
-
-  source_interface:
-    config_get: "show run tacacs all"
-    config_get_token: '/(no)?\s*ip tacacs source-interface\s+(\S+)?/'
-    config_set: "%s ip tacacs source-interface %s"
-    default_value: ""
-
-  timeout:
-    config_get: "show run tacacs all"
-    config_get_token: '/tacacs-server timeout\s+(\d+)/'
-    config_set: "%s tacacs-server timeout %d"
-    default_value: 5
-
-tacacs_server_host:
-  encryption:
-    config_set: "%s tacacs-server host %s key %s %s"
-
-  encryption_password:
-    config_get: "show run tacacs all"
-    config_get_token: '/^tacacs-server host %s key \d+\s+(\S+)/'
-    default_value: ""
-
-  encryption_type:
-    config_get: "show run tacacs all"
-    config_get_token: '/^tacacs-server host %s key (\d+)/'
-
-  host:
-    config_set: "%s tacacs-server host %s"
-
-  hosts:
-    config_get: "show run tacacs all"
-    config_get_token: '/^tacacs-server host (\S+)/'
-
-  port:
-    config_get: "show run tacacs all"
-    config_get_token: '/^tacacs-server host %s .*port (\d+)/'
-    config_set: "tacacs-server host %s port %s"
-    default_value: 49
-
-  timeout:
-    config_get: "show run tacacs all"
-    config_get_token: '/^tacacs-server host %s .*timeout (\d+)/'
-    config_set: "%s tacacs-server host %s timeout %s"
-    default_value: 0
-
-virtual_service:
-  services:
-    config_get: 'show virtual-service detail'
-    config_get_token: ["TABLE_detail", "ROW_detail"]
-
-vlan:
-  all_vlans:
-    config_get: "show vlan brief"
-    config_get_token: '/^(\d+)\s/'
-
-  create:
-    config_set: ["vlan %s" , "end"]
-
-  destroy:
-    config_set: "no vlan %s"
-
-  name:
-    config_get: "show vlan brief"
-    config_get_token: '/^%d+\s+(\S+)\s/'
-    config_set: ["vlan %d", "%s name %s", "end"]
-    test_config_result:
-      32: "String exceeded max length of (32)"
-
-  state:
-    config_get: "show vlan brief"
-    config_get_token: '/^%d+\s+\S+\s+(\S+)\s/'
-    config_set: ["vlan %d", "%s state %s", "end"]
-    default_value: "active"
-
-  shutdown:
-    config_get: "show vlan brief"
-    config_get_token: '/^%d+\s+\S+\s+(\S+)\s/'
-    config_set: ["vlan %d", "%s shutdown", "end"]
-    default_value: false
-
-vrf:
-  all_vrfs:
-    config_get: "show running | section 'vrf context'"
-    config_get_token: '/^vrf context (.*)/'
-
-  create:
-    config_set:  "vrf context <vrf>"
-
-  description:
-    config_get: "show running | section 'vrf context'"
-    config_get_token: ['/^vrf context <vrf>$/i', '/^description (.*)/']
-    config_set: ["vrf context <vrf>", "<state> description <desc>"]
-
-  destroy:
-    config_set: "no vrf context <vrf>"
-
-  shutdown:
-    config_get: "show running | section 'vrf context'"
-    config_get_token: ['/^vrf context <vrf>$/i', '/^shutdown$/']
-    config_set: ["vrf context <vrf>", "<state> shutdown"]
-
-vtp:
-  domain:
-    config_get: "show vtp status"
-    config_get_token: "domain_name"
-    config_set: "vtp domain %s"
-
-  feature:
-    config_get: "show running vtp"
-    config_get_token: '/^feature vtp$/'
-    config_set: "%s feature vtp"
-
-  filename:
-    config_get: "show running vtp"
-    config_get_token: '/vtp file (\S+)/'
-    config_set: "%s vtp file %s"
-    default_value: "bootflash:/vlan.dat"
-
-  password:
-    config_get: "show vtp password"
-    config_get_token: "passwd"
-    config_set: "%s vtp password %s"
-    default_value: ""
-
-  version:
-    config_get: "show vtp status"
-    config_get_token: '/VTP\s+version\s+running\s+:\s+(\d+)/'
-    config_set: "vtp version %s"
-    default_value: 1
-    test_config_result:
-      3: "Cisco::CliError"
-
-yum:
-  install:
-    config_set: "install add %s %s activate"
-  query:
-    config_get: "show install packages"
-    # pass in the pkg name, retrieve version
-    config_get_token: '/^%s\S*\s+(\S+)\s+(?:installed|@\S+)/'
-  remove:
-    config_set: "install deactivate %s"
-