openstack-manuals/doc/common/tables/cinder-conf-changes-icehouse.xml

<?xml version='1.0' encoding='UTF-8'?>
<section xmlns="http://docbook.org/ns/docbook" version="5.0" xml:id="cinder-conf-changes-icehouse">
  <!-- Warning: Do not edit this file. It is automatically generated and your changes will be overwritten. The tool to do so lives in the openstack-doc-tools repository. -->
  <title>New, updated and deprecated options for cinder</title>
  <table>
    <caption>New options</caption>
    <col width="50%"/>
    <col width="50%"/>
    <thead>
      <tr>
        <td>Option = default value</td>
        <td>(Type) Help string</td>
      </tr>
    </thead>
    <tr>
      <td>[DEFAULT] allocated_capacity_weight_multiplier = -1.0</td>
      <td>(FloatOpt) Multiplier used for weighing volume capacity. Negative numbers mean to stack vs spread.</td>
    </tr>
    <tr>
      <td>[DEFAULT] backup_metadata_version = 1</td>
      <td>(IntOpt) Backup metadata version to be used when backing up volume metadata. If this number is bumped, make sure the service doing the restore supports the new version.</td>
    </tr>
    <tr>
      <td>[DEFAULT] cinder_emc_config_file = /etc/cinder/cinder_emc_config.xml</td>
      <td>(StrOpt) use this file for cinder emc plugin config data</td>
    </tr>
    <tr>
      <td>[DEFAULT] default_timeout = 20</td>
      <td>(IntOpt) Default Time Out For CLI operations in minutes</td>
    </tr>
    <tr>
      <td>[DEFAULT] extra_capabilities = {}</td>
      <td>(StrOpt) User defined capabilities, a JSON formatted string specifying key/value pairs.</td>
    </tr>
    <tr>
      <td>[DEFAULT] gpfs_storage_pool = None</td>
      <td>(StrOpt) Specifies the storage pool that volumes are assigned to.  By default, the system storage pool is used.</td>
    </tr>
    <tr>
      <td>[DEFAULT] hplefthand_api_url = None</td>
      <td>(StrOpt) HP LeftHand WSAPI Server Url like https://&lt;LeftHand ip&gt;:8081/lhos</td>
    </tr>
    <tr>
      <td>[DEFAULT] hplefthand_clustername = None</td>
      <td>(StrOpt) HP LeftHand cluster name</td>
    </tr>
    <tr>
      <td>[DEFAULT] hplefthand_debug = False</td>
      <td>(BoolOpt) Enable HTTP debugging to LeftHand</td>
    </tr>
    <tr>
      <td>[DEFAULT] hplefthand_iscsi_chap_enabled = False</td>
      <td>(BoolOpt) Configure CHAP authentication for iSCSI connections (Default: Disabled)</td>
    </tr>
    <tr>
      <td>[DEFAULT] hplefthand_password = None</td>
      <td>(StrOpt) HP LeftHand Super user password</td>
    </tr>
    <tr>
      <td>[DEFAULT] hplefthand_username = None</td>
      <td>(StrOpt) HP LeftHand Super user username</td>
    </tr>
    <tr>
      <td>[DEFAULT] kombu_reconnect_delay = 1.0</td>
      <td>(FloatOpt) How long to wait before reconnecting in response to an AMQP consumer cancel notification.</td>
    </tr>
    <tr>
      <td>[DEFAULT] log_config_append = None</td>
      <td>(StrOpt) The name of logging configuration file. It does not disable existing loggers, but just appends specified logging configuration to any other existing logging options. Please see the Python logging module documentation for details on logging configuration files.</td>
    </tr>
    <tr>
      <td>[DEFAULT] max_header_line = 16384</td>
      <td>(IntOpt) Maximum line size of message headers to be accepted. max_header_line may need to be increased when using large tokens (typically those generated by the Keystone v3 API with big service catalogs).</td>
    </tr>
    <tr>
      <td>[DEFAULT] max_luns_per_storage_group = 256</td>
      <td>(IntOpt) Default max number of LUNs in a storage group</td>
    </tr>
    <tr>
      <td>[DEFAULT] msa_vdisk = OpenStack</td>
      <td>(StrOpt) The VDisk to use for volume creation.</td>
    </tr>
    <tr>
      <td>[DEFAULT] nas_ip = </td>
      <td>(StrOpt) IP address or Hostname of NAS system.</td>
    </tr>
    <tr>
      <td>[DEFAULT] nas_login = admin</td>
      <td>(StrOpt) User name to connect to NAS system.</td>
    </tr>
    <tr>
      <td>[DEFAULT] nas_password = </td>
      <td>(StrOpt) Password to connect to NAS system.</td>
    </tr>
    <tr>
      <td>[DEFAULT] nas_private_key = </td>
      <td>(StrOpt) Filename of private key to use for SSH authentication.</td>
    </tr>
    <tr>
      <td>[DEFAULT] nas_ssh_port = 22</td>
      <td>(IntOpt) SSH port to use to connect to NAS system.</td>
    </tr>
    <tr>
      <td>[DEFAULT] naviseccli_path = </td>
      <td>(StrOpt) Naviseccli Path</td>
    </tr>
    <tr>
      <td>[DEFAULT] netapp_controller_ips = None</td>
      <td>(StrOpt) This option is only utilized when the storage family is configured to eseries. This option is used to restrict provisioning to the specified controllers. Specify the value of this option to be a comma separated list of controller hostnames or IP addresses to be used for provisioning.</td>
    </tr>
    <tr>
      <td>[DEFAULT] netapp_copyoffload_tool_path = None</td>
      <td>(StrOpt) This option specifies the path of the NetApp copy offload tool binary. Ensure that the binary has execute permissions set which allow the effective user of the cinder-volume process to execute the file.</td>
    </tr>
    <tr>
      <td>[DEFAULT] netapp_sa_password = None</td>
      <td>(StrOpt) Password for the NetApp E-Series storage array.</td>
    </tr>
    <tr>
      <td>[DEFAULT] netapp_storage_pools = None</td>
      <td>(StrOpt) This option is used to restrict provisioning to the specified storage pools. Only dynamic disk pools are currently supported. Specify the value of this option to be a comma separated list of disk pool names to be used for provisioning.</td>
    </tr>
    <tr>
      <td>[DEFAULT] netapp_webservice_path = /devmgr/v2</td>
      <td>(StrOpt) This option is used to specify the path to the E-Series proxy application on a proxy server. The value is combined with the value of the netapp_transport_type, netapp_server_hostname, and netapp_server_port options to create the URL used by the driver to connect to the proxy application.</td>
    </tr>
    <tr>
      <td>[DEFAULT] nexenta_nms_cache_volroot = True</td>
      <td>(BoolOpt) If set True cache NexentaStor appliance volroot option value.</td>
    </tr>
    <tr>
      <td>[DEFAULT] nexenta_rrmgr_compression = 0</td>
      <td>(IntOpt) Enable stream compression, level 1..9. 1 - gives best speed; 9 - gives best compression.</td>
    </tr>
    <tr>
      <td>[DEFAULT] nexenta_rrmgr_connections = 2</td>
      <td>(IntOpt) Number of TCP connections.</td>
    </tr>
    <tr>
      <td>[DEFAULT] nexenta_rrmgr_tcp_buf_size = 4096</td>
      <td>(IntOpt) TCP Buffer size in KiloBytes.</td>
    </tr>
    <tr>
      <td>[DEFAULT] osapi_volume_workers = None</td>
      <td>(IntOpt) Number of workers for OpenStack Volume API service</td>
    </tr>
    <tr>
      <td>[DEFAULT] password = None</td>
      <td>(StrOpt) Password for Redis server (optional).</td>
    </tr>
    <tr>
      <td>[DEFAULT] port = 6379</td>
      <td>(IntOpt) Use this port to connect to redis host.</td>
    </tr>
    <tr>
      <td>[DEFAULT] rabbit_login_method = AMQPLAIN</td>
      <td>(StrOpt) the RabbitMQ login method</td>
    </tr>
    <tr>
      <td>[DEFAULT] storage_vnx_pool_name = None</td>
      <td>(StrOpt) ISCSI pool name</td>
    </tr>
    <tr>
      <td>[DEFAULT] transport_url = None</td>
      <td>(StrOpt) A URL representing the messaging driver to use and its full configuration. If not set, we fall back to the rpc_backend option and driver specific configuration.</td>
    </tr>
    <tr>
      <td>[DEFAULT] use_syslog_rfc_format = False</td>
      <td>(BoolOpt) (Optional) Use syslog rfc5424 format for logging. If enabled, will add APP-NAME (RFC5424) before the MSG part of the syslog message.  The old format without APP-NAME is deprecated in I, and will be removed in J.</td>
    </tr>
    <tr>
      <td>[DEFAULT] vmware_api_retry_count = 10</td>
      <td>(IntOpt) Number of times VMware ESX/VC server API must be retried upon connection related issues.</td>
    </tr>
    <tr>
      <td>[DEFAULT] vmware_host_ip = None</td>
      <td>(StrOpt) IP address for connecting to VMware ESX/VC server.</td>
    </tr>
    <tr>
      <td>[DEFAULT] vmware_host_password = None</td>
      <td>(StrOpt) Password for authenticating with VMware ESX/VC server.</td>
    </tr>
    <tr>
      <td>[DEFAULT] vmware_host_username = None</td>
      <td>(StrOpt) Username for authenticating with VMware ESX/VC server.</td>
    </tr>
    <tr>
      <td>[DEFAULT] vmware_host_version = None</td>
      <td>(StrOpt) Optional string specifying the VMware VC server version. The driver attempts to retrieve the version from VMware VC server. Set this configuration only if you want to override the VC server version.</td>
    </tr>
    <tr>
      <td>[DEFAULT] vmware_image_transfer_timeout_secs = 7200</td>
      <td>(IntOpt) Timeout in seconds for VMDK volume transfer between Cinder and Glance.</td>
    </tr>
    <tr>
      <td>[DEFAULT] vmware_max_objects_retrieval = 100</td>
      <td>(IntOpt) Max number of objects to be retrieved per batch. Query results will be obtained in batches from the server and not in one shot. Server may still limit the count to something less than the configured value.</td>
    </tr>
    <tr>
      <td>[DEFAULT] vmware_task_poll_interval = 5</td>
      <td>(IntOpt) The interval (in seconds) for polling remote tasks invoked on VMware ESX/VC server.</td>
    </tr>
    <tr>
      <td>[DEFAULT] vmware_volume_folder = cinder-volumes</td>
      <td>(StrOpt) Name for the folder in the VC datacenter that will contain cinder volumes.</td>
    </tr>
    <tr>
      <td>[DEFAULT] vmware_wsdl_location = None</td>
      <td>(StrOpt) Optional VIM service WSDL Location e.g http://&lt;server&gt;/vimService.wsdl. Optional over-ride to default location for bug work-arounds.</td>
    </tr>
    <tr>
      <td>[DEFAULT] volume_clear_ionice = None</td>
      <td>(StrOpt) The flag to pass to ionice to alter the i/o priority of the process used to zero a volume after deletion, for example "-c3" for idle only priority.</td>
    </tr>
    <tr>
      <td>[DEFAULT] xiv_chap = disabled</td>
      <td>(StrOpt) CHAP authentication mode, effective only for iscsi (disabled|enabled)</td>
    </tr>
    <tr>
      <td>[DEFAULT] zoning_mode = none</td>
      <td>(StrOpt) FC Zoning mode configured</td>
    </tr>
    <tr>
      <td>[BRCD_FABRIC_EXAMPLE] fc_fabric_address = </td>
      <td>(StrOpt) Management IP of fabric</td>
    </tr>
    <tr>
      <td>[BRCD_FABRIC_EXAMPLE] fc_fabric_password = </td>
      <td>(StrOpt) Password for user</td>
    </tr>
    <tr>
      <td>[BRCD_FABRIC_EXAMPLE] fc_fabric_port = 22</td>
      <td>(IntOpt) Connecting port</td>
    </tr>
    <tr>
      <td>[BRCD_FABRIC_EXAMPLE] fc_fabric_user = </td>
      <td>(StrOpt) Fabric user ID</td>
    </tr>
    <tr>
      <td>[BRCD_FABRIC_EXAMPLE] principal_switch_wwn = None</td>
      <td>(StrOpt) Principal switch WWN of the fabric</td>
    </tr>
    <tr>
      <td>[BRCD_FABRIC_EXAMPLE] zone_activate = True</td>
      <td>(BoolOpt) overridden zoning activation state</td>
    </tr>
    <tr>
      <td>[BRCD_FABRIC_EXAMPLE] zone_name_prefix = None</td>
      <td>(StrOpt) overridden zone name prefix</td>
    </tr>
    <tr>
      <td>[BRCD_FABRIC_EXAMPLE] zoning_policy = initiator-target</td>
      <td>(StrOpt) overridden zoning policy</td>
    </tr>
    <tr>
      <td>[fc-zone-manager] brcd_sb_connector = cinder.zonemanager.drivers.brocade.brcd_fc_zone_client_cli.BrcdFCZoneClientCLI</td>
      <td>(StrOpt) Southbound connector for zoning operation</td>
    </tr>
    <tr>
      <td>[fc-zone-manager] fc_fabric_names = None</td>
      <td>(StrOpt) Comma separated list of fibre channel fabric names. This list of names is used to retrieve other SAN credentials for connecting to each SAN fabric</td>
    </tr>
    <tr>
      <td>[fc-zone-manager] fc_san_lookup_service = cinder.zonemanager.drivers.brocade.brcd_fc_san_lookup_service.BrcdFCSanLookupService</td>
      <td>(StrOpt) FC San Lookup Service</td>
    </tr>
    <tr>
      <td>[fc-zone-manager] zone_driver = cinder.zonemanager.drivers.brocade.brcd_fc_zone_driver.BrcdFCZoneDriver</td>
      <td>(StrOpt) FC Zone Driver responsible for zone management</td>
    </tr>
    <tr>
      <td>[fc-zone-manager] zoning_policy = initiator-target</td>
      <td>(StrOpt) Zoning policy configured by user</td>
    </tr>
    <tr>
      <td>[matchmaker_ring] ringfile = /etc/oslo/matchmaker_ring.json</td>
      <td>(StrOpt) Matchmaker ring file (JSON).</td>
    </tr>
    <tr>
      <td>[ssl] ca_file = None</td>
      <td>(StrOpt) CA certificate file to use to verify connecting clients</td>
    </tr>
    <tr>
      <td>[ssl] cert_file = None</td>
      <td>(StrOpt) Certificate file to use when starting the server securely</td>
    </tr>
    <tr>
      <td>[ssl] key_file = None</td>
      <td>(StrOpt) Private key file to use when starting the server securely</td>
    </tr>
  </table>
  <table>
    <caption>New default values</caption>
    <col width="33%"/>
    <col width="33%"/>
    <col width="33%"/>
    <thead>
      <tr>
        <td>Option</td>
        <td>Previous default value</td>
        <td>New default value</td>
      </tr>
    </thead>
    <tr>
      <td>[DEFAULT] default_log_levels</td>
      <td>amqplib=WARN, sqlalchemy=WARN, boto=WARN, suds=INFO, keystone=INFO, eventlet.wsgi.server=WARN</td>
      <td>amqp=WARN, amqplib=WARN, boto=WARN, qpid=WARN, sqlalchemy=WARN, suds=INFO, oslo.messaging=INFO, iso8601=WARN, requests.packages.urllib3.connectionpool=WARN</td>
    </tr>
    <tr>
      <td>[DEFAULT] logging_context_format_string</td>
      <td>%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user)s %(tenant)s] %(instance)s%(message)s</td>
      <td>%(asctime)s.%(msecs)03d %(process)d %(levelname)s %(name)s [%(request_id)s %(user_identity)s] %(instance)s%(message)s</td>
    </tr>
    <tr>
      <td>[DEFAULT] rpc_zmq_matchmaker</td>
      <td>cinder.openstack.common.rpc.matchmaker.MatchMakerLocalhost</td>
      <td>oslo.messaging._drivers.matchmaker.MatchMakerLocalhost</td>
    </tr>
    <tr>
      <td>[DEFAULT] sf_account_prefix</td>
      <td>shock</td>
      <td>None</td>
    </tr>
    <tr>
      <td>[DEFAULT] state_path</td>
      <td>$pybasedir</td>
      <td>/var/lib/cinder</td>
    </tr>
  </table>
  <table>
    <caption>Deprecated options</caption>
    <col width="50%"/>
    <col width="50%"/>
    <thead>
      <tr>
        <td>Deprecated option</td>
        <td>New Option</td>
      </tr>
    </thead>
    <tr>
      <td>[DEFAULT] pybasedir</td>
      <td>[DEFAULT] state_path</td>
    </tr>
    <tr>
      <td>[DEFAULT] matchmaker_ringfile</td>
      <td>[matchmaker_ring] ringfile</td>
    </tr>
    <tr>
      <td>[DEFAULT] log_config</td>
      <td>[DEFAULT] log_config_append</td>
    </tr>
    <tr>
      <td>[rpc_notifier2] topics</td>
      <td>[DEFAULT] notification_topics</td>
    </tr>
    <tr>
      <td>[DEFAULT] db_backend</td>
      <td>[database] backend</td>
    </tr>
  </table>
</section>