Get Serial Port Output
|
|||||
|
|
||||
Returns the last 1 MB of serial port output from the specified instance
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage your data across Google Cloud Platform services
- View and manage your Google Compute Engine resources
- View your Google Compute Engine resources
Input
This building block consumes 5 input parameters
| Name | Format | Description |
|---|---|---|
project Required |
STRING |
Project ID for this request |
zone Required |
STRING |
The name of the zone for this request |
instance Required |
STRING |
Name of the instance scoping this request |
port |
INTEGER |
Specifies which COM or serial port to retrieve data from |
start |
INTEGER |
Returns output starting from a specific byte position. Use this to page through output when the output is too large to return in a single request. For the initial request, leave this field unspecified. For subsequent calls, this field should be set to the next value returned in the previous call |
= Parameter name
= Format
|
project STRING Required Project ID for this request |
|
zone STRING Required The name of the zone for this request |
|
instance STRING Required Name of the instance scoping this request |
|
port INTEGER Specifies which COM or serial port to retrieve data from |
|
start INTEGER Returns output starting from a specific byte position. Use this to page through output when the output is too large to return in a single request. For the initial request, leave this field unspecified. For subsequent calls, this field should be set to the next value returned in the previous call |
Output
This building block provides 5 output parameters
| Name | Format | Description |
|---|---|---|
contents |
STRING |
[Output Only] The contents of the console output |
kind |
STRING |
[Output Only] Type of the resource. Always compute#serialPortOutput for serial port output |
next |
INTEGER |
[Output Only] The position of the next byte of content from the serial console output. Use this value in the next request as the start parameter |
selfLink |
STRING |
[Output Only] Server-defined URL for this resource |
start |
INTEGER |
The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer, older output will be overwritten by newer content and the start values will be mismatched |
= Parameter name
= Format
|
contents STRING [Output Only] The contents of the console output |
|
kind STRING [Output Only] Type of the resource. Always compute#serialPortOutput for serial port output |
|
next INTEGER [Output Only] The position of the next byte of content from the serial console output. Use this value in the next request as the start parameter |
|
selfLink STRING [Output Only] Server-defined URL for this resource |
|
start INTEGER The starting byte position of the output that was returned. This should match the start parameter sent with the request. If the serial console output exceeds the size of the buffer, older output will be overwritten by newer content and the start values will be mismatched |