YAML Structure

Each YAML document contains a Task
- Each task contains sub-Tasks
  - Each sub-Task contains number of functions like execute, take_config_backup etc.

Create a new Task

Task:
  name: New Task
  log_format: markdown
  subTask:
    - name: Love forever
      vendor: cisco
      parallel: false

Task

Input	Type	Description	Options	Default
`task_log_format`	String	Task log file format	`markdown`, `txt`	`markdown`
`task_name`	String	The name of the task (which will be displayed when listing tasks)
`Task.subTask`	List	List of subtasks (will be executed in order)
`Task.subTask.name`	String	Name of sub-task
`Task.subTask.vendor`	String	Default Vendor for the sub-task	`cisco`, `huawei`	`cisco`
Task.subTask.parallel	Boolan	Wheather to execute the sub-task on the devices in Parallel, Currently not supported, will be supported in an upcoming release	`True`, `False`	False

Task.subTask.authenticate

Task:
  name: New Task
  log_format: markdown
  subTask:
    - name: Love forever
      vendor: cisco
      parallel: false
      authenticate:
        group: switches
        port: 22
        username:
          value_from_env:
            key: my_username
        password:
          value_from_env:
            key: my_password
        privileged_mode_password:
          value_from_env:
            key: my_password
        reconnect: True

Input	Type	Description	Options	Default
`group`	String	Inventory group to authenticate
`port`	Integer			22
username	dct	Username for authentication
password	dct	Password for authentication
`privileged_mode_password`	dct	Password of the Privileged mode (eg. `enable` in Cisco & `super` in Huawei) [ If Provided, the device login to `privileged_mode` after authentication. ]
reconnect	Boolan	Wheather to reconnect if the SSH connection is interupted	`True`, `False`	False

For options with dct type

Provide value directly

username:
  value: Trump

Provide value from ENV

username:
  value_from_env:
    key: my_username

Providing values from Secret managers like Vault & Cyberark, will be considered in 0.4.0 release

Task.subTask.configBackup

Task:
  name: New Task
  log_format: markdown
  subTask:
    - name: Love forever
      vendor: cisco
      parallel: false
      authenticate:
        group: switches
        port: 22
        username:
          value_from_env:
            key: my_username
        password:
          value_from_env:
            key: my_password
        privileged_mode_password:
          value_from_env:
            key: my_password
        reconnect: True
      configBackup:
        comment: "Test backup"
        exit_on_fail: True
        target: local
        skip:
          - 192.168.1.11
          - 192.168.1.12

Input	Type	Description	Options	Default
`comment`	String	Comment describes the backup reason
`exit_on_fail`	Boolean		True, False	True
target	String	Where to save the backup	`local`, `s3`	`local`
skip	List	List of hosts to skip
OnlyOn	List	List of hosts to backup and ignore others

Task.subTask.commands

Task:
  name: New Task
  log_format: markdown
  subTask:
    - name: Love forever
      vendor: cisco
      parallel: false
      authenticate:
        group: switches
        port: 22
        username:
          value_from_env:
            key: my_username
        password:
          value_from_env:
            key: my_password
        privileged_mode_password:
          value_from_env:
            key: my_password
        reconnect: True
      configBackup:
        comment: "Test backup"
        exit_on_fail: True
        target: local
        skip:
          - 192.168.1.11
          - 192.168.1.12
      commands:
        - command: show ip int br
          tag: show1
          ask_for_confirmation: false
          exit_on_fail: false
          onlyOn:
            - 90.84.41.239            
        - command: |
            show vlan br
            show version
          when:
            tag: show1
            operator: is
            exit_code: 0

Input	Type	Description	Options	Default
`commands`	List	List of commands to execute (In order)

Command options

Input	Type	Description	Options	Default
`command`	String	Command to execute
`tag`	String	A tag given to the command, allows us to refer to this commnd in other commands conditions
`ask_for_confirmation`	Boolean	If True, I will ask for confirmation before executing the command, Default: False
`exit_on_fail`	Boolean	If True, the script will exit if the command exit with an Error, Default: True	True, False	True
`onlyOn`	List	A condition (List of hosts to execute only on)
`skip`	List	A condition (List of hosts to Skip execution on)
`when`	dct	a condition that determins whether the command will be executed or not (based on another command output)

when options

Input	Type	Description	Options
`tag`	String	the tag of the previously executed command
operator	String		`is`, `is_not`
exit_code	Integer	Exit code of the condition command	0, `1`, `-1`