Developing a custom action adapter


A custom action device adapter adds a new function to what the system can do to or on a device. A custom action wraps a unit of work done on a device during a login session. You can run any command or request that the device allows, or any combination of multiple commands or requests. You can then run a job that runs the custom action on the devices where the custom action has been implemented. 

A custom action is made up of the declaration, followed by the per-device-type implementation. A custom action might examine features or components or statistics in a device (that is, inspect a device without making changes), or it can make changes (for example, you can wrap commonly performed update commands in a custom action to relieve your users from knowing obscure command syntax, especially across different device types).

When you first import or add a new custom action, the system ensures that you are able to run that action. If you already have full network rights, you can access all actions by default. But if you do not have full network rights, the system creates a new role that grants the right to run the new custom action and adds you as a user to that new role. Once you finish debugging and want to publish the custom action to other users, you can use the role the system created or you can include the custom action right into other roles.

You can develop a custom action adapter using the Network Automation XML:

Related topics

Managing-device-adapters

Adding-or-editing-a-custom-action-adapter

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*