72 lines
2.7 KiB
Python
72 lines
2.7 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# This code is part of Ansible, but is an independent component.
|
|
# This particular file snippet, and this file snippet only, is BSD licensed.
|
|
# Modules you write using this snippet, which is embedded dynamically by Ansible
|
|
# still belong to the author of the module, and may assign their own license
|
|
# to the complete work.
|
|
#
|
|
# (c) 2016 Red Hat Inc.
|
|
# (c) 2017 Cisco Systems Inc.
|
|
#
|
|
# Redistribution and use in source and binary forms, with or without modification,
|
|
# are permitted provided that the following conditions are met:
|
|
#
|
|
# * Redistributions of source code must retain the above copyright
|
|
# notice, this list of conditions and the following disclaimer.
|
|
# * Redistributions in binary form must reproduce the above copyright notice,
|
|
# this list of conditions and the following disclaimer in the documentation
|
|
# and/or other materials provided with the distribution.
|
|
#
|
|
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
|
|
# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
|
|
# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|
# IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
# INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
|
|
# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
|
|
# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
|
|
# LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
|
|
# USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
#
|
|
|
|
|
|
class ModuleDocFragment(object):
|
|
# Cisco UCS doc fragment
|
|
DOCUMENTATION = '''
|
|
options:
|
|
hostname:
|
|
description:
|
|
- IP address or hostname of Cisco UCS Manager.
|
|
type: str
|
|
required: yes
|
|
username:
|
|
description:
|
|
- Username for Cisco UCS Manager authentication.
|
|
type: str
|
|
default: admin
|
|
password:
|
|
description:
|
|
- Password for Cisco UCS Manager authentication.
|
|
type: str
|
|
required: yes
|
|
port:
|
|
description:
|
|
- Port number to be used during connection (by default uses 443 for https and 80 for http connection).
|
|
type: int
|
|
use_ssl:
|
|
description:
|
|
- If C(no), an HTTP connection will be used instead of the default HTTPS connection.
|
|
type: bool
|
|
default: yes
|
|
use_proxy:
|
|
description:
|
|
- If C(no), will not use the proxy as defined by system environment variable.
|
|
type: bool
|
|
default: yes
|
|
proxy:
|
|
description:
|
|
- If use_proxy is no, specfies proxy to be used for connection.
|
|
e.g. 'http://proxy.xy.z:8080'
|
|
type: str
|
|
'''
|