| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="osconfig_v1alpha.html">OS Config API</a> . <a href="osconfig_v1alpha.projects.html">projects</a> . <a href="osconfig_v1alpha.projects.locations.html">locations</a> . <a href="osconfig_v1alpha.projects.locations.instanceOSPoliciesCompliances.html">instanceOSPoliciesCompliances</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="#close">close()</a></code></p> |
| 79 | <p class="firstline">Close httplib2 connections.</p> |
| 80 | <p class="toc_element"> |
| 81 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 82 | <p class="firstline">Get OS policies compliance data for the specified Compute Engine VM instance.</p> |
| 83 | <p class="toc_element"> |
| 84 | <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| 85 | <p class="firstline">List OS policies compliance data for all Compute Engine VM instances in the specified zone.</p> |
| 86 | <p class="toc_element"> |
| 87 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 88 | <p class="firstline">Retrieves the next page of results.</p> |
| 89 | <h3>Method Details</h3> |
| 90 | <div class="method"> |
| 91 | <code class="details" id="close">close()</code> |
| 92 | <pre>Close httplib2 connections.</pre> |
| 93 | </div> |
| 94 | |
| 95 | <div class="method"> |
| 96 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 97 | <pre>Get OS policies compliance data for the specified Compute Engine VM instance. |
| 98 | |
| 99 | Args: |
| 100 | name: string, Required. API resource name for instance OS policies compliance resource. Format: `projects/{project}/locations/{location}/instanceOSPoliciesCompliances/{instance}` For `{project}`, either Compute Engine project-number or project-id can be provided. For `{instance}`, either Compute Engine VM instance-id or instance-name can be provided. (required) |
| 101 | x__xgafv: string, V1 error format. |
| 102 | Allowed values |
| 103 | 1 - v1 error format |
| 104 | 2 - v2 error format |
| 105 | |
| 106 | Returns: |
| 107 | An object of the form: |
| 108 | |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 109 | { # 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](/compute/docs/os-configuration-management/view-compliance). |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 110 | "detailedState": "A String", # 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. |
| 111 | "detailedStateReason": "A String", # Output only. The reason for the `detailed_state` of the VM (if any). |
| 112 | "instance": "A String", # Output only. The Compute Engine VM instance name. |
| 113 | "lastComplianceCheckTime": "A String", # Output only. Timestamp of the last compliance check for the VM. |
| 114 | "lastComplianceRunId": "A String", # 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. |
| 115 | "name": "A String", # Output only. The `InstanceOSPoliciesCompliance` API resource name. Format: `projects/{project_number}/locations/{location}/instanceOSPoliciesCompliances/{instance_id}` |
| 116 | "osPolicyCompliances": [ # Output only. Compliance data for each `OSPolicy` that is applied to the VM. |
| 117 | { # Compliance data for an OS policy |
| 118 | "osPolicyAssignment": "A String", # Reference to the `OSPolicyAssignment` API resource that the `OSPolicy` belongs to. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}` |
| 119 | "osPolicyId": "A String", # The OS policy id |
| 120 | "osPolicyResourceCompliances": [ # Compliance data for each `OSPolicyResource` that is applied to the VM. |
| 121 | { # Compliance data for an OS policy resource. |
| 122 | "configSteps": [ # Ordered list of configuration steps taken by the agent for the OS policy resource. |
| 123 | { # Step performed by the OS Config agent for configuring an `OSPolicyResource` to its desired state. |
| 124 | "outcome": "A String", # Outcome of the configuration step. |
| 125 | "type": "A String", # Configuration step type. |
| 126 | }, |
| 127 | ], |
| 128 | "osPolicyResourceId": "A String", # The id of the OS policy resource. |
| 129 | "state": "A String", # Compliance state of the OS policy resource. |
| 130 | }, |
| 131 | ], |
| 132 | "state": "A String", # Compliance state of the OS policy. |
| 133 | }, |
| 134 | ], |
| 135 | "state": "A String", # Output only. Compliance state of the VM. |
| 136 | }</pre> |
| 137 | </div> |
| 138 | |
| 139 | <div class="method"> |
| 140 | <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| 141 | <pre>List OS policies compliance data for all Compute Engine VM instances in the specified zone. |
| 142 | |
| 143 | Args: |
| 144 | parent: string, Required. The parent resource name. Format: `projects/{project}/locations/{location}` For `{project}`, either Compute Engine project-number or project-id can be provided. (required) |
| 145 | filter: string, If provided, this field specifies the criteria that must be met by a `InstanceOSPoliciesCompliance` API resource to be included in the response. |
| 146 | pageSize: integer, The maximum number of results to return. |
| 147 | pageToken: string, A pagination token returned from a previous call to `ListInstanceOSPoliciesCompliances` that indicates where this listing should continue from. |
| 148 | x__xgafv: string, V1 error format. |
| 149 | Allowed values |
| 150 | 1 - v1 error format |
| 151 | 2 - v2 error format |
| 152 | |
| 153 | Returns: |
| 154 | An object of the form: |
| 155 | |
| 156 | { # A response message for listing OS policies compliance data for all Compute Engine VMs in the given location. |
| 157 | "instanceOsPoliciesCompliances": [ # List of instance OS policies compliance objects. |
| yoshi-code-bot | 50e1b7a | 2021-06-03 00:48:27 -0700 | [diff] [blame^] | 158 | { # 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](/compute/docs/os-configuration-management/view-compliance). |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 159 | "detailedState": "A String", # 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. |
| 160 | "detailedStateReason": "A String", # Output only. The reason for the `detailed_state` of the VM (if any). |
| 161 | "instance": "A String", # Output only. The Compute Engine VM instance name. |
| 162 | "lastComplianceCheckTime": "A String", # Output only. Timestamp of the last compliance check for the VM. |
| 163 | "lastComplianceRunId": "A String", # 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. |
| 164 | "name": "A String", # Output only. The `InstanceOSPoliciesCompliance` API resource name. Format: `projects/{project_number}/locations/{location}/instanceOSPoliciesCompliances/{instance_id}` |
| 165 | "osPolicyCompliances": [ # Output only. Compliance data for each `OSPolicy` that is applied to the VM. |
| 166 | { # Compliance data for an OS policy |
| 167 | "osPolicyAssignment": "A String", # Reference to the `OSPolicyAssignment` API resource that the `OSPolicy` belongs to. Format: `projects/{project_number}/locations/{location}/osPolicyAssignments/{os_policy_assignment_id@revision_id}` |
| 168 | "osPolicyId": "A String", # The OS policy id |
| 169 | "osPolicyResourceCompliances": [ # Compliance data for each `OSPolicyResource` that is applied to the VM. |
| 170 | { # Compliance data for an OS policy resource. |
| 171 | "configSteps": [ # Ordered list of configuration steps taken by the agent for the OS policy resource. |
| 172 | { # Step performed by the OS Config agent for configuring an `OSPolicyResource` to its desired state. |
| 173 | "outcome": "A String", # Outcome of the configuration step. |
| 174 | "type": "A String", # Configuration step type. |
| 175 | }, |
| 176 | ], |
| yoshi-code-bot | 227f8c9 | 2021-05-26 00:34:03 -0700 | [diff] [blame] | 177 | "osPolicyResourceId": "A String", # The id of the OS policy resource. |
| 178 | "state": "A String", # Compliance state of the OS policy resource. |
| 179 | }, |
| 180 | ], |
| 181 | "state": "A String", # Compliance state of the OS policy. |
| 182 | }, |
| 183 | ], |
| 184 | "state": "A String", # Output only. Compliance state of the VM. |
| 185 | }, |
| 186 | ], |
| 187 | "nextPageToken": "A String", # The pagination token to retrieve the next page of instance OS policies compliance objects. |
| 188 | }</pre> |
| 189 | </div> |
| 190 | |
| 191 | <div class="method"> |
| 192 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 193 | <pre>Retrieves the next page of results. |
| 194 | |
| 195 | Args: |
| 196 | previous_request: The request for the previous page. (required) |
| 197 | previous_response: The response from the request for the previous page. (required) |
| 198 | |
| 199 | Returns: |
| 200 | A request object that you can call 'execute()' on to request the next |
| 201 | page. Returns None if there are no more items in the collection. |
| 202 | </pre> |
| 203 | </div> |
| 204 | |
| 205 | </body></html> |