Skip to content

Commit 2d92ddd

Browse files
author
David Kraushuber
committed
docs update
1 parent b478c3e commit 2d92ddd

File tree

13 files changed

+216
-6
lines changed

13 files changed

+216
-6
lines changed
Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "simplemdm_customdeclaration Data Source - simplemdm"
4+
subcategory: ""
5+
description: |-
6+
Custom Declaration data source can be used together with Device(s) or Device Group(s) to set values or in lifecycle management.
7+
---
8+
9+
# simplemdm_customdeclaration (Data Source)
10+
11+
Custom Declaration data source can be used together with Device(s) or Device Group(s) to set values or in lifecycle management.
12+
13+
14+
15+
<!-- schema generated by tfplugindocs -->
16+
## Schema
17+
18+
### Required
19+
20+
- `id` (String) ID of the custom Declaration.
21+
22+
### Read-Only
23+
24+
- `name` (String) Default (global) value of the Attribute.

docs/index.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
33
page_title: "simplemdm Provider"
4-
subcategory: ""
54
description: |-
65
SimpleMDM terraform provider developed by FreeNow.
76
---

docs/resources/app.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,13 @@ resource "simplemdm_app" "app" {
1919
}
2020
```
2121

22+
```terraform
23+
resource "simplemdm_app" "app" {
24+
bundle_id = "com.myCompany.MyApp1"
25+
deploy_to = "all" // Default to "none" if not added but possible values are "outdated" and "all"
26+
}
27+
```
28+
2229
<!-- schema generated by tfplugindocs -->
2330
## Schema
2431

@@ -37,6 +44,8 @@ resource "simplemdm_app" "app" {
3744

3845
Import is supported using the following syntax:
3946

47+
The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
48+
4049
```shell
4150
# App can be imported by specifying the app ID.
4251
terraform import simplemdm_app.example 123456

docs/resources/assignmentgroup.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ resource "simplemdm_assignmentgroup" "myfirstgroup" {
5959

6060
Import is supported using the following syntax:
6161

62+
The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
63+
6264
```shell
6365
# Assignment group can be imported by specifying the Assigntment group ID.
6466
terraform import simplemdm_assigntmentgroup.example 123456

docs/resources/attribute.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ resource "simplemdm_attribute" "myattribute" {
3838

3939
Import is supported using the following syntax:
4040

41+
The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
42+
4143
```shell
4244
# Attribute can be imported by specifying the name of attribute.
4345
terraform import simplemdm_attribute.example myattributename
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
# generated by https://github.com/hashicorp/terraform-plugin-docs
3+
page_title: "simplemdm_customdeclaration Resource - simplemdm"
4+
subcategory: ""
5+
description: |-
6+
Custom Declaration resource can be used to manage Custom Declaration. Can be used together with Device(s) and Group(s) and set addition details regarding Custom Declaration.
7+
---
8+
9+
# simplemdm_customdeclaration (Resource)
10+
11+
Custom Declaration resource can be used to manage Custom Declaration. Can be used together with Device(s) and Group(s) and set addition details regarding Custom Declaration.
12+
13+
## Example Usage
14+
15+
```terraform
16+
resource "simplemdm_customdeclaration" "test" {
17+
name = "testdeclaration"
18+
declaration = jsonencode(jsondecode(file("./testfiles/testdeclaration.json")))
19+
userscope = true
20+
attributesupport = true
21+
escapeattributes = true
22+
declaration_type = "com.apple.configuration.safari.bookmarks"
23+
activation_predicate = ""
24+
}
25+
```
26+
27+
<!-- schema generated by tfplugindocs -->
28+
## Schema
29+
30+
### Required
31+
32+
- `declaration` (String) Required. Can be string or you can use function 'file' or 'templatefile' to load string from file (see examples folder). Example: declaration = file("./declarations/declaration.json") or declaration = <<-EOT DECLARATION STRING EOT
33+
- `declaration_type` (String) Required. The type of declaration being defined
34+
- `name` (String) Required. A name for the declaration. Example: "My First declaration by terraform"
35+
36+
### Optional
37+
38+
- `activation_predicate` (String) Optional. A predicate format string as Apple's Predicate Programming describes. The activation only installs when the predicate evaluates to true or if it is left blank.
39+
- `attributesupport` (Boolean) Optional. A boolean true or false. When enabled, SimpleMDM will process variables in the uploaded declaration. Defaults to false
40+
- `escapeattributes` (Boolean) Optional. A boolean true or false. When enabled, SimpleMDM escape the values of the custom variables in the uploaded declaration. Defaults to false
41+
- `userscope` (Boolean) Optional. A boolean true or false. If false, deploy as a device declaration instead of a user declaration for macOS devices. Defaults to true.
42+
43+
### Read-Only
44+
45+
- `id` (String) ID of a Custom Declaration in SimpleMDM

docs/resources/customprofile.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,37 @@ resource "simplemdm_customprofile" "myprofile" {
2323
}
2424
```
2525

26+
```terraform
27+
resource "simplemdm_customprofile" "myprofile" {
28+
name = "My First profiles"
29+
mobileconfig = templatefile("./profiles/profile.mobileconfig", { foo = "bar" })
30+
userscope = true
31+
attributesupport = true
32+
escapeattributes = true
33+
reinstallafterosupdate = false
34+
}
35+
```
36+
37+
```terraform
38+
resource "simplemdm_customprofile" "myprofile" {
39+
name = "My First profiles"
40+
mobileconfig = <<-EOT
41+
<?xml version="1.0" encoding="UTF-8"?>
42+
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
43+
<plist version="1.0">
44+
<dict>
45+
<key>PayloadIdentifier</key>
46+
.....redacted....
47+
</dict>
48+
</plist>
49+
EOT
50+
userscope = true
51+
attributesupport = true
52+
escapeattributes = true
53+
reinstallafterosupdate = false
54+
}
55+
```
56+
2657
<!-- schema generated by tfplugindocs -->
2758
## Schema
2859

@@ -46,6 +77,8 @@ resource "simplemdm_customprofile" "myprofile" {
4677

4778
Import is supported using the following syntax:
4879

80+
The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
81+
4982
```shell
5083
# Custom profile can be imported by specifying the custom profile ID.
5184
terraform import simplemdm_customprofile.example 123456

docs/resources/device.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ resource "simplemdm_device" "firstdevice" {
5050

5151
Import is supported using the following syntax:
5252

53+
The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
54+
5355
```shell
5456
# Device can be imported by specifying the device ID.
5557
terraform import simplemdm_device.example 123456

docs/resources/devicegroup.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,8 @@ resource "simplemdm_devicegroup" "testgroup" {
4444

4545
Import is supported using the following syntax:
4646

47+
The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
48+
4749
```shell
4850
# devicegroup can be imported by specifying the numeric identifier.
4951
terraform import simplemdm_devicegroup.example 123456

docs/resources/script.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,8 @@ resource "simplemdm_script" "test" {
4545

4646
Import is supported using the following syntax:
4747

48+
The [`terraform import` command](https://developer.hashicorp.com/terraform/cli/commands/import) can be used, for example:
49+
4850
```shell
4951
# devicegroup can be imported by specifying the numeric identifier.
5052
terraform import simplemdm_script.example 123456

0 commit comments

Comments
 (0)