CLI du planificateur - Planificateur d'instances sur AWS
PrérequisInformations d'identificationInstallation de la CLI du planificateurStructure de commandeArguments courantsCommandes disponiblespériode de créationcréer-un calendrierpériode de suppressionsupprimer-planifierdécrivez les périodesdécrire les horairesdescribe-schedule-usagepériode de mise à jourcalendrier de mise à jouraide

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

CLI du planificateur

Le planificateur d'instance sur l'interface de ligne de commande (CLI) AWS vous permet de configurer des plannings et des périodes, et d'estimer les économies réalisées pour un planning donné.

Prérequis

La CLI de cette solution nécessite Python 3.8+ et la dernière version de boto3.

Informations d'identification

Pour utiliser l'interface de ligne de commande du planificateur, vous devez disposer des informations d'identification pour l'interface de ligne de commande AWS. Pour plus d'informations, reportez-vous à la section Configuration et paramètres des fichiers d'identification dans le guide de l'utilisateur de l'AWS CLI.

Vos informations d'identification doivent disposer des autorisations suivantes :

  • lambda:InvokeFunction- Pour appeler la InstanceSchedulerMain fonction dans la pile du planificateur et pour mettre à jour les informations de calendrier et de période dans la base de données de configuration du planificateur depuis la ligne de commande

  • cloudformation:DescribeStackResource- Pour récupérer l'ID de ressource physique de la fonction AWS Lambda depuis la pile afin de gérer la demande de la CLI

Les demandes effectuées par la CLI du planificateur et les réponses sont enregistrées dans le flux de AdminCliRequestHandler-yyyymmdd log.

Note

Si vous spécifiez un profil à l'aide de l'argument profile-name, le profil que vous spécifiez doit disposer de ces autorisations. Pour plus d'informations sur l'argument profile-name, reportez-vous à la section Arguments communs.

Installation de la CLI du planificateur

  1. Téléchargez le package CLI du planificateur (instance_scheduler_cli.zip) et placez-le dans un répertoire de votre ordinateur.

    Important

    L'installation échouera si vous ne placez pas les fichiers dans leur propre répertoire, puis si vous les installez à partir de ce répertoire.

  2. Décompressez l'archive zip dans son propre répertoire (instance_scheduler_cli).

  3. À partir du répertoire dans lequel vous avez placé le package CLI décompressé, installez le scheduler-cli dans votre environnement :

    Note

    Scheduler-CLI nécessite Python 3.8 ou supérieur et les dernières versions de pip et boto3. Si vous ne les avez pas tous installés sur votre machine locale, veuillez consulter la documentation officielle de pip pour obtenir des instructions d'installation avant d'essayer d'installer le Scheduler-CLI.

    pip install --no-index --find-links=instance_scheduler_cli instance_scheduler_cli

  4. Vérifiez que l'installation a réussi avec :

    scheduler-cli --help
Note

Si vous préférez, un sdist de la CLI peut être installé en utilisant le même processus que ci-dessus.

Structure de commande

La CLI du planificateur utilise une structure en plusieurs parties sur la ligne de commande. La partie suivante spécifie le script python de la CLI du planificateur. La CLI du planificateur comporte des commandes qui spécifient les opérations à effectuer sur les périodes et les calendriers. Les arguments spécifiques d'une opération peuvent être spécifiés sur la ligne de commande dans n'importe quel ordre.

scheduler-cli <command> <arguments>

Arguments courants

La CLI du planificateur prend en charge les arguments suivants que toutes les commandes peuvent utiliser :

Argument Description

--stack [replaceable]<stackname>

Nom de la pile du planificateur.

Important : Cet argument est obligatoire pour toutes les commandes.

--region [replaceable]<regionname>

Nom de la région dans laquelle la pile de planificateurs est déployée.

Remarque : vous devez utiliser cet argument lorsque les fichiers de configuration et d'identification par défaut ne sont pas installés dans la même région que la pile de solutions.

--profile-name [replaceable] <profilename>

Nom du profil à utiliser pour exécuter des commandes. Si aucun nom de profil n'est spécifié, le profil par défaut est utilisé.

--query

JMESPath Expression qui contrôle la sortie de la commande. Pour plus d'informations sur le contrôle de la sortie, reportez-vous à la section Contrôle de la sortie de commande depuis l'interface de ligne de commande AWS dans le guide de l'utilisateur de la CLI AWS.

--help

Affiche les commandes et arguments valides pour la CLI du planificateur. Lorsqu'il est utilisé avec une commande spécifique, il affiche les sous-commandes et les arguments valides pour cette commande.

--version

Affiche le numéro de version de la CLI du planificateur.

Commandes disponibles

période de création

Description

Crée un point. Un point doit contenir au moins l'un des éléments suivants : begintimeendtime,weekdays,months, oumonthdays.

Arguments

--name

  • Le nom de la période

    Type : String

    Obligatoire : oui

--description

  • Description de la période

    Type : chaîne

    Obligatoire : non

--begintime

  • Heure à laquelle la période de course commence. Si begintime et ne endtime sont pas spécifiés, la période de fonctionnement est de 00h00 à 23h59.

    Type : String

    Contraintes : H:MM ou HH:MM format

    Obligatoire : non

--endtime

  • Heure à laquelle la période de fonctionnement s'arrête. Si begintime et ne endtime sont pas spécifiés, la période de fonctionnement est de 00h00 à 23h59.

    Type : String

    Contraintes : H:MM ou HH:MM format

    Obligatoire : non

--weekdays

  • Les jours de la semaine correspondant à la période

    Type : String

    Contraintes : liste de noms de jours abrégés (mon) ou de chiffres (0) séparés par des virgules. Utilisez - pour spécifier une plage. Utilisez/pour spécifier chaque n ^ème jour de la semaine.

    Obligatoire : non

--months

  • Les mois de la période

    Type : String

    Contraintes : liste de noms de mois abrégés (jan) ou de chiffres (1) séparés par des virgules. Utilisez - pour spécifier une plage. Utilisez/pour spécifier tous les n ^ème mois.

    Obligatoire : non

--monthdays

  • Les jours du mois correspondant à la période

    Type : String

    Contraintes : liste de noms de mois abrégés (jan) ou de chiffres (1) séparés par des virgules. Utilisez - pour spécifier une plage. Utilisez/pour spécifier chaque n ^ème jour du mois.

    Obligatoire : non

Exemple

$ scheduler-cli create-period --name "weekdays" --begintime 09:00 --endtime 18:00 --weekdays mon-fri --stack Scheduler
{
   "Period": {
      "Name": "weekdays",
      "Endtime": "18:00",
      "Type": "period",
      "Begintime": "09:00",
      "Weekdays": [
         "mon-fri"
      ]
   }
    }

créer-un calendrier

Description

Crée un calendrier.

Arguments

--name

  • Le nom de l'horaire

    Type : String

    Obligatoire : oui

--description

  • Description de l'horaire

    Type : chaîne

    Obligatoire : non

--enforced

  • Applique l'état planifié pour l'instance

    Obligatoire : non

--use-metrics

  • Collectez les CloudWatch statistiques Amazon

    Obligatoire : non

--periods

  • Une liste des périodes de fonctionnement du calendrier. Si plusieurs périodes sont spécifiées, la solution démarrera une instance si l'une des périodes est évaluée àtrue.

    Type : String

    Contraintes : liste de points séparés par des virgules. <period-name>@[replaceable]<instance type>À utiliser pour spécifier un type d'instance pour une période. Par exemple, weekdays@t2.large.

    Obligatoire : oui

--retain-running

  • Empêche l'arrêt d'une instance par la solution à la fin d'une période d'exécution, si l'instance a été démarrée manuellement avant le début de la période.

    Obligatoire : non

--ssm-maintenance-window

  • Ajoute une fenêtre de maintenance AWS Systems Manager en tant que période d'exécution à un calendrier d' EC2 instance Amazon.

    Type : chaîne

    Obligatoire : non

--do-not-stop-new-instances

  • N'arrêtez pas une instance la première fois qu'elle est étiquetée si elle s'exécute en dehors d'une période d'exécution

    Obligatoire : non

--timezone

  • Le fuseau horaire utilisé par le calendrier

    Type : tableau de chaînes

    Obligatoire : Non (Si cet argument n'est pas utilisé, le fuseau horaire par défaut de la pile de solutions principale est utilisé.)

--use-maintenance-window

  • Ajoute une fenêtre de maintenance Amazon RDS en tant que période d'exécution à un calendrier d'instance Amazon RDS, ou une fenêtre de maintenance AWS Systems Manager en tant que période d'exécution à un calendrier d'instance Amazon EC2

    Type : vrai/faux

    Obligatoire : Non (vrai par défaut)

Exemple

$ scheduler-cli create-schedule --name LondonOfficeHours --periods weekdays,weekends --timezone Europe/London --stack Scheduler
{
   "Schedule": {
      "Enforced": false,
      "Name": "LondonOfficeHours",
      "StopNewInstances": true,
      "Periods": [
         "weekends",
         "weekdays"
      ],
      "Timezone": "Europe/London",
      "Type": "schedule"
   }
}

période de suppression

--name

  • Le nom de la période applicable

    Type : String

    Obligatoire : oui

Important

Si la période est utilisée dans des plannings existants, vous devez la supprimer de ces plannings avant de la supprimer.

Exemple 

$ scheduler-cli delete-period --name weekdays --stack Scheduler
{
   "Period": "weekdays"
}

supprimer-planifier

Description

Supprime un planning existant

Arguments

--name

  • Le nom de l'horaire applicable

    Type : String

    Obligatoire : oui

Exemple

$ scheduler-cli delete-schedule --name LondonOfficeHours --stack Scheduler
{
   "Schedule": "LondonOfficeHours"
}

décrivez les périodes

Description

Répertorie les périodes configurées pour la pile Instance Scheduler

Arguments

--name

  • Le nom d'une période spécifique que vous souhaitez décrire

    Type : chaîne

    Obligatoire : non

Exemple

$ scheduler-cli describe-periods --stack Scheduler
{
   "Periods": [
      {
         "Name": "first-monday-in-quarter",
         "Months": [
            "jan/3"
         ],
         "Type": "period",
         "Weekdays": [
            "mon#1"
         ],
         "Description": "Every first Monday of each quarter"
      },
      {
         "Description": "Office hours",
         "Weekdays": [
            "mon-fri"
         ],
         "Begintime": "09:00",
         "Endtime": "17:00",
         "Type": "period",
         "Name": "office-hours"
      },

      {
         "Name": "weekdays",
         "Endtime": "18:00",
         "Type": "period",
         "Weekdays": [
            "mon-fri"
         ],
         "Begintime": "09:00"
      },
      {
         "Name": "weekends",
         "Type": "period",
         "Weekdays": [
            "sat-sun"
         ],
         "Description": "Days in weekend"
      }
   ]
}

décrire les horaires

Description

Répertorie les plannings configurés pour la pile Instance Scheduler.

Arguments

--name

  • Le nom d'un calendrier spécifique que vous souhaitez décrire

    Type : chaîne

    Obligatoire : non

Exemple

$ scheduler-cli describe-schedules --stack Scheduler

{
   "Schedules": [
      {
         "OverrideStatus": "running",
         "Type": "schedule",
         "Name": "Running",
         "UseMetrics": false
      },
      {
         "Timezone": "UTC",
         "Type": "schedule",
         "Periods": [
            "working-days@t2.micro",
            "weekends@t2.nano"
         ],
         "Name": "scale-up-down"
      },
      {
         "Timezone": "US/Pacific",
         "Type": "schedule",
         "Periods": [
            "office-hours"
         ],
         "Name": "seattle-office-hours"
      },
      {
         "OverrideStatus": "stopped",
         "Type": "schedule",
         "Name": "stopped",
         "UseMetrics": true
      }
   ]
}

describe-schedule-usage

Description

Répertorie toutes les périodes comprises dans un calendrier et calcule les heures de facturation pour les instances. Utilisez cette commande pour simuler un calendrier afin de calculer les économies potentielles et les périodes de fonctionnement après la création ou la mise à jour d'un calendrier.

Arguments

--name

  • Le nom de l'horaire applicable

    Type : String

    Obligatoire : oui

--startdate

  • Date de début de la période utilisée pour le calcul. La date par défaut est la date du jour.

    Type : chaîne

    Obligatoire : non

--enddate

  • Date de fin de la période utilisée pour le calcul. La date par défaut est la date du jour.

    Type : chaîne

    Obligatoire : non

Exemple

$ scheduler-cli describe-schedule-usage --stack InstanceScheduler --name seattle-office-hours
{
   "Usage": {
      "2017-12-04": {
         "BillingHours": 8,
         "RunningPeriods": {
            "Office-hours": {
               "Begin": "12/04/17 09:00:00",
               "End": "12/04/17 17:00:00",
               "BillingHours": 8,
               "BillingSeconds": 28800
            }
         },
         "BillingSeconds": 28800
      }
   },
   "Schedule": "seattle-office-hours"

période de mise à jour

Description

Met à jour une période existante

Arguments

La update-period commande prend en charge les mêmes arguments que la create-period commande. Pour plus d'informations sur les arguments, reportez-vous à la commande create period.

Important

Si vous ne spécifiez aucun argument, celui-ci sera supprimé de la période.

calendrier de mise à jour

Description

Met à jour un calendrier existant

Arguments

La update-schedule commande prend en charge les mêmes arguments que la create-schedule commande. Pour plus d'informations sur les arguments, reportez-vous à la commande create schedule.

Important

Si vous ne spécifiez aucun argument, celui-ci sera supprimé du calendrier.

aide

Description

Affiche une liste de commandes et d'arguments valides pour la CLI du planificateur.

Exemple

$ scheduler-cli --help
usage: scheduler-cli [-h] [--version]
                     {create-period,create-schedule,delete-period,delete-schedule,describe-periods,describe-schedule-usage,describe-schedules,update-period,update-schedule}
                     ...

optional arguments:
  -h, --help            show this help message and exit
  --version             show program's version number and exit

subcommands:
  Valid subcommands

  {create-period,create-schedule,delete-period,delete-schedule,describe-periods,describe-schedule-usage,describe-schedules,update-period,update-schedule}
                        Commands help
    create-period       Creates a period
    create-schedule     Creates a schedule
    delete-period       Deletes a period
    delete-schedule     Deletes a schedule
    describe-periods    Describes configured periods
    describe-schedule-usage
                        Calculates periods and billing hours in which
                        instances are running
    describe-schedules  Described configured schedules
    update-period       Updates a period
    update-schedule     Updates a schedule

Lorsqu'il est utilisé avec une commande spécifique, l'--helpargument indique les sous-commandes et les arguments valides pour cette commande.

Exemple de commande spécifique

$ scheduler-cli describe-schedules --help
usage: scheduler-cli describe-schedules [-h] [--name NAME] [--query QUERY]
                                        [--region REGION] --stack STACK

optional arguments:
  -h, --help         show this help message and exit
  --name NAME        Name of the schedule
  --query QUERY      JMESPath query to transform or filter the result
  --region REGION    Region in which the Instance Scheduler stack is
                        deployed
  --stack STACK, -s STACK
                     Name of the Instance Scheduler stack