Table of Contents
Objeto macro de usuário
Os seguintes objetos estão diretamente relacionados à API usermacro.
Macro global
O objeto macro global possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| globalmacroid | ID | ID da macro global. Comportamento da propriedade: - somente leitura - obrigatório para operações de atualização |
| description | string | Descrição da macro. |
| macro | string | String da macro. Comportamento da propriedade: - obrigatório para operações de criação |
| type | integer | Tipo de macro. Valores possíveis: 0 - (padrão) Macro de texto; 1 - Macro secreta; 2 - Segredo do Vault. |
| value | string | Valor da macro. Comportamento da propriedade: - somente escrita se type estiver definido como "Macro secreta"- obrigatório para operações de criação |
Macro de host
O objeto macro de host define uma macro disponível em um host, protótipo de host ou template. Possui as seguintes propriedades.
| Propriedade | Tipo | Descrição |
|---|---|---|
| hostmacroid | ID | ID da macro. Comportamento da propriedade: - somente leitura - obrigatório para operações de atualização |
| automatic | integer | Define se a macro é controlada por uma regra de descoberta. Valores possíveis: 0 - (padrão) Macro gerenciada pelo usuário; 1 - Macro gerenciada por regra de descoberta. O usuário não tem permissão para criar macro automática. Para atualizar uma macro automática, ela deve ser convertida para manual. |
| config | object/array | Configuração da macro responsável por como a macro é exibida no Assistente de Host. |
| description | string | Descrição da macro. |
| hostid | ID | ID do host, protótipo de host ou template ao qual a macro pertence. Comportamento da propriedade: - constante - obrigatório para operações de criação |
| macro | string | String da macro. Comportamento da propriedade: - obrigatório para operações de criação |
| type | integer | Tipo de macro. Valores possíveis: 0 - (padrão) Macro de texto; 1 - Macro secreta; 2 - Segredo do Vault. |
| value | string | Valor da macro. Comportamento da propriedade: - somente escrita se type estiver definido como "Macro secreta"- obrigatório para operações de criação |
Configuração de macro
O objeto de configuração de macro define como uma macro é exibida no Assistente de host.
| Propriedade | Tipo | Descrição |
|---|---|---|
| type | integer | Tipo de campo de entrada da macro. Valores possíveis: 0 - A macro não é usada no Assistente de host; 1 - Caixa de texto; 2 - Lista; 3 - Caixa de seleção. Comportamento da propriedade: - obrigatório |
| label | string | Rótulo para o campo de entrada da macro. Comportamento da propriedade: - obrigatório se type estiver definido como "Caixa de texto", "Lista" ou "Caixa de seleção" |
| description | text | Texto de ajuda exibido ao lado do campo de entrada da macro. Suporta formatação Markdown. |
| priority | integer | Posição do campo de entrada da macro na lista de macros. Se priority não for definido, a macro será adicionada ao final da lista de macros não agrupadas. |
| required | integer | Marca a macro como obrigatória. Valores possíveis: 0 - Não obrigatória; 1 - Obrigatória. Comportamento da propriedade: - suportado se type estiver definido como "Caixa de texto" ou "Lista" |
| regex | string | Expressão regular para validar a entrada do usuário em um campo de caixa de texto. Comportamento da propriedade: - suportado se type estiver definido como "Caixa de texto" |
| section_name | string | Rótulo da seção recolhível onde a macro é agrupada. Se section_name não for definido, a macro não será agrupada. Macros não agrupadas são exibidas primeiro; macros agrupadas são exibidas abaixo, ordenadas por sua priority dentro de cada seção recolhível. |
| options | text | String JSON definindo itens de lista ou valores de caixa de seleção. Para listas: um array de objetos com as propriedades value e text.Exemplo: [{"value": "http", "text": "HTTP"}, {"value": "https", "text": "HTTPS"}]Para caixas de seleção: um objeto com as propriedades checked e unchecked.Exemplo: {"checked": true, "unchecked": false}Comportamento da propriedade: - obrigatório se type estiver definido como "Lista" ou "Caixa de seleção" |