Class InstanceOSPoliciesCompliance

public sealed class InstanceOSPoliciesCompliance : IMessage<InstanceOSPoliciesCompliance>, IEquatable<InstanceOSPoliciesCompliance>, IDeepCloneable<InstanceOSPoliciesCompliance>, IBufferMessage, IMessage

This API resource represents the OS policies compliance data for a Compute Engine virtual machine (VM) instance at a given point in time.

A Compute Engine VM can have multiple OS policy assignments, and each assignment can have multiple OS policies. As a result, multiple OS policies could be applied to a single VM.

You can use this API resource to determine both the compliance state of your VM as well as the compliance state of an individual OS policy.

For more information, see View compliance.

Inheritance

Object > InstanceOSPoliciesCompliance

Namespace

Google.Cloud.OsConfig.V1Alpha

Assembly

Google.Cloud.OsConfig.V1Alpha.dll

Constructors

InstanceOSPoliciesCompliance()

public InstanceOSPoliciesCompliance()

InstanceOSPoliciesCompliance(InstanceOSPoliciesCompliance)

public InstanceOSPoliciesCompliance(InstanceOSPoliciesCompliance other)
Parameter
TypeNameDescription
InstanceOSPoliciesComplianceother

Properties

DetailedState

public string DetailedState { get; set; }

Output only. Detailed compliance state of the VM. This field is populated only when compliance state is UNKNOWN.

It may contain one of the following values:

  • no-compliance-data: Compliance data is not available for this VM.
  • no-agent-detected: OS Config agent is not detected for this VM.
  • config-not-supported-by-agent: The version of the OS Config agent running on this VM does not support configuration management.
  • inactive: VM is not running.
  • internal-service-errors: There were internal service errors encountered while enforcing compliance.
  • agent-errors: OS config agent encountered errors while enforcing compliance.
Property Value
TypeDescription
String

DetailedStateReason

public string DetailedStateReason { get; set; }

Output only. The reason for the detailed_state of the VM (if any).

Property Value
TypeDescription
String

Instance

public string Instance { get; set; }

Output only. The Compute Engine VM instance name.

Property Value
TypeDescription
String

InstanceOSPoliciesComplianceName

public InstanceOSPoliciesComplianceName InstanceOSPoliciesComplianceName { get; set; }

InstanceOSPoliciesComplianceName-typed view over the Name resource name property.

Property Value
TypeDescription
InstanceOSPoliciesComplianceName

LastComplianceCheckTime

public Timestamp LastComplianceCheckTime { get; set; }

Output only. Timestamp of the last compliance check for the VM.

Property Value
TypeDescription
Timestamp

LastComplianceRunId

public string LastComplianceRunId { get; set; }

Output only. Unique identifier for the last compliance run. This id will be logged by the OS config agent during a compliance run and can be used for debugging and tracing purpose.

Property Value
TypeDescription
String

Name

public string Name { get; set; }

Output only. The InstanceOSPoliciesCompliance API resource name.

Format: projects/{project_number}/locations/{location}/instanceOSPoliciesCompliances/{instance_id}

Property Value
TypeDescription
String

OsPolicyCompliances

public RepeatedField<InstanceOSPoliciesCompliance.Types.OSPolicyCompliance> OsPolicyCompliances { get; }

Output only. Compliance data for each OSPolicy that is applied to the VM.

Property Value
TypeDescription
RepeatedField<InstanceOSPoliciesCompliance.Types.OSPolicyCompliance>

State

public OSPolicyComplianceState State { get; set; }

Output only. Compliance state of the VM.

Property Value
TypeDescription
OSPolicyComplianceState