Documentation
¶
Overview ¶
Package script implements the jamfplatform_pro_script resource, data source, and list resource backed by the Jamf Pro scripts API.
Index ¶
- Variables
- func NewScriptDataSource() datasource.DataSource
- func NewScriptListResource() list.ListResource
- func NewScriptResource() resource.Resource
- func NewScriptsDataSource() datasource.DataSource
- type ScriptDataSource
- func (d *ScriptDataSource) Configure(ctx context.Context, req datasource.ConfigureRequest, ...)
- func (d *ScriptDataSource) Metadata(ctx context.Context, req datasource.MetadataRequest, ...)
- func (d *ScriptDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse)
- func (d *ScriptDataSource) Schema(ctx context.Context, req datasource.SchemaRequest, ...)
- type ScriptDataSourceModel
- type ScriptListResource
- func (r *ScriptListResource) Configure(ctx context.Context, req resource.ConfigureRequest, ...)
- func (r *ScriptListResource) List(ctx context.Context, req list.ListRequest, stream *list.ListResultsStream)
- func (r *ScriptListResource) ListResourceConfigSchema(ctx context.Context, req list.ListResourceSchemaRequest, ...)
- func (r *ScriptListResource) Metadata(ctx context.Context, req resource.MetadataRequest, ...)
- type ScriptListResourceModel
- type ScriptResource
- func (r *ScriptResource) Configure(ctx context.Context, req resource.ConfigureRequest, ...)
- func (r *ScriptResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)
- func (r *ScriptResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)
- func (r *ScriptResource) IdentitySchema(ctx context.Context, req resource.IdentitySchemaRequest, ...)
- func (r *ScriptResource) ImportState(ctx context.Context, req resource.ImportStateRequest, ...)
- func (r *ScriptResource) Metadata(ctx context.Context, req resource.MetadataRequest, ...)
- func (r *ScriptResource) ModifyPlan(ctx context.Context, req resource.ModifyPlanRequest, ...)
- func (r *ScriptResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)
- func (r *ScriptResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse)
- func (r *ScriptResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse)
- type ScriptResourceModel
- type ScriptsDataSource
- func (d *ScriptsDataSource) Configure(ctx context.Context, req datasource.ConfigureRequest, ...)
- func (d *ScriptsDataSource) Metadata(ctx context.Context, req datasource.MetadataRequest, ...)
- func (d *ScriptsDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse)
- func (d *ScriptsDataSource) Schema(ctx context.Context, req datasource.SchemaRequest, ...)
- type ScriptsDataSourceModel
- type ScriptsDataSourceResultModel
Constants ¶
This section is empty.
Variables ¶
var ScriptFilterSelectors = []string{
"id",
"name",
"info",
"notes",
"priority",
"categoryId",
"categoryName",
"parameter4",
"parameter5",
"parameter6",
"parameter7",
"parameter8",
"parameter9",
"parameter10",
"parameter11",
"osRequirements",
"scriptContents",
}
ScriptFilterSelectors enumerates the RSQL selectors accepted by the scripts endpoint.
Functions ¶
func NewScriptDataSource ¶
func NewScriptDataSource() datasource.DataSource
NewScriptDataSource returns a new instance of ScriptDataSource.
func NewScriptListResource ¶
func NewScriptListResource() list.ListResource
NewScriptListResource returns a list resource for Jamf Pro script queries.
func NewScriptResource ¶
NewScriptResource returns a new instance of ScriptResource.
func NewScriptsDataSource ¶
func NewScriptsDataSource() datasource.DataSource
NewScriptsDataSource returns a new instance of ScriptsDataSource.
Types ¶
type ScriptDataSource ¶
type ScriptDataSource struct {
// contains filtered or unexported fields
}
ScriptDataSource implements the Terraform data source for Jamf Pro scripts.
func (*ScriptDataSource) Configure ¶
func (d *ScriptDataSource) Configure(ctx context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse)
Configure wires the Jamf Pro client into the data source via the shared providerdata.ConfigurePro helper.
func (*ScriptDataSource) Metadata ¶
func (d *ScriptDataSource) Metadata(ctx context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse)
Metadata sets the data source type name for the Terraform provider.
func (*ScriptDataSource) Read ¶
func (d *ScriptDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse)
Read fetches a script by ID and populates Terraform state.
func (*ScriptDataSource) Schema ¶
func (d *ScriptDataSource) Schema(ctx context.Context, req datasource.SchemaRequest, resp *datasource.SchemaResponse)
Schema returns the data source schema.
type ScriptDataSourceModel ¶
type ScriptDataSourceModel struct {
ID types.String `tfsdk:"id"`
Name types.String `tfsdk:"name"`
CategoryID types.String `tfsdk:"category_id"`
CategoryName types.String `tfsdk:"category_name"`
Info types.String `tfsdk:"info"`
Notes types.String `tfsdk:"notes"`
OsRequirements types.String `tfsdk:"os_requirements"`
Priority types.String `tfsdk:"priority"`
Parameter4 types.String `tfsdk:"parameter_4"`
Parameter5 types.String `tfsdk:"parameter_5"`
Parameter6 types.String `tfsdk:"parameter_6"`
Parameter7 types.String `tfsdk:"parameter_7"`
Parameter8 types.String `tfsdk:"parameter_8"`
Parameter9 types.String `tfsdk:"parameter_9"`
Parameter10 types.String `tfsdk:"parameter_10"`
Parameter11 types.String `tfsdk:"parameter_11"`
ScriptContents types.String `tfsdk:"script_contents"`
Timeouts datasourceTimeouts.Value `tfsdk:"timeouts"`
}
ScriptDataSourceModel represents the Terraform data source model for a Jamf Pro script.
type ScriptListResource ¶
type ScriptListResource struct {
// contains filtered or unexported fields
}
ScriptListResource implements Terraform query list support for Jamf Pro scripts.
func (*ScriptListResource) Configure ¶
func (r *ScriptListResource) Configure(ctx context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)
Configure wires the Jamf Pro client into the list resource via the shared providerdata.ConfigurePro helper.
func (*ScriptListResource) List ¶
func (r *ScriptListResource) List(ctx context.Context, req list.ListRequest, stream *list.ListResultsStream)
List executes the query and streams script identities back to Terraform.
func (*ScriptListResource) ListResourceConfigSchema ¶
func (r *ScriptListResource) ListResourceConfigSchema(ctx context.Context, req list.ListResourceSchemaRequest, resp *list.ListResourceSchemaResponse)
ListResourceConfigSchema describes the supported list filters.
func (*ScriptListResource) Metadata ¶
func (r *ScriptListResource) Metadata(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)
Metadata sets the list resource type name.
type ScriptListResourceModel ¶
type ScriptListResourceModel struct {
Filters []filters.FilterModel `tfsdk:"filter"`
Timeouts listtimeouts.Value `tfsdk:"timeouts"`
}
ScriptListResourceModel represents the config model for script list queries.
type ScriptResource ¶
type ScriptResource struct {
// contains filtered or unexported fields
}
ScriptResource implements the Terraform resource for Jamf Pro scripts.
func (*ScriptResource) Configure ¶
func (r *ScriptResource) Configure(ctx context.Context, req resource.ConfigureRequest, resp *resource.ConfigureResponse)
Configure wires the Jamf Pro client into the resource via the shared providerdata.ConfigurePro helper.
func (*ScriptResource) Create ¶
func (r *ScriptResource) Create(ctx context.Context, req resource.CreateRequest, resp *resource.CreateResponse)
Create creates a new Jamf Pro script.
func (*ScriptResource) Delete ¶
func (r *ScriptResource) Delete(ctx context.Context, req resource.DeleteRequest, resp *resource.DeleteResponse)
Delete removes a Jamf Pro script.
func (*ScriptResource) IdentitySchema ¶
func (r *ScriptResource) IdentitySchema(ctx context.Context, req resource.IdentitySchemaRequest, resp *resource.IdentitySchemaResponse)
IdentitySchema defines the identifier used for import and list results.
func (*ScriptResource) ImportState ¶
func (r *ScriptResource) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse)
ImportState handles import by the Jamf Pro script ID.
func (*ScriptResource) Metadata ¶
func (r *ScriptResource) Metadata(ctx context.Context, req resource.MetadataRequest, resp *resource.MetadataResponse)
Metadata sets the resource type name for the Terraform provider.
func (*ScriptResource) ModifyPlan ¶
func (r *ScriptResource) ModifyPlan(ctx context.Context, req resource.ModifyPlanRequest, resp *resource.ModifyPlanResponse)
ModifyPlan reports a script name another script already holds, then how many computers this script reaches through the policies using it.
func (*ScriptResource) Read ¶
func (r *ScriptResource) Read(ctx context.Context, req resource.ReadRequest, resp *resource.ReadResponse)
Read refreshes the Terraform state with the latest script representation.
func (*ScriptResource) Schema ¶
func (r *ScriptResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse)
Schema returns the Terraform schema for the script resource.
func (*ScriptResource) Update ¶
func (r *ScriptResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse)
Update updates a Jamf Pro script.
type ScriptResourceModel ¶
type ScriptResourceModel struct {
ID types.String `tfsdk:"id"`
Name types.String `tfsdk:"name"`
CategoryID types.String `tfsdk:"category_id"`
CategoryName types.String `tfsdk:"category_name"`
Info types.String `tfsdk:"info"`
Notes types.String `tfsdk:"notes"`
OsRequirements types.String `tfsdk:"os_requirements"`
Priority types.String `tfsdk:"priority"`
Parameter4 types.String `tfsdk:"parameter_4"`
Parameter5 types.String `tfsdk:"parameter_5"`
Parameter6 types.String `tfsdk:"parameter_6"`
Parameter7 types.String `tfsdk:"parameter_7"`
Parameter8 types.String `tfsdk:"parameter_8"`
Parameter9 types.String `tfsdk:"parameter_9"`
Parameter10 types.String `tfsdk:"parameter_10"`
Parameter11 types.String `tfsdk:"parameter_11"`
ScriptContents types.String `tfsdk:"script_contents"`
Timeouts resourceTimeouts.Value `tfsdk:"timeouts"`
}
ScriptResourceModel represents the Terraform resource model for a Jamf Pro script.
type ScriptsDataSource ¶
type ScriptsDataSource struct {
// contains filtered or unexported fields
}
ScriptsDataSource implements the Terraform data source for Jamf Pro script searches.
func (*ScriptsDataSource) Configure ¶
func (d *ScriptsDataSource) Configure(ctx context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse)
Configure wires the Jamf Pro client into the data source via the shared providerdata.ConfigurePro helper.
func (*ScriptsDataSource) Metadata ¶
func (d *ScriptsDataSource) Metadata(ctx context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse)
Metadata sets the data source type name for the Terraform provider.
func (*ScriptsDataSource) Read ¶
func (d *ScriptsDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse)
Read fetches scripts matching the supplied filters and populates state.
func (*ScriptsDataSource) Schema ¶
func (d *ScriptsDataSource) Schema(ctx context.Context, req datasource.SchemaRequest, resp *datasource.SchemaResponse)
Schema returns the plural data source schema.
type ScriptsDataSourceModel ¶
type ScriptsDataSourceModel struct {
ID types.String `tfsdk:"id"`
Scripts []ScriptsDataSourceResultModel `tfsdk:"scripts"`
Filters []filters.FilterModel `tfsdk:"filter"`
Timeouts datasourceTimeouts.Value `tfsdk:"timeouts"`
}
ScriptsDataSourceModel represents the Terraform data source model for script searches.
type ScriptsDataSourceResultModel ¶
type ScriptsDataSourceResultModel struct {
ID types.String `tfsdk:"id"`
Name types.String `tfsdk:"name"`
CategoryID types.String `tfsdk:"category_id"`
CategoryName types.String `tfsdk:"category_name"`
Info types.String `tfsdk:"info"`
Notes types.String `tfsdk:"notes"`
OsRequirements types.String `tfsdk:"os_requirements"`
Priority types.String `tfsdk:"priority"`
Parameter4 types.String `tfsdk:"parameter_4"`
Parameter5 types.String `tfsdk:"parameter_5"`
Parameter6 types.String `tfsdk:"parameter_6"`
Parameter7 types.String `tfsdk:"parameter_7"`
Parameter8 types.String `tfsdk:"parameter_8"`
Parameter9 types.String `tfsdk:"parameter_9"`
Parameter10 types.String `tfsdk:"parameter_10"`
Parameter11 types.String `tfsdk:"parameter_11"`
ScriptContents types.String `tfsdk:"script_contents"`
}
ScriptsDataSourceResultModel represents a single script in the search results.