Skip to content

Commit d3355dc

Browse files
hbollonhbollon
committed
docs: regenerate provider documentation
1 parent 1de8447 commit d3355dc

29 files changed

+788
-46
lines changed

‎docs/index.md

Lines changed: 3 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,17 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
3-
page_title: "FreeIPA Provider"
3+
page_title: "freeipa Provider"
44
subcategory: ""
55
description: |-
6-
This provider manages FreeIPA resources.
6+
77
---
88

9-
# FreeIPA provider
9+
# freeipa Provider
1010

11-
This provider manages FreeIPA resources.
1211

13-
## Example usage
1412

1513

1614

17-
```hcl
18-
required_providers {
19-
freeipa = {
20-
source = "camptocamp/freeipa"
21-
version = ">= 0.9.0"
22-
}
23-
}
24-
25-
provider "freeipa" {
26-
host = "ipa.example.test" # or set $FREEIPA_HOST
27-
username = "admin" # or set $FREEIPA_USERNAME
28-
password = "P@S5sw0rd" # or set $FREEIPA_PASSWORD
29-
}
30-
```
31-
3215
<!-- schema generated by tfplugindocs -->
3316
## Schema
3417

‎docs/resources/automemberadd.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "freeipa_automemberadd Resource - freeipa"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# freeipa_automemberadd (Resource)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `name` (String)
21+
- `type` (String)
22+
23+
### Optional
24+
25+
- `addattr` (List of String)
26+
- `description` (String)
27+
- `setattr` (List of String)
28+
29+
### Read-Only
30+
31+
- `id` (String) The ID of this resource.

‎docs/resources/automemberadd_condition.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "freeipa_automemberadd_condition Resource - freeipa"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# freeipa_automemberadd_condition (Resource)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `key` (String)
21+
- `name` (String)
22+
- `type` (String)
23+
24+
### Optional
25+
26+
- `description` (String)
27+
- `exclusiveregex` (List of String)
28+
- `inclusiveregex` (List of String)
29+
30+
### Read-Only
31+
32+
- `id` (String) The ID of this resource.

‎docs/resources/certificate.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "freeipa_certificate Resource - freeipa"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# freeipa_certificate (Resource)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `csr` (String)
21+
- `principal` (String) Principal for this certificate (e.g. HTTP/test.example.com)
22+
23+
### Read-Only
24+
25+
- `serial_number` (String)

‎docs/resources/dns_record.md

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,15 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
3-
page_title: "freeipa_dns_record Resource - terraform-provider-freeipa"
3+
page_title: "freeipa_dns_record Resource - freeipa"
44
subcategory: ""
55
description: |-
6-
6+
77
---
88

99
# freeipa_dns_record (Resource)
1010

1111

12-
## Example Usage
1312

14-
```hcl
15-
resource "freeipa_dns_record" "foo_example_test" {
16-
dnszoneidnsname = "example.test"
17-
idnsname = "foo"
18-
records = "1.2.3.4"
19-
dnsttl = 60
20-
type = "A"
21-
}
22-
```
2313

2414

2515
<!-- schema generated by tfplugindocs -->

‎docs/resources/dns_zone.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "freeipa_dns_zone Resource - freeipa"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# freeipa_dns_zone (Resource)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `zone_name` (String) Zone name (FQDN)
21+
22+
### Optional
23+
24+
- `admin_email_address` (String) Administrator e-mail address
25+
- `allow_inline_dnssec_signing` (Boolean) Allow inline DNSSEC signing of records in the zone
26+
- `allow_prt_sync` (Boolean) Allow synchronization of forward (A, AAAA) and reverse (PTR) records in the zone
27+
- `allow_query` (String) Semicolon separated list of IP addresses or networks which are allowed to issue queries
28+
- `allow_transfer` (String) Semicolon separated list of IP addresses or networks which are allowed to transfer the zone
29+
- `authoritative_nameserver` (String) Authoritative nameserver domain name
30+
- `bind_update_policy` (String) BIND update policy
31+
- `default_ttl` (Number) Time to live for records without explicit TTL definition
32+
- `disable_zone` (Boolean) Allow disabled the zone
33+
- `dynamic_updates` (Boolean) Allow dynamic updates
34+
- `is_reverse_zone` (Boolean) Allow create the reverse zone
35+
- `nsec3param_record` (String) NSEC3PARAM record for zone in format: hash_algorithm flags iterations salt
36+
- `skip_nameserver_check` (Boolean) Force DNS zone creation even if nameserver is not resolvable
37+
- `skip_overlap_check` (Boolean) Force DNS zone creation even if it will overlap with an existing zone
38+
- `soa_expire` (Number) SOA record expire time
39+
- `soa_minimum` (Number) How long should negative responses be cached
40+
- `soa_refresh` (Number) SOA record refresh time
41+
- `soa_retry` (Number) SOA record retry time
42+
- `soa_serial_number` (Number) SOA record serial number
43+
- `ttl` (Number) Time to live for records at zone apex
44+
- `zone_forwarders` (List of String) Per-zone forwarders. A custom port can be specified for each forwarder using a standard format IP_ADDRESS port PORT
45+
46+
### Read-Only
47+
48+
- `id` (String) The ID of this resource.

‎docs/resources/group.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "freeipa_group Resource - freeipa"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# freeipa_group (Resource)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `cn` (String)
21+
22+
### Optional
23+
24+
- `description` (String)
25+
- `external` (Boolean) Allow adding external non-IPA members from trusted domains
26+
- `gidnumber` (Number)
27+
- `nonposix` (Boolean) Create as a non-POSIX group

‎docs/resources/hbac_policy.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "freeipa_hbac_policy Resource - freeipa"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# freeipa_hbac_policy (Resource)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `name` (String) HBAC policy name
21+
22+
### Optional
23+
24+
- `description` (String) HBAC policy description
25+
- `enabled` (Boolean) Enable this policy (Defaults to `true`)
26+
- `hostcategory` (String) Host category the policy is applied to (allowed value: `all`)
27+
- `servicecategory` (String) Service category the policy is applied to (allowed value: `all`)
28+
- `usercategory` (String) User category the policy is applied to (allowed value: `all`)
29+
30+
### Read-Only
31+
32+
- `id` (String) The ID of this resource.

‎docs/resources/hbac_policy_host_membership.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "freeipa_hbac_policy_host_membership Resource - freeipa"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# freeipa_hbac_policy_host_membership (Resource)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `name` (String) HBAC policy name
21+
22+
### Optional
23+
24+
- `host` (String) Host FDQN the policy is applied to
25+
- `hostgroup` (String) Hostgroup the policy is applied to
26+
27+
### Read-Only
28+
29+
- `id` (String) The ID of this resource.

‎docs/resources/hbac_policy_service_membership.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "freeipa_hbac_policy_service_membership Resource - freeipa"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# freeipa_hbac_policy_service_membership (Resource)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `name` (String) HBAC policy name
21+
22+
### Optional
23+
24+
- `service` (String) Service name the policy is applied to
25+
- `servicegroup` (String) Service group name the policy is applied to
26+
27+
### Read-Only
28+
29+
- `id` (String) The ID of this resource.

‎docs/resources/hbac_policy_user_membership.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "freeipa_hbac_policy_user_membership Resource - freeipa"
4+
subcategory: ""
5+
description: |-
6+
7+
---
8+
9+
# freeipa_hbac_policy_user_membership (Resource)
10+
11+
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `name` (String) HBAC policy name
21+
22+
### Optional
23+
24+
- `group` (String) Group the policy is applied to
25+
- `user` (String) User FDQN the policy is applied to
26+
27+
### Read-Only
28+
29+
- `id` (String) The ID of this resource.

‎docs/resources/host.md

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,15 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
3-
page_title: "freeipa_host Resource - terraform-provider-freeipa"
3+
page_title: "freeipa_host Resource - freeipa"
44
subcategory: ""
55
description: |-
6-
6+
77
---
88

99
# freeipa_host (Resource)
1010

1111

12-
## Example Usage
1312

14-
```hcl
15-
resource "freeipa_host" "foo_example_test" {
16-
fqdn = "foo.example.test"
17-
description = "Managed by terraform"
18-
managedby_hosts = [
19-
"foo-1.example.test",
20-
"foo-2.example.test",
21-
"foo-3.example.test",
22-
]
23-
}
24-
```
2513

2614

2715
<!-- schema generated by tfplugindocs -->

0 commit comments

Comments
 (0)