> User macro object

The following objects are directly related to the usermacro API.

Global macro

The global macro object has the following properties.

PropertyTypeDescription
globalmacroidstring(readonly) ID of the global macro.
macro
(required)
stringMacro string.
value
(required)
stringValue of the macro.
typeintegerType of macro.

Possible values:
0 - (default) Text macro;
1 - Secret macro;
2 - Vault secret.
descriptionstringDescription of the macro.

Host macro

The host macro object defines a macro available on a host, host prototype or template. It has the following properties.

PropertyTypeDescription
hostmacroidstring(readonly) ID of the host macro.
hostid
(required)
stringID of the host that the macro belongs to.
macro
(required)
stringMacro string.
value
(required)
stringValue of the macro.
typeintegerType of macro.

Possible values:
0 - (default) Text macro;
1 - Secret macro;
2 - Vault secret.
descriptionstringDescription of the macro.