community.general.gitlab_project_access_token модуль – Управляет токенами доступа к проектам GitLab

Примечание

Этот модуль является частью коллекции community.general collection (версия 9.5.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, запустите ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Вам потребуются дополнительные требования для использования этого модуля, см. Требования для получения подробной информации.

Чтобы использовать его в playbook, укажите: community.general.gitlab_project_access_token.

Новое в community.general 8.4.0

Краткое описание
Требования
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Краткое описание

Создает и отзывает токены доступа к проекту.

Требования

Ниже указаны требования, необходимые на хосте, который выполняет этот модуль.

python-gitlab >= 3.1.0
requests (библиотека Python https://pypi.org/project/requests/)

Параметры

Параметр	Комментарии
access_level строка	Уровень доступа токена доступа. Варианты: `"guest"` `"reporter"` `"developer"` `"maintainer"` ← (по умолчанию) `"owner"`
api_job_token строка добавлено в community.general 4.2.0	Токен задания GitLab CI для входа.
api_oauth_token строка добавлено в community.general 4.2.0	Токен OAuth GitLab для входа.
api_password строка	Пароль для аутентификации в API.
api_token строка	Токен доступа GitLab с правами API.
api_url строка	Разрешаемая конечная точка для API.
api_username строка	Имя пользователя для аутентификации в API.
ca_path строка добавлено в community.general 8.1.0	Пакет сертификатов CA, используемый для проверки сертификата сервера GitLab.
expires_at строка / обязательно	Дата истечения срока действия токена доступа в формате `YYYY-MM-DD`. Убедитесь, что это значение заключено в кавычки в YAML, чтобы оно сохранялось как строка, а не интерпретировалось как дата YAML.
name строка / обязательно	Имя токена доступа.
project строка / обязательно	ID или полный путь проекта в формате group/name.
recreate строка	Будет ли токен доступа пересоздан, если он уже существует. Когда `never` токен никогда не будет пересоздан. Когда `always` токен всегда будет пересоздан. Когда `state_change` токен будет пересоздан, если есть разница между желаемым состоянием и фактическим состоянием. Варианты: `"never"` ← (по умолчанию) `"always"` `"state_change"`
scopes псевдонимы: scope список / элементы=строка / обязательно	Область действия токена доступа. Варианты: `"api"` `"read_api"` `"read_registry"` `"write_registry"` `"read_repository"` `"write_repository"` `"create_runner"` `"ai_features"` `"k8s_proxy"`
state строка	Когда `present` токен доступа будет добавлен к проекту, если он не существует. Когда `absent` он будет удален из проекта, если существует. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs логическое	Проверять ли SSL-сертификаты при предоставлении конечной точки HTTPS. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может работать в режиме `check_mode` и возвращать прогноз состояния изменений без изменения цели.
diff_mode	Поддержка: отсутствует	Возвращает подробную информацию о том, что изменилось (или, возможно, нуждается в изменении в режиме `check_mode`).

Примечания

Примечание

Токены доступа не могут быть изменены. Если необходимо изменить параметр, токен доступа должен быть пересоздан. То, будут ли токены пересозданы, контролируется параметром recreate, который по умолчанию установлен в never.
Строка токена содержится в результате только при создании или пересоздании токена доступа. Ее нельзя получить позже.
Сопоставление токенов осуществляется путем сравнения параметра name.

Примеры

- name: "Creating a project access token"
  community.general.gitlab_project_access_token:
    api_url: https://gitlab.example.com/
    api_token: "somegitlabapitoken"
    project: "my_group/my_project"
    name: "project_token"
    expires_at: "2024-12-31"
    access_level: developer
    scopes:
      - api
      - read_api
      - read_repository
      - write_repository
    state: present

- name: "Revoking a project access token"
  community.general.gitlab_project_access_token:
    api_url: https://gitlab.example.com/
    api_token: "somegitlabapitoken"
    project: "my_group/my_project"
    name: "project_token"
    expires_at: "2024-12-31"
    scopes:
      - api
      - read_api
      - read_repository
      - write_repository
    state: absent

- name: "Change (recreate) existing token if its actual state is different than desired state"
  community.general.gitlab_project_access_token:
    api_url: https://gitlab.example.com/
    api_token: "somegitlabapitoken"
    project: "my_group/my_project"
    name: "project_token"
    expires_at: "2024-12-31"
    scopes:
      - api
      - read_api
      - read_repository
      - write_repository
    recreate: state_change
    state: present

Возвращаемые значения

Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:

Ключ	Описание
access_token dictionary	API объект. Содержит только значение токена, если токен был создан или пересоздан. Возвращено: success и `state=present`

Авторы

Zoran Krleza (@pixslx)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/gitlab_project_access_token_module.html