CheckDefinitionTestBuilder - com escopo

  • Versão de lançamento: Yokohama
  • Atualizado 30 de jan. de 2025
  • 4 min. de leitura

    • A inclusão de script CheckDefinitionTestBuilder fornece métodos que permitem criar solicitações de verificação de teste em definições de verificação.

    Esta inclusão de script requer a aplicação da loja Agent Client Collector Framework (sn_agent) e é fornecida no namespace sn_agent. Para obter mais informações, consulte Agent Client Collector.

    Para a solução REST API, consulte Agent Client Collector API.

    Esta inclusão de script fornece métodos que habilitam o seguinte:
    • Definir a definição de verificação como teste
    • Definir o item de configuração para executar o teste
    Você também pode especificar um dos seguintes identificadores para usar durante o teste:
    • sys_id de credencial
    • ID do alias de credencial
    • Nome da credencial

    CheckDefinitionTestBuilder - CheckDefinitionTestBuilder()

    Cria uma instância CheckDefinitionTestBuilder.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    Nenhum(a)

    O exemplo a seguir mostra como inicializar CheckDefinitionTestBuilder.

    var builder = new sn_agent.CheckDefinitionTestBuilder();

    CheckDefinitionTestBuilder - build()

    Cria a solicitação de verificação de teste com o conjunto de argumentos.

    Tabela 2. Parâmetros
    Nome Tipo Descrição
    Nenhum
    Tabela 3. Retornos
    Propriedades Descrição
    Objeto Objeto JSON com dois atributos: o ID de registro do resultado de testes e um erro. Se a compilação for bem-sucedida, o ID do resultado do teste retornará e o erro será nulo. Se ocorrer um erro durante a compilação, o ID do resultado do teste será nulo e o erro será exibido.

    O exemplo a seguir mostra como criar uma solicitação de verificação de teste:

    var checkId = "158279505372b30034b8ddeeff7b1270";
var ciId = "cc0dcc855374301062d1ddeeff7b12b0";
var builder = new sn_agent.CheckDefinitionTestBuilder();

var testResultJson = builder.withCheckId(checkId).withCiId(ciId).build();

if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckDefinitionTestBuilder - withCheckId(cadeia de caracteres checkId)

    Define o sys_id da definição de verificação a ser testada.

    Tabela 4. Parâmetros
    Nome Tipo Descrição
    checkId Cadeia de caracteres Sys_id da definição de verificação listada na tabela Definições de verificação [sn_agent_check_def].
    Tabela 5. Retornos
    Tipo Descrição
    CheckDefinitionTestBuilder A instância do construtor para a qual o método foi invocado.

    O exemplo a seguir mostra como criar uma verificação de teste.

    var checkId = "158279505372b30034b8ddeeff7b1270";
var ciId = "cc0dcc855374301062d1ddeeff7b12b0";
var builder = new sn_agent.CheckDefinitionTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCiId(ciId).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckDefinitionTestBuilder - withCiId(cadeia de caracteres ciId)

    Define o sys_id do item de configuração para executar o teste.

    Tabela 6. Parâmetros
    Nome Tipo Descrição
    ciId Cadeia de caracteres Sys_id de um item de configuração do CMDB.
    Tabela 7. Retornos
    Tipo Descrição
    CheckDefinitionTestBuilder A instância do construtor para a qual o método foi invocado.

    O exemplo a seguir mostra como criar uma solicitação de verificação de teste com

    var checkId = "158279505372b30034b8ddeeff7b1270";
var ciId = "cc0dcc855374301062d1ddeeff7b12b0";
var builder = new sn_agent.CheckDefinitionTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCiId(ciId).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckDefinitionTestBuilder - withCredentialsAliasId(cadeia de caracteres credenciaisAliasId)

    Define o alias de credenciais sys_id a ser usado durante o teste.

    Nota:
    A execução desta remove qualquer atribuição anterior feita chamando withCredentialsName, withCredentialsAliasId ou withCredentialsAliasName.
    Tabela 8. Parâmetros
    Nome Tipo Descrição
    credenciaisAliasId Cadeia de caracteres Sys_id de um registro de credenciais.
    Tabela 9. Retornos
    Tipo Descrição
    CheckDefinitionTestBuilder A instância do construtor para a qual o método foi invocado.

    O exemplo a seguir mostra como criar uma verificação de teste e definir o ID do alias de credenciais.

    var checkId = "158279505372b30034b8ddeeff7b1270";
var credAlias = "<sys_id>";
var builder = new sn_agent.CheckDefinitionTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCredentialsAliasId(credAlias).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckDefinitionTestBuilder - withCredentialsAliasName(cadeia de caracteres credenciaisAliasName)

    Define o nome do alias de credenciais a ser usado durante o teste. Se o valor fornecido corresponder ao nome de vários registros de aliases de credenciais, um deles será escolhido aleatoriamente.

    Nota:
    A execução desta remove qualquer atribuição anterior feita chamando withCredentialsName, withCredentialsAliasId ou withCredentialsAliasName.
    Tabela 10. Parâmetros
    Nome Tipo Descrição
    credenciaisAliasName Cadeia de caracteres Nome de um alias de credenciais.
    Tabela 11. Retornos
    Tipo Descrição
    CheckDefinitionTestBuilder A instância do construtor para a qual o método foi invocado.

    O exemplo a seguir mostra como criar uma verificação de teste e definir o nome do alias das credenciais.

    var checkId = "158279505372b30034b8ddeeff7b1270";
var credentialsAliasName = "credentialsAliasName";
var builder = new sn_agent.CheckDefinitionTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCredentialsAliasName(credentialsAliasName).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckDefinitionTestBuilder - withCredentialsId(cadeia de caracteres credenciaisId)

    Define as credenciais sys_id a serem usadas durante o teste.

    Nota:
    A execução desta remove qualquer atribuição anterior feita chamando withCredentialsName, withCredentialsAliasId ou withCredentialsAliasName.
    Tabela 12. Parâmetros
    Nome Tipo Descrição
    credenciaisId Cadeia de caracteres Sys_id de um registro de credenciais.
    Tabela 13. Retornos
    Tipo Descrição
    CheckDefinitionTestBuilder A instância do construtor para a qual o método foi invocado.

    O exemplo a seguir mostra como criar uma verificação de teste e definir o ID de credenciais.

    var checkId = "158279505372b30034b8ddeeff7b1270";
var credID = "<sys_id>";
var builder = new sn_agent.CheckDefinitionTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCredentialsId(credID).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);

    CheckDefinitionTestBuilder - withCredentialsName(cadeia de caracteres credenciaisName)

    Define o nome das credenciais a serem usadas durante o teste. Se o valor fornecido for o nome de vários registros de credenciais, um deles será escolhido aleatoriamente.

    Nota:
    A execução desta remove qualquer atribuição anterior feita chamando withCredentialsName, withCredentialsAliasId ou withCredentialsAliasName.
    Tabela 14. Parâmetros
    Nome Tipo Descrição
    credenciaisNome Cadeia de caracteres Nome do registro de credenciais.
    Tabela 15. Retornos
    Tipo Descrição
    CheckDefinitionTestBuilder A instância do construtor para a qual o método foi invocado.

    O exemplo a seguir mostra como criar uma verificação de teste e definir o nome das credenciais.

    var checkId = "158279505372b30034b8ddeeff7b1270";
var credname = "credentialsName";
var builder = new sn_agent.CheckDefinitionTestBuilder();
var testResultJson = builder.withCheckId(checkId).withCredentialsName(credName).build();
if (!gs.nil(testResultJson.error))
	gs.error(testResultJson.error);