estado de la red
10 min
El componente networkstatus proporciona acceso al estado actual de red del reproductor. Proporciona el estado actual en lugar de la configuración prevista. Por ejemplo, las direcciones IP actuales asignadas a las interfaces de red pueden recuperarse desde networkstatus cuando el reproductor está configurado para usar DHCP. Este componente puede utilizarse para determinar las direcciones IP reales y otras configuraciones de red que están activas actualmente.
IDL de networkstatus
[
Constructor()
] interface NetworkStatus {
Promise<NetworkHostStatus> getHostStatus();
Promise<DiagnosticWebServerStatus> getDiagnosticWebServerStatus();
Promise<RemoteLoginStatus> getRemoteLoginStatus();
Promise<NetworkInterfaceStatus> getInterfaceStatus(string interfaceName);
Promise<WifiInterfaceStatus> getInterfaceWifiStatus(string interfaceName);
Promise<Array<string>> getPresentNetworkInterfaces();
Promise<Array<NetworkStatusRoute>> getRoutes(string protocol); // "IPv4" or "IPv6"
};
interface NetworkHostStatus {
attribute string hostName;
attribute string mDnsHostName;
attribute Array<string> domainSearchPath;
attribute Array<string> domainNameServers;
attribute Array<string> timeServers;
attribute string? proxy;
attribute Array<string>? proxyBypass;
attribute string? crashUrl;
attribute string? errorUrl;
attribute string? recoveryUrl;
};
interface DiagnosticWebServerStatus {
attribute short? port;
};
interface RemoteLoginStatus {
attribute unsigned short? telnetPort; // Not present if not enabled
attribute unsigned short? sshPort; // Not present if not enabled
};
interface NetworkInterfaceStatus {
attribute string? type;
attribute bool present; // Interface is actually present (e.g. WiFi may be configured but removed)
attribute string presentStatus;
attribute bool? hasLink;
attribute string? macAddress;
attribute bool? isVlan; // This interface is itself a VLAN
attribute short? vlanTag;
attribute string? parentInterface; // The underlying physical interface for a VLAN
attribute Array<short>? vlanChildTagList; // VLANs on this interface. Includes zero for untagged.
attribute Array<NetworkStatusIpAddress>? ipAddressList; // Includes all IPv4 and IPv6 addresses
attribute long? inboundShaperRate;
attribute Array<string>? domainSearchPath;
attribute Array<string>? domainNameServers;
};
interface NetworkStatusIpAddress {
attribute string family; // "IPv4" or "IPv6"
attribute string scope;
attribute string? address; // "172.30.1.30" or "fd44:d8b8:cab5:cb01::19"
attribute string? netmask; // IPv4 only
attribute string? broadcast; // IPv4 only
attribute int? prefixLength; // IPv4 and IPv6
attribute string? cidr; // Address with prefix length in CIDR notation
};
interface WifiInterfaceStatus {
attribute string mode; // "AP" or "STA"
attribute bool? connected; // (Not present in AP mode.)
attribute string? essid;
attribute string? bssid; // (Not present in AP mode.)
attribute string? frequency; // In MHz to match other APIs
attribute int? signalStrength; // In dBm
};
interface NetworkStatusRoute {
attribute string destination; // or "default"
attribute string? source;
attribute int metric;
attribute Array<NextHops> nextHops;
};
interface NetworkStatusNextHop {
attribute string? gateway;
attribute string? interface;
} Creación de objetos
Para crear un componente networkstatus, cargue el módulo @brightsign/networkstatus usando el método require().
const NetworkStatus = require("@brightsign/networkstatus");
let networkStatus = new NetworkStatus();NetworkStatus
getHostStatus()
Promise<NetworkHostStatus> getHostStatus() Devuelve información sobre el estado de red del reproductor en su conjunto.
getDiagnosticWebServerStatus()
Promise<DiagnosticWebServerStatus> getDiagnosticWebServerStatus() Devuelve información sobre el estado del servidor web de diagnóstico.
getRemoteLoginStatus()
Promise<RemoteLoginStatus> getRemoteLoginStatus() Devuelve información sobre el estado del reproductor relacionada con el acceso remoto al shell.
getInterfaceStatus()
Promise<NetworkInterfaceStatus> getInterfaceStatus(string interfaceName)Devuelve información sobre el estado actual de la interfaz de red especificada.
getInterfaceWifiStatus()
Promise<WifiInterfaceStatus> getInterfaceWifiStatus(string interfaceName)Devuelve información sobre el estado WiFi actual de la interfaz de red inalámbrica especificada.
getPresentNetworkInterfaces()
Promise<Array<string>> getPresentNetworkInterfaces()Devuelve un arreglo que contiene los nombres de todas las interfaces de red externas presentes en el reproductor. No incluye la interfaz de loopback.
getRoutes()
Promise<Array<NetworkStatusRoute>> getRoutes(string protocol); // "IPv4" or "IPv6"Devuelve una matriz de las rutas de red actuales para el protocolo especificado.
NetworkHostStatus
- nombreDelHost string: El nombre de host actual del reproductor.
- mDnsHostName string: El nombre de host actual de Multicast DNS del reproductor. Normalmente será el nombre de host del reproductor con ".local" al final, pero puede diferir si hay conflictos en la red local.
- domainSearchPath Array<string>: Una lista de sufijos que se aplicarán a nombres de dominio no calificados al buscarlos en DNS. Esta es la combinación de las rutas de búsqueda para todas las interfaces de red activas.
- domainNameServers Array<string>: Una lista de los servidores DNS actuales que se consultarán al realizar búsquedas de nombres. Esta es la combinación de todos los servidores DNS para todas las interfaces de red activas.
- timeServers Array<string>: Una lista de los servidores de hora actuales que se utilizarán para configurar el reloj del reproductor. Actualmente esto contendrá cero o una entrada, pero puede contener más en el futuro.
- proxy string optional: El servidor proxy de red actualmente activo, si existe.
- proxyBypass Array<string> optional: Una lista de sufijos de nombre de host para los que se omitirá el proxy (no pueden utilizarse direcciones IP)
- crashUrl string optional: La URL a la que se publicarán los volcados de fallos del reproductor, si existe.
- errorUrl string optional: La URL a la que se publicarán los errores de BrightScript, si existe.
- URL de recuperación string optional: La URL que se consultará para determinar si el reproductor debe entrar en recuperación, si existe.
DiagnosticWebServerStatus
- puerto short optional: El número de puerto en el que se ejecutará el servidor web. Si el servidor web está deshabilitado, este atributo no estará presente.
RemoteLoginStatus
- telnetPort unsigned short optional: El número de puerto en el que el reproductor escuchará conexiones telnet. Si telnet no está habilitado, este atributo no estará presente.
- sshPort unsigned short optional: El número de puerto en el que el reproductor escuchará conexiones de shell segura. Si ssh no está habilitado, este atributo no estará presente.
NetworkInterfaceStatus
- tipo string optional: Si la interfaz está presente, este atributo contendrá "Wired", "WiFi", "Dialup" o "Unknown". Tenga en cuenta que algunos dispositivos de red USB pueden aparecer para el reproductor BrightSign como un tipo cuando en realidad son de un tipo diferente. Por ejemplo, algunos módems de banda ancha aparecen como dispositivos Ethernet "Wired".
- presente bool: Indica si la interfaz de red especificada está presente actualmente en el reproductor.
- estadoActual string: Proporciona información adicional legible por humanos que explica por qué la interfaz no está presente. Por ejemplo, es posible que una interfaz VLAN no se haya habilitado en su interfaz física correspondiente.
- hasLink bool optional: Indica si la interfaz de red tiene actualmente enlace
- macAddressstring optional: Contiene la dirección MAC de hardware para las interfaces de red que tienen una.
- isVlan bool optional: Indica si esta interfaz de red es una VLAN sobre otra interfaz de red inferior.
- vlanTag short optional: Si esta interfaz es una VLAN, este atributo contiene el valor de etiqueta que se utilizará en la interfaz inferior.
- parentInterface string optional: Si esta interfaz es una VLAN, este atributo contiene el nombre de la interfaz inferior en la que se enviarán los paquetes.
- vlanChildTagList Array<short> optional: Si esta interfaz de red tiene interfaces VLAN ejecutándose sobre ella, este arreglo contiene todos sus valores de etiqueta. El valor de etiqueta especial cero indica que esta interfaz también se utiliza sin etiquetar.
- ipAddressList Array<NetworkStatusIpAddress> optional: Una lista de todas las direcciones IPv4 e IPv6 asignadas a esta interfaz de red.
- inboundShaperRate long optional: Si un conformador de ancho de banda entrante está habilitado para esta interfaz, este atributo contiene la velocidad en bits por segundo.
- domainSearchPath Array<string> optional: Una lista de sufijos que esta interfaz de red aporta a la configuración del host cuando esta interfaz de red está activa. Consulte NetworkHostStatus.
- domainNameServers Array<string> optional: Una lista de servidores DNS que esta interfaz de red aporta a la configuración del host cuando esta interfaz de red está activa. Consulte NetworkHostStatus.
NetworkStatusIpAddress
- familia string: Contiene la familia de direcciones: "IPv4" o "IPv6"
- alcance string: Principalmente útil para direcciones IPv6, este atributo indica el alcance de la dirección. Los valores posibles son "global", "site", "link", "host" y "nowhere".
- dirección string optional: La dirección real como una cadena.
- máscara de red string optional: Solo para direcciones IPv4, este atributo contiene la longitud del prefijo expresada como una máscara de red tradicional.
- difusión string optional: Solo para direcciones IPv4, este atributo contiene la dirección de broadcast de la red.
- prefixLength int optional: Para direcciones IPv4 e IPv6, este atributo contiene el número de bits de la dirección que se utilizan para identificar la red.
- cidr string optional: Para direcciones IPv4 e IPv6, este atributo contiene la dirección y la longitud del prefijo en la sintaxis de enrutamiento interdominio sin clases (CIDR): dirección/prefijo.
WifiInterfaceStatus
- modo string: Indica en qué modo se encuentra actualmente la interfaz WiFi. Cuando está en modo "AP", la interfaz actúa como un punto de acceso inalámbrico para que otros dispositivos inalámbricos se conecten. En modo "STA", la interfaz actúa como un cliente de otro punto de acceso inalámbrico.
- conectado bool optional: Si la interfaz está en modo "STA", indica si la interfaz está conectada a un punto de acceso. En modo "AP", este atributo no está presente.
- essid string optional: Si la interfaz está en modo "STA", indica el ESSID del AP al que está conectada la interfaz. En modo "AP", indica el ESSID que la interfaz inalámbrica está anunciando para que los clientes se conecten.
- bssid string optional: Si la interfaz está en modo "STA", indica el BSSID del AP al que está conectada la interfaz. En modo "AP", este atributo no está presente.
- frecuencia int optional: La frecuencia que la radio de la interfaz inalámbrica está utilizando actualmente, en MHz.
- signalStrength int optional: La intensidad actual de la señal, en dBm.
NetworkStatusRoute
- destino string: El destino de la ruta o "default" para la ruta predeterminada.
- métrica int: La prioridad de la ruta. Se prefieren las rutas con menor prioridad.
- nextHops Array<NextHops>: Una lista de dónde se enviarán a continuación los paquetes sujetos a esta ruta. Actualmente, esta lista contiene solo un elemento.
NetworkStatusNextHop
- puerta de enlace string optional: La dirección a la que se enviarán los paquetes.
- interfaz string opcional: La interfaz de red en la que se enviarán los paquetes.