configuration.import

Descrição

boolean configuration.import(object parameters)

Este método permite importar dados de configuração de um serializado corda.

Este método está disponível para usuários de qualquer tipo. Permissões para chamar o método pode ser revogado nas configurações de função do usuário. Veja Usuário funções Para maiores informações.

Parâmetros

(object) Parâmetros contendo os dados a serem importados e regras de como o dados devem ser tratados.

Parâmetro Tipo Descrição
formato
(obrigatório)		 string Formato da string serializada.

Valores possíveis:
yaml - YAML;
xml - XML;<br >json - JSON.
source
(obrigatório)		 string String serializada contendo os dados de configuração.
rules
(obrigatório)		 object Regras sobre como objetos novos e existentes devem ser importados.

O parâmetro rules é descrito em detalhes na tabela abaixo.

::: dica Se nenhuma regra for fornecida, a configuração não será Atualizada. :::

O objeto rules suporta os seguintes parâmetros.

Parâmetro Tipo Descrição
discoveryRules object Regras sobre como importar regras LLD.

Parâmetros suportados:
createMissing - (boolean) se definido como true, novas regras LLD serão criadas; default: false;
updateExisting - (boolean) se definido como true, as regras LLD existentes serão atualizadas; default: false;
deleteMissing - (boolean) se definido como true, as regras LLD não presentes nos dados importados serão excluídas do banco de dados; padrão: falso.
graphs object Regras sobre como importar gráficos.

Parâmetros suportados:
createMissing - (boolean) se definido como true, novos gráficos serão criados; default: false;
updateExisting - (boolean) se definido como true, os gráficos existentes serão atualizados; default: false;
deleteMissing - (boolean) se definido como true, os gráficos não presentes nos dados importados serão excluídos do banco de dados; padrão: falso.
groups object Regras sobre como importar grupos de hosts.

Parâmetros suportados:
createMissing - (boolean) se definido como true, novos grupos de hosts serão criados; default: false;
updateExisting - (boolean) se definido como true, os grupos de hosts existentes serão atualizados; padrão: falso.
hosts object Regras sobre como importar hosts.

Parâmetros suportados:
createMissing - (boolean) se definido como true, novos hosts serão criados; default: false;
updateExisting - (boolean) se definido como true, os hosts existentes serão atualizados; padrão: falso.
httptests object Regras sobre como importar cenários da web.

Parâmetros suportados:
createMissing - (boolean) se definido como true, novos cenários da web serão criados; default: false;
updateExisting - (boolean) se definido como true, os cenários da web existentes serão atualizados; default: false;
deleteMissing - (boolean) se definido como true, os cenários da web não presentes nos dados importados serão excluídos do banco de dados; padrão: falso.
images object Regras sobre como importar imagens.

Parâmetros suportados:
createMissing - (boolean) se definido como true, novas imagens serão criadas; default: false;
updateExisting - (boolean) se definido como true, as imagens existentes serão atualizadas; padrão: falso.
items object Regras sobre como importar itens.

Parâmetros suportados:
createMissing - (boolean) se definido como true, novos itens serão criados; default: false;
updateExisting - (boolean) se definido como true, os itens existentes serão atualizados; default: false;
deleteMissing - (boolean) se definido como true, os itens não presentes nos dados importados serão excluídos do banco de dados; padrão: falso.
maps object Regras sobre como importar mapas.

Parâmetros suportados:
createMissing - (boolean) se definido como true, novos mapas serão criados; default: false;
updateExisting - (boolean) se definido como true, os mapas existentes serão atualizados; padrão: falso.
mediaTypes object Regras sobre como importar tipos de mídia.

Parâmetros suportados:
createMissing - (boolean) se definido como true, novos tipos de mídia serão criados; default: false;
updateExisting - (boolean) se definido como true, os tipos de mídia existentes serão atualizados; padrão: falso.
templateLinkage object Regras sobre como importar links de modelo.

Parâmetros suportados:
createMissing - (boolean) se definido como true, novos links entre os modelos e o host serão criados ; default: false;
deleteMissing - (boolean) se definido como true, os links de modelo não presentes nos dados importados serão excluídos do banco de dados; padrão: falso.
templates object Regras sobre como importar modelos.

Parâmetros suportados:
createMissing - (boolean) se definido como true, novos modelos serão criados; default: false;
updateExisting - (boolean) se definido como true, os modelos existentes serão atualizados; padrão: falso.
templateDashboards object Regras sobre como importar painéis de modelo.

Parâmetros suportados:
createMissing - (boolean) se definido como true, novos painéis de modelo serão criados; default: false;
updateExisting - (boolean) se definido como true, os painéis de modelos existentes serão atualizados; default: false;
deleteMissing - (boolean) se definido como true, os painéis de modelo não presentes nos dados importados serão excluídos do banco de dados; padrão: falso.
triggers object Regras sobre como importar gatilhos.

Parâmetros suportados:
createMissing - (boolean) se definido como true, novos gatilhos serão criados; default: false;
updateExisting - (boolean) se definido como true, os gatilhos existentes serão atualizados; default: false;
deleteMissing - (boolean) se definido como true, triggers não presentes nos dados importados serão excluídos do banco de dados; padrão: falso.
valueMaps object Regras sobre como importar mapas de valor de host ou modelo.

Parâmetros suportados:
createMissing - (boolean) se definido como true, novos mapas de valor serão criados ; default: false;
updateExisting - (boolean) se definido como true, os mapas de valores existentes serão atualizados; default: false;
deleteMissing - (boolean) se definido como true, os mapas de valores não presentes nos dados importados serão excluídos do banco de dados; padrão: falso.

Valores de retorno

(boolean) Retorna true se a importação foi bem sucedida.

Exemplos

Importando hosts e itens

Importe o host e os itens contidos na string XML. Se algum item no XML estiver faltando, eles serão deletados do banco de dados e tudo mais será deixado inalterado.

Requisição:

{
    "jsonrpc": "2.0",
    "method": "configuration.import",
    "params": {
        "format": "xml",
        "rules": {
            "valueMaps": {
                "createMissing": true,
                "updateExisting": false
            },
            "hosts": {
                "createMissing": true,
                "updateExisting": true
            },
            "items": {
                "createMissing": true,
                "updateExisting": true,
                "deleteMissing": true
            }
        },
        "source": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<zabbix_export><version>5.4</version><date>2020-03-13T15:31:45Z</date><groups><group><uuid>6f6799aa69e844b4b3918f779f2abf08</uuid><name>Zabbix servers</name></group></groups><hosts><host><host>Export host</host><name>Export host</name><groups><group><name>Zabbix servers</name></group></groups><interfaces><interface><interface_ref>if1</interface_ref></interface></interfaces><items><item><name>Item</name><key>item.key</key><delay>30s</delay><valuemap><name>Host status</name></valuemap><interface_ref>if1</interface_ref><request_method>POST</request_method></item></items><valuemaps><valuemap><name>Host status</name><mappings><mapping><value>0</value><newvalue>Up</newvalue></mapping><mapping><value>2</value><newvalue>Unreachable</newvalue></mapping></mappings></valuemap></valuemaps></host></hosts></zabbix_export>"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Resposta:

{
    "jsonrpc": "2.0",
    "result": true,
    "id": 1
}

Fonte

CConfiguration::import() em ui/include/classes/api/services/CConfiguration.php.