Endpoints de diagnóstico de rDWS
33 min
url base para estos endpoints https //ws bsn cloud/rest/v1/ get /diagnostics/ ejecuta diagnósticos de red en el reproductor ejemplo de solicitud get /rest/v1/diagnostics/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json cuerpo de la respuesta para cada uno de ethernet , wifi , módem , e internet diagnóstico \<font color="#704ae0">string\</font> indica si este tipo de interfaz está presente registro \<font color="#704ae0">object\[ ]\</font> esto contiene los resultados de diagnóstico para la interfaz nombre \<font color="#704ae0">string\</font> el nombre de la prueba de diagnóstico aprobar \<font color="#704ae0">bool\</font> indica si la prueba pasó o no resultado \<font color="#704ae0">string\</font> el valor real para las pruebas de diagnóstico, como verificar el tipo y el ping vale \<font color="#704ae0">bool\</font> si los diagnósticos se ejecutaron en la interfaz o no ejemplo de respuesta { "route" "/v1/diagnostics", "method" "get", "data" { "result" { "ethernet" { "diagnosis" "ok", "log" \[ { "name" "checking model networking support", "pass" true, "result" "" }, { "name" "checking for ethernet interface", "pass" true, "result" "" }, { "name" "checking interface type", "pass" true, "result" "ethernet" }, { "name" "checking ethernet link", "pass" true, "result" "" }, { "name" "checking ethernet ip address", "pass" true, "result" "" }, { "name" "checking ethernet netmask", "pass" true, "result" "" }, { "name" "checking ethernet gateway", "pass" true, "result" "ping 10/10 1375/1537/1623us" } ], "ok" true }, "wifi" { "diagnosis" "wifi interface not present", "log" \[ { "name" "checking model networking support", "pass" true, "result" "" }, { "name" "checking for wifi interface", "pass" false, "result" "wifi interface not present" } ], "ok" false }, "modem" { "diagnosis" "modem interface not present", "log" \[ { "name" "checking model networking support", "pass" true, "result" "" }, { "name" "checking for modem interface", "pass" false, "result" "modem interface not present" } ], "ok" false }, "internet" { "diagnosis" "ok", "log" \[ { "info" \[ "dns server 2600 1700\ dac0 2060 1 is not a valid ipv4 address" ], "name" "checking dns servers", "pass" true, "result" "at least one dns server is valid" }, { "info" \[ "dns pass/fail/timeout/mismatch udp 50/0/0/0 tcp 50/0/0/0" ], "name" "checking dns server (cached)", "pass" true, "result" "dns servers responded to 100% of potentially cached requests" }, { "info" \[ "dns pass/fail/timeout/mismatch udp 5/0/0/0 tcp 5/0/0/0" ], "name" "checking dns server (hopefully not cached)", "pass" true, "result" "dns servers responded to 100% of hopefully uncached requests" }, { "name" "checking internet connectivity", "pass" true, "result" "ping 10/10 87398/87760/88247us" }, { "name" "checking http", "pass" true, "result" "external ip is 76 218 104 224" }, { "name" "checking time server", "pass" true, "result" "" } ], "ok" true } } } } get /diagnostics/dns lookup/{\ domain name}/ prueba la resolución de nombres en la dirección dns especificada segmento domain name la dirección dns (por ejemplo, google com) ejemplo de solicitud get /rest/v1/diagnostics/dns lookup/google com/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json cuerpo de la respuesta el reproductor consulta cada campo dns por separado y luego recopila los datos devueltos en el objeto registros y los errores devueltos en el objeto listadeerrores se consultan los siguientes campos dns "ipv4", "ipv6", "cname", "mx", "service", "text" registros \<font color="#704ae0">object \</font> ipv4 \<font color="#704ae0">string\[ ]\</font> direcciones ipv4 ipv6 \<font color="#704ae0">string\[ ]\</font> direcciones ipv6 texto \<font color="#704ae0">string\[ ]\</font> registros de texto mx \<font color="#704ae0">object\[ ]\</font> registros de intercambio de correo intercambio \<font color="#704ae0">string\</font> prioridad \<font color="#704ae0">int\</font> server test \<font color="#704ae0">object\</font> tcp \<font color="#704ae0">object\</font> hecho \<font color="#704ae0">int\</font> el número total de solicitudes dns realizadas aprobar \<font color="#704ae0">int\</font> el número total de solicitudes aprobadas fracaso \<font color="#704ae0">int\</font> el número total de solicitudes fallidas tiempo de espera \<font color="#704ae0">int\</font> el número total de solicitudes que agotaron el tiempo de espera desajuste \<font color="#704ae0">int\</font> el número total de solicitudes no coincidentes entre los registros de host y puntero udp \<font color="#704ae0">object\</font> hecho \<font color="#704ae0">int\</font> el número total de solicitudes dns realizadas aprobar \<font color="#704ae0">int\</font> el número total de solicitudes aprobadas fracaso \<font color="#704ae0">int\</font> el número total de solicitudes fallidas tiempo de espera \<font color="#704ae0">int\</font> el número total de solicitudes que agotaron el tiempo de espera desajuste \<font color="#704ae0">int\</font> el número total de solicitudes no coincidentes entre los registros de host y puntero listadeerrores \<font color="#704ae0">object\[ ]\</font> campo \<font color="#704ae0">string\</font> el campo ('ipv4', 'ipv6', 'cname', 'mx', 'service' o 'text') del que provino el error err \<font color="#704ae0">object\</font> errno \<font color="#704ae0">string\</font> número de error (normalmente el mismo valor que code) código \<font color="#704ae0">string\</font> número de código de error (consulte dns | documentación de node js v14 21 3 https //nodejs org/docs/latest v14 x/api/dns html#dns error codes ) llamada al sistema \<font color="#704ae0">string\</font> información sobre la pila de llamadas del sistema nombre de host \<font color="#704ae0">string\</font> el valor pasado en la url ejemplo de respuesta { "route" "/v1/diagnostics/dns lookup/google com", "method" "get", "data" { "result" { "records" { "ipv4" \[ "142 250 105 113", "142 250 105 102", "142 250 105 139", "142 250 105 101", "142 250 105 138", "142 250 105 100" ], "ipv6" \[ "2607\ f8b0 4002\ c0c 8a", "2607\ f8b0 4002\ c0c 8b", "2607\ f8b0 4002\ c0c 71", "2607\ f8b0 4002\ c0c 64" ], "mx" \[ { "exchange" "smtp google com", "priority" 10 } ] }, "server test" { "tcp" { "made" 100, "pass" 100, "fail" 0, "timeout" 0, "mismatch" 0 }, "udp" { "made" 100, "pass" 100, "fail" 0, "timeout" 0, "mismatch" 0 } }, "errorlist" \[ { "field" "cname", "err" { "code" "enodata", "syscall" "querycname", "hostname" "google com" } }, { "field" "service", "err" { "code" "enodata", "syscall" "querysrv", "hostname" "google com" } }, { "field" "text", "err" { "code" "etimeout", "syscall" "querytxt", "hostname" "google com" } } ] } } } get /diagnostics/ping/{\ domain name}/ solicita al reproductor que haga ping a la dirección ip o dns especificada en su red local esta llamada puede tardar más de 10 segundos en devolver una respuesta segmento domain name la dirección ip o dns especificada ejemplo de solicitud get /rest/v1/diagnostics/ping/0 0 0 0/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json cuerpo de la respuesta éxito \<font color="#704ae0">bool\</font> un indicador que indica si la operación se realizó correctamente o no respuesta \<font color="#704ae0">object\</font> nombre de host \<font color="#704ae0">string\</font> el valor que usted pasó en la url resultados \<font color="#704ae0">object\</font> ipv4 \<font color="#704ae0">object\[ ]\</font> dirección \<font color="#704ae0">string\</font> la dirección ipv4 a la que se hace ping resultados \<font color="#704ae0">object\</font> recibido \<font color="#704ae0">int\</font> la cantidad de paquetes recibidos estadísticas \<font color="#704ae0">object\</font> promedio \<font color="#704ae0">int\</font> el tiempo promedio para que el paquete regrese el más rápido \<font color="#704ae0">int\</font> el tiempo más rápido para que el paquete regrese más lento \<font color="#704ae0">int\</font> el tiempo más lento para que el paquete regrese unidades \<font color="#704ae0">int\</font> las unidades de tiempo (normalmente microsegundos) transmitido \<font color="#704ae0">int\</font> la cantidad de paquetes transmitidos ipv6 \<font color="#704ae0">object\[ ]\</font> esto solo se devolverá si ipv6 está presente interfaz \<font color="#704ae0">string\</font> fuente \<font color="#704ae0">string\</font> dirección \<font color="#704ae0">string\</font> la dirección ipv6 a la que se hace ping resultados \<font color="#704ae0">object\</font> recibido \<font color="#704ae0">int\</font> la cantidad de paquetes recibidos transmitido \<font color="#704ae0">int\</font> la cantidad de paquetes transmitidos la entrada ipv6 solo se devolverá si ipv6 está presente ejemplo de respuesta { "route" "/v1/diagnostics/ping/0 0 0 0", "method" "get", "data" { "result" { "success" true, "response" { "hostname" "0 0 0 0", "results" { "ipv4" \[ { "address" "0 0 0 0", "results" { "received" 10, "stats" { "average" 318, "quickest" 223, "slowest" 336, "units" "us" }, "transmitted" 10 }, "up" true } ] }, "up" true } } } } get /diagnostics/trace route/{\ domain name}/ solicita al reproductor que realice un diagnóstico estándar de trace route en la dirección ip o dns especificada esta llamada puede tardar varios minutos en devolver una respuesta segmento domain name la dirección ip o dns especificada parámetro de cadena de consulta resolverdirección \<font color="#704ae0">bool\</font> especifica si la dirección ip o dns debe resolverse o no ejemplo de solicitud get /rest/v1/diagnostics/trace route/google com/?resolveaddress=true\&destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json cuerpo de la respuesta dirección \<font color="#704ae0">string\</font> la dirección ip en la que está ejecutando la ruta de rastreo resultados \<font color="#704ae0">object\</font> salida \<font color="#704ae0">string\[ ]\</font> devuelve la información de salida de la ruta de rastreo en formato de texto protocolo \<font color="#704ae0">string\</font> el protocolo ip, por ejemplo, "ipv4" ruta \<font color="#704ae0">object\[ ]\</font> salto \<font color="#704ae0">int\</font> cuántas veces los datos se mueven de un router al siguiente servidores \<font color="#704ae0">object\</font> dirección \<font color="#704ae0">string\</font> la dirección a la que se realiza la solicitud de ruta de rastreo nombre de host \<font color="#704ae0">string\</font> el nombre de host del servidor estadísticas \<font color="#704ae0">object\</font> alcanzable \<font color="#704ae0">string\</font> tiempo \<font color="#704ae0">string\</font> el tiempo requerido para que la solicitud de ruta de rastreo regrese unidades \<font color="#704ae0">string\</font> las unidades de tiempo (generalmente en milisegundos) ejemplo de respuesta { "route" "/v1/diagnostics/trace route/152 101 32 76", "method" "get", "data" { "result" { "address" "123 456 7 890", "resolveaddress" "true", "results" { "152 101 32 76" { "output" \[ "traceroute to 152 101 32 76 (152 101 32 76), 30 hops max, 46 byte packets", " 1 10 0 4 1 0 744 ms 0 458 ms 1 740 ms", " 2 192 168 0 1 1 738 ms 1 387 ms 1 387 ms", " 3 96 120 89 217 10 553 ms 11 250 ms 11 961 ms", " 4 96 110 176 145 11 958 ms 11 250 ms 9 845 ms", " 5 162 151 78 253 11 957 ms 13 366 ms 10 549 ms", " 6 96 108 99 249 13 366 ms 14 072 ms 20 414 ms", " 7 68 86 143 93 13 368 ms 11 960 ms 10 549 ms", " 8 96 97 98 246 32 397 ms 96 112 146 22 11 954 ms 69 241 75 42 9 841 ms", " 9 ", "10 152 101 32 76 10 452 ms 152 101 32 76 13 302 ms 152 101 32 76 12 649 ms", "11 192 178 105 102 11 948 ms 142 251 224 181 11 073 ms 192 178 46 198 17 759 ms", "12 142 251 32 46 11 955 ms 12 649 ms 10 543 ms" ], "protocol" "ipv4", "result" 0, "route" \[ { "error" "timeout", "hop" 9 } ] } } } } } get /diagnostics/network configuration/{\ interface}/ recupera información sobre la configuración de la interfaz de red en el reproductor segmento interfaz la interfaz de red los nombres posibles incluyen eth0 , wlan0 , y módem ejemplo de solicitud get /rest/v1/diagnostics/network configuration/eth0/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json cuerpo de la respuesta algunas entradas (p ej , cacertificates , identificadordelcliente ) son idénticas para todas las interfaces texto \<font color="#704ae0">string\</font> la información de configuración de red en formato de texto sin formato salida \<font color="#704ae0">output\</font> la información de configuración de red como un objeto json interfaces \<font color="#704ae0">interface\[ ]\</font> un arreglo de objetos interface que representan interfaces de red nombre \<font color="#704ae0">string\</font> el nombre de la interfaz (por ejemplo, "eth0" ) errores \<font color="#704ae0">error\[ ]\</font> un arreglo de mensajes de error asociados con la interfaz params \<font color="#704ae0">param\[ ]\</font> un arreglo de objetos param que representan parámetros asociados con la interfaz de red cada interfaz param tiene las siguientes entradas nombre \<font color="#704ae0">string\</font> el nombre de la propiedad (p ej "mac" ) valor \<font color="#704ae0">string\</font> el valor de la propiedad (p ej "90\ ac 3f 0b\ d2 88" ) anfitrión \<font color="#704ae0">info\[ ]\</font> un arreglo de objetos info que proporcionan información del host de red cada objeto puede tener las siguientes entradas errores \<font color="#704ae0">error\[ ]\</font> un arreglo de mensajes de error asociados con el host de red params \<font color="#704ae0">param\[ ]\</font> un arreglo de objetos param que representan parámetros asociados con el host de red bsn \<font color="#704ae0">info\[ ]\</font> un arreglo de objetos info que proporcionan información sobre la comunicación bsn otro \<font color="#704ae0">info\[ ]\</font> un arreglo de objetos info que proporcionan información diversa de la red cacertificate \<font color="#704ae0">string\</font> el contenido de un archivo de certificado ca en formato de texto (es decir, un archivo "pem") clientcertificate \<font color="#704ae0">bool\</font> un indicador que señala si el reproductor está utilizando un certificado de cliente identificadordelcliente \<font color="#704ae0">string\</font> el identificador de cliente dhcp para la interfaz de red dnsserverlist \<font color="#704ae0">string\[ ]\</font> una lista de direcciones ip de los servidores dns dominio \<font color="#704ae0">string\</font> el nombre de dominio para la interfaz de red eaptlsoptions \<font color="#704ae0">string\</font> una cadena que contiene opciones específicas de eap enabledprotocollist \<font color="#704ae0">string\[ ]\</font> una matriz de protocolos ip habilitados los valores compatibles actualmente son "ipv4" y " ipv6" identidad \<font color="#704ae0">string\</font> la identidad radius ipaddresslist \<font color="#704ae0">string\[ ]\</font> las direcciones ip asignadas al reproductor inboundshaperrate \<font color="#704ae0">int\</font> el límite de ancho de banda para el tráfico entrante en bits por segundo un valor de 1 especifica el límite de ancho de banda predeterminado y un valor de 0 especifica que no hay límite de ancho de banda (estas dos configuraciones son funcionalmente iguales) métrica \<font color="#704ae0">int\</font> la métrica de enrutamiento para la puerta de enlace predeterminada en la interfaz las rutas con métricas más bajas tienen prioridad sobre las rutas con métricas más altas mtu \<font color="#704ae0">int\</font> la unidad máxima de transmisión (mtu) para la interfaz de red en bytes privatekey \<font color="#704ae0">string\</font> la clave privada para la autenticación vlanidlist \<font color="#704ae0">int\[ ]\</font> una matriz de ids de vlan compatibles con la interfaz de red principal modo de seguridad \<font color="#704ae0">string\</font> modo de seguridad para la autenticación ejemplo de respuesta { "route" "/v1/diagnostics/network configuration/eth0", "method" "get", "data" { "result" { "success" true, "response" \[ { "text" "\r\ninterface eth0\r\ntype wired\r\nlink yes\r\nconfiguration dhcp\r\nclient id brightsign\ re433d006644\r\nmac 90\ ac 3f 2a 01 79\r\ncurrent ip 192 168 1 174\r\nnetmask 255 255 255 0\r\nbroadcast 192 168 1 255\r\ngateway 192 168 1 254\r\nip6 address 2600 1700\ dac0 2060 43/128\r\nip6 address 2600 1700\ dac0 2060 92ac 3fff\ fe2a 179/64\r\nip6 address fe80 92ac 3fff\ fe2a 179/64\r\nmetric 0\r\ndomains attlocal net\r\ndns 192 168 1 254\r\n 2600 1700\ dac0 2060 1\r\nshape inbound no\r\n\r\nhost \r\nhost name brightsign re433d006644\r\nmdns host name brightsign re433d006644 local\r\ntime server http //time brightsignnetwork com\r\nproxy bypass \<none>\r\n\r\nbsn \r\ncrash url https //crashes brightsignnetwork com/bs/crashdump\r\nerror url https //handlers bsn cloud//bs/error ashx\r\nrecovery url https //handlers bsn cloud//recovery/recovery ashx\r\n\r\nother \r\nhttp port \r\n\r\n\r\n", "output" { "interfaces" \[ { "name" "eth0", "errors" \[], "params" \[ { "name" "type", "value" \[ "wired" ] }, { "name" "link", "value" \[ "yes" ] }, { "name" "configuration", "value" \[ "dhcp" ] }, { "name" "client id", "value" \[ "brightsign\ re433d006644" ] }, { "name" "mac", "value" \[ "90\ ac 3f 2a 01 79" ] }, { "name" "current ip", "value" \[ "192 168 1 174" ] }, { "name" "netmask", "value" \[ "255 255 255 0" ] }, { "name" "broadcast", "value" \[ "192 168 1 255" ] }, { "name" "gateway", "value" \[ "192 168 1 254" ] }, { "name" "ip6 address", "value" \[ "2600 1700\ dac0 2060 43/128" ] }, { "name" "ip6 address", "value" \[ "2600 1700\ dac0 2060 92ac 3fff\ fe2a 179/64" ] }, { "name" "ip6 address", "value" \[ "fe80 92ac 3fff\ fe2a 179/64" ] }, { "name" "metric", "value" \[ "0" ] }, { "name" "domains", "value" \[ "attlocal net" ] }, { "name" "dns", "value" \[ "192 168 1 254", "2600 1700\ dac0 2060 1" ] }, { "name" "shape inbound", "value" \[ "no" ] } ] } ], "host" \[ { "errors" \[], "params" \[ { "name" "host name", "value" \[ "brightsign re433d006644" ] }, { "name" "mdns host name", "value" \[ "brightsign re433d006644 local" ] }, { "name" "time server", "value" \[ "http //time brightsignnetwork com" ] }, { "name" "proxy bypass", "value" \[ "\<none>" ] } ] } ], "bsn" \[ { "errors" \[], "params" \[ { "name" "crash url", "value" \[ "https //crashes brightsignnetwork com/bs/crashdump" ] }, { "name" "error url", "value" \[ "https //handlers bsn cloud//bs/error ashx" ] }, { "name" "recovery url", "value" \[ "https //handlers bsn cloud//recovery/recovery ashx" ] } ] } ], "other" \[ { "errors" \[], "params" \[ { "name" "http port", "value" \[ "" ] } ] } ] } }, { "cacertificates" "", "clientcertificate" false, "clientidentifier" "brightsign\ re433d006644", "dnsserverlist" \[], "domain" "", "eaptlsoptions" "", "enabledprotocollist" \[ "ipv4", "ipv6" ], "identity" "", "ipaddresslist" \[], "metric" 0, "privatekey" false, "securitymode" "", "vlanidlist" \[] } ] } } } put /diagnostics/network configuration/{\ interface}/ aplica una configuración de red de prueba en el reproductor debe usar get para obtener los parámetros de configuración antes de establecerla mediante esta api los parámetros texto y salida no son necesarios en put segmento interfaz la interfaz de red los nombres posibles incluyen eth0 , wlan0 , y módem cuerpo de la solicitud cacertificate \<font color="#704ae0">string\</font> \<font color="#01a0af">optional\</font> el contenido de un archivo de certificado de ca en formato de texto (es decir, un archivo "pem") clientcertificate \<font color="#704ae0">bool\</font> \<font color="#01a0af">optional\</font> un indicador de si el reproductor está usando un certificado de cliente identificadordelcliente \<font color="#704ae0">string\</font> \<font color="#01a0af">optional\</font> el identificador de cliente dhcp para la interfaz de red dnsserverlist \<font color="#704ae0">string\[ ]\</font> \<font color="#01a0af">optional\</font> una lista de direcciones ip de los servidores dns dominio \<font color="#704ae0">string\</font> \<font color="#01a0af">optional\</font> el nombre de dominio para la interfaz de red eaptlsoptions \<font color="#704ae0">string\</font> \<font color="#01a0af">optional\</font> una cadena que contiene opciones específicas de eap enabledprotocollist \<font color="#704ae0">string\[ ]\</font> \<font color="#01a0af">optional\</font> una matriz de protocolos ip habilitados actualmente, los valores compatibles son "ipv4" y "ipv6" identidad \<font color="#704ae0">string\</font> \<font color="#01a0af">optional\</font> la identidad radius ipaddresslist \<font color="#704ae0">string\[ ]\</font> \<font color="#01a0af">optional\</font> las direcciones ip asignadas al reproductor inboundshaperrate \<font color="#704ae0">int\</font> \<font color="#01a0af">optional\</font> el límite de ancho de banda para el tráfico entrante en bits por segundo un valor de 1 especifica el límite de ancho de banda predeterminado y un valor de 0 especifica que no hay límite de ancho de banda (estas dos configuraciones son funcionalmente iguales) métrica \<font color="#704ae0">int\</font> \<font color="#01a0af">optional\</font> la métrica de enrutamiento para la puerta de enlace predeterminada en la interfaz las rutas con métricas más bajas tienen prioridad sobre las rutas con métricas más altas mtu \<font color="#704ae0">int\</font> \<font color="#01a0af">optional\</font> la unidad máxima de transmisión (mtu) para la interfaz de red en bytes privatekey \<font color="#704ae0">string\</font> \<font color="#01a0af">optional\</font> la clave privada para la autenticación vlanidlist \<font color="#704ae0">int\[ ]\</font> \<font color="#01a0af">optional\</font> un arreglo de ids de vlan compatibles con la interfaz de red principal modo de seguridad \<font color="#704ae0">string\</font> \<font color="#01a0af">optional\</font> modo de seguridad para la autenticación ejemplo de solicitud los parámetros y encabezados de la solicitud de ejemplo se establecen de la siguiente manera put /rest/v1/diagnostics/network configuration/eth0 http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json content type application/json content length 75 este es el cuerpo de la solicitud de ejemplo { "data" { "cacertificates" "", "clientcertificate" false, "clientidentifier" "brightsign\ d7e8cv332141", "dnsserverlist" \[], "domain" "", "eaptlsoptions" "", "enabledprotocollist" \[ "ipv4", "ipv6" ], "identity" "", "ipaddresslist" \[], "privatekey" false, "securitymode" "", "vlanidlist" \[] } } get /diagnostics/network neighborhood/ recupera información sobre el entorno de red actual del reproductor (los otros reproductores en la misma red) ejemplo de solicitud get /rest/v1/diagnostics/network neighborhood/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json cuerpo de la respuesta éxito \<font color="#704ae0">bool\</font> un indicador que indica si la operación se realizó correctamente respuesta \<font color="#704ae0">object\[ ]\</font> un arreglo de información sobre los reproductores en su entorno de red chassis descr \<font color="#704ae0">string\</font> la versión del modelo, la versión del sistema operativo, el número de serie, etc chassis id \<font color="#704ae0">string\</font> un identificador único para el reproductor nombre del chasis \<font color="#704ae0">string\</font> el nombre del reproductor mgmt ip \<font color="#704ae0">string\</font> port descr \<font color="#704ae0">string\</font> qué interfaz está utilizando el reproductor port id \<font color="#704ae0">string\</font> vlan pvid \<font color="#704ae0">string\</font> si no se pudo realizar el diagnóstico, el cuerpo de la respuesta puede ser en cambio un mensaje de error ejemplo de respuesta { "route" "/v1/diagnostics/network neighborhood", "method" "get", "data" { "result" { "success" true, "response" \[ { "chassis descr" "brightsign xt1144 reve 8 5 47 uhe115005214", "chassis id" "90\ ac 3f 28\ fb\ a4", "chassis name" "brightsign uhe115005214", "mgmt ip" "2601 647 4500 1e5e 92ac 3fff\ fe28\ fba4", "port descr" "eth0", "port id" "90\ ac 3f 28\ fb\ a4", "vlan pvid" "0" } ] } } } get /diagnostics/packet capture/ obtiene el estado actual de la operación de captura de paquetes la operación de captura de paquetes requiere que el dws heredado esté funcionando ejemplo de solicitud get /rest/v1/diagnostics/packet capture/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json cuerpo de la respuesta statuscode \<font color="#704ae0">int\</font> el código de éxito o error (200 es éxito) is running \<font color="#704ae0">bool\</font> indicador que indica si la operación de captura de paquetes está en ejecución ejemplo de respuesta { "route" "/v1/diagnostics/packet capture", "method" "get", "data" { "result" { "statuscode" 200, "is running" false } } } post /diagnostics/packet capture/ inicia una operación de captura de paquetes cuerpo de la solicitud nombre de archivo \<font color="#704ae0">string\</font> el nombre del archivo de captura de paquetes si no pasa esta cadena, 'capture pcap' es el valor predeterminado interfaz \<font color="#704ae0">string\</font> el nombre de la interfaz para la cual se está realizando la captura de paquetes 'eth0' es el valor predeterminado duración \<font color="#704ae0">int\</font> la duración durante la cual se ejecuta la captura de paquetes en segundos el valor predeterminado es 300 segundos (5 minutos) maxpackets \<font color="#704ae0">int\</font> el número máximo de paquetes que se capturarán antes de finalizar el proceso 0 es el valor predeterminado snaplen \<font color="#704ae0">int\</font> el tamaño máximo de cada paquete especificar 0 indicará a la función que capture el paquete completo sin importar el tamaño filtro \<font color="#704ae0">string\</font> un campo para el filtrado condicional de paquetes esta operación utiliza sintaxis pcap estándar esta cadena está vacía de forma predeterminada ejemplo de solicitud post /rest/v1/diagnostics/packet capture/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json content type application/json content length 190 este es el cuerpo de solicitud de ejemplo { "data" { "filename" "capture pcap", "interface" "eth0", "duration" 300, "maxpackets" 0, "snaplen" 0, "filter" "" } } ejemplo de respuesta { "data" { "result" { "statuscode" 200, "is running" true } }, "route" "/v1/diagnostics/packet capture", "method" "post" } delete /diagnostics/packet capture/ detiene una operación de captura de paquetes ejemplo de solicitud delete /rest/v1/diagnostics/packet capture/?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json, application/vnd bsn error+json ejemplo de respuesta { "route" "/v1/diagnostics/packet capture", "method" "delete", "data" { "result" { "statuscode" 200, "is running" false } } } get /diagnostics/telnet/ obtiene información sobre telnet del reproductor, incluido su estado habilitado y número de puerto esto solo está disponible en bos 9 0 110 y versiones posteriores ejemplo de solicitud get /rest/v1/diagnostics/telnet?destinationtype=player\&destinationname={{deviceserial}} http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} ejemplo de respuesta { "route" "/v1/diagnostics/telnet", "method" "get", "data" { "result" { "enabled" true, "portnumber" 23 } } } put /diagnostics/telnet/ esto solo está disponible en bos 9 0 110 y versiones posteriores cuerpo de la solicitud habilitado \<font color="#704ae0">bool\</font> habilita o deshabilita telnet en el reproductor númerodepuerto \<font color="#704ae0">int\</font> el número de puerto en el que se habilitará telnet reinicio \<font color="#704ae0">bool\</font> este parámetro opcional reinicia el reproductor inmediatamente después de ejecutar esta operación es verdadero de forma predeterminada ejemplo de solicitud los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera put /rest/v1/diagnostics/telnet/ http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json content type application/json content length 75 este es el cuerpo de la solicitud de ejemplo { "data" { "enabled" true "portnumber" "23", "password" {{password}} } } ejemplo de respuesta { "data" { "result" { "success" true, "reboot" true } }, "route" "/v1/diagnostics/telnet", "method" "put" } get /diagnostics/ssh/ devuelve información sobre si ssh está habilitado o no en el reproductor, y el número de puerto en el que está habilitado, si lo está esto solo está disponible en bos 9 0 110 y versiones posteriores ejemplo de solicitud los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera get /rest/v1/diagnostics/ssh/ http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json ejemplo de respuesta una respuesta correcta es un \<font color="#15803d">200\</font> y este cuerpo de respuesta { "enabled" true, "portnumber" 22, "password" true // indicates that a value is set } put /diagnostics/ssh/ esto solo está disponible en bos 9 0 110 y versiones posteriores cuerpo de la solicitud habilitado \<font color="#704ae0">bool\</font> habilita o deshabilita ssh en el reproductor númerodepuerto \<font color="#704ae0">int\</font> el número de puerto en el que se habilitará ssh contraseña \<font color="#704ae0">string\</font> establece la contraseña de inicio de sesión en texto plano para la conexión ssh reinicio \<font color="#704ae0">bool\</font> este parámetro opcional reinicia el reproductor inmediatamente después de ejecutar esta operación es verdadero de forma predeterminada contraseñaofuscada \<font color="#704ae0">string\</font> este parámetro opcional establece la contraseña de inicio de sesión para la conexión ssh la contraseña debe haber sido previamente ofuscada usando un secreto compartido contacte con support\@brightsign biz mailto\ support\@brightsign biz para obtener más información sobre cómo generar una clave para la ofuscación y almacenarla en el reproductor ejemplo de solicitud los parámetros y encabezados de la solicitud de ejemplo se configuran de la siguiente manera put /rest/v1/diagnostics/ssh/ http/1 1 host ws bsn cloud authorization bearer {{useraccesstoken}} accept application/json content type application/json content length 65 este es el cuerpo de la solicitud de ejemplo { "data" { "enabled" true, "portnumber" 22, "password" {{password}} } } ejemplo de respuesta { "data" { "result" { "success" true, "reboot" true } }, "route" "/v1/diagnostics/ssh", "method" "put" }