diff --git a/reference/ssh2/functions/ssh2-auth-agent.xml b/reference/ssh2/functions/ssh2-auth-agent.xml index 0a13bf853..5fd01a528 100644 --- a/reference/ssh2/functions/ssh2-auth-agent.xml +++ b/reference/ssh2/functions/ssh2-auth-agent.xml @@ -1,7 +1,5 @@ - - - + ssh2_auth_agent @@ -21,7 +19,7 @@ La función ssh2_auth_agent solo está disponible - cuando la extensión ssh2 ha sido compilada con libssh >= 1.2.3. + cuando la extensión ssh2 ha sido compilada con libssh2 >= 1.2.3. diff --git a/reference/ssh2/functions/ssh2-auth-pubkey-file.xml b/reference/ssh2/functions/ssh2-auth-pubkey-file.xml index 6c8722d96..31268f775 100644 --- a/reference/ssh2/functions/ssh2-auth-pubkey-file.xml +++ b/reference/ssh2/functions/ssh2-auth-pubkey-file.xml @@ -1,7 +1,5 @@ - - - + ssh2_auth_pubkey_file @@ -106,7 +104,7 @@ if (ssh2_auth_pubkey_file($connection, 'username', &reftitle.notes; - La biblioteca libssh subyacente no soporta muy limpiamente las + La biblioteca libssh2 subyacente no soporta muy limpiamente las autenticaciones parciales. Es decir, que si debe proporcionar a la vez una clave pública y una contraseña, entonces parecerá como si la función estuviera en error. En este caso particular, un error en esta diff --git a/reference/ssh2/functions/ssh2-auth-pubkey.xml b/reference/ssh2/functions/ssh2-auth-pubkey.xml index c259e195e..4cde411fc 100644 --- a/reference/ssh2/functions/ssh2-auth-pubkey.xml +++ b/reference/ssh2/functions/ssh2-auth-pubkey.xml @@ -1,7 +1,5 @@ - - - + ssh2_auth_pubkey @@ -108,7 +106,7 @@ if (ssh2_auth_pubkey($connection, 'username', &reftitle.notes; - La biblioteca libssh subyacente no soporta muy limpiamente las + La biblioteca libssh2 subyacente no soporta muy limpiamente las autenticaciones parciales. Es decir, que si debe proporcionar a la vez una clave pública y una contraseña, entonces parecerá como si la función estuviera en error. En este caso particular, un error en esta diff --git a/reference/ssh2/functions/ssh2-keepalive-config.xml b/reference/ssh2/functions/ssh2-keepalive-config.xml new file mode 100644 index 000000000..471f15d96 --- /dev/null +++ b/reference/ssh2/functions/ssh2-keepalive-config.xml @@ -0,0 +1,142 @@ + + + + + ssh2_keepalive_config + Configura la frecuencia de envío de los mensajes de mantenimiento de conexión + + + + &reftitle.description; + + voidssh2_keepalive_config + resourcesession + boolwant_reply + intinterval + + + Configura con qué frecuencia se envían los mensajes de mantenimiento de + conexión en la session indicada, y si se solicita al + servidor que responda a ellos. + + + Los mensajes de mantenimiento de conexión no se envían automáticamente. Una + vez configurados, se debe llamar a ssh2_keepalive_send + para enviar realmente un mensaje de mantenimiento de conexión. + + + + Esta función solo está disponible cuando la extensión se compila con una + versión de libssh2 que proporciona soporte de mantenimiento de conexión. + + + + + + &reftitle.parameters; + + + session + + + Un identificador de enlace de conexión SSH, obtenido de una llamada a + ssh2_connect. + + + + + want_reply + + + Indica si se solicita al servidor que responda a los mensajes de + mantenimiento de conexión. Solicitar una respuesta permite detectar un + servidor que no responde, a costa de algo de tráfico adicional. + + + + + interval + + + El número de segundos que pueden transcurrir sin ningún tráfico antes de + que deba enviarse un mensaje de mantenimiento de conexión. El valor + 0 deshabilita los mensajes de mantenimiento de + conexión, y el valor 1 es tratado como + 2 por la biblioteca subyacente. + + + Los valores aceptados van de 0 a + 4294967295. + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + + &reftitle.errors; + + Se emite un error de nivel E_WARNING cuando + interval queda fuera del rango aceptado; en ese caso + la configuración del mantenimiento de conexión permanece sin cambios. + + + + + &reftitle.examples; + + Envío de mensajes de mantenimiento de conexión + + +]]> + + + + + + &reftitle.seealso; + + ssh2_keepalive_send + ssh2_connect + + + + + + diff --git a/reference/ssh2/functions/ssh2-keepalive-send.xml b/reference/ssh2/functions/ssh2-keepalive-send.xml new file mode 100644 index 000000000..60399c224 --- /dev/null +++ b/reference/ssh2/functions/ssh2-keepalive-send.xml @@ -0,0 +1,112 @@ + + + + + ssh2_keepalive_send + Envía un mensaje de mantenimiento de conexión + + + + &reftitle.description; + + intfalsessh2_keepalive_send + resourcesession + + + Envía un mensaje de mantenimiento de conexión en la + session indicada, de acuerdo con la configuración + establecida con ssh2_keepalive_config. + + + + Esta función solo está disponible cuando la extensión se compila con una + versión de libssh2 que proporciona soporte de mantenimiento de conexión. + + + + + + &reftitle.parameters; + + + session + + + Un identificador de enlace de conexión SSH, obtenido de una llamada a + ssh2_connect. + + + + + + + + &reftitle.returnvalues; + + Devuelve el número de segundos que pueden transcurrir antes de que deba + enviarse otro mensaje de mantenimiento de conexión, o &false; en caso de + error. Devuelve 0 cuando los mensajes de mantenimiento de + conexión están deshabilitados. + + + Puesto que tanto 0 como &false; se evalúan como falso, + debe utilizarse el operador === para distinguirlos. + + + + + &reftitle.examples; + + Envío de un mensaje de mantenimiento de conexión + + +]]> + + + + + + &reftitle.seealso; + + ssh2_keepalive_config + ssh2_connect + + + + + + diff --git a/reference/ssh2/functions/ssh2-send-signal.xml b/reference/ssh2/functions/ssh2-send-signal.xml new file mode 100644 index 000000000..3aec51749 --- /dev/null +++ b/reference/ssh2/functions/ssh2-send-signal.xml @@ -0,0 +1,127 @@ + + + + + ssh2_send_signal + Envía una señal a un proceso remoto + + + + &reftitle.description; + + boolssh2_send_signal + resourcechannel + stringsignal + + + Envía una señal al proceso que se ejecuta en el extremo remoto del + channel indicado. + + + + Esta función solo está disponible cuando la extensión se compila con + libssh2 >= 1.9.0. + + + + + + &reftitle.parameters; + + + channel + + + Un flujo de canal SSH, tal como el devuelto por + ssh2_exec o ssh2_shell. + + + + + signal + + + El nombre de la señal a enviar, sin el prefijo SIG, + tal como lo define el protocolo de conexión SSH + (RFC 4254); por ejemplo + TERM, KILL o + INT. + + + El valor se transmite al servidor tal cual; no se valida contra los + nombres enumerados por el protocolo. + + + + + + + + &reftitle.returnvalues; + + &return.success; + + + + + &reftitle.errors; + + Se emite un error de nivel E_WARNING cuando + channel no es un flujo de canal SSH, y cuando no se + ha podido enviar la señal. + + + + + &reftitle.examples; + + Interrupción de un comando remoto + + +]]> + + + + + + &reftitle.seealso; + + ssh2_exec + ssh2_shell + ssh2_send_eof + + + + + + diff --git a/reference/ssh2/functions/ssh2-set-timeout.xml b/reference/ssh2/functions/ssh2-set-timeout.xml new file mode 100644 index 000000000..2bdab9e34 --- /dev/null +++ b/reference/ssh2/functions/ssh2-set-timeout.xml @@ -0,0 +1,117 @@ + + + + + ssh2_set_timeout + Define el tiempo límite de las operaciones bloqueantes de una sesión + + + + &reftitle.description; + + voidssh2_set_timeout + resourcesession + intseconds + intmicroseconds0 + + + Define cuánto tiempo puede esperar una operación bloqueante en la + session indicada antes de considerarse expirada. + + + Cuando el tiempo límite resultante es 0, que es el valor + por omisión, no se aplica ningún tiempo límite y las operaciones bloqueantes + pueden esperar indefinidamente. + + + + + &reftitle.parameters; + + + session + + + Un identificador de enlace de conexión SSH, obtenido de una llamada a + ssh2_connect. + + + + + seconds + + + El tiempo límite, en segundos. + + + + + microseconds + + + Un número adicional de microsegundos que se añade al tiempo límite. La + biblioteca subyacente solo soporta precisión de milisegundos, por lo que + este valor se redondea al milisegundo entero superior. + + + + + + + + &reftitle.returnvalues; + + &return.void; + + + + + &reftitle.examples; + + Limitación del tiempo de espera de las operaciones bloqueantes + + +]]> + + + + + + &reftitle.seealso; + + ssh2_connect + ssh2_keepalive_config + stream_set_timeout + + + + + + diff --git a/reference/ssh2/functions/ssh2-shell-resize.xml b/reference/ssh2/functions/ssh2-shell-resize.xml new file mode 100644 index 000000000..30e9e0784 --- /dev/null +++ b/reference/ssh2/functions/ssh2-shell-resize.xml @@ -0,0 +1,152 @@ + + + + + ssh2_shell_resize + Cambia las dimensiones del pseudoterminal de un canal + + + + &reftitle.description; + + boolssh2_shell_resize + resourcechannel + intwidth + intheight + intwidth_px0 + intheight_px0 + + + Solicita que el pseudoterminal (PTY) asociado al + channel indicado se redimensione a las dimensiones + dadas. + + + + La extensión solo declara los tres primeros parámetros, con el nombre + session para channel. Por + consiguiente, width_px y + height_px solo pueden pasarse posicionalmente. + + + + + + &reftitle.parameters; + + + channel + + + Un flujo de canal SSH, tal como el devuelto por + ssh2_exec o ssh2_shell. + + + + + width + + + El ancho del terminal, en caracteres. + + + + + height + + + La altura del terminal, en caracteres. + + + + + width_px + + + El ancho del terminal en píxeles, o 0 para dejar sin + especificar las dimensiones en píxeles. + + + + + height_px + + + La altura del terminal en píxeles, o 0 para dejar sin + especificar las dimensiones en píxeles. + + + + + + + + &reftitle.returnvalues; + + Devuelve &true;, o &false; cuando channel no es un + flujo de canal SSH. + + + El resultado de la propia solicitud de redimensionado no se informa: se + devuelve &true; incluso cuando el extremo remoto no la atiende. + + + + + &reftitle.errors; + + Se emite un error de nivel E_WARNING cuando + channel no es un flujo de canal SSH. + + + + + &reftitle.examples; + + Redimensionado del pseudoterminal de un shell + + +]]> + + + + + + &reftitle.seealso; + + ssh2_shell + ssh2_exec + + + + + + diff --git a/reference/ssh2/setup.xml b/reference/ssh2/setup.xml index fb6389d34..021fb8bbe 100644 --- a/reference/ssh2/setup.xml +++ b/reference/ssh2/setup.xml @@ -1,6 +1,5 @@ - - + &reftitle.setup; @@ -21,11 +20,11 @@ La función ssh2_auth_agent estará disponible únicamente - con libssh >= 1.2.3. + con libssh2 >= 1.2.3. El soporte para stream_set_timeout para canalizar secuencias - sólo estará disponible con libssh >= 1.2.9. + sólo estará disponible con libssh2 >= 1.2.9. libssh2 viene en dos versiones: gcrypt y openssl. Algunas distribuciones