1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2024-09-14 20:13:21 +02:00
community.general/plugins/doc_fragments/hwc.py

66 lines
2.2 KiB
Python
Raw Normal View History

2021-08-07 15:02:21 +02:00
# -*- coding: utf-8 -*-
# Copyright (c) 2018, Huawei Inc.
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
# SPDX-License-Identifier: GPL-3.0-or-later
2020-03-09 10:11:07 +01:00
from __future__ import (absolute_import, division, print_function)
__metaclass__ = type
2020-03-09 10:11:07 +01:00
class ModuleDocFragment(object):
# HWC doc fragment.
DOCUMENTATION = '''
options:
identity_endpoint:
description:
- The Identity authentication URL.
type: str
required: true
user:
description:
- The user name to login with.
- Currently only user names are supported, and not user IDs.
2020-03-09 10:11:07 +01:00
type: str
required: true
password:
description:
- The password to login with.
type: str
required: true
domain:
description:
- The name of the Domain to scope to (Identity v3).
- Currently only domain names are supported, and not domain IDs.
2020-03-09 10:11:07 +01:00
type: str
required: true
project:
description:
- The name of the Tenant (Identity v2) or Project (Identity v3).
- Currently only project names are supported, and not project IDs.
2020-03-09 10:11:07 +01:00
type: str
required: true
region:
description:
- The region to which the project belongs.
type: str
id:
description:
- The ID of resource to be managed.
2020-03-09 10:11:07 +01:00
type: str
notes:
- For authentication, you can set identity_endpoint using the
E(ANSIBLE_HWC_IDENTITY_ENDPOINT) environment variable.
2020-03-09 10:11:07 +01:00
- For authentication, you can set user using the
E(ANSIBLE_HWC_USER) environment variable.
- For authentication, you can set password using the E(ANSIBLE_HWC_PASSWORD) environment
2020-03-09 10:11:07 +01:00
variable.
- For authentication, you can set domain using the E(ANSIBLE_HWC_DOMAIN) environment
2020-03-09 10:11:07 +01:00
variable.
- For authentication, you can set project using the E(ANSIBLE_HWC_PROJECT) environment
2020-03-09 10:11:07 +01:00
variable.
- For authentication, you can set region using the E(ANSIBLE_HWC_REGION) environment variable.
2020-03-09 10:11:07 +01:00
- Environment variables values will only be used if the playbook values are
not set.
'''