• id
    Descrição: Campo autoincrementável, não deve ser enviado ao inserir um novo registro!
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 11
    • Campo auto incrementável: Sim
  • nome
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 80
    • Valor Padrão: server
  • descricao
    Dados técnicos:
    • Tipo de campo: Campo de área de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 250
  • usar_servidor_local
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Sim
    • Valor Padrão: Sim
    • Valores disponíveis:
      1 = Sim
      0 = Não
  • ssh_host
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 100
    • Valor Padrão: 127.0.0.1
  • ssh_porta
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 5
    • Máscara: Número inteiro
    • Valor Padrão: 22
  • ssh_usuario
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 20
    • Valor Padrão: root
  • ssh_senha
    Dados técnicos:
    • Tipo de campo: Campo de senha
    • Campo obrigatório: Não
  • ssh_timeout
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 3
    • Valor Padrão: 10
  • dev
    Dados técnicos:
    • Tipo de campo: Campo de seleção
    • Campo obrigatório: Sim
    • Valor Padrão: Interface Tun
    • Valores disponíveis:
      tun = Interface Tun
      tap = Interface Tap
  • remote
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 60
  • proto
    Dados técnicos:
    • Tipo de campo: Campo de seleção
    • Campo obrigatório: Sim
    • Valor Padrão: Protocolo Tcp server
    • Valores disponíveis:
      tcp-server = Protocolo Tcp server
      udp = Protocolo Udp
  • porta
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 5
    • Valor Padrão: 1194
  • local
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 100
    • Valor Padrão: 10.57.113.1
  • rede
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 100
    • Valor Padrão: 10.57.113.0
  • mascara
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 100
    • Valor Padrão: 255.255.255.0
  • cert_pais
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 2
    • Valor Padrão: BR
  • cert_estado
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 2
    • Valor Padrão: SP
  • cert_cidade
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 100
    • Valor Padrão: Sao_Paulo
  • cert_email
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 100
    • Valor Padrão: tecnico@provedor.com.br
  • cert_organizacao
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 100
    • Valor Padrão: Provedor
  • cert_unidade
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 100
    • Valor Padrão: ProvedorFilial
  • caminho_ca
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 100
    • Somente leitura: Sim
  • visualizar_ca
    Dados técnicos:
    • Tipo de campo: Campo de área de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 0
    • Somente leitura: Sim
  • caminho_crt
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 0
    • Somente leitura: Sim
  • visualizar_crt
    Dados técnicos:
    • Tipo de campo: Campo de área de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 0
    • Somente leitura: Sim
  • caminho_key
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 0
    • Somente leitura: Sim
  • visualizar_key
    Dados técnicos:
    • Tipo de campo: Campo de área de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 0
    • Somente leitura: Sim
  • caminho_dh
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 0
    • Somente leitura: Sim
  • visualizar_dh
    Dados técnicos:
    • Tipo de campo: Campo de área de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 0
    • Somente leitura: Sim
  • caminho_shared
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 0
    • Somente leitura: Sim
  • visualizar_shared
    Dados técnicos:
    • Tipo de campo: Campo de área de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 0
    • Somente leitura: Sim
  • comprime_lzo
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Sim
    • Valor Padrão: Não
    • Valores disponíveis:
      1 = Sim
      0 = Não
  • ping
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 3
    • Valor Padrão: 5
  • ping_restart
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Sim
    • Quant. máx. de caracteres: 3
    • Valor Padrão: 20
  • persistent_tun
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Sim
    • Valor Padrão: Sim
    • Valores disponíveis:
      1 = Sim
      0 = Não
  • persistent_key
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Sim
    • Valor Padrão: Sim
    • Valores disponíveis:
      1 = Sim
      0 = Não
  • verb
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Sim
    • Valor Padrão: 3
    • Valores disponíveis:
      1 = 1
      2 = 2
      3 = 3
      4 = 4
      5 = 5
      6 = 6
      7 = 7
      8 = 8
      9 = 9
      10 = 10
      11 = 11
  • script_security
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Sim
    • Valor Padrão: 3
    • Valores disponíveis:
      0 = 0
      1 = 1
      2 = 2
      3 = 3
  • tls_server
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Sim
    • Valor Padrão: Não
    • Valores disponíveis:
      1 = Sim
      0 = Não
  • cipher
    Dados técnicos:
    • Tipo de campo: Campo de seleção
    • Campo obrigatório: Sim
    • Valor Padrão: AES-256-CBC
    • Valores disponíveis:
      AES-128-CBC = AES-128-CBC
      AES-192-CBC = AES-192-CBC
      AES-256-CBC = AES-256-CBC
      CAMELLIA-128-CBC = CAMELLIA-128-CBC
      CAMELLIA-192-CBC = CAMELLIA-192-CBC
      CAMELLIA-256-CBC = CAMELLIA-256-CBC
  • auth
    Dados técnicos:
    • Tipo de campo: Botão de seleção
    • Campo obrigatório: Sim
    • Valor Padrão: SHA1
    • Valores disponíveis:
      MD5 = MD5
      SHA1 = SHA1
  • caminho_log
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 0
    • Somente leitura: Sim
  • visualizar_log
    Dados técnicos:
    • Tipo de campo: Campo de área de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 0
    • Somente leitura: Sim
  • caminho_status
    Dados técnicos:
    • Tipo de campo: Campo de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 100
    • Somente leitura: Sim
  • visualizar_status
    Dados técnicos:
    • Tipo de campo: Campo de área de texto
    • Campo obrigatório: Não
    • Quant. máx. de caracteres: 0
    • Somente leitura: Sim
  • Inserir
    
    require(__DIR__ . DIRECTORY_SEPARATOR . 'WebserviceClient.php');
    $host = 'https://SEU_DOMINIO/webservice/v1';
    $token = '6:4dacdb8e47193e8cbbabe508c3c59b4547e463817b1d9b9a1d20ab4812fe1a62';//token gerado no cadastro do usuario (verificar permissões)
    $selfSigned = true; //true para certificado auto assinado
    $api = new IXCsoft\WebserviceClient($host, $token, $selfSigned);
    $dados = array(
        'nome' => 'server',
        'descricao' => '',
        'usar_servidor_local' => '1',
        'ssh_host' => '127.0.0.1',
        'ssh_porta' => '22',
        'ssh_usuario' => 'root',
        'ssh_senha' => '',
        'ssh_timeout' => '10',
        'dev' => 'tun',
        'remote' => '',
        'proto' => 'tcp-server',
        'porta' => '1194',
        'local' => '10.57.113.1',
        'rede' => '10.57.113.0',
        'mascara' => '255.255.255.0',
        'cert_pais' => 'BR',
        'cert_estado' => 'SP',
        'cert_cidade' => 'Sao_Paulo',
        'cert_email' => 'tecnico@provedor.com.br',
        'cert_organizacao' => 'Provedor',
        'cert_unidade' => 'ProvedorFilial',
        'caminho_ca' => '',
        'visualizar_ca' => '',
        'caminho_crt' => '',
        'visualizar_crt' => '',
        'caminho_key' => '',
        'visualizar_key' => '',
        'caminho_dh' => '',
        'visualizar_dh' => '',
        'caminho_shared' => '',
        'visualizar_shared' => '',
        'comprime_lzo' => '0',
        'ping' => '5',
        'ping_restart' => '20',
        'persistent_tun' => '1',
        'persistent_key' => '1',
        'verb' => '3',
        'script_security' => '3',
        'tls_server' => '0',
        'cipher' => 'AES-256-CBC',
        'auth' => 'SHA1',
        'caminho_log' => '',
        'visualizar_log' => '',
        'caminho_status' => '',
        'visualizar_status' => ''
    );
    $api->post('openvpn_server', $dados);
    $retorno = $api->getRespostaConteudo(false);// false para json | true para array
    
  • Editar
    
    require(__DIR__ . DIRECTORY_SEPARATOR . 'WebserviceClient.php');
    $host = 'https://SEU_DOMINIO/webservice/v1';
    $token = '6:4dacdb8e47193e8cbbabe508c3c59b4547e463817b1d9b9a1d20ab4812fe1a62';//token gerado no cadastro do usuario (verificar permissões)
    $selfSigned = true; //true para certificado auto assinado
    $api = new IXCsoft\WebserviceClient($host, $token, $selfSigned);
    
    $dados = array(
        'nome' => 'server',
        'descricao' => '',
        'usar_servidor_local' => '1',
        'ssh_host' => '127.0.0.1',
        'ssh_porta' => '22',
        'ssh_usuario' => 'root',
        'ssh_senha' => '',
        'ssh_timeout' => '10',
        'dev' => 'tun',
        'remote' => '',
        'proto' => 'tcp-server',
        'porta' => '1194',
        'local' => '10.57.113.1',
        'rede' => '10.57.113.0',
        'mascara' => '255.255.255.0',
        'cert_pais' => 'BR',
        'cert_estado' => 'SP',
        'cert_cidade' => 'Sao_Paulo',
        'cert_email' => 'tecnico@provedor.com.br',
        'cert_organizacao' => 'Provedor',
        'cert_unidade' => 'ProvedorFilial',
        'caminho_ca' => '',
        'visualizar_ca' => '',
        'caminho_crt' => '',
        'visualizar_crt' => '',
        'caminho_key' => '',
        'visualizar_key' => '',
        'caminho_dh' => '',
        'visualizar_dh' => '',
        'caminho_shared' => '',
        'visualizar_shared' => '',
        'comprime_lzo' => '0',
        'ping' => '5',
        'ping_restart' => '20',
        'persistent_tun' => '1',
        'persistent_key' => '1',
        'verb' => '3',
        'script_security' => '3',
        'tls_server' => '0',
        'cipher' => 'AES-256-CBC',
        'auth' => 'SHA1',
        'caminho_log' => '',
        'visualizar_log' => '',
        'caminho_status' => '',
        'visualizar_status' => ''
    );
    $registro = '1';//registro a ser editado
    $api->put('openvpn_server', $dados, $registro);
    $retorno = $api->getRespostaConteudo(false);// false para json | true para array
    
  • Deletar
    
    require(__DIR__ . DIRECTORY_SEPARATOR . 'WebserviceClient.php');
    $host = 'https://SEU_DOMINIO/webservice/v1';
    $token = '6:4dacdb8e47193e8cbbabe508c3c59b4547e463817b1d9b9a1d20ab4812fe1a62';//token gerado no cadastro do usuario (verificar permissões)
    $selfSigned = true; //true para certificado auto assinado
    $api = new IXCsoft\WebserviceClient($host, $token, $selfSigned);
    $registro = '1';//registro a ser deletado
    $api->delete('openvpn_server', $registro);
    $retorno = $api->getRespostaConteudo(false);// false para json | true para array
    
  • Listar
    
    require(__DIR__ . DIRECTORY_SEPARATOR . 'WebserviceClient.php');
    $host = 'https://SEU_DOMINIO/webservice/v1';
    $token = '6:4dacdb8e47193e8cbbabe508c3c59b4547e463817b1d9b9a1d20ab4812fe1a62';//token gerado no cadastro do usuario (verificar permissões)
    $selfSigned = true; //true para certificado auto assinado
    $api = new IXCsoft\WebserviceClient($host, $token, $selfSigned);
    $params = array(
        'qtype' => 'openvpn_server.id',//campo de filtro
        'query' => '1',//valor para consultar
        'oper' => '=',//operador da consulta
        'page' => '1',//página a ser mostrada
        'rp' => '20',//quantidade de registros por página
        'sortname' => 'openvpn_server.id',//campo para ordenar a consulta
        'sortorder' => 'desc'//ordenação (asc= crescente | desc=decrescente)
    );
    $api->get('openvpn_server', $params);
    $retorno = $api->getRespostaConteudo(false);// false para json | true para array