CreateSessions - Gerenciador de Sessões do Amazon DCV
Parâmetros de solicitaçãoParâmetros de respostaExemplo

As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

CreateSessions

Cria uma nova sessão do Amazon DCV com os detalhes especificados.

Parâmetros de solicitação

Name

Um nome para a sessão.

Tipo: string

Obrigatório: Sim

Owner

O nome do proprietário da sessão. Deve ser o nome de um usuário existente no servidor Amazon DCV de destino.

Tipo: string

Obrigatório: Sim

Type

O tipo de sessão. Para obter mais informações sobre os tipos de sessões, consulte Introdução às sessões do Amazon DCV no Guia do administrador do Amazon DCV.

Valores válidos: CONSOLE | VIRTUAL

Tipo: string

Obrigatório: Sim

InitFile

Compatível com sessões virtuais nos servidores Amazon DCV do Linux. Não é compatível com sessões do console nos servidores Amazon DCV do Windows e do Linux. O caminho para o script personalizado no servidor Amazon DCV a ser executado para inicializar a sessão quando ela for criada. O caminho do arquivo é relativo ao diretório init especificado para o parâmetro de configuração do Atendente agent.init_folder. Se o arquivo estiver no diretório init especificado, especifique somente o nome do arquivo. Se o arquivo não estiver no diretório init especificado, especifique o caminho relativo. Para obter mais informações, consulte o arquivo de configuração do Atendente no Guia do administrador do Gerenciador de Sessões do Amazon DCV.

Tipo: String

Obrigatório: Não

MaxConcurrents

O número máximo de clientes simultâneos do Amazon DCV.

Tipo: inteiro

Obrigatório: Não

DcvGlEnabled

Indica se a sessão virtual está configurada para usar OpenGL baseado em hardware. Compatível somente com sessões virtuais. Este parâmetro não é compatível com servidores Amazon DCV do Windows.

Valores válidos: true | false

Tipo: booliano

Obrigatório: Não

PermissionsFile

O conteúdo codificado em Base64 do arquivo de permissões. O padrão é o servidor padrão, se omitido. Para obter mais informações, consulte Configurar a autorização do Amazon DCV no Guia do administrador do Amazon DCV.

Tipo: String

Obrigatório: Não

EnqueueRequest

Indica se a solicitação deverá ser colocada em fila se ela não puder ser atendida imediatamente.

Tipo: booliano

Padrão: False

Obrigatório: Não

AutorunFile

Compatível com sessões de console em servidores Amazon DCV do Windows e sessões virtuais em servidores Amazon DCV do Linux. Não é compatível com sessões do console nos servidores Amazon DCV do Linux.

O caminho para um arquivo no servidor host que será executado dentro da sessão. O caminho do arquivo é relativo ao diretório autorun especificado para o parâmetro de configuração do Atendente do agent.autorun_folder. Se o arquivo estiver no diretório autorun especificado, especifique somente o nome do arquivo. Se o arquivo não estiver no diretório autorun especificado, especifique o caminho relativo. Para obter mais informações, consulte o arquivo de configuração do Atendente no Guia do administrador do Gerenciador de Sessões do Amazon DCV.

O arquivo é executado em nome do proprietário especificado. O proprietário especificado deve ter permissão para executar o arquivo no servidor. Nos servidores Amazon DCV do Windows, o arquivo é executado quando o proprietário faz login na sessão. Nos servidores Amazon DCV do Linux, o arquivo é executado quando a sessão é criada.

Tipo: String

Obrigatório: Não

AutorunFileArguments

Compatível com sessões virtuais nos servidores Amazon DCV do Linux. Não é compatível com sessões do console nos servidores Amazon DCV do Windows e do Linux. Os argumentos de linha de comando são transmitidos para AutorunFile após sua execução dentro da sessão. Os argumentos são transmitidos na ordem em que aparecem na matriz fornecida. O número máximo permitido de argumentos e o tamanho máximo permitido de cada argumento podem ser configurados. Para obter mais informações, consulte o arquivo de configuração do Agente no Guia do administrador do Gerenciador de Sessões do Amazon DCV.

Tipo: matriz de strings

Obrigatório: Não

DisableRetryOnFailure

Indica se a solicitação de criação de sessão não deve ser repetida após ela falhar em um host do Amazon DCV por algum motivo. Para obter mais informações sobre criar o mecanismo de nova tentativa de sessão, consulte Arquivo de configuração do Agente no Guia do administrador do Gerenciador de Sessões do Amazon DCV.

Tipo: booliano

Padrão: False

Obrigatório: Não

Requirements

Os requisitos que o servidor deve atender para realizar a sessão. Os requisitos podem incluir tags do servidor e/ou propriedades do servidor. Tanto as tags quanto as propriedades do servidor são recuperadas chamando a API DescribeServers.

Expressões de condição de requisitos:

  • a != b é verdadeiro se a não for igual a b

  • a = b é verdadeiro se a for igual a b

  • a > b é verdadeiro se a for maior que b

  • a >= b é verdadeiro se a for maior que ou igual a b

  • a < b é verdadeiro se a for menor que b

  • a <= b é verdadeiro se a for menor que ou igual a b

  • a = b é verdadeiro se a contiver a string b

Requisitos para operadores booleanos:

  • a e b são verdadeiros se a e b forem verdadeiros

  • a ou b são verdadeiros se a ou b forem verdadeiros

  • a não é verdadeiro se a for falso

As chaves de tag devem ser prefixadas por tag:, as propriedades do servidor devem ser prefixadas por server:. As expressões de requisitos oferecem suporte a parênteses ().

Exemplos de requisitos:

  • tag:color = 'pink' and (server:Host.Os.Family = 'windows' or tag:color := 'red')

  • "server:Host.Aws.Ec2InstanceType := 't2' and server:Host.CpuInfo.NumberOfCpus >= 2"

Valores numéricos podem ser especificados usando a notação exponencial, por exemplo: "server:Host.Memory.TotalBytes > 1024E6".

As propriedades do servidor compatíveis são:

  • Id

  • Hostname

  • Version

  • SessionManagerAgentVersion

  • Host.Os.BuildNumber

  • Host.Os.Family

  • Host.Os.KernelVersion

  • Host.Os.Name

  • Host.Os.Version

  • Host.Memory.TotalBytes

  • Host.Memory.UsedBytes

  • Host.Swap.TotalBytes

  • Host.Swap.UsedBytes

  • Host.CpuLoadAverage.OneMinute

  • Host.CpuLoadAverage.FiveMinutes

  • Host.CpuLoadAverage.FifteenMinutes

  • Host.Aws.Ec2InstanceId

  • Host.Aws.Ec2InstanceType

  • Host.Aws.Region

  • Host.Aws.Ec2ImageId

  • Host.CpuInfo.Architecture

  • Host.CpuInfo.ModelName

  • Host.CpuInfo.NumberOfCpus

  • Host.CpuInfo.PhysicalCoresPerCpu

  • Host.CpuInfo.Vendor

Tipo: String

Obrigatório: Não

StorageRoot

Especifica o caminho para a pasta a ser usada para armazenamento de sessão. Para obter mais informações sobre o armazenamento de sessão do Amazon DCV, consulte Ativar o armazenamento de sessão no Guia do administrador do Amazon DCV.

Tipo: String

Obrigatório: Não

Parâmetros de resposta

Id

O ID exclusivo da sessão.

Name

O nome da sessão.

Owner

O proprietário da sessão.

Type

O tipo de sessão.

State

O estado da sessão. Se a solicitação for concluída com êxito, a sessão entrará no estado CREATING.

Substate

O subestado da sessão. Se a solicitação for concluída com êxito, o subestado entrará no subestado SESSION_PLACING.

Exemplo

Python
Solicitação

O exemplo a seguir cria três sessões.


from swagger_client.models.create_session_request_data import CreateSessionRequestData

def get_sessions_api():
    api_instance = swagger_client.SessionsApi(swagger_client.ApiClient(get_client_configuration()))
    set_request_headers(api_instance.api_client)
    return api_instance

def create_sessions(sessions_to_create):
    create_sessions_request = list()
    for name, owner, session_type, init_file_path, autorun_file, autorun_file_arguments, max_concurrent_clients,\
            dcv_gl_enabled, permissions_file, requirements, storage_root in sessions_to_create:
        a_request = CreateSessionRequestData(
            name=name, owner=owner, type=session_type,
            init_file_path=init_file_path, autorun_file=autorun_file, autorun_file_arguments=autorun_file_arguments, max_concurrent_clients=max_concurrent_clients,
            dcv_gl_enabled=dcv_gl_enabled, permissions_file=permissions_file, requirements=requirements, storage_root=storage_root)
        create_sessions_request.append(a_request)

    api_instance = get_sessions_api()
    print('Create Sessions Request:', create_sessions_request)
    api_response = api_instance.create_sessions(body=create_sessions_request)
    print('Create Sessions Response:', api_response)

def main():
    create_sessions([
    ('session1', 'user1', 'CONSOLE', None, None, None, 1, None, '/dcv/permissions.file', "tag:os = 'windows' and server:Host.Memory.TotalBytes > 1024", "/storage/root"),
    ('session2', 'user1', 'VIRTUAL', None, 'myapp.sh', None, 1, False, None, "tag:os = 'linux'", None),
    ('session3', 'user1', 'VIRTUAL', '/dcv/script.sh', 'myapp.sh', ['argument1', 'argument2'], 1, False, None, "tag:os = 'linux'", None),
])
Resposta

Esta é uma saída de exemplo.

{
              "RequestId": "e32d0b83-25f7-41e7-8c8b-e89326ecc87f",
    "SuccessfulList": [
    {
            "Id": "78b45deb-1163-46b1-879b-7d8fcbe9d9d6",
            "Name": "session1",
            "Owner": "user1",
            "Type": "CONSOLE",
            "State": "CREATING"
    },
    {
            "Id": " a0c743c4-9ff7-43ce-b13f-0c4d55a268dd",
            "Name": "session2",
            "Owner": "user1",
            "Type": "VIRTUAL",
            "State": "CREATING"
    },
    {
            "Id": " 10311636-df90-4cd1-bcf7-474e9675b7cd",
            "Name": "session3",
            "Owner": "user1",
            "Type": "VIRTUAL",
            "State": "CREATING"
    }
    ],
    "UnsuccessfulList": [
    ]
}