Skip to content

Latest commit

 

History

History
228 lines (124 loc) · 6.39 KB

REFERENCE.md

File metadata and controls

228 lines (124 loc) · 6.39 KB

Reference

Table of Contents

Defined types

Resource types

Data types

Defined types

puppet_authorization

Define type to manage the puppetserver authorization

Parameters

The following parameters are available in the puppet_authorization defined type:

version

Data type: Integer

The version of the authorization

Default value: 1

allow_header_cert_info

Data type: Boolean

Whether to allow header cert info

Default value: false

replace

Data type: Boolean

Whether to replace the file

Default value: false

path

Data type: Stdlib::Absolutepath

The path to the auth.conf file

Default value: $name

puppet_authorization::rule

manage a puppetserver authorization rule

Parameters

The following parameters are available in the puppet_authorization::rule defined type:

path

Data type: Stdlib::Absolutepath

The path to the auth.conf file

ensure

Data type: Enum['present', 'absent']

State of rule

Default value: 'present'

rule_name

Data type: String

An arbitrary name used to identity the rule

Default value: $name

allow

Data type: Variant[Array[Variant[String, Hash]], String, Hash, Undef]

Value(s) to permit an authenticated request

Default value: undef

allow_unauthenticated

Data type: Boolean

Puppet Server will always permit the request (potentially insecure) when set to true. If true, the rule cannot use the allow or deny parameters.

Default value: false

deny

Data type: Variant[Array[Variant[String, Hash]], String, Hash, Undef]

Value(s) to deny an authenticated request, even if an allow is also matched.

Default value: undef

match_request_method

Data type: Variant[Array[Puppet_authorization::Httpmethod], Puppet_authorization::Httpmethod, Undef]

Limit rule to match specific HTTP request method(s).

Default value: undef

match_request_query_params

Data type: Hash

Limit rule to matching query parameters with specific value(s). An Array of values can be provided to match a request with any of the values.

Default value: {}

sort_order

Data type: Integer

Rule processing priority, 1 to 399 are evaluated before default Puppet rules, or 601 to 998 are be evaluated after Puppet. Lower-numbered values evaluated first, and secondarily sorts lexicographically by the name string value's Unicode code points.

Default value: 200

match_request_path

Data type: Optional[String]

Match request when the endpoint URL starts with or contains the parameter value.

Default value: undef

match_request_type

Data type: Optional[Enum['path', 'regex']]

How Puppet Server will interpret the match_request_path parameter value.

Default value: undef

Resource types

puppet_authorization_hocon_rule

Manage the state of this type.

Properties

The following properties are available in the puppet_authorization_hocon_rule type.

ensure

Valid values: present, absent

Manage the state of this type.

Default value: present

value

The value of the setting to be defined.

Parameters

The following parameters are available in the puppet_authorization_hocon_rule type.

name

namevar

An arbitrary name used as the identity of the resource.

path

The file Puppet will ensure contains the specified setting.

provider

The specific backend to use for this puppet_authorization_hocon_rule resource. You will seldom need to specify this --- Puppet will usually discover the appropriate provider for your platform.

Data types

Puppet_authorization::Httpmethod

Type for validating supported HTTP methods

Alias of Enum['put', 'post', 'get', 'head', 'delete']