Skip to content

neops.core.provider.generic_simple_workflow

GenericSimpleWorkflow

Provider to summarize other tasks.

Every other task is called by its id or uniquetaskname, it has two templates on to set the entities on which the task is called and one to pass the input values.

JSON Schema

Excel to Process Tasks

Properties

  • run_as (string): Select on which entity the task should run on. Must be one of: ['GLOBAL', 'GROUP', 'DEVICE', 'INTERFACE', 'CLIENT'].

  • tasks (array): This description is used as a help message.

  • Items (object)

    • titleProp (string)

    • run_as (string): Select on which execute on entities will be passed to the task. Must be one of: ['GROUP', 'DEVICE', 'INTERFACE', 'CLIENT'].

    • allow_all (boolean): some providers have the ability to run on all elements if there are none given, decide if this is fine for your task. Default: False.

    • entity_template (string): Get a List of Entity by the Template. Default: {% set device_list = [] %} {% for device in neops.search_devices("devices.hostname: *.neops.io") %} {{ device.hostname }} {% do device_list.append(device.id) %} {% endfor %} {% do neops.set_entities(device_list) %}.

    • task_id (number): Set task id of task to process (set 0 if unique task name is used). Default: 0.

    • task_uniquename (string): Set unique task name of task to process (task_id has priority).

    • task_main (boolean): Include pre and post run tasks in this step. Default: True.

    • task_template (string): Provide the data structure for the task input params. Default: {% do neops.set_params({}) %}.

Entity and Params Templates

Entity Template

A Jinja Template which is processed to select the entities where the task is applied on.

The following parameters are passed to the template processing:

  • input: all inputs from the task run arguments
  • elements: the current selected objects based on run_as serialized as dictionary
  • neops: the neops object brings methods to access to other elements over the neops.io search and to save the facts objects
    • neops.search_devices(query): returns a list of devices found by the search query
    • neops.search_interfaces(query): returns a list of interfaces found by the search query
    • neops.search_device_groups(query): returns a list of groups found by the search query
    • neops.search_client(query): returns a list of clients found by the search query
    • neops.get_common_facts(key): returns the common/global fact of the given key
    • neops.set_entities(ids): sets entities to run the task as list of ids

For more information on how to build a Jinja2 template, have a look at Appendix under Jinja2

Params Template

A Jinja Template which is processed to pass the params to the task.

The following parameters are passed to the template processing:

  • input: all inputs from the task run arguments
  • entities: ids of elements to run the task on
  • elements: entity objects serialized as dictionary
  • neops: the neops object brings methods to access to other elements over the neops.io search and to save the facts objects
    • neops.search_devices(query): returns a list of devices found by the search query
    • neops.search_interfaces(query): returns a list of interfaces found by the search query
    • neops.search_device_groups(query): returns a list of groups found by the search query
    • neops.search_client(query): returns a list of clients found by the search query
    • neops.get_common_facts(key): returns the common/global fact of the given key
    • neops.set_params(dictionary): sets params as input values for the task

For more information on how to build a Jinja2 template, have a look at Appendix under Jinja2

Methods

run_global(self,execute_on: List[int],execute_on_type: neops.core.provider.base.enum.RunOnEnum,dry_run: bool,task_input_kwargs: Dict[Any, Any],search_query: str,task_kwargs: Dict[Any, Any],result=neops.core.provider.base.result.provider_global_result.ProviderGlobalResult,**kwargs) -> Any
Process all subtasks