dsmInitEx

Editar on-line

A chamada de função dsmInitEx inicia uma sessão API usando os parâmetros adicionais para verificação estendida.

Sintaxe

dsInt16_t  dsmInitEx   (dsUint32_t        *dsmHandleP,
                        dsmInitExIn_t     *dsmInitExInP,
                        dsmInitExOut_t    *dsmInitExOutP) ;

Parâmetros

dsUint32_t *dsmHandleP (O)
A manipulação que identifica essa sessão de inicialização e a associa às chamadas subsequentes do IBM® Storage Protect
dsmInitExIn_t *dsmInitExInP
Essa estrutura contém os seguintes parâmetros de entrada:
dsmApiVersion *dsmApiVersionP (I)
Esse parâmetro é um ponteiro para a estrutura de dados que identifica a versão da API que o cliente aplicativo está utilizando para a sessão. A estrutura contém os valores das quatro constantes, DSM_API_VERSION, DSM_API_RELEASE, DSM_API_LEVEL e DSM_API_SUBLEVEL que estão configurados no arquivo dsmapitd.h . Chame dsmQueryApiVersionEx e verifique se a versão da API do aplicativo cliente e a versão da biblioteca da API instalada na estação de trabalho do usuário são compatíveis.
char *clientNodeNameP (I)
Esse parâmetro é um ponteiro para o nó para a sessão do IBM Storage Protect Todas as sessões devem estar associadas a um nome do nó. A constante DSM_MAX_NODE_LENGTH no arquivo dsmapitd.h configura o tamanho máximo para um nome do nó.

O nome do nó não faz distinção entre maiúsculas e minúsculas.

Se esse parâmetro for configurado para NULL e passwordaccess for configurado para prompt, a API tentará obter primeiro o nome do nó da sequência de opções transmitida. Se não estiver lá, a API tenta obter o nome do nó do arquivo de configuração ou dos arquivos de opções. Se essas tentativas de encontrar o nome do nó falharem, a API do UNIX ou do Linux® usa o nome do host do sistema, enquanto as APIs de outros sistemas operacionais retornamDSM_RC_REJECT_ID_UNKNOWN.

Se este parâmetro for NULL, e a opção passwordaccess no arquivo dsm.opt (para a API do Windows) ou no arquivo dsm.sys (para a API do UNIX ou Linux ) será configurado como gerar, a API usa o valor da opção nodename ou o nome do host do sistema.

char *clientOwnerNameP (I)
Esse parâmetro é um ponteiro para o proprietário da sessão do IBM Storage Protect Se o sistema operacional for uma plataforma multiusuário, um nome de proprietário NULL (o usuário raiz) tem autoridade para fazer backup, arquivar, restaurar ou recuperar qualquer objeto pertencente ao aplicativo, independentemente do proprietário do objeto.

O nome do proprietário faz distinção entre maiúsculas e minúsculas.

Se esse parâmetro for NULL e a opção passwordaccess no arquivo dsm.sys for configurada como generate, a API usará o ID do usuário de login.

Nota: Em uma plataforma multiusuário, não é necessário que o nome do proprietário corresponda ao ID de usuário ativo da sessão que executa o aplicativo.
char *clientPasswordP (I)
Um ponteiro para a senha do nó no qual a sessão do IBM Storage Protect é executada A constante DSM_MAX_VERIFIER_LENGTH no arquivo dsmapitd.h configura o tamanho máximo permitido para uma senha.

A senha não é sensível a maiúscula/minúscula.

Exceto quando o arquivo de senha é iniciado pela primeira vez, o valor deste parâmetro será ignorado se passwordaccess for configurado como gerar.

char *userNameP;
Um ponteiro para o nome do usuário administrativo que tem autoridade de cliente para o nó.
char *userPasswordP;
Um ponteiro para a senha do parâmetro userName, se um valor for fornecido.
char *applicationType (I)
Identifica o aplicativo que está executando a sessão IBM Storage Protect . O cliente aplicativo identifica o valor.

Toda vez que um cliente aplicativo da API inicia uma sessão com o servidor, o tipo de aplicativo (ou sistema operacional) do cliente é atualizado no servidor. O valor é inserido no campo platform no servidor. Considere usar um ID do sistema operacional no valor. O comprimento máximo da sequência é definido na constante DSM_MAX_PLATFORM_LENGTH.

Para visualizar o valor atual do tipo de aplicativo, ligue para dsmQuerySessInfo.

char *configfile (I)
Aponta para uma sequência de caracteres que contém o nome completo de um arquivo de configuração da API. As opções especificadas no arquivo de configuração da API substituem sua especificação no arquivo de opções do cliente. Arquivos de opções são definidos quando o IBM Storage Protect (cliente ou API) é instalado.
char *options (I)
Aponta para uma cadeia de caracteres que pode conter opções do usuário, como:
  • Compressalways
  • Servername (apenas sistemas UNIX e Linux )
  • TCPServeraddr (não para sistemas UNIX)
  • Fromnode
  • Fromowner
  • Passwordaccess

O cliente aplicativo pode utilizar a lista de opções para substituir os valores dessas opções que o arquivo de configuração define.

As opções têm o formato a seguir:

  1. Cada opção especificada na lista de opções começa com um traço (-) e é seguida pela palavra-chave da opção.
  2. A palavra-chave é seguida por um sinal de igual (=) e pelo parâmetro da opção.
  3. Se o parâmetro da opção contiver um espaço em branco, coloque o parâmetro entre aspas simples ou duplas.
  4. Se mais de uma opção for especificada, separe as opções por espaços em branco.

Se as opções forem NULL, os valores para todas as opções serão retirados do arquivo de opções do usuário ou do arquivo de configuração da API.

dirDelimiter
O delimitador de diretório utilizado como prefixo nos nomes de nível superior ou nível inferior do espaço no arquivo. Você deve especificar o parâmetro dirDelimiter somente se o aplicativo substituir os padrões do sistema. Em um ambiente UNIX ou Linux , o padrão é barra (/). Em um ambiente Windows, o padrão é barra backslash (\).
useUnicode
Uma sinalização booleana que indica se o Unicode foi ativado. A sinalização useUnicode deve ser falsa para alcançar a interoperabilidade de plataforma cruzada entre os sistemas UNIX e Windows.
bCrossPlatform
Uma sinalização booleana que deve ser configurada (bTrue) para atingir a interoperabilidade entre plataformas entre sistemas UNIX e Windows. Quando a sinalização bCrossPlatform for configurada, a API assegurará que os espaços no arquivo não são Unicode e que o aplicativo não usa Unicode. Um aplicativo Windows que usa Unicode não é compatível com aplicativos que usam codificações não Unicode. A sinalização bCrossPlatform não deve ser configurada para um aplicativo Windows que usa Unicode.
UseTsmBuffers
Indica se a eliminação de cópia de buffer deve ser utilizada.
numTsmBuffers
Número de buffers quando useTsmBuffers=bTrue.
bEncryptKeyEnabled
Indica se criptografia com chave gerenciada pelo aplicativo é utilizada.
encryptionPasswordP
A senha de criptografia.
Restrição: Quando encryptkey=save, se existir uma chave criptografada, o valor que é especificado no encryptionPasswordP é ignorado.
dsmAppVersion *appVersionP (I)
Esse parâmetro é um ponteiro para a estrutura de dados que identifica as informações de versão do aplicativo que está iniciando uma sessão da API. A estrutura contém os valores das quatro constantes, applicationVersion, applicationRelease, applicationLevel e applicationSubLevel, que estão configuradas no arquivo tsmapitd.h.
dsmInitExOut_t *dsmInitExOut P
Essa estrutura contém os parâmetros de saída.
dsUint32_t *dsmHandle (0)
O identificador que identifica esta sessão de inicialização e a associa a chamadas subsequentes da API.
infoRC
Informações adicionais sobre o código de retorno. Verifique o código de retorno de função e o valor de infoRC. Um valor de infoRC de DSM_RC_REJECT_LASTSESS_CANCELADO (69), o IBM Storage Protect indica que o administrador cancelou a última sessão.

Códigos de retorno

Os números do código de retorno são fornecidos entre parênteses ( ).

Tabela 1. Códigos de retorno para dsmInitEx
Código de retorno Explicação
DSM_RC_ABORT_SYSTEM_ERROR (1) O servidor IBM Storage Protect detectou um erro no sistema e notificou os clientes..
DSM_RC_REJECT_VERIFIER_EXPIRED (52) A senha expirou e deve ser atualizada. A próxima chamada deve ser dsmChangePW com o identificador retornado na chamada.
DSM_RC_REJECT_ID_UNKNOWN (53) Não é possível localizar o nome do nó.
DSM_RC_TA_COMM_DOWN (103) O link de comunicações está inativo.
DSM_RC_AUTH_FAILURE (137) Ocorreu uma falha de autenticação.
DSM_RC_NO_STARTING_DELIMITER (148) Não há nenhum delimitador inicial no padrão.
DSM_RC_NEEDED_DIR_DELIMITER (149) Um delimitador de diretório é necessário imediatamente antes e depois da meta-string de diretórios de correspondência (...), mas não foi localizado.
DSM_RC_NO_PASS_FILE (168) O arquivo de senha não está disponível.
DSM_RC_UNMATCHED_QUOTE (177) Aspas sem correspondente estão na sequência de opções.
DSM_RC_NLS_CANT_OPEN_TXT (0610) Não foi possível abrir o arquivo de texto de mensagens.
DSM_RC_INVALID_OPT (2013) Uma entrada na cadeia de opções é inválida.
DSM_RC_INVALID_DS_HANDLE (2014) Identificador DSM inválido.
DSM_RC_NO_OWNER_REQD (2032) Parâmetro do proprietário deve ser NULL quando passwordaccess é configurado como gerar.
DSM_RC_NO_NODE_REQD (2033) O parâmetro do nó deve ser NULL quando passwordaccess estiver configurado para generate.
DSM_RC_WRONG_VERSION (2064) A versão da API do aplicativo cliente tem um valor mais alto do que a versão do IBM Storage Protect
DSM_RC_PASSWD_TOOLONG (2103) A senha especificada é muito longa.
DSM_RC_NO_OPT_FILE (2220) Nenhum arquivo de configuração foi localizado.
DSM_RC_INVALID_KEYWORD (2221) Uma palavra-chave especificada em uma sequência de opções é inválida.
DSM_RC_PATTERN_TOO_COMPLEX (2222) Padrão de inclusão-exclusão muito complexo para ser interpretado pelo IBM Storage Protect.
DSM_RC_NO_CLOSING_BRACKET (2223) Está faltando o colchete direito no padrão.
DSM_RC_INVALID_SERVER (2225) Para um ambiente multiusuário, o servidor não foi localizado no arquivo de configuração do sistema.
DSM_RC_NO_HOST_ADDR (2226) Não há informações suficientes para conectar ao host.
DSM_RC_MACHINE_SAME (2227) O nome do nó definido no arquivo de opções não pode ser o mesmo que o nome do host do sistema.
DSM_RC_NO_API_CONFIGFILE (2228) Não é possível abrir o arquivo de configuração.
DSM_RC_NO_INCLEXCL_FILE (2229) O arquivo include-exclude não foi localizado.
DSM_RC_NO_SYS_OR_INCLEXCL (2230) dsm.sys ou o arquivo include-exclude não foi localizado.