cicserver
Version information
This version is compatible with:
- Windows
Start using this module
Add this module to your Puppetfile:
mod 'PierrickL-cicserver', '1.2.8'
Learn more about managing modules with a PuppetfileDocumentation
cicserver::install & cicserver::icsurvey
Table of Contents
- Overview
- Module Description - What the modules do and why it is useful
- Setup - The basics of getting started with cicserver::install and cicserver::icsurvey
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Overview
Installs CIC, Interaction Firmware and Media Server silently. Also contains functionality to create ICSurvey files to run the Setup Assistant manually.
Module Description
Uses ruby to create an xml file with the options pre-populated from a template (.erb) file. Allows quick unattended configuration of CIC.
Setup
What install affects
- Installs CIC, Interaction Firmware and Media Server.
- Warning: not recommended for production environments.
What icsurvey affects
- Creates an .icsurvey file.
- Warning: not recommended for production environments.
Setup Requirements OPTIONAL
If your module requires anything extra before setting up (pluginsync enabled, etc.), mention it here.
Beginning with install
The very basic steps needed for a user to get the module up and running.
If your most recent release breaks compatibility or requires particular steps for upgrading, you may wish to include an additional section here: Upgrading (For an example, see http://forge.puppetlabs.com/puppetlabs/firewall).
Beginning with icsurvey
The very basic steps needed for a user to get the module up and running.
If your most recent release breaks compatibility or requires particular steps for upgrading, you may wish to include an additional section here: Upgrading (For an example, see http://forge.puppetlabs.com/puppetlabs/firewall).
Usage
class { 'cicserver::install':
ensure => installed,
survey => 'C:/I3/IC/Manifest/newsurvey.icsurvey', # Where the survey should be generated (and later on, used by the IC Setup Assistant)
installnodomain => true,
organizationname => 'demoorg',
locationname => 'demolocation',
sitename => 'demosite',
dbreporttype => 'db',
dbservertype => 'mssql',
dbtablename => 'I3_IC',
dialplanlocalareacode => '317',
emailfbmc => true,
recordingspath => 'C:/I3/IC/Recordings',
sipnic => 'Ethernet',
outboundaddress => '3178723000',
defaulticpassword => '1234',
licensefile => 'C:/vagrant-data/cic-license.i3lic',
loggedonuserpassword => 'vagrant',
}
class {'cicserver::icsurvey':
path => 'C:/I3/IC/manifest/newsurvey.icsurvey',
installnodomain => true, # set to true if no domain
organizationname => 'organizationname',
locationname => 'locationname',
sitename => 'sitename',
dbreporttype => 'db', # other types will be supported later on (i.e. access)
dbservertype => 'mssql'
dbtablename => 'I3_IC',
dialplanlocalareacode => '317', # only option supported so far
emailfbmc => true,
recordingspath => 'C:/I3/IC/Recordings',
sipnic => 'Ethernet', # use the same name as shown in windows
outboundaddress => '3178723000',
defaulticpassword => '1234', # only valid for users created by ic setup assistant
licensefile => 'C:/I3/IC/iclicense.i3lic',
loggedonuserpassword => 'vagrant',
template => 'cicserver/DefaultSurvey.ICSurvey.erb',
}
class {'cicserver::user':
ensure => installed,
username => 'testuser1', # The new CIC username
password => '1234',
extension => 8001,
pathtoscripts => 'C:/Users/Vagrant/Desktop/Scripts/posh-ic', # Path to the powershell scripts. You can download them here: https://github.com/PierrickI3/posh-ic
cicadminusername => 'vagrant', # CIC user with administrative priviledges
cicadminpassword => '1234',
cicserver => 'testregfr', # your CIC server name
}
class {'cicserver::workgroup':
ensure => installed,
workgroupname => 'testworkgroup1', # The name for the new CIC workgroup
extension => 8001,
members => ['testuser1', 'testuser2']
pathtoscripts => 'C:/Users/Vagrant/Desktop/Scripts/posh-ic', # Path to the powershell scripts. You can download them here: https://github.com/PierrickI3/posh-ic
cicadminusername => 'vagrant', # CIC user with administrative priviledges
cicadminpassword => '1234',
cicserver => 'testregfr', # your CIC server name
}
class {'cicserver::users':
ensure => installed,
cicuserdata => '{"randomidentifier":{"username":"testuser1","password":"1234","extension":"8001"}, "anotherrandomidentifier":{"username":"testuser2","password":"5678","extension":"8003"}}', # JSON data
pathtoscripts => 'C:/Users/Vagrant/Desktop/Scripts/posh-ic', # Path to the powershell scripts. You can download them here: https://github.com/PierrickI3/posh-ic
cicadminusername => 'vagrant', # CIC user with administrative priviledges
cicadminpassword => '1234',
cicserver => 'testregfr', # your CIC server name
}
class {'cicserver::workgroups':
ensure => installed,
cicworkgroupdata => '{"randomidentifier":{"workgroupname":"testworkgroup1","extension":"6001"}, "anotherrandomidentifier":{"workgroupname":"testworkgroup2","extension":"6002"}}', # JSON data
pathtoscripts => 'C:/Users/Vagrant/Desktop/Scripts/posh-ic', # Path to the powershell scripts. You can download them here: https://github.com/PierrickI3/posh-ic
cicadminusername => 'vagrant', # CIC user with administrative priviledges
cicadminpassword => '1234',
cicserver => 'testregfr', # your CIC server name
}
Reference
Here, list the classes, types, providers, facts, etc contained in your module. This section should include all of the under-the-hood workings of your module so people know what the module is touching on their system but don't need to mess with things. (We are working on automating this section!)
Limitations
Only compatible with Windows Tested with Windows 2012 R2
Development
No specific rules. Share/Use/Participate as you wish!
Release Notes
See http://www.inin.com for more information about Interactive Intelligence products.
2014-11-03: Original commit 2014-12-01: Changing name to cicserver 2014-12-09: Adding ICSurvey class 2014-12-17: Fixing cicserver-install-run path 2014-12-17: Fixed cic_icws_installed custom fact & minor fixes 2014-12-18: Adding missing loggedonuserpassword parameter 2014-12-19: Finetuning ic server install parameters 2014-12-19: Removing unnecessary files 2014-12-22: Using powershell instead of psexec 2014-12-22: Added ICServer dependency to Setup Assistant 2014-12-23: Fixed survey directory creation 2014-12-23: Using Start-Process to wait for msiexec to finish for CIC server install 2014-12-23: Using powershell script to install CIC server 2014-01-03: Replaced unless option by onlyif when running setup assistant 2015-01-15: No need to start the Interaction Center service after running setup assistant 2015-01-19: Changed how copies work. Now supports UNC paths and URLs 2015-01-20: Using cache_dir all the way 2015-01-22: Using package to install media server 2015-01-23: removed mediaserverlicensefile parameter 2015-01-27: Fixed media server license copy issue 2015-01-28: Set Interaction Center service to automatic 2015-01-30: Removing unnecessary script parameters 2015-02-08: Changing paths 2015-02-11: Removing hostid 2015-02-12: Linting changes 2015-03-04: Removing the need for the source parameter when installing CIC 2015-04-02: Changing how the ININ Media Server is started as it can timeout on slower machines 2015-04-23: Added support for imdisk 2015-05-29: Added support for CIC 2015 R3 2015-05-29: Also installing R3 Patch 2 2015-06-01: Moved template to a parameter 2015-06-03: Adding temporary fix to set the Notifier value correctly 2015-06-05: Renaming all registry entries that contain old server names before Setup Assistant starts 2015-07-01: Added CPU core check for media server license 2015-08-20: Added cicserver::user to create CIC users 2015-08-21: Added cicserver::workgroup to create CIC workgroups 2015-08-21: Added cicserver::users to create multiple CIC users at once 2015-08-24: Disable regular and idle windows maintenance scheduled tasks 2015-08-24: Added cicserver:workgroups to create multiple CIC workgroups at once 2015-09-11: Added code to install latest version available 2015-09-14: Improved code to use latest version available 2015-11-04: Fixed media server license when using only 1 core 2015-11-04: Fixed facts 2015-11-18: Fixed issue when no patch is available 2015-12-23: MediaServer registry path has changed 2016-03-02: Fixed path to posh-ic scripts 2016-03-08: Made cic license an optional parameter
Dependencies
- puppetlabs/stdlib (>= 4.4.0)
- puppetlabs/powershell (>= 1.0.4)
- puppetlabs/registry (>= 1.0.3)
- puppetlabs/dism (>= 1.1.0)
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.