Changelog📝

2024.6.0 (2024-06-04)

  • #407: Methods to pass MFA totp to VPN.

  • #408: Upgrade requests to gt 2.32.0.

  • #409: Update installation docs.

  • #410: docs/publish docs to confluence cloud (VSS Public Documentation).

  • #411: CI/CD replace CI_BUILD_TAG with CI_COMMIT_TAG.

2024.5.0 (2024-05-22)

  • #401: Add get_vm_usb_xhci_devices and get_vm_usb_devices.

  • #402: Lib/Upgrade minio to 7.2.7 .

  • #403: Lib/Docs upgrade sphinxcontrib-confluencebuilder to 2.5.2.

  • #405: update const.VALID_VM_VMX with latest values.

2023.12.0 (2023-11-13)

  • #399: GPU management methods.

2023.11.0 (2023-11-16)

  • #395: CI/CD pre-commit hook updates

  • #396: Add set_vm_memory_reservation

  • #397: CI/CD moving to Token auth for test.pypi.org

2023.10.0 (2023-10-23)

  • #392: Restore VM method restore_vm.

  • #393: VM restore points improvements get_vm_restore_points.

v2023.9.0 (2023-09-27)

  • #384: Get VM GPU with get_vm_gpu.

  • #385: Get VM restore points get_vm_restore_points.

  • #386: Get Restore Requests get methods.

  • #387: Update inline vss-wiki documentation invalid links.

  • #389: Decouple stor, dev and test requirements.

  • #390: Add missing sphinxcontrib.jquery to docs/config.py.

  • #391: Update pipeline with new sphinx command: sphinx-build.

v2023.6.0 (2023-06-22)

  • #379: Deprecate Virtual Machine Remote Console (VMRC) Settings.

  • #380: CI/CD Rename Gitlab CI variable CI_BUILD_REF_NAME -> CI_COMMIT_REF_NAME.

  • #381: Manage ubuntu pro for vms.

  • #382: Get message of the day.

v2023.2.1 (2023-02-24)

  • #371: Add AUTHORS.md and AUTHORS.rst file with authors/maintainers/contributors.

  • #376: Add enable_vm_secure_boot/disable_vm_secure_boot.

  • #377: update_vm_storage_type missing kwargs.

v2023.2.0 (2023-02-16)

  • #364: Contribution doc is out of date.

  • #369: Addressing docs/changelong.rst sphinx warnings.

  • #370: Set minimal required python version to 3.7.5.

  • #372: Add methods to manage VSS Preferences.

  • #373: upgrade requests to 2.28.2.

  • #374: upgrade pyjwt to 2.6.0.

v2022.10.0 (2022-10-07)

  • #362: Add update_vm_storage_type and get_vm_storage_type.

v2022.9.0 (2022-09-27)

  • #359: Add storage_type to deployment methods.

  • #361: Support for python 3.10.

v2022.8.1 (2022-08-16)

  • #356 Method get_vm_vbs queries incorrect resource

  • #357 Add tpm to deployment methods.

v2022.8.0 (2022-08-15)

  • #353: VBS management modules: get_vm_vbs, enable_vm_vbs and disable_vm_vbs.

  • #354: Floppy management methods create_vm_floppy and delete_vm_floppies.

v2022.6.0 (2022-06-15)

  • #351: TPM management modules: get_vm_tpm, create_vm_tpm and delete_vm_tpm.

v2022.5.0 (2022-05-25)

  • #349: deploy_vm_from_clib_item support additional_parameters.

v2022.4.0 (2022-04-26)

  • #345: get_vm_disk_capacity KeyError exception.

  • #347: Cleanup unused constants.

  • #348: Update pre-commit hook black to 22.3.0.

v2022.3.1 (2022-03-24)

  • #342: Replace webdavclient with minio for vskey-stor ops.

  • #343: missing change log v2022.3.0.

v2022.3.0 (2022-03-18)

  • #338: Manage virtual machine disk notes.

  • #339: Upgrade requests to 2.27.1.

  • #340: Standardize update_vm_disk methods to use unit instead of disk arg.

v2022.2.0 (2022-02-14)

  • #336: add prune arg to delete_vm.

v2021.12.0 (2021-12-17)

  • #331: create_vm_snapshot to support with_memory parameter.

  • #332: docs/removing outdated badges.

v2021.11.2 (2021-11-29)

  • #331: Improve exception definition and handling VssError.

v2021.11.1 (2021-11-04)

  • #329: disable_totp_confirm method for completely disable mfa.

v2021.11.0 (2021-11-01)

  • #321: MFA/TOTP methods to enable, disable, request token and generate access token.

  • #322: User method to get totp settings.

  • #323: CI/Revert #317 move pipeline to local images.

  • #324: docker/update base image to local repository.

  • #325: Update stor lib webdavclient to 3.14.6.

  • #326: Update dev/test requirements.

  • #328: Drop support for python 3.6 and 3.7.

v2021.8.0 (2021-08-18)

  • #313: Deploy/Create vm methods to support complex cpu payload.

  • #314: VM/CPU set_vm_cpu to support cores_per_socket.

  • #315: Deploy VM methods to support converting to template in payload.

v2021.6.0 (2021-06-10)

  • #308: Cloning virtual machines include vmtools extra-config.

  • #309: Ignore extra_config if empty in create_vm* and deploy_vm* methods.

  • #310: Deprecate high_io in create_vm* and deploy_vm* methods.

  • #311: Update create_vm method to support new payload format for scsi.

  • #311: Update create_vms method to support new payload format for scsi.

  • #311: Update create_vm_from_image method to support new payload format for scsi.

  • #311: Update create_vm_from_clone method to support new payload format for scsi.

  • #311: Update create_vms_from_clone method to support new payload format for scsi.

  • #311: Update deploy_vm_from_template method to support new payload format for scsi.

  • #311: Update deploy_vms_from_template method to support new payload format for scsi.

v2021.5.0 (2021-05-05)

  • #304: Moving from semver to calver: Calendar versioning.

  • #305: Vm Retirement methods to manage retirement requests.

  • #306: Deploy/Create vm methods to support retirement in payload.

v0.18.1 (2021-04-08)

  • #297: Content library browsing methods.

  • #298: Fetch Virtual Machine build processes from API.

  • #299: Content library deployment method deploy_vm_from_clib_item.

  • #300: Set alternate webdav server with VSS_API_WEBDAV_SERVER env var.

  • #302: Allow snapshot_id in create_vm_from_clone and create_vms_from_clone.

v0.17.2 (2021-03-04)

  • #292: Gitlab/CI deployment on internal repo.

  • #293: get_vm_change_requests method to provide crs by VM.

  • #295: Giltab/CI Docker image missing dependency: Job Failed #39505.

  • #296: GitlabCI/Missing rust and cargo dependency to build cryptography.

v0.17.1 (2020-11-18)

  • #289: Support firmware in vm deployment methods (efi, bios).

  • #290: update_vm_firmware to update VM firmware type (efi, bios).

v0.17.0 (2020-11-16)

  • #280: GitlabCI/move docker images to local hub.eis..

  • #281: Docker/base image to local due to recent docker hub limits.

  • #282: Methods to manage vmdk files: get_user_vmdks, sync_user_vmdks, get_vmdk_sync_requests and get_vmdk_sync_request.

  • #283: Update create_vm_disk to support backing_vmdk.

  • #284: Add support for Python 3.9.

  • #285: Lib/update requests from 2.24.0 to 2.25.0.

  • #286: Update vm extra_cfg methods to support new structure.

  • #287: Update create_vm related methods to support extra_cfg new structure.

v0.16.0 (2020-10-27)

  • #273: Add validate_vm_disk_backing_sharing method.

  • #273: Add update_vm_disk_backing_sharing method.

  • #273: Add get_supported_disk_sharing method.

  • #274: Update create_vm method to support new payload format for disks.

  • #274: Update create_vms method to support new payload format for disks.

  • #274: Update create_vm_from_image method to support new payload format for disks.

  • #274: Update create_vm_from_clone method to support new payload format for disks.

  • #274: Update create_vms_from_clone method to support new payload format for disks.

  • #274: Update deploy_vm_from_template method to support new payload format for disks.

  • #274: Update deploy_vms_from_template method to support new payload format for disks.

  • #275: Add update_vm_scsi_device_sharing method.

  • #275: Add get_supported_scsi_sharing method.

  • #275: Add validate_vm_scsi_controller_sharing method.

  • #275: Update validate_vm_scsi_controller_sharing method.

  • #276: Update create_vm_scsi_device to support new payload for scsi controllers.

  • #276: Update validate_scsi_controllers to support new payload for scsi controllers.

  • #277: Fix docstirng issues in pyvss.manager.VssManager issues.

  • #278: Fix black pre-commit hook issue.

v0.15.1 (2020-09-25)

  • #271: add delete_vm_template method.

v0.15.0 (2020-08-04)

  • #266: Add dry_run flag to verify payload, url and headers to be sent to the API.

  • #267: Adding/Updating pre-commit hooks.

  • #268: Compliance with flake8-docstrings.

  • #269: libs/update requests from 2.23.0 to 2.24.0.

v0.14.4 (2020-06-04)

  • #259:get_vm_memory throws exception

  • #260: libs/update requests to latest from 2.21.0 to 2.23.0

  • #262: get_user_groups update to latest api changes.

  • #263: get_group, get_group_members methods recently added to api.

  • #265: docker image broken due to missing dependency (man) in alpine.

v0.14.2 (2020-05-06)

  • #257: is_powered_on_vm and is_powered_off_vm do not look for vm properly

v0.14.1 (2020-04-27)

  • #255: add migrate_vm_vss_ha_group method to migrate uuid based to moref based

v0.14.0 (2020-04-24)

  • #252: Method get_vm_vsphere_link to get vsphere client direct link to vm

  • #253: Rename param uuid to vm_id in order to support both uuid and moref (breaking change)

v0.13.1 (2020-04-09)

  • #250: Set consolidate to True by default in create_vm_snapshot

  • #249: Add power_on argument to create_vm, create_vm_from_clone, deploy_vm_from_template, create_vm_from_image

v0.13.0 (2020-02-05)

  • #243: Add suspend to update_vm_state

  • #244: Add get_supported_vss_options to provide supported options

  • #245: Fix README/docs build image broken link

  • #246: Add suspend_vm

  • #247: Implement wheels packaging

v0.12.1 (2020-01-30)

  • #239: get_vm_scsi_devices KeyError ‘_links’ exception

  • #240: get_vm_controllers KeyError scsi exception when no device is found

  • #241: get_vm_scsi_device KeyError exception when no device is found

v0.12.0 (2020-01-23)

  • #233: create_vm_snapshot to support consolidate parameter

  • #234: Add method delete_vm_vss_ha_group

  • #235: Drop support for python 2.7

  • #236: Add support for python 3.8

  • #238: GitlabCI/release dist step fails due to missing os requirement

v0.11.0 (2019-11-14)

  • #231: get_vm_disk_capacity get disk capacity in gb

  • #230: needs_consolidation check if vm requires disk consolidation

  • #229: update_vm_disk_capacity validate if vm needs consolidation and size gt target /

  • #228: Replace bill_dept with client attribute when deploying a VM.

  • #227: validate_vm_vmx_version throws exception

v0.10.0 (2019-11-08)

  • #224: extend_snapshot_request does not work properly

  • #225: add vscode exceptions to .gitignore

v0.9.43 (2019-10-24)

  • #216: methods to enable/disable Copy/Paste between VMRC client and vm

  • #217: missing kwargs in methods enable** disable**

  • #218: rename_vm docstring typo

  • #219: update webdavclient3 to v0.12

  • #220: core/webdavclient dependency moved to extras

  • #221: methods to get vmx versions from api and validate

  • #223: update get_domain, get_domains and get_vms_by_domain

v0.9.42 (2019-10-11)

  • #210: Add get_supported_scsi_controllers and validate_vm_scsi_controller_type

  • #211: Add get_supported_disk_backing_modes and validate_vm_disk_backing_mode

  • #212: Add repr method to VssManager class

  • #213: Add create_vms_from_clone to deploy multiple vms from a virtual machine

  • #214: Update create_vms_from_clone rename arg source_vm to source

v0.9.41 (2019-09-18)

  • #203: Update create_vm_nic to support adapter type in payload

  • #204: Update get_os method to handle properly api resource

  • #205: Update update_vm_nic_type to validate supported nics

  • #206: Update docstrings and code to support snake_case implementation

  • #207: Support new network adapter payload in create_vm methods

  • #208: Update create_inventory_file to support new transfer attribute in payload

v0.9.40 (2019-09-03)

  • #201: Image management method improvements

  • #198: CI/Check in version and git SHA on VSS API

v0.9.39 (2019-08-13)

  • #199: missing get_template method

  • #197: adding changelog to documentation

v0.9.38 (2019-07-25)

  • #195: methods to query by hostname, ip address and name

  • #194: update method get_vms to support filtering and sorting

  • #193: update vm disk backing mode

v0.9.36 (2019-07-18)

  • #191: error when updating floppy update_vm_floppy

  • #190: update VM disk SCSI controller

  • #189: rename VM SCSI methods

  • #188: add VM SCSI management methods

  • #187: add get_folder_children to get children objects of a given folder

  • #186: update method get_folders, get_vms_by_folder to support filtering and sorting

v0.9.35 (2019-07-09)

  • #184: update method get_networks, get_vms_by_network to support filtering and sorting

v0.9.34 (2019-06-25)

  • #182: create_vm_cd methods to add cd/dvd units to vm

v0.9.33 (2019-05-24)

  • #180 update_vm_cd validates iso path incorrectly

v0.9.32 (2019-05-14)

  • #179 get_vm_console does not send query params needed to generate the link

v0.9.31 (2019-05-13)

  • #173 Ci/Pipeline improvements

  • #175 docker/docs update documentation with a single image

  • #176 extra-config in create vm methods

  • #177 get_vm_console to take client param to specify whether to generate a flash, html5 or vmrc URL

  • #172 Documentation Improvement: Add vss-service info to py-vss main docs

  • #174 vm/extra-config methods

v0.9.30 (2019-03-30)

  • #165 core/adopting vss-cli project structure

  • #167 ci/update build_pages job to implement python setup.py build_sphinx

  • #168 ci/gitlab-ci issue template updates

  • #169 core/improving python workflow using pre-commits

  • #170 core/add enums34 for python2.7 installs

v0.9.29 (2019-03-26)

  • #163 Expose request.timeout setting as VSS_API_TIMEOUT

  • #164 VSS Service methods

v0.9.28 (2019-02-08)

  • #161 get_inventory_properties to List available inventory properties

  • #160 Replace webdavclient with webdavclient3

v0.9.27 (2018-01-25)

  • #158 Methods to manage VSS options

  • #159 Include filters in create inventory report

v0.9.26 (2018-12-07)

  • #157 VssManager code improvements

  • #156 VM/Controller resource list

  • #155 docker image issue when removing library

v0.9.25 (2018-09-28)

  • #152 download_inventory_result fails when no file has been created

  • #153 Update requests module to 2.19.1

  • #155 docker image issue when pulling

v0.9.24 (2018-07-27)

  • #147 Rename docker/2.7 to docker/2 and docker/3.6 to docker/3

  • #148 Set Default Docker image to python 3 instead of python 2

  • #149 get_token throws 404 error

  • #151 Update gitlab issue template VersionRelease.md

v0.9.23 (2018-07-20)

  • #145 Add methods to manage user ssh-keys

v0.9.22 (2018-07-09)

  • #143 Update create_inventory_file and remove uuid, name properties since they are no longer needed

  • #142 Expose new disk backing as get_vm_disk_backing

v0.9.21 (2018-06-01)

  • #139 Implement bumb2version to handle version management and update in multiple files

  • #140 Implement delete folder method

v0.9.20 (2018-05-22)

  • #135 Exception thrown when call update_user_request_notification_settings

  • #136 enable_user_message_digest and disable_user_message_digest are not working properly

  • #137 Missing get_user_message_digest method in class

v0.9.18 (2018-05-18)

  • #132 Add/Update User notification and digest settings

  • #128 Upgrade docker/2.7 image to python 2.7.15

  • #134 Changelog improvements: add release date

v0.9.17 (2018-05-04)

  • #125 Use twine to deploy to PyPI

  • #126 Decommission python 3.5 Image

  • #127 Update update_vm_cd to improve usability

  • #129 Upgrade docker/3.6 image to python 3.6.5

  • #131 Remove docker/3.5/Dockerfile from gitlab issue template version release

v0.9.16 (2018-04-27)

  • #122 Update Repository documentation from RST to MD

  • #124 Update User email settings to enable submission and completion

v0.9.15 (2018-04-20)

  • #117 Update VM memory hot add setting

  • #116 Update VM cpu hot add/remove setting

  • #119 Update User email settings to enable/disable digests

  • #121 Update PyPI package metadata

v0.9.13 (2018-04-13)

  • #113 VMX updates update_vm_version and update_vm_version_policy

v0.9.12 (2018-03-29)

  • #111 Error installing on environments where Python 3 thinks are restricted to ASCII data

v0.9.11 (2018-02-28)

  • #108 Expose API user message methods

  • #110 manager._get_objects fails when empty data body is returned

v0.9.10 (2018-02-22)

  • #106 User Agent structure improvements #106

v0.9.9 (2018-02-09)

  • #103 Re-Branding EIS Virtual Cloud to ITS Private Cloud

  • #104 Update docker/3.5 image to 3.5.5

v0.9.8 (2018-02-02)

  • #98 Method reboot_vm invalid return attribute

  • #99 Update Python 3.6 Docker image to 3.6.4

  • #100 Add GitLab issue templates

  • #101 Handle authentication credentials in get_vm_console

  • #102 Add get_vm_guest to obtain guest os attributes

v0.9.7.1 (2018-01-26)

  • #89 Update create_vm_nic to support multiple NIC creation

  • #93 Update create_vm_disk to support multiple Disk creation

  • #90 Doc/Reference update VSS Wiki links

  • #91 Update requests module to 2.18.4

  • #92 Warnings when building documentation

  • #96 New method to delete multiple disks

  • #95 New method to delete multiple NICs

  • #97 request_v2 DELETE method do not send a valid payload

v0.9.6 (2017-11-28)

  • Docker: Remove Maintainer from Dockerfile since it’s been deprecated #88

  • CI: Replace PEP8 python library with Pycodestyle #87

  • get_images lists public ISOs instead of VM images #86

  • Reprocess failed new and change requests #85

v0.9.5 (2017-11-20)

  • Sort for folders and networks #84

  • Methods to manage ImageSyncRequests: sync personal image store #83

  • Adapt new personal and global image stores: advanced sorting and filtering #82

  • Dump response headers if an exception occurs: debug flag for troubleshooting #81

v0.9.4 (2017-10-25)

  • Create virtual nic without unit #80

  • Create virtual disk without unit #79

  • VM sorting query string parameters #78

  • ISO/Image/Floppy filter and sorting query string parameters #77

  • GitLab CI general improvements for build optimization #76

v0.9.3 (2017-10-12)

  • New customization specification improvements #74

v0.9.2 (2017-10-11)

  • New customization specification is introduced in version 3.2 of the RESTful API #73

  • CI deploy docs to eis.utoronto.ca/~vss/pyvss #72

v0.9.1 (2017-10-04)

  • Update Docker images with latest python version #71

v0.9.0 (2017-09-14)

  • get_vm_vss_description & update_vm_vss_description to get and set vm description #69

  • get_vm_notes & update_vm_notes to get and set vm client custom notes #70

v0.8.8 (2017-07-21)

  • get_vm_vss_client & update_vm_vss_client to obtain and set vm client #67

  • support for different endpoints #68

v0.8.7 (2017-04-20)

  • Compatibility issues between python versions #66

  • Relative import error in python 3 #65

  • Handle properly unicode in authentication credentials #64

v0.8.6 (2017-03-31)

  • get_user_group to obtain user group info and members #63

v0.8.5 (2017-03-25)

  • Error cloning virtual machine create_vm_from_clone #62

v0.8.4 (2017-03-17)

  • get_vm_alarm to obtain given alarm info #61

  • extend_snapshot_request does not return a valid object #60

v0.8.3 (2017-03-07)

  • Download inventory file from API #56

  • Improvements in processing responses #57

v0.8.2 (2017-02-23)

  • New method deploy_vm_from_template allow individual specification #54

  • GetToken method generates token based on env vars and user/pass params #50

  • create_vms_from_template renamed to deploy_vms_from_template #55

  • 5xx errors from API need to be properly handled #49

  • create_vms_from_templates adds suffix _n if one vm is deployed #52

v0.8.1 (2017-02-13)

  • New virtual machine request method exposing new attribute meta_data #44

  • New virtual machine request method exposing new attribute custom_spec #45

  • New virtual machine request method exposing new attribute user_data #46

  • Create virtual machine custom spec for guest os reconfiguration #47

  • Documentation improvements

  • Install instructions from source should let users know public key is required when cloning via ssh #43

  • Executing manager.py throws import error #48

v0.8.0 (2017-02-06)

  • Display permissions in objects #31

  • Upgrade Docker images to latest python #32

  • Extend and improve create_vm method #35

  • Display HA group of a given VM #38

  • Manage VM VSS HA Group #39

  • Guest OS Customization Specification #41

  • Get Operating System method improvements #29

  • VM updating custom notes payload #30

  • Update backend URL to https://vss-api.eis.utoronto.ca #34

  • pyvss.exceptions.VssError does not provide any feedback but the status code #36

  • PATCH method not supported error in revert_vm_snapshot #40

v0.7.1 (2017-01-02)

  • Implement Bearer Authorization Header #28

  • Error when renaming vm #27

v0.7 (2016-12-07)

  • Delete VM method check for power state != on #26

  • Remove webdav client dependency #24

  • Method not supported update_vm_vss_admin #25

  • Usage parameter is ignored in create_vm, create_vms and create_vm_from_image #23

v0.6.1 (2016-11-16)

  • User resource methods #16

  • Virtual Machine floppy management #18

  • Get available Floppy images #19

  • Helper method to hash strings using SHA-512 #22

  • Docker Image build and deployed to internal registry #15

  • Docker Image build for python 2.7 and 3.5 #17

  • Documentation theme and contents updated #21

  • Helper methods not working properly on python3 #20

v0.5 (2016-10-31)

  • Querying Request management with pagination #14

  • Method to update change request scheduled #12

  • Module to interact with VSKEY-STOR from within PyVSS #11

  • New method to extend snapshots for a given number of hours. #10

  • Add helper module to store support functions #9

  • Add get extra_config method #8

  • Get user tokens improvements #13

University of Toronto - Since 1827