Class InstanceOSPoliciesCompliance (1.12.2)

Stay organized with collections Save and categorize content based on your preferences.
InstanceOSPoliciesCompliance(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

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 <https://cloud.google.com/compute/docs/os-configuration-management/view-compliance>__.

Attributes

NameDescription
name str
Output only. The ``InstanceOSPoliciesCompliance`` API resource name. Format: ``projects/{project_number}/locations/{location}/instanceOSPoliciesCompliances/{instance_id}``
instance str
Output only. The Compute Engine VM instance name.
state google.cloud.osconfig_v1alpha.types.OSPolicyComplianceState
Output only. Compliance state of the VM.
detailed_state str
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.
detailed_state_reason str
Output only. The reason for the ``detailed_state`` of the VM (if any).
os_policy_compliances Sequence[google.cloud.osconfig_v1alpha.types.InstanceOSPoliciesCompliance.OSPolicyCompliance]
Output only. Compliance data for each ``OSPolicy`` that is applied to the VM.
last_compliance_check_time google.protobuf.timestamp_pb2.Timestamp
Output only. Timestamp of the last compliance check for the VM.
last_compliance_run_id str
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.

Inheritance

builtins.object > proto.message.Message > InstanceOSPoliciesCompliance

Classes

OSPolicyCompliance

OSPolicyCompliance(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Compliance data for an OS policy