upgrades

Creates, updates, deletes, gets or lists a upgrades resource.

Overview

Name	upgrades
Type	Resource
Id	sumologic.collectors.upgrades

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Identifier of the upgrade task.
collector_id	integer	Identifier of the Collector being upgraded. (wire: collectorId)
message	string	Status message.
request_time	integer (int64)	Time the upgrade was requested, in milliseconds since epoch. (wire: requestTime)
status	integer	Upgrade status: 0 not started, 1 running, 2 succeeded, 3 failed, 6 progressing.
to_version	string	Target version. (wire: toVersion)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	upgrade_task_id, region		Get the status of a Collector upgrade task.
create	insert	region, collector_id		Start an upgrade (or downgrade) task for an Installed Collector. Poll the returned task with the upgrade status method.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	Sumo Logic deployment (au, ca, ch, de, eu, fed, in, jp, kr, us1, us2). Resolved from the SUMOLOGIC_ENVIRONMENT environment variable when it is set (x-stackQL-envVar, the same variable the Terraform provider reads); otherwise defaults to us2. A WHERE region = '...' value always takes precedence. (enum: [au, ca, ch, de, eu, fed, in, jp, kr, us1, us2], default: us2, x-stackQL-envVar: SUMOLOGIC_ENVIRONMENT)
upgrade_task_id	string	Identifier of the upgrade task. (wire: upgradeTaskId)

SELECT examples

get

Get the status of a Collector upgrade task.

SELECT
id,
collector_id,
message,
request_time,
status,
to_version
FROM sumologic.collectors.upgrades
WHERE upgrade_task_id = '{{ upgrade_task_id }}' -- required
AND region = '{{ region }}' -- required unless SUMOLOGIC_ENVIRONMENT is set
;

INSERT examples

create

Start an upgrade (or downgrade) task for an Installed Collector. Poll the returned task with the upgrade status method.

INSERT INTO sumologic.collectors.upgrades (
collector_id,
to_version,
region
)
SELECT 
{{ collector_id }} /* required */,
'{{ to_version }}',
'{{ region }}'
RETURNING
id,
link
;

Manifest

# Description fields are for documentation purposes
- name: upgrades
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the upgrades resource.
  - name: collector_id
    value: {{ collector_id }}
    description: |
      Identifier of the Installed Collector to upgrade.
  - name: to_version
    value: "{{ to_version }}"
    description: |
      Target version. Defaults to the latest version.