template#

Autogenerated API

argus_api.lib.configurationadmin.v1.template.add_comment_2(id: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

DEPRECATED : add_comment_2 is an alias for add_template_comment. Exists only for backward compatibility - do not use - use add_template_comment instead.

argus_api.lib.configurationadmin.v1.template.add_template_comment(id: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Add a comment to a configuration template (INTERNAL)

Parameters

  • id (int) – ID of template to add comment to

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.configurationadmin.v1.template.create_4(name: str = None, shortName: str = None, mnemonic: str = None, configuration: str = None, configurationResource: str = None, properties: dict = None, information: str = None, dependsOnID: int = None, codeProfile: str = None, startupIndex: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

DEPRECATED : create_4 is an alias for create_template. Exists only for backward compatibility - do not use - use create_template instead.

argus_api.lib.configurationadmin.v1.template.create_template(name: str = None, shortName: str = None, mnemonic: str = None, configuration: str = None, configurationResource: str = None, properties: dict = None, information: str = None, dependsOnID: int = None, codeProfile: str = None, startupIndex: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Create new configuration template (INTERNAL)

Parameters

  • name (str) – A unique name for this template => [a-zA-Z0-9_:\-.]*

  • shortName (str) – A unique shortname for this template => [a-zA-Z0-9_:\-.]*

  • mnemonic (str) – DEPRECATED: A unique shortname for this template. Use shortName instead. => [a-zA-Z0-9_:\-.]*

  • configuration (str) – The configuration XML to use for this template. One of configuration and configurationResource is required. => format:xml

  • configurationResource (str) – Name of configuration resource (class name or classpath to Spring XML. One of configuration and configurationResource is required. The resource must exist in the classpath of the code profile.

  • properties (dict) – Configuration properties to use for this template, with default values. Values may be overridden on host or instance

  • information (str) – Informational text about this template. Default sanitation. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • dependsOnID (int) – If set, this declares the ID of the template that this template requires as parent. Instances must be created with another instance with template dependsOnID as parent.

  • codeProfile (str) – The code profile to use when running this template => [a-zA-Z0-9_:\-.]*

  • startupIndex (int) – Specify the startup order of this component (default 0)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.configurationadmin.v1.template.delete_3(id: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

DEPRECATED : delete_3 is an alias for delete_template. Exists only for backward compatibility - do not use - use delete_template instead.

argus_api.lib.configurationadmin.v1.template.delete_template(id: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Delete configuration template (INTERNAL)

Parameters

  • id (int) – ID of template to delete

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.configurationadmin.v1.template.duplicate_3(id: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

DEPRECATED : duplicate_3 is an alias for duplicate_template. Exists only for backward compatibility - do not use - use duplicate_template instead.

argus_api.lib.configurationadmin.v1.template.duplicate_template(id: int, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Create a duplicate of a configuration template (INTERNAL)

Parameters

  • id (int) – ID of template to duplicate

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.configurationadmin.v1.template.get_template_configuration_data(idOrShortname: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Fetch configuration template configuration data (INTERNAL)

Parameters

  • idOrShortname (str) – ID or shortname of template

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.configurationadmin.v1.template.get_template_properties(idOrShortname: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Fetch configuration template properties (INTERNAL)

Parameters

  • idOrShortname (str) – ID or shortname of template

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.configurationadmin.v1.template.list_4(search: str = None, orderDesc: bool = None, limit: int = 25, orderBy: str = 'name', includeComments: bool = None, includeDeleted: bool = None, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

DEPRECATED : list_4 is an alias for list_templates. Exists only for backward compatibility - do not use - use list_templates instead.

argus_api.lib.configurationadmin.v1.template.list_templates(search: str = None, orderDesc: bool = None, limit: int = 25, orderBy: str = 'name', includeComments: bool = None, includeDeleted: bool = None, offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

List configuration templates (INTERNAL)

Parameters

  • search (str) – Keyword search string

  • orderDesc (bool) – Sort results descending

  • limit (int) – Return a limited number of results

  • orderBy (str) – Sort results

  • includeComments (bool) – If true, also include comments on every returned search result

  • includeDeleted (bool) – If true, also include templates marked as deleted

  • offset (int) – Skip the first matching results

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.configurationadmin.v1.template.promote_all_template_instances(idOrShortname: str, templateRevision: int = None, instances: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Promote all configuration instances for this template (INTERNAL)

Parameters

  • idOrShortname (str) – ID or shortname of template to promote

  • templateRevision (int) – The template revision to promote to. If not set, this will default to latest revision.

  • instances (list) – The instances to promote. Default is to promote all instances.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.configurationadmin.v1.template.revisions_1(idOrShortname: str, limit: int = 25, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

DEPRECATED : revisions_1 is an alias for template_revisions. Exists only for backward compatibility - do not use - use template_revisions instead.

argus_api.lib.configurationadmin.v1.template.search_4(limit: int = None, offset: int = None, includeDeleted: bool = None, includeFlags: int = None, excludeFlags: int = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, codeProfile: str = None, keywords: str = None, template: str = None, dependingOnID: int = None, sortBy: str = None, includeComments: bool = None, includeConfiguration: bool = True, includeProperties: bool = True, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

DEPRECATED : search_4 is an alias for search_templates. Exists only for backward compatibility - do not use - use search_templates instead.

argus_api.lib.configurationadmin.v1.template.search_templates(limit: int = None, offset: int = None, includeDeleted: bool = None, includeFlags: int = None, excludeFlags: int = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, codeProfile: str = None, keywords: str = None, template: str = None, dependingOnID: int = None, sortBy: str = None, includeComments: bool = None, includeConfiguration: bool = True, includeProperties: bool = True, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Search configuration templates (INTERNAL)

Parameters

  • limit (int) – Max number of results.

  • offset (int) – Skip the first (offset) objects. By default, return result from first object.

  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.

  • includeFlags (int) – Only include objects which have includeFlags set.

  • excludeFlags (int) – Exclude objects which have excludeFlags set.

  • subCriteria (list) – Set additional criterias which are applied using a logical OR.

  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.

  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).

  • codeProfile (list) – If true, filter on templates having any of these code profiles.

  • keywords (list) – If true, filter on templates where name matches these keywords.

  • template (list) – If set, filter on templates by ID or shortname.

  • dependingOnID (list) – If set, filter on templates set to depend on any of the given template IDs.

  • sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).

  • includeComments (bool) – If true, also include comments on output. (default false)

  • includeConfiguration (bool) – If true, also include configuration on output. (default true)

  • includeProperties (bool) – If true, also include properties on output. (default true)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.configurationadmin.v1.template.template_revisions(idOrShortname: str, limit: int = 25, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

List revisions of configuration template (INTERNAL)

Parameters

  • idOrShortname (str) – ID or shortname of template

  • limit (int) – Max number of revisions to fetch

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Returns

dictionary translated from JSON

argus_api.lib.configurationadmin.v1.template.update_3(idOrShortname: str, name: str = None, mnemonic: str = None, shortName: str = None, configuration: str = None, configurationResource: str = None, properties: dict = None, information: str = None, dependsOnID: int = None, codeProfile: str = None, startupIndex: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

DEPRECATED : update_3 is an alias for update_template. Exists only for backward compatibility - do not use - use update_template instead.

argus_api.lib.configurationadmin.v1.template.update_template(idOrShortname: str, name: str = None, mnemonic: str = None, shortName: str = None, configuration: str = None, configurationResource: str = None, properties: dict = None, information: str = None, dependsOnID: int = None, codeProfile: str = None, startupIndex: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Update configuration template (INTERNAL)

Parameters

  • idOrShortname (str) – ID or shortname of template to update

  • name (str) – If set, update the name of this template => [a-zA-Z0-9_:\-.]*

  • mnemonic (str) – DEPRECATED: If set, update the shortname of this template. Use shortName instead => [a-zA-Z0-9_:\-.]*

  • shortName (str) – If set, update the shortname of this template => [a-zA-Z0-9_:\-.]*

  • configuration (str) – If set, update the configuration of this template. Will clear configurationResource => format:xml

  • configurationResource (str) – Name of configuration resource (class name or classpath to Spring XML. Will clear explicit configuration. The resource must exist in the classpath of the code profile.

  • properties (dict) – If set, add these properties to the template. Properties with null value will be removed.

  • information (str) – If set, update the informational text of this template. Default sanitation. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • dependsOnID (int) – If set, update the parent dependency to the template with this ID

  • codeProfile (str) – If set, update the code profile to use for this template. => [a-zA-Z0-9_:\-.]*

  • startupIndex (int) – If set, change the startup order of this component

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.configurationadmin.v1.template.update_template_properties(idOrShortname: str, properties: dict = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Update configuration template properties (INTERNAL)

Parameters

  • idOrShortname (str) – ID of template to update properties on

  • properties (dict) – The template properties to update to, null value will clear the property

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.configurationadmin.v1.template.view_2(idOrShortname: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

DEPRECATED : view_2 is an alias for view_template. Exists only for backward compatibility - do not use - use view_template instead.

argus_api.lib.configurationadmin.v1.template.view_template(idOrShortname: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Fetch configuration template (INTERNAL)

Parameters

  • idOrShortname (str) – ID or shortname of template

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON