Skip to content

PersistentVolumeClaim

Bases: DuploResourceV3

Commands

apply

Apply a PersistentVolumeClaim

Create or Update a PersistentVolumeClaim resource with Duplocloud cli.

CLI Usage

duploctl persistentvolumeclaim apply -f 'persistentvolumeclaim.yaml'
Contents of the persistentvolumeclaim.yaml file

Returns:

Name Type Description
message dict

Success message.

Parameters:

--file, -f, --cli-input
A file to read the input from
FileType('r') action: YamlAction
--patches, --add, --remove, --copy, --replace, --test, --move
The json patch to apply
str action: JsonPatchAction

create

Create a PersistentVolumeClaim resource.

CLI Usage

duploctl persistentvolumeclaim create -f 'persistentvolumeclaim.yaml'
Contents of the persistentvolumeclaim.yaml file

One liner example
echo """
""" | duploctl persistentvolumeclaim create -f -

Returns:

Name Type Description
message dict

Success message.

Raises:

Type Description
DuploError

If the resource could not be created.

Parameters:

--file, -f, --cli-input
A file to read the input from
FileType('r') action: YamlAction

delete

Delete a PersistentVolumeClaim resource by name.

cli usage
duploctl persistentvolumeclaim delete <name>

Returns:

Name Type Description
message dict

A success message.

Raises:

Type Description
DuploError

If the {{kind}} resource could not be found or deleted.

Parameters:

name positional
The resource name
str

find

Find PersistentVolumeClaim resources by name.

cli usage
duploctl persistentvolumeclaim find <name>

Returns:

Name Type Description
resource dict

The PersistentVolumeClaim object.

Raises:

Type Description
DuploError

If the {{kind}} could not be found.

Parameters:

name positional
The resource name
str

list

Retrieve a List of PersistentVolumeClaim resources

cli usage
duploctl persistentvolumeclaim list

Returns:

Name Type Description
list list

A list of PersistentVolumeClaim.

update

Update a V3 resource by name.

Returns:

Name Type Description
message

Success message.

Raises:

Type Description
DuploError

If the resource could not be created.

Parameters:

name positional
The resource name
str
--file, -f, --cli-input
A file to read the input from
FileType('r') action: YamlAction
--patches, --add, --remove, --copy, --replace, --test, --move
The json patch to apply
str action: JsonPatchAction

Methods

name_from_body