Placement

This section details Placement-related Linode CLI commands.

assign-linode 

Add one or more compute instances to your placement group.

Usage

The format accepted by this command.

linode-cli placement assign-linode [-h] [--linodes linodes]
    groupId

Sample

Examples of how this command might be used.

linode-cli placement assignLinode 528 \
    --linodes 123 456 \
    --non-compliant true

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
groupId	int	ID of the placement group to look up.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--linodes	[]int	528	The `linodeId` values for individual compute instances included in the placement group.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
id	int	528	The placement group’s ID.
is_compliant	bool	true	Whether all of the compute instances in your placement group are compliant.
label	str	PG_Miami_failover	The unique name set for the placement group.
placement_group_policy	str	strict	How requests to add future compute instances to your placement group are handled, and whether it remains compliant: - `strict`.
placement_group_type	str	anti-affinity:local	How compute instances are distributed in your placement group.
region	str	us-mia	The region where the placement group was deployed.

members

Name	Type	Example	Description
members.is_compliant	bool	true	The compliance status of each individual compute instance in the placement group.
members.linode_id	int	123	The unique identifier for a compute instance included in the placement group.

group-view 

View a specific placement group by ID.

Usage

The format accepted by this command.

linode-cli placement group-view [-h] [--region region]
    [--placement_group_type placement_group_type] [--label label]
    [--order-by {region,placement_group_type,label}]
    [--order {asc,desc}] groupId

Sample

Examples of how this command might be used.

linode-cli placement view 528

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
groupId	int	ID of the placement group to look up.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
id	int	528	The placement group’s ID.
is_compliant	bool	true	Whether all of the compute instances in your placement group are compliant.
label	str	PG_Miami_failover	The unique name set for the placement group.
placement_group_policy	str	strict	How requests to add future compute instances to your placement group are handled, and whether it remains compliant: - `strict`.
placement_group_type	str	anti-affinity:local	How compute instances are distributed in your placement group.
region	str	us-mia	The region where the placement group was deployed.

members

Name	Type	Example	Description
members.is_compliant	bool	true	The compliance status of each individual compute instance in the placement group.
members.linode_id	int	123	The unique identifier for a compute instance included in the placement group.

group-create 

Creates a placement group on your account.

Usage

The format accepted by this command.

linode-cli placement group-create [-h] [--region region]
    [--placement_group_policy placement_group_policy]
    [--placement_group_type placement_group_type] [--label label]

Sample

Examples of how this command might be used.

linode-cli placement create \
    --label PG_Miami_failover \
    --region us-mia \
    --placement_group_type "anti-affinity:local" \
    --placement_group_policy strict

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--label *	str	PG_Miami_failover	A unique name for the placement group.
--placement_group_policy *	str	strict	How requests to add future compute instances to your placement group are handled: - `strict`.
--placement_group_type *	str	[‘anti_affinity:local’]	How compute instances are distributed in your placement group.
--region *	str	us-iad	The data center that houses the compute instances you want to add to your placement group.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
id	int	528	The placement group’s ID.
is_compliant	bool	true	Whether all of the compute instances in your placement group are compliant.
label	str	PG_Miami_failover	The unique name set for the placement group.
placement_group_policy	str	strict	How requests to add future compute instances to your placement group are handled, and whether it remains compliant: - `strict`.
placement_group_type	str	anti-affinity:local	How compute instances are distributed in your placement group.
region	str	us-mia	The region where the placement group was deployed.

members

Name	Type	Example	Description
members.is_compliant	bool	true	The compliance status of each individual compute instance in the placement group.
members.linode_id	int	123	The unique identifier for a compute instance included in the placement group.

group-update 

Change the label for a specific placement group.

Usage

The format accepted by this command.

linode-cli placement group-update [-h] [--label label] groupId

Sample

Examples of how this command might be used.

linode-cli placement update 528 \
    --label PG_Miami_failover_update

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
groupId	int	ID of the placement group to look up.

Arguments

Additional fields used to execute this request.

Name	Type	Example	Description
--label	str	PG_Miami_failover	A unique name for the placement group.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
id	int	528	The placement group’s ID.
is_compliant	bool	true	Whether all of the compute instances in your placement group are compliant.
label	str	PG_Miami_failover	The unique name set for the placement group.
placement_group_policy	str	strict	How requests to add future compute instances to your placement group are handled, and whether it remains compliant: - `strict`.
placement_group_type	str	anti-affinity:local	How compute instances are distributed in your placement group.
region	str	us-mia	The region where the placement group was deployed.

members

Name	Type	Example	Description
members.is_compliant	bool	true	The compliance status of each individual compute instance in the placement group.
members.linode_id	int	123	The unique identifier for a compute instance included in the placement group.

group-delete 

Aliases: group-rm

Deletes a placement group you have permission to read_write.

Usage

The format accepted by this command.

linode-cli placement group-delete [-h] groupId

Sample

Examples of how this command might be used.

linode-cli placement delete 528

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
groupId	int	ID of the placement group to look up.

groups-list 

Aliases: groups-ls

Returns a paginated list of placement groups you have permission to view.

Usage

The format accepted by this command.

linode-cli placement groups-list [-h]
    [--placement_group_type placement_group_type]
    [--region region] [--label label]
    [--order-by {placement_group_type,region,label}]
    [--order {asc,desc}]

Sample

Examples of how this command might be used.

linode-cli placement-list

Filterable Attributes

Arguments used to define a filter for response entries.

Name	Type	Description
--label	str	The unique name set for the placement group.
--placement_group_type	str	How compute instances are distributed in your placement group.
--region	str	The region where the placement group was deployed.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
id	int	528	The placement group’s ID.
is_compliant	bool	true	Whether all of the compute instances in your placement group are compliant.
label	str	PG_Miami_failover	The unique name set for the placement group.
placement_group_policy	str	strict	How requests to add future compute instances to your placement group are handled, and whether it remains compliant: - `strict`.
placement_group_type	str	anti-affinity:local	How compute instances are distributed in your placement group.
region	str	us-mia	The region where the placement group was deployed.

members

Name	Type	Example	Description
members.is_compliant	bool	true	The compliance status of each individual compute instance in the placement group.
members.linode_id	int	123	The unique identifier for a compute instance included in the placement group.

unassign-linode 

Remove one or more compute instances from your placement group.

Usage

The format accepted by this command.

linode-cli placement unassign-linode [-h] groupId

Sample

Examples of how this command might be used.

linode-cli placement unassignLinode 528 \
    --linode 123 456

Parameters

Positional parameters used to define the resource this command should target.

Name	Type	Description
groupId	int	ID of the placement group to look up.

Result Attributes

The attributes returned by this command.

Name	Type	Example	Description
id	int	528	The placement group’s ID.
is_compliant	bool	true	Whether all of the compute instances in your placement group are compliant.
label	str	PG_Miami_failover	The unique name set for the placement group.
placement_group_policy	str	strict	How requests to add future compute instances to your placement group are handled, and whether it remains compliant: - `strict`.
placement_group_type	str	anti-affinity:local	How compute instances are distributed in your placement group.
region	str	us-mia	The region where the placement group was deployed.

members

Name	Type	Example	Description
members.is_compliant	bool	true	The compliance status of each individual compute instance in the placement group.
members.linode_id	int	123	The unique identifier for a compute instance included in the placement group.

Placement

assign-linode

group-view

group-create

group-update

group-delete

groups-list

unassign-linode

assign-linode 

group-view 

group-create 

group-update 

group-delete 

groups-list 

unassign-linode 