Add Your Own Command

While hyperglass does come with several built-in directives (commands), you can also add your own. For example, say you want to add a command that shows the BGP summary from a device:

show-bgp-summary:
    name: BGP Summary
    rules:
        - condition: null
          command: show bgp all summary
    field: null

devices:
    - name: Your Router
      address: 192.0.2.1
      platform: cisco_ios
      directives:
          - show-bgp-summary

Default Directives

By default, all built-in directives are also enabled. If you wish to only enable directives you specify, you can use builtins: false as a directive:

devices:
    - name: Your Router
      address: 192.0.2.1
      platform: cisco_ios
      directives:
          - builtins: false
          - show-bgp-summary

In the above example, only the show-bgp-summary directive will be enabled.

You can also selectively enable certain built-in directives:

devices:
    - name: Your Router
      address: 192.0.2.1
      platform: cisco_ios
      directives:
          - builtins: [bgp_route, traceroute]

In the above example, only the BGP Route and Traceroute built-in directives will be enabled.