Cláusula SYNTAX

  • Artigo

A macro OBJECT-TYPE contém uma cláusula SYNTAX que define os dados e o tipo para o objeto MIB. Embora o Provedor SNMP observe regras gerais para mapear cláusulas SYNTAX, o provedor também segue regras específicas para vários tipos de dados.

Observação

Para obter mais informações sobre como instalar o provedor, confira Como configurar o ambiente SNMP do WMI.

As seguintes regras de mapeamento se aplicam a todos os tipos de dados descritos na tabela abaixo:

  • A representação textual da cláusula SYNTAX é mapeada para o qualificador de propriedade CIM textual_convention.
  • A definição de tipo nomeado na cláusula SYNTAX é mapeada para o qualificador de propriedade CIM object_syntax. Esse mapeamento é diferente dependendo do tipo de dados. Para obter mais informações, confira as Descrições de mapeamento.
  • O tipo SNMP usado ao codificar quadros de protocolo SNMPv1 e SNMPv2C é mapeado para o qualificador de propriedade CIM encoding.
  • O qualificador de propriedade CIM cimtype contém a representação textual que formata o valor do protocolo CIM subjacente.

A tabela a seguir lista os tipos de dados que têm regras específicas que regem o comportamento de mapeamento do provedor.

Tipo de dados SNMP Descrição
Tipo primitivo Um dos tipos de dados básicos definidos nos documentos da SMI (Estrutura de Informações de Gerenciamento) RFC 1213 e RFC 1903.
Convenção textual Definição de tipo gerada por meio do uso explícito da macro TEXTUAL-CONVENTION SNMPv2C ou gerada por meio do uso de um tipo nomeado. A convenção textual atribui um nome e, em alguns casos, um intervalo de valores a um tipo de dado existente.
Tipo nomeado Referência nomeada a um tipo primitivo, convenção textual ou tipo restrito.
Tipo restrito Tipo primitivo, tipo nomeado ou convenção textual que foi restringido por algum mecanismo de subtipagem definido nos documentos SMI RFC 1213 e RFC 1903.

Tipo Primitivo

O tipo primitivo é um dos tipos de dados básicos definidos nos documentos da SMI (Estrutura de Informações de Gerenciamento) RFC 1213 e RFC 1903. Os tipos primitivos SNMP são mapeados para os tipos definidos por CIM. A tabela a seguir lista o mapeamento que ocorre quando a cláusula SYNTAX se refere explicitamente a um tipo primitivo para SNMPv1. Os qualificadores textual_convention, encoding e object_syntax são sempre iguais ao tipo MIB e o valor padrão é sempre NULL.

Tipo MIB Tipo de variante do CIM Valor cimtype
INTEGER VT_I4 sint32
OCTETSTRING VT_BSTR cadeia de caracteres
OBJECTIDENTIFIER VT_BSTR cadeia de caracteres
NULO VT_NULL Sem suporte
IpAddress VT_BSTR cadeia de caracteres
Contador VT_I4 uint32
Medidor VT_I4 uint32
TimeTicks VT_I4 uint32
Opaco VT_BSTR cadeia de caracteres
NetworkAddress VT_BSTR cadeia de caracteres

O provedor ignora a macro OBJECT-TYPE quando a cláusula SYNTAX se refere a NULL, explicitamente ou por meio de uma atribuição de tipo nomeado. A tabela a seguir lista o mapeamento que ocorre quando a cláusula SYNTAX se refere explicitamente a um tipo primitivo para SNMPv2. Os qualificadores textual_convention, encoding e object_syntax são sempre iguais ao tipo MIB e o valor padrão é sempre NULL.

Tipo MIB Tipo de variante do CIM Valor cimtype
INTEGER VT_I4 sint32
OCTET STRING VT_BSTR cadeia de caracteres
OBJECT IDENTIFIER VT_BSTR cadeia de caracteres
IpAddress VT_BSTR cadeia de caracteres
Counter32 VT_I4 uint32
Gauge32 VT_I4 uint32
Unsigned32 VT_I4 uint32
Integer32 VT_I4 sint32
Counter64 VT_BSTR uint64
TimeTicks VT_I4 uint32
Opaco VT_BSTR cadeia de caracteres

Tipo Nomeado

Os tipos nomeados SNMP são mapeados para os tipos definidos por CIM. Quando a cláusula SYNTAX se referis a um tipo primitivo, convenção textual ou tipo restrito por meio de uma derivação de atribuição de tipo, use esses tipos para determinar quais procedimentos de mapeamento são aplicáveis.

  • Se, por meio da derivação das regras de atribuição de tipo, você encontrar uma definição de tipo restrito:

    • E se, por meio de derivação adicional, você encontrar uma das convenções textuais listadas na Macro TEXTUAL-CONVENTION, aplique as regras de mapeamento para tipos restritos e convenções textuais.
    • Caso contrário, se você encontrar um dos tipos primitivos listados em qualquer tabela de tipo primitivo, aplique as regras de mapeamento para tipos primitivos e tipos restritos.

  • Se você encontrar uma das convenções textuais listadas no TEXTUAL_CONVENTION Macro, aplique as regras de mapeamento para convenções textuais.

  • Se você encontrar um dos tipos primitivos listados em qualquer tabela de tipo primitivo, aplique as regras de mapeamento para tipos primitivos.

Observação

As classes que contêm tipos de propriedade que não estão em conformidade com o mapeamento descrito acima não são válidas. Nesse caso, o provedor retornará um erro se e quando o provedor solicitar a recuperação de uma definição de classe durante a execução de uma função de recuperação de instância.

Tipo Restrito

Um tipo restrito é um tipo primitivo, tipo nomeado ou convenção textual que foi restringido por algum mecanismo de subtipagem definido nos documentos SMI RFC 1213 e RFC 1903. Quando ocorre a subtipagem, qualificadores de CIM adicionais são necessários para especificar os valores de subtipo. A definição de tipo nomeado na cláusula SYNTAX é mapeada textualmente para o qualificador de propriedade CIM object_syntax até, mas não incluindo as restrições do subtipo.

Os subtipos podem seguir qualquer um dos seguintes formatos:

  • INTEGER enumerado

    O qualificador de propriedade CIM enumeration especifica os valores enumerados. Esse qualificador é representado como uma cadeia de caracteres que contém uma lista separada por vírgulas de valores inteiros assinados de 32 bits. A tabela a seguir lista os tipos de mapeamento. O valor padrão é sempre NULL.

Tipo de MIB restrito Tipo de variante do CIM Qualificadores do CIM
INTEGER enumerado VT_BSTR textual_convention: enumeratedinteger
encoding: INTEGER
cimtype: string

  • BITS

    O qualificador de propriedade CIM bits especifica os valores enumerados. Esse qualificador é representado como uma cadeia de caracteres que contém uma lista separada por vírgulas de valores inteiros assinados de 32 bits. A tabela a seguir lista os tipos de mapeamento. O valor padrão é sempre NULL.

Tipo de MIB restrito Tipo de variante do CIM Qualificadores do CIM
BITS VT_ARRAY | VT_BSTR textual_convention: bits
encoding: OCTETSTRING
cimtype: string

  • Comprimento variável

    Quando a cláusula SYNTAX se refere a um tipo primitivo, tipo nomeado ou convenção textual que é subtipado como OCTET STRING de comprimento variável ou opaco, o qualificador de propriedade CIM variable_length especifica os valores mínimo, máximo e de comprimento fixo associados à definição de tipo. Esse qualificador é implementado como uma cadeia de caracteres no formato a seguir, em que os valores de comprimento variável são representados como inteiros de 32 bits sem sinal.

    (((0.9) .. (0.9)) | (0.9))(, (((0.9) .. (0.9)) | (0.9)))*

  • Comprimento fixo

    Quando a cláusula SYNTAX se refere a um tipo primitivo, tipo nomeado ou convenção textual que é subtipado como OCTET STRING de comprimento fixo ou opaco, o qualificador de propriedade CIM fixed_length especifica o valor de comprimento fixo. Esse qualificador é representado como valor inteiro de 32 bits sem sinal.

  • Intervalo

    Quando a cláusula SYNTAX se refere a um tipo primitivo, tipo nomeado ou convenção textual que é subtipado como INTEGER ou Gauge de valor fixo ou intervalo, o qualificador de propriedade CIM variable_value especifica os valores de intervalo e fixo associados à definição de tipo. Esse qualificador é implementado como uma cadeia de caracteres no formato a seguir, em que os valores de intervalo e comprimento fixo são representados como inteiros de 32 bits sem sinal.

    (((0.9)..(0.9))|(0.9))(,(((0.9)..(0.9))|(0.9)))*

Código de exemplo

O exemplo a seguir descreve um subtipo INTEGER enumerado.

Status := INTEGER {
up(1),
down(2),
testing(3)
}

Este exemplo é mapeado para:

enumeration("up(1),down(2),testing(3)")

O exemplo de código a seguir descreve um subtipo BITS.

Status := BITS {
up(1),
down(2), 
testing(3)
}

O exemplo de código a seguir é mapeado para:

bits("up(1),down(2),testing(3)")

O exemplo de código a seguir descreve um subtipo de comprimento variável.

MySnmpOSIAddress ::=  TEXTUAL-CONVENTION

    DISPLAY-HINT    "*1x:/1x:"
    STATUS        current
    DESCRIPTION
            "Represents an OSI transport-address:

            octets    contents         encoding
              1        length of NSAP   'n' as an unsigned-integer
                                        (either 0 or from 3 to 20)
              2..(n+1)  NSAP          concrete binary representation
              (n+2)..m  TSEL             string of (up to 64) octets
            "
    SYNTAX         OCTET STRING (SIZE (1|4..85))

Este exemplo é mapeado para:

display_hint("*1x:/1x:"),
encoding("OCTETSTRING"),
textual_convention("OCTETSTRING"),
variable_length ("1,4..85")

O exemplo a seguir descreve um subtipo de comprimento fixo.

IPXADDRESS := OCTET STRING (SIZE (6))

Este exemplo é mapeado para:

fixed_length(6)

O exemplo a seguir descreve um subtipo de intervalo.

Status := INTEGER (10..20|8)

Este exemplo é mapeado para:

variable_value("10..20,8")