hammer_cli_foreman 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d9e0a20cb5bb0c548422b81c51845d180f0248a5
-  data.tar.gz: dd3d176d20d93db8fc965b34d3c3aff90e83a575
+  metadata.gz: c487f375a9d6eec9d6b9fc03c382fe8dba041d28
+  data.tar.gz: 4f313e829274ca36c57522c9094fc9b37c2e8c13
 SHA512:
-  metadata.gz: 0d7109efe44db2a67b8795a6914a9d518040eb8d8bb7f9c068c72382e3a3447fe43e82d1a1a154c585414378dfb56e988618c2895fe1b471d36614242ddbf2e2
-  data.tar.gz: 8eed5877f859165ee08e64275401c217f085ceb1d9794c32cc5f6eb5229818479f76c223efed758bc00e86c69ad19989432808091d8d6f274b4cdce03a68014e
+  metadata.gz: 39d9cd46059539b650189d50196dcb08e2a1a77aecb292ab8d4e4f97c34a0738a5e403b14c6bc95e7e0f6b9a4197152612467118fbc43159df2d94826d9bf9a3
+  data.tar.gz: cb773aba24bfcbe45dd4ec9420855f569c1dcab84e80ef72eb7951a8abacfa12700d8fd49a8a06344ebaa5a35738970c6fcab4680a6e0b64e2748b1fddaa782a

data/doc/host_create.md

@@ -7,7 +7,7 @@ is obvious but there are some that need further explanation as their values diff
 **Warning:**
 Output of `hammer host create -h` may vary with the Foreman server used and plugins installed.
 
-Sample help output for `hammer-cli-foreman 0.2.0` and `Foreman 1.8` follows:
+Sample help output for `hammer-cli-foreman 0.15.0` and `Foreman 1.20` follows:
 
 ```
 $ hammer host create -h
@@ -15,71 +15,103 @@ Usage:
     hammer host create [OPTIONS]
 
 Options:
- --architecture ARCHITECTURE_NAME          Architecture name
- --architecture-id ARCHITECTURE_ID
- --ask-root-password ASK_ROOT_PW           One of true/false, yes/no, 1/0.
- --build BUILD                             One of true/false, yes/no, 1/0.
-                                           Default: "true"
- --comment COMMENT                         Additional information about this host
- --compute-attributes COMPUTE_ATTRS        Compute resource attributes.
-                                           Comma-separated list of key=value.
- --compute-profile COMPUTE_PROFILE_NAME    Name to search by
- --compute-profile-id COMPUTE_PROFILE_ID
- --compute-resource COMPUTE_RESOURCE_NAME  Compute resource name
- --compute-resource-id COMPUTE_RESOURCE_ID
- --domain DOMAIN_NAME                      Domain name
- --domain-id DOMAIN_ID                     Numerical ID or domain name
- --enabled ENABLED                         One of true/false, yes/no, 1/0.
-                                           Default: "true"
- --environment ENVIRONMENT_NAME            Environment name
- --environment-id ENVIRONMENT_ID
- --hostgroup HOSTGROUP_NAME                Hostgroup name
- --hostgroup-id HOSTGROUP_ID
- --hostgroup-title HOSTGROUP_TITLE         Hostgroup title
- --image IMAGE_NAME                        Name to search by
- --image-id IMAGE_ID
- --interface INTERFACE                     Interface parameters.
-                                           Comma-separated list of key=value.
-                                           Can be specified multiple times.
- --ip IP                                   not required if using a subnet with DHCP proxy
- --location LOCATION_NAME                  Location name
- --location-id LOCATION_ID
- --mac MAC                                 required for managed host that is bare metal, not required if it’s a virtual machine
- --managed MANAGED                         One of true/false, yes/no, 1/0.
-                                           Default: "true"
- --medium MEDIUM_NAME                      Medium name
- --medium-id MEDIUM_ID
- --model MODEL_NAME                        Model name
- --model-id MODEL_ID
- --name NAME
- --operatingsystem OPERATINGSYSTEM_TITLE   Operating system title
- --operatingsystem-id OPERATINGSYSTEM_ID
- --organization ORGANIZATION_NAME          Organization name
- --organization-id ORGANIZATION_ID
- --owner OWNER_LOGIN                       Login of the owner
- --owner-id OWNER_ID                       ID of the owner
- --owner-type OWNER_TYPE                   Host’s owner type
- --parameters PARAMS                       Host parameters.
-                                           Comma-separated list of key=value.
- --partition-table PARTITION_TABLE_NAME    Partition table name
- --partition-table-id PARTITION_TABLE_ID
- --progress-report-id PROGRESS_REPORT_ID   UUID to track orchestration tasks status, GET /api/orchestration/:UUID/tasks
- --provision-method METHOD                 One of 'build', 'image'
- --puppet-ca-proxy PUPPET_CA_PROXY_NAME
- --puppet-ca-proxy-id PUPPET_CA_PROXY_ID
- --puppet-class-ids PUPPET_CLASS_IDS       Comma separated list of values.
- --puppet-classes PUPPET_CLASS_NAMES       Comma separated list of values.
- --puppet-proxy PUPPET_PROXY_NAME
- --puppet-proxy-id PUPPET_PROXY_ID
- --realm REALM_NAME                        Name to search by
- --realm-id REALM_ID                       Numerical ID or realm name
- --root-password ROOT_PW                   required if host is managed and value is not inherited from host group or default password in settings
- --subnet SUBNET_NAME                      Subnet name
- --subnet-id SUBNET_ID
- --volume VOLUME                           Volume parameters
-                                           Comma-separated list of key=value.
-                                           Can be specified multiple times.
- -h, --help                                print help
+ --architecture ARCHITECTURE_NAME                              Architecture name
+ --architecture-id ARCHITECTURE_ID                              
+ --ask-root-password ASK_ROOT_PW                               One of true/false, yes/no, 1/0.
+ --autoheal AUTOHEAL                                           Sets whether the Host will autoheal subscriptions upon checkin
+                                                               One of true/false, yes/no, 1/0.
+ --build BUILD                                                 One of true/false, yes/no, 1/0.
+ --comment COMMENT                                             Additional information about this host
+ --compute-attributes COMPUTE_ATTRS                            Compute resource attributes
+                                                               Comma-separated list of key=value
+ --compute-profile COMPUTE_PROFILE_NAME                        Name to search by
+ --compute-profile-id COMPUTE_PROFILE_ID                        
+ --compute-resource COMPUTE_RESOURCE_NAME                      Compute resource name
+ --compute-resource-id COMPUTE_RESOURCE_ID                      
+ --config-group-ids CONFIG_GROUP_IDS                           IDs of associated config groups
+                                                               Comma separated list of values. Values containing comma should be quoted or escaped with backslash
+ --config-groups CONFIG_GROUP_NAMES                            Comma separated list of values. Values containing comma should be quoted or escaped with backslash
+ --content-source CONTENT_SOURCE_NAME                          Content Source name
+ --content-source-id CONTENT_SOURCE_ID                          
+ --content-view CONTENT_VIEW_NAME                              Name to search by
+ --content-view-id CONTENT_VIEW_ID                             Content view numeric identifier
+ --domain DOMAIN_NAME                                          Domain name
+ --domain-id DOMAIN_ID                                         Numerical ID or domain name
+ --enabled ENABLED                                             Include this host within Foreman reporting
+                                                               One of true/false, yes/no, 1/0.
+ --environment ENVIRONMENT_NAME                                Environment name
+ --environment-id ENVIRONMENT_ID                                
+ --hostgroup HOSTGROUP_NAME                                    Hostgroup name
+ --hostgroup-id HOSTGROUP_ID                                    
+ --hostgroup-title HOSTGROUP_TITLE                             Hostgroup title
+ --hypervisor-guest-uuids HYPERVISOR_GUEST_UUIDS               List of hypervisor guest uuids
+                                                               Comma separated list of values. Values containing comma should be quoted or escaped with backslash
+ --image IMAGE_NAME                                            Name to search by
+ --image-id IMAGE_ID                                            
+ --installed-products-attributes INSTALLED_PRODUCTS_ATTRIBUTES List of products installed on the host
+                                                               Comma separated list of values. Values containing comma should be quoted or escaped with backslash
+ --interface INTERFACE                                         Interface parameters
+                                                               Comma-separated list of key=value
+                                                               Can be specified multiple times.
+ --ip IP                                                       Not required if using a subnet with DHCP proxy
+ --kickstart-repository REPOSITORY_NAME                        Kickstart repository name
+ --kickstart-repository-id KICKSTART_REPOSITORY_ID             Repository Id associated with the kickstart repo used for provisioning
+ --lifecycle-environment LIFECYCLE_ENVIRONMENT_NAME            Name to search by
+ --lifecycle-environment-id LIFECYCLE_ENVIRONMENT_ID           ID of the environment
+ --location LOCATION_NAME                                      Location name
+ --location-id LOCATION_ID                                      
+ --location-title LOCATION_TITLE                               Location title
+ --mac MAC                                                     Required for managed host that is bare metal, not required if it's a
+                                                               Virtual machine
+ --managed MANAGED                                             True/False flag whether a host is managed or unmanaged. Note: this value
+                                                               Also determines whether several parameters are required or not
+                                                               One of true/false, yes/no, 1/0.
+ --medium MEDIUM_NAME                                          Medium name
+ --medium-id MEDIUM_ID                                          
+ --model MODEL_NAME                                            Model name
+ --model-id MODEL_ID                                            
+ --name NAME                                                    
+ --operatingsystem OPERATINGSYSTEM_TITLE                       Operating system title
+ --operatingsystem-id OPERATINGSYSTEM_ID                        
+ --organization ORGANIZATION_NAME                              Organization name
+ --organization-id ORGANIZATION_ID                             Organization ID
+ --organization-title ORGANIZATION_TITLE                       Organization title
+ --overwrite OVERWRITE                                         One of true/false, yes/no, 1/0.
+                                                               Default: "true"
+ --owner OWNER_LOGIN                                           Login of the owner
+ --owner-id OWNER_ID                                           ID of the owner
+ --owner-type OWNER_TYPE                                       Host's owner type
+                                                               Possible value(s): 'User', 'Usergroup'
+ --parameters PARAMS                                           Host parameters
+                                                               Comma-separated list of key=value
+ --partition-table PARTITION_TABLE_NAME                        Partition table name
+ --partition-table-id PARTITION_TABLE_ID                        
+ --product PRODUCT_NAME                                        Name to search by
+ --product-id PRODUCT_ID                                       Product numeric identifier
+ --progress-report-id PROGRESS_REPORT_ID                       UUID to track orchestration tasks status, GET
+                                                               /api/orchestration/:UUID/tasks
+ --provision-method PROVISION_METHOD                           The method used to provision the host.
+                                                               Possible value(s): 'build', 'image'
+ --puppet-ca-proxy PUPPET_CA_PROXY_NAME                         
+ --puppet-ca-proxy-id PUPPET_CA_PROXY_ID                       Puppet CA proxy ID
+ --puppet-class-ids PUPPET_CLASS_IDS                           Comma separated list of values. Values containing comma should be quoted or escaped with backslash
+ --puppet-classes PUPPET_CLASS_NAMES                           Comma separated list of values. Values containing comma should be quoted or escaped with backslash
+ --puppet-proxy PUPPET_PROXY_NAME                               
+ --puppet-proxy-id PUPPET_PROXY_ID                             Puppet proxy ID
+ --pxe-loader PXE_LOADER                                       DHCP filename option (Grub2/PXELinux by default)
+                                                               Possible value(s): 'None', 'PXELinux BIOS', 'PXELinux UEFI', 'Grub UEFI', 'Grub2 UEFI', 'Grub2 UEFI SecureBoot', 'Grub2 UEFI HTTP', 'Grub2 UEFI HTTPS', 'Grub2 UEFI HTTPS SecureBoot', 'iPXE Embedded', 'iPXE UEFI HTTP', 'iPXE Chain BIOS', 'iPXE Chain UEFI'
+ --realm REALM_NAME                                            Name to search by
+ --realm-id REALM_ID                                           Numerical ID or realm name
+ --release-version RELEASE_VERSION                             Release version for this Host to use (7Server, 7.1, etc)
+ --root-password ROOT_PW                                       Required if host is managed and value is not inherited from host group or default password in settings
+ --service-level SERVICE_LEVEL                                 Service level to be used for autoheal
+ --subnet SUBNET_NAME                                          Subnet name
+ --subnet-id SUBNET_ID                                          
+ --volume VOLUME                                               Volume parameters
+                                                               Comma-separated list of key=value
+                                                               Can be specified multiple times.
+ -h, --help                                                    Print help
+
 ```
 
 Example
@@ -223,38 +255,41 @@ image_id
 ## VMware
 Available keys for `--compute-attributes`:
 ```
-cpus                 # cpu count
-corespersocket       # number of cores per socket
-                     # (applicable to hardware versions < 10 only)
-memory_mb            # integer number
-cluster              # cluster id from VMware
-path                 # path to folder
-guest_id             # guest OS id form VMware
-scsi_controller_type # id of the controller from VMware
-hardware_version     # hardware version id from VMware
-start                # Boolean, expressed as 0 or 1, whether to start the machine or not
+cpus                  CPU count
+corespersocket        Number of cores per socket (applicable to hardware versions < 10 only)
+memory_mb             Integer number, amount of memory in MB
+firmware              automatic/bios/efi
+cluster               Cluster ID from VMware
+resource_pool         Resource Pool ID from VMware
+path                  Path to folder
+guest_id              Guest OS ID form VMware
+scsi_controller_type  ID of the controller from VMware
+hardware_version      Hardware version ID from VMware
+add_cdrom             Must be a 1 or 0, Add a CD-ROM drive to the virtual machine
+cpuHotAddEnabled      Must be a 1 or 0, lets you add memory resources while the machine is on
+memoryHotAddEnabled   Must be a 1 or 0, lets you add CPU resources while the machine is on
+start                 Must be a 1 or 0, whether to start the machine or not
+annotation            Annotation Notes
 ```
 
 Available keys for `--interface`:
 ```
 compute_type      # Type of the network adapter, for example one of:
-                  #   VirtualVmxnet
-                  #   VirtualVmxnet2
                   #   VirtualVmxnet3
                   #   VirtualE1000
-                  #   VirtualE1000e
-                  #   VirtualPCNet32
                   # See documentation center for your version of vSphere to find
                   # more details about available adapter types:
                   # https://www.vmware.com/support/pubs/
-compute_network   # network id from VMware
+compute_network   # network ID from VMware
 ```
 
 Available keys for `--volume`:
 ```
-datastore  # datastore id from VMware
 name
-size_gb    # integer number
-thin       # true/false
-eager_zero # true/false
+storage_pod         Storage Pod ID from VMware
+datastore           Datastore ID from VMware
+size_gb             Integer number, volume size in GB
+thin                true/false
+eager_zero          true/false
+mode                persistent/independent_persistent/independent_nonpersistent
 ```

data/doc/release_notes.md

@@ -1,5 +1,17 @@
 Release notes
 =============
+### 0.15.0 (2018-10-24)
+* Use SPDX 2.0 codes
+* Provides a way of listing compute attribute values ([#3651](http://projects.theforeman.org/issues/3651))
+* Foreman CLI command for BMC boot commands ([#24099](http://projects.theforeman.org/issues/24099))
+* Update VMware helpers and host create page ([#25192](http://projects.theforeman.org/issues/25192))
+* Enable structured formatters for refernces. ([#24980](http://projects.theforeman.org/issues/24980))
+* Correct homepage and license in the gemspec
+* Display Host Status in Hammer ([#20187](http://projects.theforeman.org/issues/20187))
+* Subnet create/update should accept proxy names ([#20609](http://projects.theforeman.org/issues/20609))
+* Add Cluster option to Hammer CR. ([#24748](http://projects.theforeman.org/issues/24748))
+* Retain data while host update in hammer ([#20725](http://projects.theforeman.org/issues/20725))
+
 ### 0.14.0 (2018-08-27)
 * Add template combinations commands ([#3969](http://projects.theforeman.org/issues/3969))
 * Fix and extend tests for user update ([#23996](http://projects.theforeman.org/issues/23996))

data/lib/hammer_cli_foreman/compute_resource.rb

@@ -108,29 +108,124 @@ module HammerCLIForeman
       build_options
     end
 
-    class AvailableNetworksCommand < HammerCLIForeman::ListCommand
+    class AvailableClustersCommand < HammerCLIForeman::ListCommand
+      action :available_clusters
+      command_name 'clusters'
+
+      output do
+        field :id, _('Id')
+        field :name, _('Name')
+      end
 
-      resource :compute_resources, :available_networks
+      build_options
+    end
+
+    class AvailableNetworksCommand < HammerCLIForeman::ListCommand
+      action :available_networks
       command_name 'networks'
-      desc _("Show available networks")
+
+      output do
+        field :id, _('Id')
+        field :name, _('Name')
+      end
 
       build_options
+    end
 
-      validate_options do
-        any(:option_id, :option_name).required
+    class AvailableImagesCommand < HammerCLIForeman::ListCommand
+      action :available_images
+      command_name 'images'
+
+      output do
+        field :id, _('Id')
+        field :name, _('Name')
       end
 
-      def request_params
-        params = super
-        params['id'] ||= get_identifier
-        params
+      build_options
+    end
+
+    class AvailableFlavorsCommand < HammerCLIForeman::ListCommand
+      action :available_flavors
+      command_name 'flavors'
+
+      output do
+        field :id, _('Id')
+        field :name, _('Name')
       end
 
+      build_options
+    end
+
+    class AvailableFoldersCommand < HammerCLIForeman::ListCommand
+      action :available_folders
+      command_name 'folders'
+
       output do
-        field :name, _("Name")
-        field :id, _("Id")
+        field :id, _('Id')
+        field :name, _('Name')
+      end
+
+      build_options
+    end
+
+    class AvailableZonesCommand < HammerCLIForeman::ListCommand
+      action :available_zones
+      command_name 'zones'
+
+      output do
+        field :id, _('Id')
+        field :name, _('Name')
+      end
+
+      build_options
+    end
+
+    class AvailableResourcePoolsCommand < HammerCLIForeman::ListCommand
+      action :available_resource_pools
+      command_name 'resource-pools'
+
+      output do
+        field :id, _('Id')
+        field :name, _('Name')
+      end
+
+      build_options
+    end
+
+    class AvailableStorageDomainsCommand < HammerCLIForeman::ListCommand
+      action :available_storage_domains
+      command_name 'storage-domains'
+
+      output do
+        field :id, _('Id')
+        field :name, _('Name')
       end
 
+      build_options
+    end
+
+    class AvailableStoragePodsCommand < HammerCLIForeman::ListCommand
+      action :available_storage_pods
+      command_name 'storage-pods'
+
+      output do
+        field :id, _('Id')
+        field :name, _('Name')
+      end
+
+      build_options
+    end
+
+    class AvailableSecurityGroupsCommand < HammerCLIForeman::ListCommand
+      action :available_security_groups
+      command_name 'security-groups'
+
+      output do
+        field :id, _('Id')
+        field :name, _('Name')
+      end
+
+      build_options
     end
 
     autoload_subcommands

data/lib/hammer_cli_foreman/compute_resources/vmware/host_help_extenstion.rb

@@ -3,45 +3,49 @@ module HammerCLIForeman
     module VMware
       class HostHelpExtenstion
         INTERFACE_TYPES = %w(
-          VirtualVmxnet,
-          VirtualVmxnet2,
           VirtualVmxnet3,
-          VirtualE1000,
-          VirtualE1000e,
-          VirtualPCNet32
+          VirtualE1000
         )
 
         def name
-          _('VMWare')
+          _('VMware')
         end
 
         def host_create_help(h)
           h.section '--compute-attributes' do |h|
             h.list([
-              ['cpus',                 _("Cpu count")],
-              ['corespersocket',       _("Number of cores per socket (applicable to hardware versions < 10 only)")],
-              ['memory_mb',            _("Integer number, amount of memory in MB")],
-              ['cluster',              _("Cluster id from VMware")],
-              ['path',                 _("Path to folder")],
-              ['guest_id',             _("Guest OS id form VMware")],
-              ['scsi_controller_type', _("Id of the controller from VMware")],
-              ['hardware_version',     _("Hardware version id from VMware")],
-              ['start',                _("Must be a 1 or 0, whether to start the machine or not")]
+              ['cpus',                 _('CPU count')],
+              ['corespersocket',       _('Number of cores per socket (applicable to hardware versions < 10 only)')],
+              ['memory_mb',            _('Integer number, amount of memory in MB')],
+              ['firmware',             'automatic/bios/efi'],
+              ['cluster',              _('Cluster ID from VMware')],
+              ['resource_pool',        _('Resource Pool ID from VMware')],
+              ['path',                 _('Path to folder')],
+              ['guest_id',             _('Guest OS ID form VMware')],
+              ['scsi_controller_type', _('ID of the controller from VMware')],
+              ['hardware_version',     _('Hardware version ID from VMware')],
+              ['add_cdrom',            _('Must be a 1 or 0, Add a CD-ROM drive to the virtual machine')],
+              ['cpuHotAddEnabled',     _('Must be a 1 or 0, lets you add memory resources while the machine is on')],
+              ['memoryHotAddEnabled',  _('Must be a 1 or 0, lets you add CPU resources while the machine is on')],
+              ['start',                _("Must be a 1 or 0, whether to start the machine or not")],
+              ['annotation',           _("Annotation Notes")]
             ])
           end
           h.section '--interface' do |h|
             h.list([
               ['compute_type', interface_type_description(h)],
-              ['compute_network', _('Network id from VMware')]
+              ['compute_network', _('Network ID from VMware')]
             ])
           end
           h.section '--volume' do |h|
             h.list([
               ['name'],
-              ['datastore',  _('Datastore id from VMware')],
-              ['size_gb',    _('Integer number, volume size in GB')],
-              ['thin',       'true/false'],
-              ['eager_zero', 'true/false']
+              ['storage_pod', _('Storage Pod ID from VMware')],
+              ['datastore',   _('Datastore ID from VMware')],
+              ['size_gb',     _('Integer number, volume size in GB')],
+              ['thin',        'true/false'],
+              ['eager_zero',  'true/false'],
+              ['mode',        'persistent/independent_persistent/independent_nonpersistent']
             ])
           end
         end
@@ -53,7 +57,7 @@ module HammerCLIForeman
             _('Type of the network adapter, for example one of:'),
             h.indent(INTERFACE_TYPES),
             _("See documentation center for your version of vSphere to find more details about available adapter types:"),
-            h.indent("https://www.vmware.com/support/pubs/")
+            h.indent('https://www.vmware.com/support/pubs/')
           ].join("\n")
         end
       end