Manage software volumes, or reboot to a specific volume

REST Endpoints

Collection URI
Collection Methods
Resource URI
/mgmt/tm/sys/software/volume/~resource id
Resource Methods
Resource Natural Key


Name Type Default Value Required Access Description
active boolean   optional read/write Set if this volume is being run.
basebuild string   optional read/write The original build number (before any hotfixes)
build string   optional read/write The build number of the hotfix presently applied or the original build
edition string   optional read/write A textual description of the image, used to specify which hotfix is installed
product string   optional read/write The F5 product that is installed on this volume
status string   optional read/write The installation status of this volume (complete, installing, etc)
version string   optional read/write The version of the software installed on this volume

Array Structures

Name Type Default Value Required Access Description
/media array_structure   optional read/write  
/media/default-boot-location boolean   optional read/write Set if the volume will be booted into if the machine resets
/media/media string   optional read/write The type of the media (hd or cf)
/media/size string   optional read/write The amount of space reserved by the volume
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.