Class OSPolicy.Types.Resource.Types.ExecResource

public sealed class ExecResource : IMessage<OSPolicy.Types.Resource.Types.ExecResource>, IEquatable<OSPolicy.Types.Resource.Types.ExecResource>, IDeepCloneable<OSPolicy.Types.Resource.Types.ExecResource>, IBufferMessage, IMessage

A resource that allows executing scripts on the VM.

The ExecResource has 2 stages: validate and enforce and both stages accept a script as an argument to execute.

When the ExecResource is applied by the agent, it first executes the script in the validate stage. The validate stage can signal that the ExecResource is already in the desired state by returning an exit code of 100. If the ExecResource is not in the desired state, it should return an exit code of 101. Any other exit code returned by this stage is considered an error.

If the ExecResource is not in the desired state based on the exit code from the validate stage, the agent proceeds to execute the script from the enforce stage. If the ExecResource is already in the desired state, the enforce stage will not be run. Similar to validate stage, the enforce stage should return an exit code of 100 to indicate that the resource in now in its desired state. Any other exit code is considered an error.

NOTE: An exit code of 100 was chosen over 0 (and 101 vs 1) to have an explicit indicator of in desired state, not in desired state and errors. Because, for example, Powershell will always return an exit code of 0 unless an exit statement is provided in the script. So, for reasons of consistency and being explicit, exit codes 100 and 101 were chosen.

Inheritance

Object > OSPolicy.Types.Resource.Types.ExecResource

Namespace

Google.Cloud.OsConfig.V1

Assembly

Google.Cloud.OsConfig.V1.dll

Constructors

ExecResource()

public ExecResource()

ExecResource(OSPolicy.Types.Resource.Types.ExecResource)

public ExecResource(OSPolicy.Types.Resource.Types.ExecResource other)
Parameter
NameDescription
otherOSPolicy.Types.Resource.Types.ExecResource

Properties

Enforce

public OSPolicy.Types.Resource.Types.ExecResource.Types.Exec Enforce { get; set; }

What to run to bring this resource into the desired state. An exit code of 100 indicates "success", any other exit code indicates a failure running enforce.

Property Value
TypeDescription
OSPolicy.Types.Resource.Types.ExecResource.Types.Exec

Validate

public OSPolicy.Types.Resource.Types.ExecResource.Types.Exec Validate { get; set; }

Required. What to run to validate this resource is in the desired state. An exit code of 100 indicates "in desired state", and exit code of 101 indicates "not in desired state". Any other exit code indicates a failure running validate.

Property Value
TypeDescription
OSPolicy.Types.Resource.Types.ExecResource.Types.Exec