Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
reubenmiller committed Oct 16, 2022
1 parent 5e2e6a3 commit 98920bc
Show file tree
Hide file tree
Showing 66 changed files with 538 additions and 538 deletions.
14 changes: 7 additions & 7 deletions docs/go-c8y-cli/docs/cli/c8y/agents/c8y_agents_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ Create agent with custom properties
### Options

```
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-h, --help help for create
--name string Agent name (accepts pipeline)
--processingMode string Cumulocity processing mode
--template string Body template
--templateVars string Body template variables
--type string Agent type
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-h, --help help for create
--name string Agent name (accepts pipeline)
--processingMode string Cumulocity processing mode
--template string Body template
--templateVars stringArray Body template variables
--type string Agent type
```

### Options inherited from parent commands
Expand Down
14 changes: 7 additions & 7 deletions docs/go-c8y-cli/docs/cli/c8y/agents/c8y_agents_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ Update agent by id
### Options

```
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-h, --help help for update
--id strings Agent ID (required) (accepts pipeline)
--newName string Agent name
--processingMode string Cumulocity processing mode
--template string Body template
--templateVars string Body template variables
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-h, --help help for update
--id strings Agent ID (required) (accepts pipeline)
--newName string Agent name
--processingMode string Cumulocity processing mode
--template string Body template
--templateVars stringArray Body template variables
```

### Options inherited from parent commands
Expand Down
22 changes: 11 additions & 11 deletions docs/go-c8y-cli/docs/cli/c8y/alarms/c8y_alarms_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,17 +23,17 @@ Create a new alarm for device
### Options

```
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
--device strings The ManagedObject that the alarm originated from (accepts pipeline)
-h, --help help for create
--processingMode string Cumulocity processing mode
--severity string The severity of the alarm: CRITICAL, MAJOR, MINOR or WARNING. Must be upper-case.
--status string The status of the alarm: ACTIVE, ACKNOWLEDGED or CLEARED. If status was not appeared, new alarm will have status ACTIVE. Must be upper-case.
--template string Body template
--templateVars string Body template variables
--text string Text description of the alarm.
--time string Time of the alarm. Defaults to current timestamp.
--type string Identifies the type of this alarm, e.g. 'com_cumulocity_events_TamperEvent'.
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
--device strings The ManagedObject that the alarm originated from (accepts pipeline)
-h, --help help for create
--processingMode string Cumulocity processing mode
--severity string The severity of the alarm: CRITICAL, MAJOR, MINOR or WARNING. Must be upper-case.
--status string The status of the alarm: ACTIVE, ACKNOWLEDGED or CLEARED. If status was not appeared, new alarm will have status ACTIVE. Must be upper-case.
--template string Body template
--templateVars stringArray Body template variables
--text string Text description of the alarm.
--time string Time of the alarm. Defaults to current timestamp.
--type string Identifies the type of this alarm, e.g. 'com_cumulocity_events_TamperEvent'.
```

### Options inherited from parent commands
Expand Down
18 changes: 9 additions & 9 deletions docs/go-c8y-cli/docs/cli/c8y/alarms/c8y_alarms_update.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ Update severity of an existing alarm to CRITICAL
### Options

```
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-h, --help help for update
--id strings Alarm id (required) (accepts pipeline)
--processingMode string Cumulocity processing mode
--severity string Alarm severity, for example CRITICAL, MAJOR, MINOR or WARNING.
--status string The status of the alarm. If not specified, a new alarm will be created as ACTIVE.
--template string Body template
--templateVars string Body template variables
--text string Text description of the alarm.
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-h, --help help for update
--id strings Alarm id (required) (accepts pipeline)
--processingMode string Cumulocity processing mode
--severity string Alarm severity, for example CRITICAL, MAJOR, MINOR or WARNING.
--status string The status of the alarm. If not specified, a new alarm will be created as ACTIVE.
--template string Body template
--templateVars stringArray Body template variables
--text string Text description of the alarm.
```

### Options inherited from parent commands
Expand Down
28 changes: 14 additions & 14 deletions docs/go-c8y-cli/docs/cli/c8y/alarms/c8y_alarms_updateCollection.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,20 +23,20 @@ Update the status of all active alarms on a device to ACKNOWLEDGED
### Options

```
--createdFrom string Start date or date and time of the alarm creation. Version >= 10.11
--createdTo string End date or date and time of the alarm creation. Version >= 10.11
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
--dateFrom string Start date or date and time of alarm occurrence.
--dateTo string End date or date and time of alarm occurrence.
--device strings The ManagedObject that the alarm originated from (accepts pipeline)
-h, --help help for updateCollection
--newStatus string New status to be applied to all of the matching alarms
--processingMode string Cumulocity processing mode
--resolved When set to true only resolved alarms will be removed (the one with status CLEARED), false means alarms with status ACTIVE or ACKNOWLEDGED.
--severity string The severity of the alarm: CRITICAL, MAJOR, MINOR or WARNING. Must be upper-case.
--status string The status of the alarm: ACTIVE, ACKNOWLEDGED or CLEARED. If status was not appeared, new alarm will have status ACTIVE. Must be upper-case.
--template string Body template
--templateVars string Body template variables
--createdFrom string Start date or date and time of the alarm creation. Version >= 10.11
--createdTo string End date or date and time of the alarm creation. Version >= 10.11
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
--dateFrom string Start date or date and time of alarm occurrence.
--dateTo string End date or date and time of alarm occurrence.
--device strings The ManagedObject that the alarm originated from (accepts pipeline)
-h, --help help for updateCollection
--newStatus string New status to be applied to all of the matching alarms
--processingMode string Cumulocity processing mode
--resolved When set to true only resolved alarms will be removed (the one with status CLEARED), false means alarms with status ACTIVE or ACKNOWLEDGED.
--severity string The severity of the alarm: CRITICAL, MAJOR, MINOR or WARNING. Must be upper-case.
--status string The status of the alarm: ACTIVE, ACKNOWLEDGED or CLEARED. If status was not appeared, new alarm will have status ACTIVE. Must be upper-case.
--template string Body template
--templateVars stringArray Body template variables
```

### Options inherited from parent commands
Expand Down
24 changes: 12 additions & 12 deletions docs/go-c8y-cli/docs/cli/c8y/api/c8y_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,18 +45,18 @@ a template to also build the request's body from the piped input data.
### Options

```
--accept string accept (header)
--contentType string content type (header)
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
--file string File to be uploaded as a binary
--formdata string form data (json or shorthand json)
-h, --help help for api
--host string host to use for the rest request. If empty, then the session's host will be used
--keepProperties Don't strip Cumulocity properties from the data property, i.e. source etc. (default true)
--method string HTTP method (default "GET")
--template string Body template
--templateVars string Body template variables
--url string URL path. Any reference to '%s' will be replaced with the current input value (accepts pipeline)
--accept string accept (header)
--contentType string content type (header)
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
--file string File to be uploaded as a binary
--formdata string form data (json or shorthand json)
-h, --help help for api
--host string host to use for the rest request. If empty, then the session's host will be used
--keepProperties Don't strip Cumulocity properties from the data property, i.e. source etc. (default true)
--method string HTTP method (default "GET")
--template string Body template
--templateVars stringArray Body template variables
--url string URL path. Any reference to '%s' will be replaced with the current input value (accepts pipeline)
```

### Options inherited from parent commands
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Create a new hosted application
--resourcesUrl string URL to application base directory hosted on an external server. Required when application type is HOSTED
--resourcesUsername string authorization username to access resourcesUrl
--template string Body template
--templateVars string Body template variables
--templateVars stringArray Body template variables
--type string Type of application. Possible values are EXTERNAL, HOSTED, MICROSERVICE
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,18 +32,18 @@ Create/update hosted web application but don't activate it, so the current versi
### Options

```
--availability string Access level for other tenants. Possible values are : MARKET, PRIVATE (default)
--contextPath string contextPath of the hosted application
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
--file string File or Folder of the web application. It should contain a index.html file in the root folder/ or zip file
-h, --help help for createHostedApplication
--key string Shared secret of application. Defaults to the value inside the cumulocity.json file (if present)
--name string Name of application
--resourcesUrl string URL to application base directory hosted on an external server. Required when application type is HOSTED (default "/")
--skipActivation Don't activate to the application after it has been created and uploaded
--skipUpload Don't uploaded the web app binary. Only the application placeholder will be created
--template string Body template
--templateVars string Body template variables
--availability string Access level for other tenants. Possible values are : MARKET, PRIVATE (default)
--contextPath string contextPath of the hosted application
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
--file string File or Folder of the web application. It should contain a index.html file in the root folder/ or zip file
-h, --help help for createHostedApplication
--key string Shared secret of application. Defaults to the value inside the cumulocity.json file (if present)
--name string Name of application
--resourcesUrl string URL to application base directory hosted on an external server. Required when application type is HOSTED (default "/")
--skipActivation Don't activate to the application after it has been created and uploaded
--skipUpload Don't uploaded the web app binary. Only the application placeholder will be created
--template string Body template
--templateVars stringArray Body template variables
```

### Options inherited from parent commands
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Update application availability to MARKET
--resourcesUrl string URL to application base directory hosted on an external server
--resourcesUsername string authorization username to access resourcesUrl
--template string Body template
--templateVars string Body template variables
--templateVars stringArray Body template variables
```

### Options inherited from parent commands
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,19 +23,19 @@ Create an audit record for a custom managed object update
### Options

```
--activity string The activity that was carried out.
--application string The application used to carry out the audited action.
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-h, --help help for create
--processingMode string Cumulocity processing mode
--severity string The severity of action: critical, major, minor, warning or information.
--source string An optional ManagedObject that the audit record originated from (accepts pipeline)
--template string Body template
--templateVars string Body template variables
--text string Text description of the audit record.
--time string Time of the audit record. Defaults to current timestamp.
--type string Identifies the type of this audit record.
--user string The user responsible for the audited action.
--activity string The activity that was carried out.
--application string The application used to carry out the audited action.
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
-h, --help help for create
--processingMode string Cumulocity processing mode
--severity string The severity of action: critical, major, minor, warning or information.
--source string An optional ManagedObject that the audit record originated from (accepts pipeline)
--template string Body template
--templateVars stringArray Body template variables
--text string Text description of the audit record.
--time string Time of the audit record. Defaults to current timestamp.
--type string Identifies the type of this audit record.
--user string The user responsible for the audited action.
```

### Options inherited from parent commands
Expand Down
16 changes: 8 additions & 8 deletions docs/go-c8y-cli/docs/cli/c8y/binaries/c8y_binaries_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,14 @@ Upload a file with a custom name and custom meta information
### Options

```
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
--file string File to be uploaded as a binary (required)
-h, --help help for create
--name string Set the name of the binary file. This will be the name of the file when it is downloaded in the UI
--processingMode string Cumulocity processing mode
--template string Body template
--templateVars string Body template variables
--type string Custom type. If left blank, the MIME type will be detected from the file extension
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
--file string File to be uploaded as a binary (required)
-h, --help help for create
--name string Set the name of the binary file. This will be the name of the file when it is downloaded in the UI
--processingMode string Cumulocity processing mode
--template string Body template
--templateVars stringArray Body template variables
--type string Custom type. If left blank, the MIME type will be detected from the file extension
```

### Options inherited from parent commands
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,15 +26,15 @@ Create bulk operation for a group (using pipeline)
### Options

```
--creationRampSec float32 Delay between every operation creation.
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
--group strings Identifies the target group on which this operation should be performed. (accepts pipeline)
-h, --help help for create
--operation string Operation prototype to send to each device in the group
--processingMode string Cumulocity processing mode
--startDate string Time when operations should be created. Defaults to 300s
--template string Body template
--templateVars string Body template variables
--creationRampSec float32 Delay between every operation creation.
-d, --data string static data to be applied to body. accepts json or shorthand json, i.e. --data 'value1=1,my.nested.value=100'
--group strings Identifies the target group on which this operation should be performed. (accepts pipeline)
-h, --help help for create
--operation string Operation prototype to send to each device in the group
--processingMode string Cumulocity processing mode
--startDate string Time when operations should be created. Defaults to 300s
--template string Body template
--templateVars stringArray Body template variables
```

### Options inherited from parent commands
Expand Down
Loading

0 comments on commit 98920bc

Please sign in to comment.