hardware_component_groups
Creates, updates, deletes, gets or lists a hardware_component_groups
resource.
Overview
Name | hardware_component_groups |
Type | Resource |
Id | azure_extras.storsimple_8000_series.hardware_component_groups |
Fields
The following fields are returned by SELECT
queries:
- list_by_device
Successfully fetched hardware component groups.
Name | Datatype | Description |
---|---|---|
id | string | The path ID that uniquely identifies the object. |
name | string | The name of the object. |
kind | string | The Kind of the object. Currently only Series8000 is supported |
properties | object | The properties of the hardware component group. |
type | string | The hierarchical type of the object. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
list_by_device | select | deviceName , subscriptionId , resourceGroupName , managerName | Lists the hardware component groups at device-level. | |
change_controller_power_state | exec | deviceName , hardwareComponentGroupName , subscriptionId , resourceGroupName , managerName , properties | Changes the power state of the controller. |
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 |
---|---|---|
deviceName | string | The device name |
hardwareComponentGroupName | string | The hardware component group name. |
managerName | string | The manager name |
resourceGroupName | string | The resource group name |
subscriptionId | string | The subscription id |
SELECT
examples
- list_by_device
Lists the hardware component groups at device-level.
SELECT
id,
name,
kind,
properties,
type
FROM azure_extras.storsimple_8000_series.hardware_component_groups
WHERE deviceName = '{{ deviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND managerName = '{{ managerName }}' -- required
;
Lifecycle Methods
- change_controller_power_state
Changes the power state of the controller.
EXEC azure_extras.storsimple_8000_series.hardware_component_groups.change_controller_power_state
@deviceName='{{ deviceName }}' --required,
@hardwareComponentGroupName='{{ hardwareComponentGroupName }}' --required,
@subscriptionId='{{ subscriptionId }}' --required,
@resourceGroupName='{{ resourceGroupName }}' --required,
@managerName='{{ managerName }}' --required
@@json=
'{
"kind": "{{ kind }}",
"properties": "{{ properties }}"
}'
;