-
Notifications
You must be signed in to change notification settings - Fork 2.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
#### osconfig:v1 The following keys were added: - resources.projects.resources.locations.resources.instances.resources.osPolicyAssignments.methods.getReport (Total Keys: 11) - resources.projects.resources.locations.resources.instances.resources.osPolicyAssignments.resources.reports.methods.list (Total Keys: 18) - resources.projects.resources.locations.resources.osPolicyAssignments.resources.operations.methods.cancel (Total Keys: 12) - resources.projects.resources.locations.resources.osPolicyAssignments.resources.operations.methods.get (Total Keys: 11) - schemas.CancelOperationRequest (Total Keys: 2) - schemas.ListOSPolicyAssignmentReportsResponse (Total Keys: 5) - schemas.OSPolicyAssignmentReport (Total Keys: 33)
- Loading branch information
1 parent
e7f9373
commit bec27e8
Showing
10 changed files
with
785 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
140 changes: 140 additions & 0 deletions
140
docs/dyn/osconfig_v1.projects.locations.instances.osPolicyAssignments.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| <html><body> | ||
| <style> | ||
|
|
||
| body, h1, h2, h3, div, span, p, pre, a { | ||
| margin: 0; | ||
| padding: 0; | ||
| border: 0; | ||
| font-weight: inherit; | ||
| font-style: inherit; | ||
| font-size: 100%; | ||
| font-family: inherit; | ||
| vertical-align: baseline; | ||
| } | ||
|
|
||
| body { | ||
| font-size: 13px; | ||
| padding: 1em; | ||
| } | ||
|
|
||
| h1 { | ||
| font-size: 26px; | ||
| margin-bottom: 1em; | ||
| } | ||
|
|
||
| h2 { | ||
| font-size: 24px; | ||
| margin-bottom: 1em; | ||
| } | ||
|
|
||
| h3 { | ||
| font-size: 20px; | ||
| margin-bottom: 1em; | ||
| margin-top: 1em; | ||
| } | ||
|
|
||
| pre, code { | ||
| line-height: 1.5; | ||
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; | ||
| } | ||
|
|
||
| pre { | ||
| margin-top: 0.5em; | ||
| } | ||
|
|
||
| h1, h2, h3, p { | ||
| font-family: Arial, sans serif; | ||
| } | ||
|
|
||
| h1, h2, h3 { | ||
| border-bottom: solid #CCC 1px; | ||
| } | ||
|
|
||
| .toc_element { | ||
| margin-top: 0.5em; | ||
| } | ||
|
|
||
| .firstline { | ||
| margin-left: 2 em; | ||
| } | ||
|
|
||
| .method { | ||
| margin-top: 1em; | ||
| border: solid 1px #CCC; | ||
| padding: 1em; | ||
| background: #EEE; | ||
| } | ||
|
|
||
| .details { | ||
| font-weight: bold; | ||
| font-size: 14px; | ||
| } | ||
|
|
||
| </style> | ||
|
|
||
| <h1><a href="osconfig_v1.html">OS Config API</a> . <a href="osconfig_v1.projects.html">projects</a> . <a href="osconfig_v1.projects.locations.html">locations</a> . <a href="osconfig_v1.projects.locations.instances.html">instances</a> . <a href="osconfig_v1.projects.locations.instances.osPolicyAssignments.html">osPolicyAssignments</a></h1> | ||
| <h2>Instance Methods</h2> | ||
| <p class="toc_element"> | ||
| <code><a href="osconfig_v1.projects.locations.instances.osPolicyAssignments.reports.html">reports()</a></code> | ||
| </p> | ||
| <p class="firstline">Returns the reports Resource.</p> | ||
|
|
||
| <p class="toc_element"> | ||
| <code><a href="#close">close()</a></code></p> | ||
| <p class="firstline">Close httplib2 connections.</p> | ||
| <p class="toc_element"> | ||
| <code><a href="#getReport">getReport(name, x__xgafv=None)</a></code></p> | ||
| <p class="firstline">Get the OS policy asssignment report for the specified Compute Engine VM instance.</p> | ||
| <h3>Method Details</h3> | ||
| <div class="method"> | ||
| <code class="details" id="close">close()</code> | ||
| <pre>Close httplib2 connections.</pre> | ||
| </div> | ||
|
|
||
| <div class="method"> | ||
| <code class="details" id="getReport">getReport(name, x__xgafv=None)</code> | ||
| <pre>Get the OS policy asssignment report for the specified Compute Engine VM instance. | ||
|
|
||
| Args: | ||
| name: string, Required. API resource name for OS policy assignment report. Format: `/projects/{project}/locations/{location}/instances/{instance}/osPolicyAssignments/{assignment}/report` For `{project}`, either `project-number` or `project-id` can be provided. For `{instance_id}`, either Compute Engine `instance-id` or `instance-name` can be provided. For `{assignment_id}`, the OSPolicyAssignment id must be provided. (required) | ||
| x__xgafv: string, V1 error format. | ||
| Allowed values | ||
| 1 - v1 error format | ||
| 2 - v2 error format | ||
|
|
||
| Returns: | ||
| An object of the form: | ||
|
|
||
| { # A report of the OS policy assignment status for a given instance. | ||
| "instance": "A String", # The Compute Engine VM instance name. | ||
| "lastRunId": "A String", # Unique identifier of the last attempted run to apply the OS policies associated with this assignment on the VM. This ID is logged by the OS Config agent while applying the OS policies associated with this assignment on the VM. NOTE: If the service is unable to successfully connect to the agent for this run, then this id will not be available in the agent logs. | ||
| "name": "A String", # The `OSPolicyAssignmentReport` API resource name. Format: `projects/{project_number}/locations/{location}/instances/{instance_id}/osPolicyAssignments/{os_policy_assignment_id}/report` | ||
| "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}` | ||
| "osPolicyCompliances": [ # Compliance data for each `OSPolicy` that is applied to the VM. | ||
| { # Compliance data for an OS policy | ||
| "complianceState": "A String", # The compliance state of the OS policy. | ||
| "complianceStateReason": "A String", # The reason for the OS policy to be in an unknown compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. If populated, the field can contain one of the following values: * `vm-not-running`: The VM was not running. * `os-policies-not-supported-by-agent`: The version of the OS Config agent running on the VM does not support running OS policies. * `no-agent-detected`: The OS Config agent is not detected for the VM. * `resource-execution-errors`: The OS Config agent encountered errors while executing one or more resources in the policy. See `os_policy_resource_compliances` for details. * `task-timeout`: The task sent to the agent to apply the policy timed out. * `unexpected-agent-state`: The OS Config agent did not report the final status of the task that attempted to apply the policy. Instead, the agent unexpectedly started working on a different task. This mostly happens when the agent or VM unexpectedly restarts while applying OS policies. * `internal-service-errors`: Internal service errors were encountered while attempting to apply the policy. | ||
| "osPolicyId": "A String", # The OS policy id | ||
| "osPolicyResourceCompliances": [ # Compliance data for each resource within the policy that is applied to the VM. | ||
| { # Compliance data for an OS policy resource. | ||
| "complianceState": "A String", # The compliance state of the resource. | ||
| "complianceStateReason": "A String", # A reason for the resource to be in the given compliance state. This field is always populated when `compliance_state` is `UNKNOWN`. The following values are supported when `compliance_state == UNKNOWN` * `execution-errors`: Errors were encountered by the agent while executing the resource and the compliance state couldn't be determined. * `execution-skipped-by-agent`: Resource execution was skipped by the agent because errors were encountered while executing prior resources in the OS policy. * `os-policy-execution-attempt-failed`: The execution of the OS policy containing this resource failed and the compliance state couldn't be determined. | ||
| "configSteps": [ # Ordered list of configuration completed by the agent for the OS policy resource. | ||
| { # Step performed by the OS Config agent for configuring an `OSPolicy` resource to its desired state. | ||
| "errorMessage": "A String", # An error message recorded during the execution of this step. Only populated if errors were encountered during this step execution. | ||
| "type": "A String", # Configuration step type. | ||
| }, | ||
| ], | ||
| "execResourceOutput": { # ExecResource specific output. # ExecResource specific output. | ||
| "enforcementOutput": "A String", # Output from enforcement phase output file (if run). Output size is limited to 100K bytes. | ||
| }, | ||
| "osPolicyResourceId": "A String", # The ID of the OS policy resource. | ||
| }, | ||
| ], | ||
| }, | ||
| ], | ||
| "updateTime": "A String", # Timestamp for when the report was last generated. | ||
| }</pre> | ||
| </div> | ||
|
|
||
| </body></html> |
Oops, something went wrong.