{"type":"doc","content":[{"type":"paragraph","content":[{"text":"Logical Folders are containers for storing and organizing inventory objects, in this case virtual machines. Just like networks, a Folder has a Managed Object Reference (moref) which is required for either virtual machine deployment (where a virtual machine will be placed upon creation) or updating virtual machine containing folder (move).","type":"text"}]},{"type":"paragraph","content":[{"text":"The ","type":"text"},{"text":"vss-cli compute folder","type":"text","marks":[{"type":"code"}]},{"text":" command lists, create and obtain information regarding a specific folder you have permission on.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"Usage: vss-cli compute folder [OPTIONS] COMMAND [ARGS]...\n\nLogical Folders are containers for storing and organizing inventory\nobjects, in this case virtual machines.\n\nOptions:\n--help Show this message and exit.\n\nCommands:\nget Given folder info.\nls list folders\nmk create folder\nrm remove folder\nset update folder","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"List"},"legacyAnchorId":{"value":"ManageLogicalFolders-List"}},"macroMetadata":{"macroId":{"value":"2c909aba-dda5-4973-8c01-ec28d45efb96"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"ManageLogicalFolders-List"},"legacyAnchorId":{"value":"ManageLogicalFolders-ManageLogicalFolders-List"}},"macroMetadata":{"macroId":{"value":"0d8e73e2-fdb4-4c26-bbbf-f3ec2f37b601"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"text":"List","type":"text"}]},{"type":"paragraph","content":[{"text":"Run ","type":"text"},{"text":"vss-cli compute folder","type":"text","marks":[{"type":"code"}]},{"text":" to list available logical folders. Filter list by name using the option ","type":"text"},{"text":"--filter-by/-f","type":"text","marks":[{"type":"code"}]},{"text":" which is structured ","type":"text"},{"text":"=,","type":"text","marks":[{"type":"code"}]},{"text":" and available operators are ","type":"text"},{"text":"eq, ne, lt, le, gt, ge, like, in","type":"text","marks":[{"type":"strong"}]},{"text":" as follows:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss-cli compute folder ls -f name=ut\n\nmoref name parent.name path\n----------- ---------------- ----------- ----------------------------------------------\ngroup-v8900 ut20170135153548 Testing VSS > Development > Testing > ut20170135153548\ngroup-v8923 ut20170621092129 Testing VSS > Development > Testing > ut20170621092129","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Info"},"legacyAnchorId":{"value":"ManageLogicalFolders-Info"}},"macroMetadata":{"macroId":{"value":"97252b74-8201-42a0-a9d7-74bbc38c7851"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"ManageLogicalFolders-Info"},"legacyAnchorId":{"value":"ManageLogicalFolders-ManageLogicalFolders-Info"}},"macroMetadata":{"macroId":{"value":"11e32da6-9520-4fb8-9d89-b8bb08796f3e"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"text":"Info","type":"text"}]},{"type":"paragraph","content":[{"text":"Folder info, such as name, parent and path, children folders and stored virtual machines are available via ","type":"text"},{"text":"vss-cli compute folder get ","type":"text","marks":[{"type":"code"}]},{"text":" command.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss-cli compute folder get group-v8900\n\nmoref : group-v905\nname : ut20170135153548\npath : Development > Testing > ut20170135153548\nparent.name : Testing\nparent.moref : group-v8900\nhas_children : False","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Create"},"legacyAnchorId":{"value":"ManageLogicalFolders-Create"}},"macroMetadata":{"macroId":{"value":"25ad9d95-c149-45bf-9011-9b47ae2a12be"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"ManageLogicalFolders-Create"},"legacyAnchorId":{"value":"ManageLogicalFolders-ManageLogicalFolders-Create"}},"macroMetadata":{"macroId":{"value":"c5356d26-3f72-4cd0-8be4-f0c61fd9c98c"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"text":"Create","type":"text"}]},{"type":"paragraph","content":[{"text":"To create a new folder just run ","type":"text"},{"text":"vss-cli compute folder mk --parent ","type":"text","marks":[{"type":"code"}]},{"text":", for instance:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss-cli compute folder mk Dev --parent group-v8900\nvss-cli compute folder mk Prod --parent ut20170135153548\nvss-cli compute folder mk UAT --parent group-v8900","type":"text"}]},{"type":"paragraph","content":[{"text":"Check the state of the request made by running ","type":"text"},{"text":"vss-cli request folder ls -s created_on desc -c 1","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"vss-cli request folder get ","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"Or you can submit multiple folder creation for a given folder, for instance:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss-cli --wait compute folder mk --parent group-v8900 QA DEV PROD UAT\n\nid status task_id message\n---- --------- ------------------------------------ ----------------------------------------\n49 SUBMITTED dbd51c34-fd1c-48e4-a2dc-dd33aa44f1e1 Request has been accepted for processing\n50 SUBMITTED 03f0d9cf-e23f-4f70-b511-2c0f69888e63 Request has been accepted for processing\n51 SUBMITTED a9380056-9d07-44f3-8469-c1e8149e90bf Request has been accepted for processing\n52 SUBMITTED 8100b93c-0dba-463c-a76a-4d8b97e47c03 Request has been accepted for processing\n\n⏳ Waiting for request 49 to complete...\n⏳ Waiting for request 50 to complete...\n⏳ Waiting for request 51 to complete...\n⏳ Waiting for request 52 to complete...\n\n🎉 Request 50 completed successfully:\nwarnings : Folder ITS > EIS > Data Centre Dev > Folder10 > DEV created\nerrors :\n🎉 Request 52 completed successfully:\nwarnings : Folder ITS > EIS > Data Centre Dev > Folder10 > UAT created\nerrors :\n🎉 Request 49 completed successfully:\nwarnings : Folder ITS > EIS > Data Centre Dev > Folder10 > QA created\nerrors :\n🎉 Request 51 completed successfully:\nwarnings : Folder ITS > EIS > Data Centre Dev > Folder10 > PROD created\nerrors :","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Update"},"legacyAnchorId":{"value":"ManageLogicalFolders-Update"}},"macroMetadata":{"macroId":{"value":"6e0dedd1-bf66-446d-850c-104bd54407f7"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"ManageLogicalFolders-Update"},"legacyAnchorId":{"value":"ManageLogicalFolders-ManageLogicalFolders-Update"}},"macroMetadata":{"macroId":{"value":"1145ff2e-1833-4dbf-8ae0-ab5ea8026101"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"text":"Update","type":"text"}]},{"type":"paragraph","content":[{"text":"Moving and renaming folders are command enclosed in the ","type":"text"},{"text":"vss-cli compute folder set","type":"text","marks":[{"type":"code"}]},{"text":" group.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Rename"},"legacyAnchorId":{"value":"ManageLogicalFolders-Rename"}},"macroMetadata":{"macroId":{"value":"17c01aa6-bdcb-44a5-8e78-2e991cb31b3c"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"ManageLogicalFolders-Rename"},"legacyAnchorId":{"value":"ManageLogicalFolders-ManageLogicalFolders-Rename"}},"macroMetadata":{"macroId":{"value":"47faf16f-74fc-47b7-a4eb-357ce3e3c66b"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"text":"Rename","type":"text"}]},{"type":"paragraph","content":[{"text":"Run ","type":"text"},{"text":"vss-cli compute folder set name ","type":"text","marks":[{"type":"code"}]},{"text":" to rename a folder. For example, the following command renames a given moref to ","type":"text"},{"text":"Prd","type":"text","marks":[{"type":"strong"}]},{"text":":","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss-cli compute folder set group-v9271 name Prd","type":"text"}]},{"type":"paragraph","content":[{"text":"Check the state of the request made by running ","type":"text"},{"text":"vss-cli request folder ls -s created_on desc -c 1","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"vss-cli request folder get ","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Move"},"legacyAnchorId":{"value":"ManageLogicalFolders-Move"}},"macroMetadata":{"macroId":{"value":"44966ca6-5178-412b-a02e-d3df1467e4be"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"ManageLogicalFolders-Move"},"legacyAnchorId":{"value":"ManageLogicalFolders-ManageLogicalFolders-Move"}},"macroMetadata":{"macroId":{"value":"95343fd7-4b85-4238-b8ed-30c927107c3f"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"text":"Move","type":"text"}]},{"type":"paragraph","content":[{"text":"To move folders run ","type":"text"},{"text":"vss-cli compute folder set parent ","type":"text","marks":[{"type":"code"}]},{"text":" where the first ","type":"text"},{"text":"name-path-moref","type":"text","marks":[{"type":"code"}]},{"text":" is the folder required to move and the ","type":"text"},{"text":"parent-name-path-moref","type":"text","marks":[{"type":"code"}]},{"text":" is the target folder to move to.","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss-cli compute folder set group-v9271 parent group-v9271","type":"text"}]},{"type":"paragraph","content":[{"text":"Check the state of the request made by running ","type":"text"},{"text":"vss-cli request folder ls -s created_on desc -c 1","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"vss-cli request folder get ","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"Remove"},"legacyAnchorId":{"value":"ManageLogicalFolders-Remove"}},"macroMetadata":{"macroId":{"value":"f4611fee-a41c-4e93-bc53-e5b5764da892"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"type":"inlineExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"anchor","parameters":{"macroParams":{"":{"value":"ManageLogicalFolders-Remove"},"legacyAnchorId":{"value":"ManageLogicalFolders-ManageLogicalFolders-Remove"}},"macroMetadata":{"macroId":{"value":"97b55f02-c703-4978-aaf7-1cf861302bc9"},"schemaVersion":{"value":"1"},"title":"Anchor"}}}},{"text":"Remove","type":"text"}]},{"type":"paragraph","content":[{"text":"To remove a new folder just run ","type":"text"},{"text":"vss-cli compute folder rm ...","type":"text","marks":[{"type":"code"}]},{"text":", for instance:","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"Folder must be empty or request will not be accepted.","type":"text"}]}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"Usage: vss-cli compute folder rm [OPTIONS] MOREF...\n\n Delete a logical folder. Folder must be empty.\n\n Options:\n -m, --max-del INTEGER RANGE Maximum items to delete [default: 3]\n --help Show this message and exit.","type":"text"}]},{"type":"paragraph","content":[{"text":"To delete multiple folders and wait for requests to complete, execute the following command:","type":"text"}]},{"type":"codeBlock","attrs":{"language":"shell"},"content":[{"text":"vss-cli --wait compute folder rm Folder1 Folder2\n\nid status task_id message\n---- --------- ------------------------------------ ----------------------------------------\n24 SUBMITTED 10f58cf5-2e57-4316-9d4a-c3609f6326d5 Request has been accepted for processing\n25 SUBMITTED 3352632e-1d29-4e82-add4-2179da37d965 Request has been accepted for processing\n\n⏳ Waiting for request 24 to complete...\n⏳ Waiting for request 25 to complete...\n\n🎉 Request 25 completed successfully:\nwarnings : Folder has been deleted\nerrors :\n🎉 Request 24 completed successfully:\nwarnings : Folder has been deleted\nerrors :","type":"text"}]},{"type":"paragraph","content":[{"text":"Check the state of the request made by running ","type":"text"},{"text":"vss-cli request folder ls -s created_on desc -c 1","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"vss-cli request folder get ","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]}],"version":1}