Especifique el formato de salida para las solicitudes de información operativa en una sesión de protocolo JUnos XML
En una sesión de protocolo Junos XML, para solicitar información sobre una plataforma de enrutamiento, conmutación o seguridad que ejecuta Junos OS, una aplicación cliente encierra un elemento de etiqueta de solicitud JUnos XML en un <rpc> elemento tag. Al establecer el atributo opcional format en la etiqueta de solicitud operativa de apertura, la aplicación cliente puede especificar el formato del resultado devuelto por el servidor de protocolo XML de Junos. La información se puede devolver como formato etiquetado XML, notación de objetos JavaScript (JSON) o texto ASCII formateado. La sintaxis básica es la siguiente:
<rpc>
<operational-request format="(ascii | json | text | xml)">
<!-- tag elements for options -->
</operational-request>
</rpc>
Formato XML
De forma predeterminada, el servidor de protocolo XML de Junos devuelve información operativa en formato con etiqueta XML. Si el valor del format atributo se establece en "xml", o si se omite el format atributo, el servidor devuelve la respuesta en XML. En el siguiente ejemplo se solicita información para la interfaz ge-0/3/0. El format atributo se omite.
<rpc>
<get-interface-information>
<brief/>
<interface-name>ge-0/3/0</interface-name>
</get-interface-information>
</rpc>
El servidor de protocolo JUnos XML devuelve la información en formato con etiqueta XML, que es idéntica a la salida que se muestra en la CLI cuando se incluye la | display xml opción después del comando del modo operativo.
<rpc-reply xmlns:junos="http://xml.juniper.net/junos/11.4R1/junos">
<interface-information
xmlns="http://xml.juniper.net/junos/11.4R1/junos-interface" junos:style="brief">
<physical-interface>
<name>ge-0/3/0</name>
<admin-status junos:format="Enabled">up</admin-status>
<oper-status>down</oper-status>
<link-level-type>Ethernet</link-level-type>
<mtu>1514</mtu>
<source-filtering>disabled</source-filtering>
<speed>1000mbps</speed>
<bpdu-error>none</bpdu-error>
<l2pt-error>none</l2pt-error>
<loopback>disabled</loopback>
<if-flow-control>enabled</if-flow-control>
<if-auto-negotiation>enabled</if-auto-negotiation>
<if-remote-fault>online</if-remote-fault>
<if-device-flags>
<ifdf-present/>
<ifdf-running/>
<ifdf-down/>
</if-device-flags>
<if-config-flags>
<iff-hardware-down/>
<iff-snmp-traps/>
<internal-flags>0x4000</internal-flags>
</if-config-flags>
<if-media-flags>
<ifmf-none/>
</if-media-flags>
</physical-interface>
</interface-information>
</rpc-reply>
Formato ASCII
Para solicitar que el servidor de protocolo JUnos XML devuelva información operativa como texto ASCII formateado en lugar de etiquetarlo con elementos de etiqueta Junos XML, la aplicación cliente incluye el format="text" atributo or format="ascii" en la etiqueta de solicitud de apertura. La aplicación cliente encierra la solicitud en un <rpc> elemento tag.
<rpc>
<get-interface-information format="(text | ascii)">
<brief/>
<interface-name>ge-0/3/0</interface-name>
</get-interface-information>
</rpc>
Cuando la aplicación cliente incluye el format="text" atributo o format="ascii" en la etiqueta de solicitud, el servidor de protocolo JUnos XML formatee la respuesta como texto ASCII y la encierra en un <output> elemento tag. Los format="text" atributos y format="ascii" producen un resultado idéntico.
<rpc-reply xmlns:junos="http://xml.juniper.net/junos/11.4R1/junos"> <output> Physical interface: ge-0/3/0, Enabled, Physical link is Down Link-level type: Ethernet, MTU: 1514, Speed: 1000mbps, Loopback: Disabled, Source filtering: Disabled, Flow control: Enabled, Auto-negotiation: Enabled, Remote fault: Online Device flags : Present Running Down Interface flags: Hardware-Down SNMP-Traps Internal: 0x4000 Link flags : None </output> </rpc-reply>
En el ejemplo siguiente se muestra el comando de modo operativo equivalente ejecutado en la CLI:
user@host> show interfaces ge-0/3/0 brief Physical interface: ge-0/3/0, Enabled, Physical link is Down Link-level type: Ethernet, MTU: 1514, Speed: 1000mbps, Loopback: Disabled, Source filtering: Disabled, Flow control: Enabled, Auto-negotiation: Enabled, Remote fault: Online Device flags : Present Running Down Interface flags: Hardware-Down SNMP-Traps Internal: 0x4000 Link flags : None
El texto ASCII formateado devuelto por el servidor de protocolo XML de Junos es idéntico al resultado de la CLI, excepto en los casos en que la salida incluye caracteres no permitidos, como '<' (signo menor que), '>' (mayor que el signo) y '&' (ampersand). El servidor de protocolo XML de Junos sustituye estos caracteres por la referencia de entidad predefinida equivalente de '<', '>' y '&' respectivamente.
Si la API Junos XML no define un elemento de etiqueta de respuesta para el tipo de salida solicitado por una aplicación cliente, el servidor de protocolo Junos XML devuelve la respuesta como texto ASCII formateado incluido en un <output> elemento de etiqueta, incluso si se solicita una salida etiqueta XML.
Para obtener más información acerca del <output> elemento tag, consulte la Referencia del desarrollador operativo de la API XML de Junos.
El contenido y el formato de los datos de un <output> elemento de etiqueta están sujetos a cambios, por lo que las aplicaciones cliente no deben depender de ellos.
Formato JSON
A partir de Junos OS versión 14.2, una aplicación cliente puede solicitar información operativa y de configuración en formato JSON. Para solicitar que el servidor de protocolo Junos XML devuelva información operativa con formato JSON en lugar de etiquetarla con elementos de etiqueta Junos XML, la aplicación cliente incluye el format="json" atributo en la etiqueta de solicitud de apertura. La aplicación cliente encierra la solicitud en un <rpc> elemento tag.
<rpc>
<get-interface-information format="json">
<brief/>
<interface-name>cbp0</interface-name>
</get-interface-information>
</rpc>
]]>]]>
Cuando la aplicación cliente incluye el format="json" atributo en la etiqueta de solicitud, el servidor de protocolo XML junos formatee la respuesta mediante JSON.
<rpc-reply xmlns:junos="http://xml.juniper.net/junos/16.1R1/junos">
{
"interface-information" : [
{
"attributes" : {"xmlns" : "http://xml.juniper.net/junos/16.1R1/junos-interface",
"junos:style" : "brief"
},
"physical-interface" : [
{
"name" : [
{
"data" : "cbp0"
}
],
"admin-status" : [
{
"data" : "up",
"attributes" : {"junos:format" : "Enabled"}
}
],
"oper-status" : [
{
"data" : "up"
}
],
"if-type" : [
{
"data" : "Ethernet"
}
],
"link-level-type" : [
{
"data" : "Ethernet"
}
],
"mtu" : [
{
"data" : "1514"
}
],
"speed" : [
{
"data" : "Unspecified"
}
],
"clocking" : [
{
"data" : "Unspecified"
}
],
"if-device-flags" : [
{
"ifdf-present" : [
{
"data" : [null]
}
],
"ifdf-running" : [
{
"data" : [null]
}
]
}
],
"ifd-specific-config-flags" : [
{
"internal-flags" : [
{
"data" : "0x0"
}
]
}
],
"if-config-flags" : [
{
"iff-snmp-traps" : [
{
"data" : [null]
}
]
}
]
}
]
}
]
}
</rpc-reply>
A partir de Junos OS versión 17.3R1, los dispositivos que ejecutan Junos OS admiten emitir el estado operativo del dispositivo en formato JSON compacto, en el que solo los objetos que tienen varios valores se emiten como matrices JSON. Para configurar el dispositivo para que emita formato JSON compacto, configure la compact instrucción en el [edit system export-format state-data json] nivel jerárquico.
user@host# set system export-format state-data json compact
En el siguiente ejemplo se ejecuta el show system uptime comando y se muestra la salida en formato JSON no compacto y compacto.
user@host> show system uptime | display json
Formato JSON no compacto:
{
"system-uptime-information" : [
{
"attributes" : {"xmlns" : "http://xml.juniper.net/junos/18.1R1/junos"},
"current-time" : [
{
"date-time" : [
{
"data" : "2018-05-15 13:43:46 PDT",
"attributes" : {"junos:seconds" : "1526417026"}
}
]
}
],
"time-source" : [
{
"data" : " NTP CLOCK "
}
],
"system-booted-time" : [
{
"date-time" : [
{
"data" : "2018-05-15 10:57:02 PDT",
"attributes" : {"junos:seconds" : "1526407022"}
}
],
"time-length" : [
{
"data" : "02:46:44",
"attributes" : {"junos:seconds" : "10004"}
}
]
}
],
"protocols-started-time" : [
{
"date-time" : [
{
"data" : "2018-05-15 10:59:33 PDT",
"attributes" : {"junos:seconds" : "1526407173"}
}
],
"time-length" : [
{
"data" : "02:44:13",
"attributes" : {"junos:seconds" : "9853"}
}
]
}
],
"last-configured-time" : [
{
"date-time" : [
{
"data" : "2018-05-02 17:57:44 PDT",
"attributes" : {"junos:seconds" : "1525309064"}
}
],
"time-length" : [
{
"data" : "1w5d 19:46",
"attributes" : {"junos:seconds" : "1107962"}
}
],
"user" : [
{
"data" : "admin"
}
]
}
],
"uptime-information" : [
{
"date-time" : [
{
"data" : "1:43PM",
"attributes" : {"junos:seconds" : "1526417026"}
}
],
"up-time" : [
{
"data" : "2:47",
"attributes" : {"junos:seconds" : "10034"}
}
],
"active-user-count" : [
{
"data" : "1",
"attributes" : {"junos:format" : "1 user"}
}
],
"load-average-1" : [
{
"data" : "0.49"
}
],
"load-average-5" : [
{
"data" : "0.19"
}
],
"load-average-15" : [
{
"data" : "0.10"
}
]
}
]
}
]
}
El formato JSON compacto para el mismo comando es:
{
"system-uptime-information" :
{
"current-time" :
{
"date-time" : "2018-05-15 13:49:56 PDT"
},
"time-source" : " NTP CLOCK ",
"system-booted-time" :
{
"date-time" : "2018-05-15 10:57:02 PDT",
"time-length" : "02:52:54"
},
"protocols-started-time" :
{
"date-time" : "2018-05-15 10:59:33 PDT",
"time-length" : "02:50:23"
},
"last-configured-time" :
{
"date-time" : "2018-05-15 13:49:40 PDT",
"time-length" : "00:00:16",
"user" : "admin"
},
"uptime-information" :
{
"date-time" : "1:49PM",
"up-time" : "2:53",
"active-user-count" : "1",
"load-average-1" : "0.00",
"load-average-5" : "0.06",
"load-average-15" : "0.06"
}
}
}