Windows: Add parameter types (#53325)

This PR also includes:
-  Added missing seealso sections
This commit is contained in:
Dag Wieers 2019-03-06 20:22:58 +01:00 committed by Alicia Cozine
parent 5ef7b7d767
commit b011ec4638
4 changed files with 41 additions and 18 deletions

View file

@ -19,30 +19,29 @@ options:
log:
description:
- Name of the event log to write an entry to.
type: str
required: yes
source:
description:
- Name of the log source to indicate where the entry is from.
type: str
required: yes
event_id:
description:
- The numeric event identifier for the entry.
- Value must be between 0 and 65535.
required: yes
type: int
required: yes
message:
description:
- The message for the given log entry.
type: str
required: yes
entry_type:
description:
- Indicates the entry being written to the log is of a specific type.
choices:
- Error
- FailureAudit
- Information
- SuccessAudit
- Warning
type: str
choices: [ Error, FailureAudit, Information, SuccessAudit, Warning ]
category:
description:
- A numeric task category associated with the category message file for the log source.
@ -51,6 +50,7 @@ options:
description:
- Binary data associated with the log entry.
- Value must be a comma-separated array of 8-bit unsigned integers (0 to 255).
type: str
notes:
- This module will always report a change when writing an event entry.
seealso:

View file

@ -22,6 +22,7 @@ options:
name:
description:
- Name of the connection authorization policy.
type: str
required: yes
state:
description:
@ -30,13 +31,15 @@ options:
- If C(present) will ensure the policy is configured and exists.
- If C(enabled) will ensure the policy is configured, exists and enabled.
- If C(disabled) will ensure the policy is configured, exists, but disabled.
choices: [ absent, present, enabled, disabled ]
type: str
choices: [ absent, enabled, disabled, present ]
default: present
auth_method:
description:
- Specifies how the RD Gateway server authenticates users.
- When a new CAP is created, the default value is C(password).
choices: [ password, smartcard, both, none ]
type: str
choices: [ both, none, password, smartcard ]
order:
description:
- Evaluation order of the policy.
@ -56,6 +59,7 @@ options:
- The action the server takes when a session times out.
- 'C(disconnect): disconnect the session.'
- 'C(reauth): silently reauthenticate and reauthorize the session.'
type: str
choices: [ disconnect, reauth ]
default: disconnect
idle_timeout:
@ -100,6 +104,10 @@ options:
requirements:
- Windows Server 2008R2 (6.1) or higher.
- The Windows Feature "RDS-Gateway" must be enabled.
seealso:
- module: win_rds_cap
- module: win_rds_rap
- module: win_rds_settings
'''
EXAMPLES = r'''
@ -110,12 +118,12 @@ EXAMPLES = r'''
- BUILTIN\users
session_timeout: 30
session_timeout_action: disconnect
allow_only_sdrts_servers: true
redirect_clipboard: true
redirect_drives: false
redirect_printers: false
redirect_serial: false
redirect_pnp: false
allow_only_sdrts_servers: yes
redirect_clipboard: yes
redirect_drives: no
redirect_printers: no
redirect_serial: no
redirect_pnp: no
state: enabled
'''

View file

@ -31,11 +31,13 @@ options:
- If C(present) will ensure the policy is configured and exists.
- If C(enabled) will ensure the policy is configured, exists and enabled.
- If C(disabled) will ensure the policy is configured, exists, but disabled.
choices: [ absent, present, enabled, disabled ]
type: str
choices: [ absent, disabled, enabled, present ]
default: present
description:
description:
- Optionnal description of the resource authorization policy.
type: str
user_groups:
description:
- List of user groups that are associated with this resource authorization policy (RAP).
@ -53,21 +55,27 @@ options:
- 'C(rdg_group): RD Gateway-managed group'
- 'C(ad_network_resource_group): Active Directory Domain Services network resource group'
- 'C(allow_any): Allow users to connect to any network resource.'
type: str
choices: [ rdg_group, ad_network_resource_group, allow_any ]
computer_group:
description:
- The computer group name that is associated with this resource authorization policy (RAP).
- This is required when I(computer_group_type) is C(rdg_group) or C(ad_network_resource_group).
type: str
requirements:
- Windows Server 2008R2 (6.1) or higher.
- The Windows Feature "RDS-Gateway" must be enabled.
seealso:
- module: win_rds_cap
- module: win_rds_rap
- module: win_rds_settings
'''
EXAMPLES = r'''
- name: Create a new RDS RAP
win_rds_rap:
name: My RAP
description: 'Allow all users to connect to any resource through ports 3389 and 3390'
description: Allow all users to connect to any resource through ports 3389 and 3390
user_groups:
- BUILTIN\users
computer_group_type: allow_any

View file

@ -21,18 +21,21 @@ options:
certificate_hash:
description:
- Certificate hash (thumbprint) for the Remote Desktop Gateway server. The certificate hash is the unique identifier for the certificate.
type: str
max_connections:
description:
- The maximum number of connections allowed.
- If set to C(0), no new connections are allowed.
- If set to C(-1), the number of connections is unlimited.
type: int
ssl_bridging:
description:
- Specifies whether to use SSL Bridging.
- 'C(none): no SSL bridging.'
- 'C(https_http): HTTPS-HTTP bridging.'
- 'C(https_https): HTTPS-HTTPS bridging.'
choices: [ none, https_http, https_https ]
type: str
choices: [ https_http, https_https, none ]
enable_only_messaging_capable_clients:
description:
- If enabled, only clients that support logon messages and administrator messages can connect.
@ -40,6 +43,10 @@ options:
requirements:
- Windows Server 2008R2 (6.1) or higher.
- The Windows Feature "RDS-Gateway" must be enabled.
seealso:
- module: win_rds_cap
- module: win_rds_rap
- module: win_rds_settings
'''
EXAMPLES = r'''