CreateSessions

Crée une nouvelle session Amazon DCV avec les informations spécifiées.

Paramètres de demande

Name

Le nom de la session.

Type : String

Obligatoire : oui

Owner

Le nom du propriétaire de la session. Il doit s'agir du nom d'un utilisateur existant sur le serveur Amazon DCV cible.

Type : String

Obligatoire : oui

Type

Le type de session. Pour plus d'informations sur les types de sessions, consultez la section Introduction aux sessions Amazon DCV dans le manuel Amazon DCV Administrator Guide.

Valeurs valides : CONSOLE | VIRTUAL

Type : String

Obligatoire : oui

InitFile

Pris en charge par les sessions virtuelles sur les serveurs Linux Amazon DCV. Il n'est pas pris en charge avec les sessions de console sur les serveurs Amazon DCV Windows et Linux. Le chemin d'accès au script personnalisé sur le serveur Amazon DCV à exécuter pour initialiser la session lors de sa création. Le chemin du fichier est relatif au répertoire d'initialisation spécifié pour le paramètre de configuration de l'agent.init_folderagent. Si le fichier se trouve dans le répertoire d'initialisation spécifié, spécifiez uniquement le nom du fichier. Si le fichier ne se trouve pas dans le répertoire d'initialisation spécifié, spécifiez le chemin relatif. Pour plus d'informations, consultez le fichier de configuration de l'agent dans le guide de l'administrateur d'Amazon DCV Session Manager.

Type : chaîne

Obligatoire : non

MaxConcurrents

Le nombre maximum de clients Amazon DCV simultanés.

Type : entier

Obligatoire : non

DcvGlEnabled

Indique si la session virtuelle est configurée pour utiliser OpenGL basé sur le matériel. Pris en charge uniquement avec les sessions virtuelles. Ce paramètre n'est pas pris en charge par les serveurs Windows Amazon DCV.

Valeurs valides : true | false

Type : booléen

Obligatoire : non

PermissionsFile

Le contenu codé en Base64 du fichier d'autorisations. Si elle est omise, il s'agit par défaut des valeurs par défaut du serveur. Pour plus d'informations, consultez la section Configuration de l'autorisation Amazon DCV dans le guide de l'administrateur Amazon DCV.

Type : chaîne

Obligatoire : non

EnqueueRequest

Indique si la demande doit être mise en file d'attente si elle ne peut pas être traitée immédiatement.

Type : booléen

Valeur par défaut : false

Obligatoire : non

AutorunFile

Compatible avec les sessions de console sur les serveurs Windows Amazon DCV et les sessions virtuelles sur les serveurs Amazon DCV Linux. Il n'est pas pris en charge avec les sessions de console sur les serveurs Linux Amazon DCV.

Le chemin d'accès à un fichier sur le serveur hôte qui doit être exécuté dans le cadre de la session. Le chemin du fichier est relatif au répertoire autorun spécifié pour le paramètre de configuration de l'agent.autorun_folderagent. Si le fichier se trouve dans le répertoire autorun spécifié, spécifiez uniquement le nom du fichier. Si le fichier ne se trouve pas dans le répertoire autorun spécifié, spécifiez le chemin relatif. Pour plus d'informations, consultez le fichier de configuration de l'agent dans le guide de l'administrateur d'Amazon DCV Session Manager.

Le fichier est exécuté pour le compte du propriétaire spécifié. Le propriétaire indiqué doit être autorisé à exécuter le fichier sur le serveur. Sur les serveurs Windows Amazon DCV, le fichier est exécuté lorsque le propriétaire se connecte à la session. Sur les serveurs Linux Amazon DCV, le fichier est exécuté lors de la création de la session.

Type : chaîne

Obligatoire : non

AutorunFileArguments

Pris en charge par les sessions virtuelles sur les serveurs Linux Amazon DCV. Il n'est pas pris en charge dans les sessions de console sur les serveurs Amazon DCV Windows et Linux. Arguments de ligne de commande transmis AutorunFilelors de son exécution dans la session. Les arguments sont transmis dans l'ordre dans lequel ils apparaissent dans le tableau donné. Le nombre maximum autorisé d'arguments et la longueur maximale autorisée de chaque argument peuvent être configurés. Pour plus d'informations, consultez le fichier de configuration du courtier dans le guide de l'administrateur d'Amazon DCV Session Manager.

Type : tableau de chaînes

Obligatoire : non

DisableRetryOnFailure

Indique s'il convient de ne pas réessayer la demande de création de session après son échec sur un hôte Amazon DCV pour une raison quelconque. Pour plus d'informations sur le mécanisme de création de nouvelles tentatives de session, consultez le fichier de configuration de Broker dans le guide de l'administrateur d'Amazon DCV Session Manager.

Type : booléen

Valeur par défaut : false

Obligatoire : non

Requirements

Les exigences auxquelles le serveur doit satisfaire pour pouvoir ouvrir la session. Les exigences peuvent inclure les balises de serveur, les propriétés and/or du serveur, les balises de serveur et les propriétés du serveur sont récupérées en appelant l'DescribeServersAPI.

Expressions de conditions d'exigences :

• a! = b vrai si a ce n'est pas égal à b

• a= b vrai si a c'est égal à b

• a> b vrai si a c'est supérieur à b

• a>= b vrai s'il a est supérieur ou égal à b

• a< b vrai si a c'est inférieur à b

• a<= b vrai s'il a est inférieur ou égal à b

• a= b vrai si a contient la chaîne b

Opérateurs booléens des exigences :

• aet b vrai si a et si c'best vrai

• aou b vrai si a ou b sont vrais

• non a vrai si a c'est faux

Les clés de balise doivent être préfixées partag:, les propriétés du serveur doivent être préfixées parserver:. Les expressions d'exigences acceptent les parenthèses. ()

Exemples d'exigences :

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

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

Les valeurs numériques peuvent être spécifiées à l'aide de la notation exponentielle, par exemple :"server:Host.Memory.TotalBytes > 1024E6".

Les propriétés de serveur prises en charge sont les suivantes :

• 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

Type : chaîne

Obligatoire : non

StorageRoot

Indique le chemin du dossier utilisé pour le stockage de session. Pour plus d'informations sur le stockage de sessions Amazon DCV, consultez la section Activation du stockage de session dans le manuel Amazon DCV Administrator Guide.

Type : chaîne

Obligatoire : non

Paramètres de réponse

Id

L'identifiant unique de la session.

Name

Nom de la session.

Owner

Le propriétaire de la session.

Type

Type de session.

State

État de la session. Si la demande aboutit, la session passe à l'CREATINGétat.

Substate

Sous-état de la session. Si la demande aboutit, le sous-état entre dans le SESSION_PLACING sous-état.

exemple

Python

Demande

L'exemple suivant crée trois sessions.

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),
])

Réponse

Voici un exemple de sortie.

{
              "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": [
    ]
}