Ajuda do Tableau Server no Windows

Use os comandos tsm authentication para habilitar, desabilitar e configurar as opções de autenticação de usuário do Tableau Server.

tsm authentication kerberos <commands>

Habilita, desabilita e configura a autenticação de usuário do Kerberos no Tableau Server. Consulte Configurar o Kerberos.

Sinopse

tsm authentication kerberos configure --keytab-file <keytab_file.keytab> [global options]

tsm authentication kerberos enable [global options]

tsm authentication kerberos disable [global options]

Opções de configuração do Kerberos

-kt, --keytab-file <keytab_file.keytab>

Obrigatório.

Especifica o arquivo de serviço .keytab usado para solicitações ao KDC.

tsm authentication list

Lista as definições de configuração relacionadas à autenticação existente do servidor.

Sinopse

tsm authentication list [--verbose][global options]

Opções

v, --verbose

Opcional.

Apresenta parâmetros configurados.

tsm authentication mutual-ssl <commands>

Habilita, desabilita e configura o SSL mútuo para autenticação de usuário no Tableau Server. Para saber mais sobre SSL mútuo, consulte Configurar autenticação do SSL mútuo.

Antes de habilitar o SSL mútuo, é necessário configurar o SSL para comunicação externa. Para obter informações, consulte Configurar o SSL para tráfego de HTTP externo e do Tableau Server.

Sinopse

tsm authentication mutual-ssl configure [options] [global options]

tsm authentication mutual-ssl disable [global options]

tsm authentication mutual-ssl enable [global options]

Opções

-cf, --ca-cert <certificate-file.crt>

Opcional.

Especifica a localização e o nome do arquivo do arquivo de certificado. O arquivo deve ser um certificado confiável e válido de uma Autoridade de certificação (Verisign, por exemplo).

-fb, --fallback-to-basic <true | false>

Opcional.

Especifica se o Tableau Server deve aceitar o nome e senha de usuário para a autenticação se a autenticação do SSL falhar.

O valor padrão é falso para indicar que, quando configurado para SSL mútuo, o Tableau Server não permite uma conexão se houver falha na autenticação de SSL. No entanto, o Tableau Server aceita autenticação com nome de usuário e senha de clientes REST API, mesmo que a opção acima esteja definida como false.

-m, --user-name-mapping <upn | ldap | cn>

Opcional.

Especifica a sintaxe do nome de usuário (UPN, LDAP or CN) para recuperar do armazenamento de identidades ou diretório. A sintaxe deve corresponder ao formato de Subject (Assunto) ou de Subject Alternative Name (SAN, Nome alternativo) no certificado do usuário.

-rf, --revocation-file <revoke-file.pem>

Opcional.

Especifica a localização e o nome do arquivo do arquivo de certificado da lista de revogação. Este arquivo pode ser um arquivo .pem ou .der.

tsm authentication openid <commands>

Habilite, desabilite e configure a autenticação de usuário do OpenID Connect (OIDC) no Tableau Server.

Sinopse

tsm authentication openid configure [options] [global options]

tsm authentication openid disable [global options]

tsm authentication openid enable [global options]

tsm authentication openid get-redirect-url [global options]

tsm authentication openid map-claims [options] [global options]

Opções de configuração do OpenID

Observação: as opções devem ser definidas durante a configuração inicial ou durante a reconfiguração. As opções individuais não podem ser definidas separadamente.

-a, --client-authentication <string>

Obrigatório.

Especifica o método de autenticação de cliente personalizado para OpenID Connect.

Para configurar o Tableau Server para usar o Salesforce IdP, defina esse valor como client_secret_post.

-cs, --client-secret <string>

Obrigatório.

Especifica o segredo do cliente do provedor. Este é um token usado pelo Tableau para verificar a autenticidade da resposta do IdP. Este valor é um segredo e deve ser mantido em segurança.

-cu, --config-url <url>

Obrigatório.

Especifica a localização do documento de descoberta de configuração do provedor que contém os metadados do provedor OpenID. Se o provedor hospedar um arquivo JSON público, use --config-url. Caso contrário, especifique um caminho no computador local e o nome do arquivo usando --metadata-file.

-mf, --metadata-file <file-path>, --config-file <config-file.json>

Opcional.

Especifica o caminho local para o documento JSON de descoberta OIDC estático.

-i, --client-id <client-id>

Obrigatório.

Especifica a ID do cliente do provedor que o IdP designou para o aplicativo.

-id, --ignore-domain <true | false>

Opcional. Padrão: false

Defina isso como true, se o seguinte for verdadeiro:

• Você está usando endereços de e-mail como nomes de usuário no Tableau Server

• Você forneceu aos usuários no IdP vários nomes de domínio

• Você quer ignorar a parte de nome de domínio da recuperação email no IdP

Antes de prosseguir, revise os nomes de usuário que serão usados como um resultado da configuração desta opção como true. Podem ocorrer conflitos do nome de usuário. Em caso de conflito de nome de usuário, o risco de divulgação de informações é alto. Consulte Requisitos para usar o OpenID Connect.

-if, --iframed-idp-enabled <true | false>

Opcional. Padrão: false

Especifica se o IdP é permitido em um iFrame. O IdP deve desabilitar a proteção contra roubo de cliques para permitir a apresentação do iFrame.

-ij, --ignore-jwk <true | false>

Opcional. Padrão: false

Defina como true se o seu IdP não oferecer suporte à validação JWK. Neste caso, recomendamos autenticar a comunicação com o seu IdP usando TLS mútuo ou outro protocolo de segurança da camada de rede.

-r, --return-url <return-url>

A URL do servidor. Ela é normalmente o nome público do seu servidor, como "http://example.tableau.com".

-sn, --custom-scope-name <string>

Opcional.

Especifica um valor de escopo personalizado relacionado ao usuário que pode ser usado para consultar o IdP. Consulte Requisitos para usar o OpenID Connect.

Opções para openid map-claims

Use essas opções para alterar as solicitações padrão do OIDC que o Tableau Server usará ao se comunicar com o IdP. Consulte Requisitos para usar o OpenID Connect.

-i, --id <string>

Opcional. Padrão: sub

Altere este valor se o seu IdP não usar a recuperação sub para identificar exclusivamente os usuários do token ID. A recuperação IdP especificada deve conter uma única e exclusiva cadeia de caracteres.

-un, --user-name <string>

Opcional. Padrão: email

Altere este valor para a recuperação IdP que a sua empresa usará para corresponder nomes de usuários, conforme armazenado no Tableau Server.

tsm authentication pat-impersonation <commands>

Ative e desative a representação do token de acesso pessoal para administradores em Tableau Server.

Para obter mais informações sobre tokens de acesso pessoal, consulte Tokens de acesso pessoal.

Sinopse

tsm authentication pat-impersonation disable [global options]

tsm authentication pat-impersonation enable [global options]

Para ver se a representação do token de acesso pessoal está ativada, execute o seguinte comando:

tsm authentication list

tsm authentication saml <commands>

Configura o Tableau Server para suportar logon único ao usar o padrão do SAML 2.0, habilita ou desabilita o SAML para um site, mapeia nomes de atributo de afirmação entre o Tableau Server e o provedor de identidade (IdP).

Comandos disponíveis

tsm authentication saml configure [options] [global options]

tsm authentication saml disable [options] [global options]

tsm authentication saml enable [options] [global options]

tsm authentication saml export-metadata [options] [global options]

tsm authentication saml map-assertions [options]

tsm authentication saml configure

Defina as configurações de SAML para o servidor. Especifique o certificado SAML e os arquivos de metadados, forneça informações adicionais necessárias e defina as opções adicionais.

Se estiver configurando o SAML pela primeira vez ou se o tiver desativado anteriormente, você deverá executar este comando com tsm authentication saml enable. Para obter mais informações, consulte Configurar SAML em todo o servidor.

Sinopse

tsm authentication saml configure [options] [global options]

Opções

-e, --idp-entity-id <id>

Obrigatório para a configuração SAML inicial; opcional em outros casos. Valor de ID da entidade do IdP

Normalmente, é igual a URL de retorno do Tableau Server (especificada no parâmetro --idp-return-url). A ID de entidade que você insere é usada como uma base para a geração de IDs de entidade de sites específicos. Por exemplo, se você inserir:

http://tableau-server

Um site configurado para SAML pode exibir a seguinte ID de entidade:

http://tableau-server/samlservice/public/sp/metadata?alias=48957410-9396-430a-967c-75bdb6e002a0

Para localizar a ID da entidade do site, vá para a página de Configurações do site e selecione a guia Autenticação. Quando o SAML está habilitado, a ID da entidade é mostrada na primeira etapa para configurar o SAML específico do site, exportando os metadados.

-r, --idp-return-url <idp-return-url>

Obrigatório para a configuração SAML inicial; opcional em outros casos. A URL de retorno do SAML configurada no IdP. Normalmente, é a URL externa do Tableau Server; por exemplo, https://tableau-server.

Observações

• http://localhost não funciona em um servidor externo.

• Adicionar uma barra à direita da URL (http://tableau-server/) não é suportado.

-i, --idp-metadata <idp-metadata.xml>

Obrigatório para a configuração SAML inicial; opcional em outros casos. Forneça o local e o nome do arquivo de metadados XML exportado das configurações do IdP.

Por exemplo, C:\ProgramData\Tableau\Tableau Server\data\saml\<metadata-file.xml>

-cf, --cert-file <certificate.crt>

Obrigatório para a configuração SAML inicial; opcional em outros casos. O local e o nome do arquivo de certificado. Para requisitos do arquivo de certificado, consulte Requisitos do SAML.

Por exemplo, C:\ProgramData\Tableau\Tableau Server\data\saml\<file.crt>

-kf, --key-file <certificate.key>

Obrigatório para a configuração SAML inicial; opcional em outros casos. Local e nome do arquivo-chave que acompanha o certificado.

Por exemplo, C:\ProgramData\Tableau\Tableau Server\data\saml\<file.key>

-a, --max-auth-age <max-auth-age>

Opcional. O valor padrão é -1 (começando no Tableau Server versão 2020.4.15, 2021.1.12, 2021.2.9,2021.3.8, 20214.4, 2022 e posteriores). O valor padrão anterior é 7200 (2 horas).

O número máximo de segundos permitidos entre a autenticação do usuário e o processamento da mensagem AuthNResponse.

Recomendamos que você mantenha esse valor padrão, que desativa a verificação da idade máxima de autenticação. Se esse valor for diferente do seu IdP, os usuários que fizerem login no Tableau Server poderão ver um erro de login. Para obter mais informações sobre esse erro, consulte o artigo Erro intermitente “Não é possível fazer login” com SAML SSO no Tableau Server(O link abre em nova janela) na Base de dados de conhecimento do Tableau.

-d, --desktop-access <enable | disable>

Opcional. O valor padrão é enable.

Esta opção aplica-se somente ao SAML em todo o servidor Usa o SAML para fazer logon no servidor pelo Tableau Desktop. Se o logon único por meio dos aplicativos cliente do Tableau não funcionar com seu IdP, é possível definir isso como disable.

-m, --mobile-access <enable | disable>

Opcional. O valor padrão é enable.

Permita o uso de SAML para fazer logon de versões mais antigas do aplicativo Tableau Mobile. Os dispositivos que executam a versão 19.225.1731 do aplicativo Tableau Mobile e ignoram essa opção. Para desabilitar os dispositivos que executam a versão 19.225.1731 e posteriores do Tableau Mobile, desabilite o SAML como uma opção de logon do cliente no Tableau Server.

-so, --signout <enable | disable>

Opcional. Habilitado por padrão.

Habilita ou desabilita a opção SAML de "sair da sessão" para Tableau Server.

-su, --signout-url <url>

Opcional. Insere a URL de redirecionamento usada depois que os usuários saem do servidor. Por padrão, esta é a página de logon do Tableau Server. Você pode especificar uma URL absoluta ou relativa.

Exemplo

tsm authentication saml configure --idp-entity-id https://tableau-server --idp-metadata "C:\ProgramData\Tableau\Tableau Server\data\saml\<metadata.xml>" --idp-return-url https://tableau-server --cert-file "C:\ProgramData\Tableau\Tableau Server\data\saml\<file.crt>" --key-file "C:\ProgramData\Tableau\Tableau Server\data\saml\<file.key>"

tsm authentication saml enable and saml disable

Habilita ou desabilita a autenticação SAML por todo o servidor. Neste contexto, todos os sites e usuários habilitados para SAML passam por um único provedor de identidade.

Sinopse

tsm authentication saml enable [global options]

tsm authentication saml disable [global options]

tsm authentication saml export-metadata

Exportar o arquivo de metadados.xml do Tableau Server que será usado para configurar o SAML IdP.

Sinopse

tsm authentication saml export-metadata [options] [global options]

Opções

-f, --file [/path/to/file.xml]

Opcional.

Especifica a localização e nome de arquivo em que os metadados serão gravados. Se não incluir essa opção, o comando export-metadata salva o arquivo no diretório atual e o nomeia samlmetadata.xml.

-o, --overwrite

Opcional.

Substitui um arquivo existente com o mesmo nome especificado em -f, ou do nome padrão se o -f não estiver incluído. Caso um arquivo especificado em -f existir e -o não estiver incluído, o comando não substitui o arquivo existente.

tsm authentication saml map-assertions

Mapeia atributos entre o IdP e o Tableau Server. Fornece o nome que o IdP usa para o atributo especificado em cada argumento.

Sinopse

tsm authentication saml map-assertions --user-name <user-name> [global options]

Opções

-r, --user-name <user-name-attribute>

Opcional. O atributo no qual o IdP armazena o nome de usuário. No Tableau Server é igual ao nome de exibição.

-e, --email <email-name-attribute>

Não use. Esta opção não é compatível com o Tableau.

-o, --domain <domain-name-attribute>

Opcional. O atributo no qual o IdP armazena o nome de domínio. Use essa opção se você adicionar usuários de um domínio diferente do domínio do computador do Tableau Server. Para obter mais informações, consulte Ao executar vários domínios.

-d --display-name <display-name-attribute>

Não use. Esta opção não é compatível com o Tableau.

Example for saml map-assertions

tsm authentication saml map-assertions --user-name=<sAMAccountName> --domain=<FQDM> ou tsm authentication saml map-assertions --user-name=jnguyen --domain=example.myco.com

tsm authentication sitesaml enable and sitesaml disable

Configura o servidor para permitir ou negar a autenticação SAML no nível de site. Habilitar o SAML específico ao site fornece acesso à guia Configurações > Autenticação na interface do usuário na Web do Tableau Server. A guia Autenticação contém as definições de configuração para o SAML específico ao site.

Use o comando sitesaml enable com o saml configure se o servidor ainda não foi configurado para permitir o SAML específico ao site. Para obter mais informações, consulte Configurar SAML específico ao site.

Sinopse

tsm authentication sitesaml enable [global options]

tsm authentication sitesaml disable [global options]

tsm authentication trusted <commands>

Configura autenticação confiável (tickets confiáveis) para autenticação de usuário no Tableau Server.

Sinopse

tsm authentication trusted configure [options] [global options]

Opções

-th, --hosts <string>

Opcional.

Especifica os nomes de host confiável (ou endereços do IPv4) dos servidores da Web que hospedarão páginas com o conteúdo do Tableau.

Para vários valores, insira os nomes em uma lista separada por vírgulas onde cada valor é encapsulado em aspas duplas.

Por exemplo:

tsm authentication trusted configure -th "192.168.1.101", "192.168.1.102", "192.168.1.103" 

ou

tsm authentication trusted configure -th "webserv1", "webserv2", "webserv3" 

-t, --token-length <integer>

Opcional.

Determina o número de caracteres em cada ticket confiável. A configuração padrão de 24 caracteres fornece 144 bits de aleatório. O valor pode ser definido como qualquer inteiro entre 9 e 255, inclusive.

Opções globais

-h, --help

Opcional.

Exibir a ajuda do comando.

-p, --password <senha>

Obrigatório, com -u ou --username se não tiver sessões ativas.

Especificar a senha do usuário especificado no -u ou --username.

Se a senha tiver espaços ou caracteres especiais, coloque-a entre aspas:

--password "my password"

-s, --server https://<hostname>:8850

Opcional.

Usar o endereço definido para o Gerenciador de serviços do Tableau. A URL deve começar com https, incluir a porta 8850 e usar o nome do servidor, não o endereço IP. Por exemplo, https://<tsm_hostname>:8850. Se nenhum servidor for especificado, o https://<localhost | dnsname>:8850 é considerado.

--trust-admin-controller-cert

Opcional.

Use este sinalizador para confiar no certificado autoassinado do controlador TSM. Para obter mais informações sobre confiança de certificado e conexões CLI, consulte Conexão de clientes do TSM.

-u, --username <usuário>

Obrigatório se nenhuma sessão estiver ativa, com -p ou --password.

Especificar uma conta de usuário. Se não incluir essa opção, o comando é executado usando as credenciais de logon.